Package com.mongodb.client.model.search

Interface SearchOperator

All Superinterfaces:

org.bson.conversions.Bson

All Known Subinterfaces:

AutocompleteSearchOperator, CompoundSearchOperator, DateNearSearchOperator, DateRangeSearchOperator, EqualsSearchOperator, ExistsSearchOperator, FilterCompoundSearchOperator, GeoNearSearchOperator, InSearchOperator, MoreLikeThisSearchOperator, MustCompoundSearchOperator, MustNotCompoundSearchOperator, NumberNearSearchOperator, NumberRangeSearchOperator, PhraseSearchOperator, QueryStringSearchOperator, RegexSearchOperator, ShouldCompoundSearchOperator, TextSearchOperator, WildcardSearchOperator

@Sealed
@Beta(CLIENT)
public interface SearchOperator
extends org.bson.conversions.Bson

The core part of the $search pipeline stage of an aggregation pipeline.

Since:

4.7

MongoDB Atlas documentation

Search operators

Field Summary

Fields inherited from interface org.bson.conversions.Bson

DEFAULT_CODEC_REGISTRY

Method Summary

Modifier and Type	Method	Description
static AutocompleteSearchOperator	autocomplete(FieldSearchPath path, Iterable<String> queries)	Returns a SearchOperator that may be used to implement search-as-you-type functionality.
static AutocompleteSearchOperator	autocomplete(FieldSearchPath path, String query, String... queries)	Returns a SearchOperator that may be used to implement search-as-you-type functionality.
static CompoundSearchOperatorBase	compound()	Returns a base for a SearchOperator that may combine multiple SearchOperators.
static DateRangeSearchOperatorBase	dateRange(FieldSearchPath path, FieldSearchPath... paths)	Returns a base for a SearchOperator that tests if the BSON Date values of the specified fields are within an interval.
static DateRangeSearchOperatorBase	dateRange(Iterable<? extends FieldSearchPath> paths)	Returns a base for a SearchOperator that tests if the BSON Date values of the specified fields are within an interval.
static EqualsSearchOperator	equals(FieldSearchPath path, boolean value)	Returns a SearchOperator that searches for documents where a field matches the specified value.
static EqualsSearchOperator	equals(FieldSearchPath path, Number value)	Returns a SearchOperator that searches for documents where a field matches the specified value.
static EqualsSearchOperator	equals(FieldSearchPath path, String value)	Returns a SearchOperator that searches for documents where a field matches the specified value.
static EqualsSearchOperator	equals(FieldSearchPath path, Instant value)	Returns a SearchOperator that searches for documents where a field matches the specified value.
static EqualsSearchOperator	equals(FieldSearchPath path, UUID value)	Returns a SearchOperator that searches for documents where a field matches the specified value.
static EqualsSearchOperator	equals(FieldSearchPath path, org.bson.types.ObjectId value)	Returns a SearchOperator that searches for documents where a field matches the specified value.
static EqualsSearchOperator	equalsNull(FieldSearchPath path)	Returns a SearchOperator that searches for documents where a field matches null.
static ExistsSearchOperator	exists(FieldSearchPath path)	Returns a SearchOperator that tests if the path exists in a document.
static InSearchOperator	in(FieldSearchPath path, boolean value, boolean... values)	Returns a SearchOperator that searches for documents where the value or array of values at a given path contains any of the specified values
static <T> InSearchOperator	in(FieldSearchPath path, Iterable<? extends T> values)	Returns a SearchOperator that searches for documents where the value or array of values at a given path contains any of the specified values
static InSearchOperator	in(FieldSearchPath path, Number value, Number... values)	Returns a SearchOperator that searches for documents where the value or array of values at a given path contains any of the specified values
static InSearchOperator	in(FieldSearchPath path, String value, String... values)	Returns a SearchOperator that searches for documents where the value or array of values at a given path contains any of the specified values
static InSearchOperator	in(FieldSearchPath path, Instant value, Instant... values)	Returns a SearchOperator that searches for documents where the value or array of values at a given path contains any of the specified values
static InSearchOperator	in(FieldSearchPath path, UUID value, UUID... values)	Returns a SearchOperator that searches for documents where the value or array of values at a given path contains any of the specified values
static InSearchOperator	in(FieldSearchPath path, org.bson.types.ObjectId value, org.bson.types.ObjectId... values)	Returns a SearchOperator that searches for documents where the value or array of values at a given path contains any of the specified values
static MoreLikeThisSearchOperator	moreLikeThis(Iterable<org.bson.BsonDocument> likes)	Returns a SearchOperator that returns documents similar to input documents.
static MoreLikeThisSearchOperator	moreLikeThis(org.bson.BsonDocument like)	Returns a SearchOperator that returns documents similar to input document.
static GeoNearSearchOperator	near(Point origin, Number pivot, FieldSearchPath path, FieldSearchPath... paths)	Returns a SearchOperator that allows finding results that are near the specified origin.
static GeoNearSearchOperator	near(Point origin, Number pivot, Iterable<? extends FieldSearchPath> paths)	Returns a SearchOperator that allows finding results that are near the specified origin.
static NumberNearSearchOperator	near(Number origin, Number pivot, FieldSearchPath path, FieldSearchPath... paths)	Returns a SearchOperator that allows finding results that are near the specified origin.
static NumberNearSearchOperator	near(Number origin, Number pivot, Iterable<? extends FieldSearchPath> paths)	Returns a SearchOperator that allows finding results that are near the specified origin.
static DateNearSearchOperator	near(Instant origin, Duration pivot, FieldSearchPath path, FieldSearchPath... paths)	Returns a SearchOperator that allows finding results that are near the specified origin.
static DateNearSearchOperator	near(Instant origin, Duration pivot, Iterable<? extends FieldSearchPath> paths)	Returns a SearchOperator that allows finding results that are near the specified origin.
static NumberRangeSearchOperatorBase	numberRange(FieldSearchPath path, FieldSearchPath... paths)	Returns a base for a SearchOperator that tests if the BSON 32-bit integer / 64-bit integer / Double values of the specified fields are within an interval.
static NumberRangeSearchOperatorBase	numberRange(Iterable<? extends FieldSearchPath> paths)	Returns a base for a SearchOperator that tests if the BSON 32-bit integer / 64-bit integer / Double values of the specified fields are within an interval.
static SearchOperator	of(org.bson.conversions.Bson operator)	Creates a SearchOperator from a Bson in situations when there is no builder method that better satisfies your needs.
static PhraseSearchOperator	phrase(SearchPath path, String query)	Returns a SearchOperator that performs a search for documents containing an ordered sequence of terms.
static PhraseSearchOperator	phrase(Iterable<? extends SearchPath> paths, Iterable<String> queries)	Returns a SearchOperator that performs a search for documents containing an ordered sequence of terms.
static QueryStringSearchOperator	queryString(FieldSearchPath defaultPath, String query)	Returns a SearchOperator that supports querying a combination of indexed fields and values.
static RegexSearchOperator	regex(SearchPath path, String query)	Returns a SearchOperator that performs a search using a regular expression.
static RegexSearchOperator	regex(Iterable<? extends SearchPath> paths, Iterable<String> queries)	Returns a SearchOperator that performs a search using a regular expression.
SearchOperator	score(SearchScore modifier)	Creates a new SearchOperator with the scoring modifier specified.
static TextSearchOperator	text(SearchPath path, String query)	Returns a SearchOperator that performs a full-text search.
static TextSearchOperator	text(Iterable<? extends SearchPath> paths, Iterable<String> queries)	Returns a SearchOperator that performs a full-text search.
static WildcardSearchOperator	wildcard(SearchPath path, String query)	Returns a SearchOperator that performs a search using a special characters in the search string that can match any character.
static WildcardSearchOperator	wildcard(Iterable<String> queries, Iterable<? extends SearchPath> paths)	Returns a SearchOperator that performs a search using a special characters in the search string that can match any character.

