MongoFilters
Definition of the filters in Bson that are used in MongoDB collection operations.
all
all(fieldName: string, values: java.lang.Object[]) : org.bson.conversions.Bson
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| fieldName | string | |
| values | java.lang.Object[] |
Return
( org.bson.conversions.Bson )
all(fieldName: string, values: Values | DataSchema | java.lang.Iterable) : org.bson.conversions.Bson
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| fieldName | string | |
| values | Values | DataSchema | java.lang.Iterable |
Return
( org.bson.conversions.Bson )
and
and(filters: org.bson.conversions.Bson[]) : org.bson.conversions.Bson
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| filters | org.bson.conversions.Bson[] |
Return
( org.bson.conversions.Bson )
and(filters: Values | DataSchema | java.lang.Iterable) : org.bson.conversions.Bson
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| filters | Values | DataSchema | java.lang.Iterable |
Return
( org.bson.conversions.Bson )
empty
empty() : org.bson.conversions.Bson
Return
( org.bson.conversions.Bson )
eq
eq(value: java.lang.Object) : org.bson.conversions.Bson
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| value | java.lang.Object |
Return
( org.bson.conversions.Bson )
eq(fieldName: string, value: java.lang.Object) : org.bson.conversions.Bson
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| fieldName | string | |
| value | java.lang.Object |
Return
( org.bson.conversions.Bson )
exists
exists(fieldName: string) : org.bson.conversions.Bson
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| fieldName | string |
Return
( org.bson.conversions.Bson )
exists(fieldName: string, exists: boolean) : org.bson.conversions.Bson
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| fieldName | string | |
| exists | boolean |
Return
( org.bson.conversions.Bson )
gt
gt(fieldName: string, value: java.lang.Object) : org.bson.conversions.Bson
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| fieldName | string | |
| value | java.lang.Object |
Return
( org.bson.conversions.Bson )
gte
gte(fieldName: string, value: java.lang.Object) : org.bson.conversions.Bson
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| fieldName | string | |
| value | java.lang.Object |
Return
( org.bson.conversions.Bson )
in
in(fieldName: string, values: java.lang.Object[]) : org.bson.conversions.Bson
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| fieldName | string | |
| values | java.lang.Object[] |
Return
( org.bson.conversions.Bson )
in(fieldName: string, values: Values | DataSchema | java.lang.Iterable) : org.bson.conversions.Bson
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| fieldName | string | |
| values | Values | DataSchema | java.lang.Iterable |
Return
( org.bson.conversions.Bson )
lt
lt(fieldName: string, value: java.lang.Object) : org.bson.conversions.Bson
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| fieldName | string | |
| value | java.lang.Object |
Return
( org.bson.conversions.Bson )
lte
lte(fieldName: string, value: java.lang.Object) : org.bson.conversions.Bson
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| fieldName | string | |
| value | java.lang.Object |
Return
( org.bson.conversions.Bson )
mod
mod(fieldName: string, divisor: long, remainder: long) : org.bson.conversions.Bson
Description
Creates a filter that matches all documents where the value of a field divided by a divisor has the specified remainder (i.e. perform a modulo operation to select documents).
How To Use
_mongo.filters().mod('quantity', 5, 2);
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| fieldName | string | Document field name. |
| divisor | long | The modulus of the operation. |
| remainder | long | The remainder of the operation. |
Return
( org.bson.conversions.Bson )
Returns a filter in Bson format.
ne
ne(fieldName: string, value: java.lang.Object) : org.bson.conversions.Bson
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| fieldName | string | |
| value | java.lang.Object |
Return
( org.bson.conversions.Bson )
nin
nin(fieldName: string, values: java.lang.Object[]) : org.bson.conversions.Bson
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| fieldName | string | |
| values | java.lang.Object[] |
Return
( org.bson.conversions.Bson )
nin(fieldName: string, values: Values | DataSchema | java.lang.Iterable) : org.bson.conversions.Bson
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| fieldName | string | |
| values | Values | DataSchema | java.lang.Iterable |
Return
( org.bson.conversions.Bson )
nor
nor(filters: org.bson.conversions.Bson[]) : org.bson.conversions.Bson
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| filters | org.bson.conversions.Bson[] |
Return
( org.bson.conversions.Bson )
nor(filters: Values | DataSchema | java.lang.Iterable) : org.bson.conversions.Bson
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| filters | Values | DataSchema | java.lang.Iterable |
Return
( org.bson.conversions.Bson )
not
not(filter: org.bson.conversions.Bson) : org.bson.conversions.Bson
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| filter | org.bson.conversions.Bson |
Return
( org.bson.conversions.Bson )
or
or(filters: org.bson.conversions.Bson[]) : org.bson.conversions.Bson
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| filters | org.bson.conversions.Bson[] |
Return
( org.bson.conversions.Bson )
or(filters: Values | DataSchema | java.lang.Iterable) : org.bson.conversions.Bson
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| filters | Values | DataSchema | java.lang.Iterable |
Return
( org.bson.conversions.Bson )
regex
regex(fieldName: string, pattern: string) : org.bson.conversions.Bson
Description
Creates a filter that matches all documents where the value of the field matches the given regular expression pattern.
How To Use
_mongo.filters().regex('fieldName', 'regex');
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| fieldName | string | Document field name. |
| pattern | string | Regular expression. |
Return
( org.bson.conversions.Bson )
Returns a filter in Bson format.
regex(fieldName: string, pattern: string, options: string) : org.bson.conversions.Bson
Description
Creates a filter that matches all documents where the value of the field matches the given regular expression pattern with the given options applied.
How To Use
_mongo.filters().regex('fieldName', 'regex', 'i');
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| fieldName | string | Document field name. |
| pattern | string | Regular expression. |
| options | string | Regex options. |
Return
( org.bson.conversions.Bson )
Returns a filter in Bson format.
regex(fieldName: string, pattern: java.util.regex.Pattern) : org.bson.conversions.Bson
Description
Creates a filter that matches all documents where the value of the field matches the given regular expression pattern.
How To Use
_mongo.filters().regex('fieldName', 'regex');
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| fieldName | string | Document field name. |
| pattern | java.util.regex.Pattern | Regular expression. |
Return
( org.bson.conversions.Bson )
Returns a filter in Bson format.
size
size(fieldName: string, size: int) : org.bson.conversions.Bson
Description
Creates a filter that matches all documents where the value of a field is an array of the specified size.
How To Use
_mongo.filters().size('fieldName', '3');
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| fieldName | string | Document field name. |
| size | int | Size of the array. |
Return
( org.bson.conversions.Bson )
Returns a filter in Bson format.
text
text(search: string) : org.bson.conversions.Bson
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| search | string |
Return
( org.bson.conversions.Bson )
text(search: string, textSearchOptions: com.mongodb.client.model.TextSearchOptions) : org.bson.conversions.Bson
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| search | string | |
| textSearchOptions | com.mongodb.client.model.TextSearchOptions |
Return
( org.bson.conversions.Bson )
type
type(fieldName: string, type: string) : org.bson.conversions.Bson
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| fieldName | string | |
| type | string |
Return
( org.bson.conversions.Bson )
type(fieldName: string, type: org.bson.BsonType) : org.bson.conversions.Bson
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| fieldName | string | |
| type | org.bson.BsonType |
Return
( org.bson.conversions.Bson )
where
where(javaScriptExpression: string) : org.bson.conversions.Bson
Description
Creates a filter that matches all documents for which the given expression is true.
How To Use
_mongo.filters().where('javascript-expression');
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| javaScriptExpression | string | JavaScript expression. |
Return
( org.bson.conversions.Bson )
Returns a filter in Bson format.