NodeIdFilterBuilder
Methods
| Method | Description |
|---|---|
contains | Returns a filter expression that checks whether the string |
ends_with | Returns a filter expression that checks whether the string |
fuzzy_search | Returns a filter expression that performs fuzzy matching |
is_in | Returns a filter expression that checks whether the node ID |
is_not_in | Returns a filter expression that checks whether the node ID |
not_contains | Returns a filter expression that checks whether the string |
starts_with | Returns a filter expression that checks whether the string |
Method Details
contains
Signature: contains(value)
Returns a filter expression that checks whether the string representation of the node ID contains the given substring.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
value | str | - | Substring that must appear within the value. |
Returns
| Type | Description |
|---|---|
filter.FilterExpr | A filter expression evaluating substring search. |
ends_with
Signature: ends_with(value)
Returns a filter expression that checks whether the string representation of the node ID ends with the given suffix.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
value | str | - | Suffix to check for. |
Returns
| Type | Description |
|---|---|
filter.FilterExpr | A filter expression evaluating suffix matching. |
fuzzy_search
Signature: fuzzy_search(value, levenshtein_distance, prefix_match)
Returns a filter expression that performs fuzzy matching against the string representation of the node ID.
Uses a specified Levenshtein distance and optional prefix matching.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
value | str | - | String to approximately match against. |
levenshtein_distance | int | - | Maximum allowed edit distance. |
prefix_match | bool | - | If true, the value must also match as a prefix. |
Returns
| Type | Description |
|---|---|
filter.FilterExpr | A filter expression performing approximate text matching. |
is_in
Signature: is_in(values)
Returns a filter expression that checks whether the node ID is contained within the specified iterable of IDs.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
values | list[int] | - | Iterable of node IDs to match against. |
Returns
| Type | Description |
|---|---|
filter.FilterExpr | A filter expression evaluating membership. |
is_not_in
Signature: is_not_in(values)
Returns a filter expression that checks whether the node ID is not contained within the specified iterable of IDs.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
values | list[int] | - | Iterable of node IDs to exclude. |
Returns
| Type | Description |
|---|---|
filter.FilterExpr | A filter expression evaluating non-membership. |
not_contains
Signature: not_contains(value)
Returns a filter expression that checks whether the string representation of the node ID does not contain the given substring.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
value | str | - | Substring that must not appear within the value. |
Returns
| Type | Description |
|---|---|
filter.FilterExpr | A filter expression evaluating substring exclusion. |
starts_with
Signature: starts_with(value)
Returns a filter expression that checks whether the string representation of the node ID starts with the given prefix.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
value | str | - | Prefix to check for. |
Returns
| Type | Description |
|---|---|
filter.FilterExpr | A filter expression evaluating prefix matching. |