Methods inherited from interface org.bson.conversions.Bson

toBsonDocument, toBsonDocument

Method Details

score

SearchOperator score(SearchScore modifier)

Creates a new SearchOperator with the scoring modifier specified.

Parameters:

modifier - The scoring modifier.

Returns:

A new SearchOperator.

compound

static CompoundSearchOperatorBase compound()

Returns a base for a SearchOperator that may combine multiple SearchOperators. Combining SearchOperators affects calculation of the relevance score.

Returns:

A base for a CompoundSearchOperator.

MongoDB Atlas documentation

compound operator

exists

static ExistsSearchOperator exists(FieldSearchPath path)

Returns a SearchOperator that tests if the path exists in a document.

Parameters:

path - The path to test.

Returns:

The requested SearchOperator.

MongoDB Atlas documentation

exists operator

text

static TextSearchOperator text(SearchPath path,
 String query)

Returns a SearchOperator that performs a full-text search.

Parameters:

path - The field to be searched.

query - The string to search for.

Returns:

The requested SearchOperator.

MongoDB Atlas documentation

text operator

text

static TextSearchOperator text(Iterable<? extends SearchPath> paths,
 Iterable<String> queries)

Returns a SearchOperator that performs a full-text search.

Parameters:

paths - The non-empty fields to be searched.

