Skip to content

Add case insensitive filters documentation #269

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 28, 2025
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 31 additions & 2 deletions modules/ROOT/pages/filtering.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -177,7 +177,7 @@ query CloseByUsers {

=== String comparison

The following case-sensitive comparison operators are available for `String` and `ID` types:
The following comparison operators are available for `String` and `ID` types:

* `startsWith`
* `endsWith`
Expand Down Expand Up @@ -230,6 +230,35 @@ const features = {
const neoSchema = new Neo4jGraphQL({ features, typeDefs, driver });
----

==== Case-insensitive comparison

Case insensitive filters can be enabled with the `CASE_INSENSITIVE` option:

```javascript
const neoSchema = new Neo4jGraphQL({
features: {
filters: {
String: {
CASE_INSENSITIVE: true,
},
},
},
});
```

This enables the field `caseInsensitive` on string filters:

```graphql
query {
movies(where: { title: { caseInsensitive: { eq: "the matrix" } } }) {
title
}
}
```

All the string filters can be used along with `caseInsensitive`.


=== RegEx matching

The filter `matches` is available for comparison of `String` and `ID` types.
Expand Down Expand Up @@ -628,4 +657,4 @@ query EventsAggregate {
| -
| -

|===
|===