SearchDefinitionBuilderTDocumentEqualsTField Method (FieldDefinitionTDocument, TField, TField, SearchScoreDefinitionTDocument)

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.

Namespace: MongoDB.Driver.Search
Assembly: MongoDB.Driver (in MongoDB.Driver.dll) Version: 2.21.0+5a9c3311e158910b88195f290e6d4b1b2715d2b2

Syntax

Copy

public SearchDefinition<TDocument> Equals<TField>(
	FieldDefinition<TDocument, TField> path,
	TField value,
	SearchScoreDefinition<TDocument> score = null
)
where TField : struct, new(), IComparable<TField>

Public Function Equals(Of TField As {Structure, New, IComparable(Of TField)}) ( 
	path As FieldDefinition(Of TDocument, TField),
	value As TField,
	Optional score As SearchScoreDefinition(Of TDocument) = Nothing
) As SearchDefinition(Of TDocument)

member Equals : 
        path : FieldDefinition<'TDocument, 'TField> * 
        value : 'TField * 
        ?score : SearchScoreDefinition<'TDocument> 
(* Defaults:
        let _score = defaultArg score null
*)
-> SearchDefinition<'TDocument>  when 'TField : struct, new() and IComparable<'TField>

Parameters

path: Type: MongoDB.DriverFieldDefinitionTDocument, TField
The indexed field to search.
value: Type: TField
The value to query for.
score (Optional): Type: MongoDB.Driver.SearchSearchScoreDefinitionTDocument
The score modifier.

Type Parameters

TField: The type of the field.

Return Value

Type: SearchDefinitionTDocument
An equality search definition.

Reference

SearchDefinitionBuilderTDocument Class

Equals Overload

MongoDB.Driver.Search Namespace