queries - The non-empty strings to search for.

Returns:

The requested SearchOperator.

MongoDB Atlas documentation

text operator

autocomplete

static AutocompleteSearchOperator autocomplete(FieldSearchPath path,
 String query,
 String... queries)

Returns a SearchOperator that may be used to implement search-as-you-type functionality.

Parameters:

path - The field to be searched.

query - The string to search for.

queries - More strings to search for.

Returns:

The requested SearchOperator.

MongoDB Atlas documentation

autocomplete operator

autocomplete

static AutocompleteSearchOperator autocomplete(FieldSearchPath path,
 Iterable<String> queries)

Returns a SearchOperator that may be used to implement search-as-you-type functionality.

Parameters:

path - The field to be searched.

queries - The non-empty strings to search for.

Returns:

The requested SearchOperator.

MongoDB Atlas documentation

autocomplete operator

numberRange

static NumberRangeSearchOperatorBase numberRange(FieldSearchPath path,
 FieldSearchPath... paths)

Returns a base for a SearchOperator that tests if the BSON 32-bit integer / 64-bit integer / Double values of the specified fields are within an interval.

Parameters:

path - The field to be searched.

paths - More fields to be searched.

Returns:

A base for a NumberRangeSearchOperator.

MongoDB Atlas documentation

range operator

numberRange

static NumberRangeSearchOperatorBase numberRange(Iterable<? extends FieldSearchPath> paths)

Returns a base for a SearchOperator that tests if the BSON 32-bit integer / 64-bit integer / Double values of the specified fields are within an interval.

Parameters:

paths - The non-empty fields to be searched.

Returns:

A base for a NumberRangeSearchOperator.

MongoDB Atlas documentation

range operator

dateRange

static DateRangeSearchOperatorBase dateRange(FieldSearchPath path,
 FieldSearchPath... paths)

Returns a base for a SearchOperator that tests if the BSON Date values of the specified fields are within an interval.

Parameters:

path - The field to be searched.

paths - More fields to be searched.

Returns:

A base for a DateRangeSearchOperator.

MongoDB Atlas documentation

range operator

dateRange

static DateRangeSearchOperatorBase dateRange(Iterable<? extends FieldSearchPath> paths)

Returns a base for a SearchOperator that tests if the BSON Date values of the specified fields are within an interval.

Parameters:

paths - The non-empty fields to be searched.

Returns:

A base for a DateRangeSearchOperator.

MongoDB Atlas documentation

range operator

near

static NumberNearSearchOperator near(Number origin,
 Number pivot,
 FieldSearchPath path,
 FieldSearchPath... paths)

