Skip to content

Commit

Permalink
Update readme for anyOf and not
Browse files Browse the repository at this point in the history
  • Loading branch information
acerbusace committed Nov 27, 2024
1 parent 7ec7e83 commit bba1322
Show file tree
Hide file tree
Showing 7 changed files with 15 additions and 14 deletions.
Original file line number Diff line number Diff line change
@@ -1,19 +1,19 @@
[`gt`]({% link query-api/filtering/comparison.md %})
: Matches records where the field value is greater than (>) the provided value.

Will be ignored when `null` is passed.
Will be treated as `true` when `null` is passed.

[`gte`]({% link query-api/filtering/comparison.md %})
: Matches records where the field value is greater than or equal to (>=) the provided value.

Will be ignored when `null` is passed.
Will be treated as `true` when `null` is passed.

[`lt`]({% link query-api/filtering/comparison.md %})
: Matches records where the field value is less than (<) the provided value.

Will be ignored when `null` is passed.
Will be treated as `true` when `null` is passed.

[`lte`]({% link query-api/filtering/comparison.md %})
: Matches records where the field value is less than or equal to (<=) the provided value.

Will be ignored when `null` is passed.
Will be treated as `true` when `null` is passed.
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,12 @@
filters that can't be provided on a single filter input because of collisions between key names.
For example, if you want to provide multiple `anySatisfy: ...` filters, you could do `allOf: [{anySatisfy: ...}, {anySatisfy: ...}]`.

Will be ignored when `null` or an empty list is passed.
Will be treated as `true` when `null` or an empty object is passed.
When an empty list is passed, will cause this part of the filter to match no documents.

[`anyOf`]({% link query-api/filtering/conjunctions.md %})
: Matches records where any of the provided sub-filters evaluate to true.
This works just like an `OR` operator in SQL.

Will be ignored when `null` is passed. When an empty list is passed, will
cause this part of the filter to match no documents.
Will be treated as `true` when `null` or an empty object is passed.
When an empty list is passed, will cause this part of the filter to match no documents.
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,6 @@
: Matches records where the field value is equal to any of the provided values.
This works just like an `IN` operator in SQL.

Will be ignored when `null` is passed.
Will be treated as `true` when `null` is passed.
When an empty list is passed, will cause this part of the filter to match no documents.
When `null` is passed in the list, will match records where the field value is `null`.
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,11 @@
full text search. This is stricter than `matchesQuery`: all terms must match
and be in the same order as the provided phrase.

Will be ignored when `null` is passed.
Will be treated as `true` when `null` is passed.

[`matchesQuery`]({% link query-api/filtering/full-text-search.md %})
: Matches records where the field value matches the provided query using full text search.
This is more lenient than `matchesPhrase`: the order of terms is ignored, and, by default,
only one search term is required to be in the field value.

Will be ignored when `null` is passed.
Will be treated as `true` when `null` is passed.
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
[`anySatisfy`]({% link query-api/filtering/list.md %})
: Matches records where any of the list elements match the provided sub-filter.

Will be ignored when `null` or an empty object is passed.
Will be treated as `true` when `null` or an empty object is passed.

[`count`]({% link query-api/filtering/list.md %})
: Used to filter on the number of non-null elements in this list field.

Will be ignored when `null` or an empty object is passed.
Will be treated as `true` when `null` or an empty object is passed.
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@
: Matches records where the provided sub-filter evaluates to false.
This works just like a `NOT` operator in SQL.

Will be ignored when `null` or an empty object is passed.
Will be treated as `false` when `null` or an empty object is passed.
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
[`timeOfDay`]({% link query-api/filtering/date-time.md %})
: Matches records based on the time-of-day of the DateTime values.

Will be ignored when `null` of an empty object is passed.
Will be treated as `true` when `null` or an empty object is passed.

0 comments on commit bba1322

Please sign in to comment.