Click or drag to resize

SearchDefinitionBuilder<TDocument> Class

A builder for a search definition.
Inheritance Hierarchy
System.Object
  MongoDB.Driver.Search.SearchDefinitionBuilder<TDocument>

Namespace:  MongoDB.Driver.Search
Assembly:  MongoDB.Driver (in MongoDB.Driver.dll) Version: 2.21.0+5a9c3311e158910b88195f290e6d4b1b2715d2b2
Syntax
public sealed class SearchDefinitionBuilder<TDocument>

Type Parameters

TDocument
The type of the document.

The SearchDefinitionBuilder<TDocument> type exposes the following members.

Constructors
  NameDescription
Public methodSearchDefinitionBuilder<TDocument>
Initializes a new instance of the SearchDefinitionBuilder<TDocument> class
Top
Methods
  NameDescription
Public methodAutocomplete(SearchPathDefinition<TDocument>, SearchQueryDefinition, SearchAutocompleteTokenOrder, SearchFuzzyOptions, SearchScoreDefinition<TDocument>)
Creates a search definition that performs a search for a word or phrase that contains a sequence of characters from an incomplete input string.
Public methodAutocomplete<TField>(Expression<Func<TDocument, TField>>, SearchQueryDefinition, SearchAutocompleteTokenOrder, SearchFuzzyOptions, SearchScoreDefinition<TDocument>)
Creates a search definition that performs a search for a word or phrase that contains a sequence of characters from an incomplete search string.
Public methodCompound
Creates a builder for a compound search definition.
Public methodEmbeddedDocument<TField>(Expression<Func<TDocument, IEnumerable<TField>>>, SearchDefinition<TField>, SearchScoreDefinition<TDocument>)
Creates a search definition that performs a search for documents where the specified query operator is satisfied from a single element of an array of embedded documents specified by path.
Public methodEmbeddedDocument<TField>(FieldDefinition<TDocument, IEnumerable<TField>>, SearchDefinition<TField>, SearchScoreDefinition<TDocument>)
Creates a search definition that performs a search for documents where the specified query operator is satisfied from a single element of an array of embedded documents specified by path.
Public methodEquals(Object)
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Public methodEquals<TField>(Expression<Func<TDocument, TField>>, TField, SearchScoreDefinition<TDocument>)
Creates a search definition that queries for documents where an indexed field is equal to the specified value. Supported value types are boolean, numeric, ObjectId and date.
Public methodEquals<TField>(FieldDefinition<TDocument, TField>, TField, SearchScoreDefinition<TDocument>)
Creates a search definition that queries for documents where an indexed field is equal to the specified value. Supported value types are boolean, numeric, ObjectId and date.
Public methodExists(FieldDefinition<TDocument>)
Creates a search definition that tests if a path to a specified indexed field name exists in a document.
Public methodExists<TField>(Expression<Func<TDocument, TField>>)
Creates a search definition that tests if a path to a specified indexed field name exists in a document.
Public methodFacet(SearchDefinition<TDocument>,SearchFacet<TDocument>[])
Creates a search definition that groups results by values or ranges in the specified faceted fields and returns the count for each of those groups.
Public methodFacet(SearchDefinition<TDocument>, IEnumerable<SearchFacet<TDocument>>)
Creates a search definition that groups results by values or ranges in the specified faceted fields and returns the count for each of those groups.
Public methodGeoShape<TCoordinates>(SearchPathDefinition<TDocument>, GeoShapeRelation, GeoJsonGeometry<TCoordinates>, SearchScoreDefinition<TDocument>)
Creates a search definition that queries for shapes with a given geometry.
Public methodGeoShape<TCoordinates, TField>(Expression<Func<TDocument, TField>>, GeoShapeRelation, GeoJsonGeometry<TCoordinates>, SearchScoreDefinition<TDocument>)
Creates a search definition that queries for shapes with a given geometry.
Public methodGeoWithin<TCoordinates>(SearchPathDefinition<TDocument>, GeoJsonGeometry<TCoordinates>, SearchScoreDefinition<TDocument>)
Creates a search definition that queries for geographic points within a given geometry.
Public methodGeoWithin<TCoordinates>(SearchPathDefinition<TDocument>, GeoWithinArea<TCoordinates>, SearchScoreDefinition<TDocument>)
Creates a search definition that queries for geographic points within a given geo object.
Public methodGeoWithin<TCoordinates, TField>(Expression<Func<TDocument, TField>>, GeoJsonGeometry<TCoordinates>, SearchScoreDefinition<TDocument>)
Creates a search definition that queries for geographic points within a given geometry.
Public methodGeoWithin<TCoordinates, TField>(Expression<Func<TDocument, TField>>, GeoWithinArea<TCoordinates>, SearchScoreDefinition<TDocument>)
Creates a search definition that queries for geographic points within a given geo object.
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodMoreLikeThis<TLike>(IEnumerable<TLike>)
Creates a search definition that returns documents similar to the input documents.
Public methodMoreLikeThis<TLike>(TLike[])
Creates a search definition that returns documents similar to the input documents.
Public methodNear(SearchPathDefinition<TDocument>, DateTime, Int64, SearchScoreDefinition<TDocument>)
Creates a search definition that supports querying and scoring numeric and date values.
Public methodNear(SearchPathDefinition<TDocument>, Double, Double, SearchScoreDefinition<TDocument>)
Creates a search definition that supports querying and scoring numeric and date values.
Public methodNear(SearchPathDefinition<TDocument>, Int32, Int32, SearchScoreDefinition<TDocument>)
Creates a search definition that supports querying and scoring numeric and date values.
Public methodNear(SearchPathDefinition<TDocument>, Int64, Int64, SearchScoreDefinition<TDocument>)
Creates a search definition that supports querying and scoring numeric and date values.
Public methodNear<TField>(Expression<Func<TDocument, TField>>, DateTime, Int64, SearchScoreDefinition<TDocument>)
Creates a search definition that supports querying and scoring numeric and date values.
Public methodNear<TField>(Expression<Func<TDocument, TField>>, Double, Double, SearchScoreDefinition<TDocument>)
Creates a search definition that supports querying and scoring numeric and date values.
Public methodNear<TField>(Expression<Func<TDocument, TField>>, Int32, Int32, SearchScoreDefinition<TDocument>)
Creates a search definition that supports querying and scoring numeric and date values.
Public methodNear<TField>(Expression<Func<TDocument, TField>>, Int64, Int64, SearchScoreDefinition<TDocument>)
Creates a search definition that supports querying and scoring numeric and date values.
Public methodNear<TCoordinates>(SearchPathDefinition<TDocument>, GeoJsonPoint<TCoordinates>, Double, SearchScoreDefinition<TDocument>)
Creates a search definition that supports querying and scoring numeric and date values.
Public methodNear<TCoordinates, TField>(Expression<Func<TDocument, TField>>, GeoJsonPoint<TCoordinates>, Double, SearchScoreDefinition<TDocument>)
Creates a search definition that supports querying and scoring numeric and date values.
Public methodPhrase(SearchPathDefinition<TDocument>, SearchQueryDefinition, Nullable<Int32>, SearchScoreDefinition<TDocument>)
Creates a search definition that performs search for documents containing an ordered sequence of terms.
Public methodPhrase<TField>(Expression<Func<TDocument, TField>>, SearchQueryDefinition, Nullable<Int32>, SearchScoreDefinition<TDocument>)
Creates a search definition that performs search for documents containing an ordered sequence of terms.
Public methodQueryString(FieldDefinition<TDocument>, String, SearchScoreDefinition<TDocument>)
Creates a search definition that queries a combination of indexed fields and values.
Public methodQueryString<TField>(Expression<Func<TDocument, TField>>, String, SearchScoreDefinition<TDocument>)
Creates a search definition that queries a combination of indexed fields and values.
Public methodRange<TField>(Expression<Func<TDocument, TField>>, SearchRange<TField>, SearchScoreDefinition<TDocument>)
Creates a search definition that queries for documents where a field is in the specified range.
Public methodRange<TField>(SearchPathDefinition<TDocument>, SearchRange<TField>, SearchScoreDefinition<TDocument>)
Creates a search definition that queries for documents where a field is in the specified range.
Public methodRegex(SearchPathDefinition<TDocument>, SearchQueryDefinition, Boolean, SearchScoreDefinition<TDocument>)
Creates a search definition that interprets the query as a regular expression.
Public methodRegex<TField>(Expression<Func<TDocument, TField>>, SearchQueryDefinition, Boolean, SearchScoreDefinition<TDocument>)
Creates a search definition that interprets the query as a regular expression.
Public methodSpan
Creates a search definition that finds text search matches within regions of a text field.
Public methodText(SearchPathDefinition<TDocument>, SearchQueryDefinition, SearchFuzzyOptions, SearchScoreDefinition<TDocument>)
Creates a search definition that performs full-text search using the analyzer specified in the index configuration.
Public methodText<TField>(Expression<Func<TDocument, TField>>, SearchQueryDefinition, SearchFuzzyOptions, SearchScoreDefinition<TDocument>)
Creates a search definition that performs full-text search using the analyzer specified in the index configuration.
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Public methodWildcard(SearchPathDefinition<TDocument>, SearchQueryDefinition, Boolean, SearchScoreDefinition<TDocument>)
Creates a search definition that uses special characters in the search string that can match any character.
Public methodWildcard<TField>(Expression<Func<TDocument, TField>>, SearchQueryDefinition, Boolean, SearchScoreDefinition<TDocument>)
Creates a search definition that uses special characters in the search string that can match any character.
Top
Extension Methods
  NameDescription
Public Extension MethodToBson
Serializes an object to a BSON byte array.
(Defined by BsonExtensionMethods.)
Public Extension MethodToBsonDocument
Serializes an object to a BsonDocument.
(Defined by BsonExtensionMethods.)
Public Extension MethodToJson
Serializes an object to a JSON string.
(Defined by BsonExtensionMethods.)
Top
See Also