Returns a SearchOperator that allows finding results that are near the specified origin.

Parameters:

origin - The origin from which the proximity of the results is measured. The relevance score is 1 if the values of the fields are origin.

pivot - The distance from the origin at which the relevance score drops in half.

path - The field to be searched.

paths - More fields to be searched.

Returns:

The requested SearchOperator.

MongoDB Atlas documentation

near operator

near

static NumberNearSearchOperator near(Number origin,
 Number pivot,
 Iterable<? extends FieldSearchPath> paths)

Returns a SearchOperator that allows finding results that are near the specified origin.

Parameters:

origin - The origin from which the proximity of the results is measured. The relevance score is 1 if the values of the fields are origin.

pivot - The distance from the origin at which the relevance score drops in half.

paths - The non-empty fields to be searched.

Returns:

The requested SearchOperator.

MongoDB Atlas documentation

near operator

near

static DateNearSearchOperator near(Instant origin,
 Duration pivot,
 FieldSearchPath path,
 FieldSearchPath... paths)

Returns a SearchOperator that allows finding results that are near the specified origin.

Parameters:

origin - The origin from which the proximity of the results is measured. The relevance score is 1 if the values of the fields are origin.

pivot - The distance from the origin at which the relevance score drops in half. Data is extracted via Duration.toMillis().

path - The field to be searched.

paths - More fields to be searched.

Returns:

The requested SearchOperator.

See Also:

• InstantCodec

MongoDB Atlas documentation

near operator

near

static DateNearSearchOperator near(Instant origin,
 Duration pivot,
 Iterable<? extends FieldSearchPath> paths)

Returns a SearchOperator that allows finding results that are near the specified origin.

Parameters:

origin - The origin from which the proximity of the results is measured. The relevance score is 1 if the values of the fields are origin.

pivot - The distance from the origin at which the relevance score drops in half. Data is extracted via Duration.toMillis().

paths - The non-empty fields to be searched.

Returns:

The requested SearchOperator.

See Also:

• InstantCodec

MongoDB Atlas documentation

near operator

near

static GeoNearSearchOperator near(Point origin,
 Number pivot,
 FieldSearchPath path,
 FieldSearchPath... paths)

Returns a SearchOperator that allows finding results that are near the specified origin.

Parameters:

origin - The origin from which the proximity of the results is measured. The relevance score is 1 if the values of the fields are origin.

pivot - The distance in meters from the origin at which the relevance score drops in half.

path - The field to be searched.

paths - More fields to be searched.

Returns:

The requested SearchOperator.

MongoDB Atlas documentation

near operator

near

static GeoNearSearchOperator near(Point origin,
 Number pivot,
 Iterable<? extends FieldSearchPath> paths)

Returns a SearchOperator that allows finding results that are near the specified origin.

Parameters:

origin - The origin from which the proximity of the results is measured. The relevance score is 1 if the values of the fields are origin.

pivot - The distance in meters from the origin at which the relevance score drops in half.

paths - The non-empty fields to be searched.

Returns:

The requested SearchOperator.

MongoDB Atlas documentation

near operator

in

static InSearchOperator in(FieldSearchPath path,
 boolean value,
 boolean... values)

Returns a SearchOperator that searches for documents where the value or array of values at a given path contains any of the specified values

Parameters:

path - The indexed field to be searched.

value - The boolean value to search for.

values - More fields to be searched.

Returns:

The requested SearchOperator.

MongoDB Atlas documentation

in operator

in

static InSearchOperator in(FieldSearchPath path,
 org.bson.types.ObjectId value,
 org.bson.types.ObjectId... values)

Returns a SearchOperator that searches for documents where the value or array of values at a given path contains any of the specified values

Parameters:

path - The indexed field to be searched.

value - The objectId value to search for.

values - More fields to be searched.

Returns:

The requested SearchOperator.

MongoDB Atlas documentation

in operator

in

static InSearchOperator in(FieldSearchPath path,
 Number value,
 Number... values)

Returns a SearchOperator that searches for documents where the value or array of values at a given path contains any of the specified values

Parameters:

path - The indexed field to be searched.

value - The number value to search for.

values - More fields to be searched.

Returns:

The requested SearchOperator.

MongoDB Atlas documentation

in operator

in

static InSearchOperator in(FieldSearchPath path,
 Instant value,
 Instant... values)

Returns a SearchOperator that searches for documents where the value or array of values at a given path contains any of the specified values

Parameters:

path - The indexed field to be searched.

value - The instant date value to search for.

values - More fields to be searched.

Returns:

The requested SearchOperator.

MongoDB Atlas documentation

in operator

in

static InSearchOperator in(FieldSearchPath path,
 UUID value,
 UUID... values)

Returns a SearchOperator that searches for documents where the value or array of values at a given path contains any of the specified values

Parameters:

path - The indexed field to be searched.

value - The uuid value to search for.

values - More fields to be searched.

Returns:

The requested SearchOperator.

MongoDB Atlas documentation

in operator

in

static InSearchOperator in(FieldSearchPath path,
 String value,
 String... values)

Returns a SearchOperator that searches for documents where the value or array of values at a given path contains any of the specified values

Parameters:

path - The indexed field to be searched.

value - The string value to search for.

values - More fields to be searched.

Returns:

The requested SearchOperator.

MongoDB Atlas documentation

in operator

in

static <T> InSearchOperator in(FieldSearchPath path,
 Iterable<? extends T> values)

Returns a SearchOperator that searches for documents where the value or array of values at a given path contains any of the specified values

Type Parameters:

T - the type of elements in values.

Parameters:

path - The indexed field to be searched.

values - The non-empty values to search for. Value can be either a single value or an array of values of only one of the supported BSON types and can't be a mix of different types.

Returns:

The requested SearchOperator.

MongoDB Atlas documentation

in operator

equals

static EqualsSearchOperator equals(FieldSearchPath path,
 boolean value)

Returns a SearchOperator that searches for documents where a field matches the specified value.

Parameters:

path - The indexed field to be searched.

value - The boolean value to query for.

Returns:

The requested SearchOperator.

MongoDB Atlas documentation

equals operator

equals

static EqualsSearchOperator equals(FieldSearchPath path,
 org.bson.types.ObjectId value)

Returns a SearchOperator that searches for documents where a field matches the specified value.

Parameters:

path - The indexed field to be searched.

value - The object id value to query for.

Returns:

The requested SearchOperator.

MongoDB Atlas documentation

equals operator

equals

static EqualsSearchOperator equals(FieldSearchPath path,
 Number value)

Returns a SearchOperator that searches for documents where a field matches the specified value.

Parameters:

path - The indexed field to be searched.

value - The number value to query for.

Returns:

The requested SearchOperator.

MongoDB Atlas documentation

equals operator

equals

static EqualsSearchOperator equals(FieldSearchPath path,
 Instant value)

Returns a SearchOperator that searches for documents where a field matches the specified value.

Parameters:

path - The indexed field to be searched.

value - The instant date value to query for.

Returns:

The requested SearchOperator.

MongoDB Atlas documentation

equals operator

equals

static EqualsSearchOperator equals(FieldSearchPath path,
 String value)

Returns a SearchOperator that searches for documents where a field matches the specified value.

Parameters:

path - The indexed field to be searched.

value - The string value to query for.

Returns:

The requested SearchOperator.

MongoDB Atlas documentation

equals operator

equals

static EqualsSearchOperator equals(FieldSearchPath path,
 UUID value)

Returns a SearchOperator that searches for documents where a field matches the specified value.

Parameters:

path - The indexed field to be searched.

value - The uuid value to query for.

Returns:

The requested SearchOperator.

MongoDB Atlas documentation

equals operator

equalsNull

static EqualsSearchOperator equalsNull(FieldSearchPath path)

Returns a SearchOperator that searches for documents where a field matches null.

Parameters:

path - The indexed field to be searched.

Returns:

The requested SearchOperator.

MongoDB Atlas documentation

equals operator

moreLikeThis

static MoreLikeThisSearchOperator moreLikeThis(org.bson.BsonDocument like)

Returns a SearchOperator that returns documents similar to input document.

Parameters:

like - The BSON document that is used to extract representative terms to query for.

Returns:

The requested SearchOperator.

MongoDB Atlas documentation

moreLikeThis operator

moreLikeThis

static MoreLikeThisSearchOperator moreLikeThis(Iterable<org.bson.BsonDocument> likes)

Returns a SearchOperator that returns documents similar to input documents.

Parameters:

likes - The BSON documents that are used to extract representative terms to query for.

Returns:

The requested SearchOperator.

MongoDB Atlas documentation

moreLikeThis operator

queryString

static QueryStringSearchOperator queryString(FieldSearchPath defaultPath,
 String query)

Returns a SearchOperator that supports querying a combination of indexed fields and values.

Parameters:

defaultPath - The field to be searched by default.

query - One or more indexed fields and values to search.

Returns:

The requested SearchOperator.

MongoDB Atlas documentation

queryString operator

phrase

static PhraseSearchOperator phrase(SearchPath path,
 String query)

Returns a SearchOperator that performs a search for documents containing an ordered sequence of terms.

Parameters:

path - The field to be searched.

query - The string to search for.

Returns:

The requested SearchOperator.

MongoDB Atlas documentation

phrase operator

phrase

static PhraseSearchOperator phrase(Iterable<? extends SearchPath> paths,
 Iterable<String> queries)

Returns a SearchOperator that performs a search for documents containing an ordered sequence of terms.

Parameters:

paths - The non-empty fields to be searched.

queries - The non-empty strings to search for.

Returns:

The requested SearchOperator.

MongoDB Atlas documentation

phrase operator

wildcard

static WildcardSearchOperator wildcard(SearchPath path,
 String query)

Returns a SearchOperator that performs a search using a special characters in the search string that can match any character.

Parameters:

path - The indexed field to be searched.

query - The string to search for.

Returns:

The requested SearchOperator.

MongoDB Atlas documentation

wildcard operator

wildcard

static WildcardSearchOperator wildcard(Iterable<String> queries,
 Iterable<? extends SearchPath> paths)

Returns a SearchOperator that performs a search using a special characters in the search string that can match any character.

Parameters:

queries - The non-empty strings to search for.

paths - The non-empty index fields to be searched.

Returns:

The requested SearchOperator.

MongoDB Atlas documentation

wildcard operator

regex

static RegexSearchOperator regex(SearchPath path,
 String query)

Returns a SearchOperator that performs a search using a regular expression.

Parameters:

path - The field to be searched.

query - The string to search for.

Returns:

The requested SearchOperator.

MongoDB Atlas documentation

regex operator

regex

static RegexSearchOperator regex(Iterable<? extends SearchPath> paths,
 Iterable<String> queries)

Returns a SearchOperator that performs a search using a regular expression.

Parameters:

paths - The non-empty fields to be searched.

queries - The non-empty strings to search for.

Returns:

The requested SearchOperator.

MongoDB Atlas documentation

regex operator

of

static SearchOperator of(org.bson.conversions.Bson operator)

Creates a SearchOperator from a Bson in situations when there is no builder method that better satisfies your needs. This method cannot be used to validate the syntax.

Example
The following code creates two functionally equivalent SearchOperators, though they may not be equal.

  SearchOperator operator1 = SearchOperator.exists(
          SearchPath.fieldPath("fieldName"));
  SearchOperator operator2 = SearchOperator.of(new Document("exists",
          new Document("path", SearchPath.fieldPath("fieldName").toValue())));
 

Parameters:

operator - A Bson representing the required SearchOperator.

Returns:

The requested SearchOperator.