SearchDefinitionBuilderTDocumentEmbeddedDocumentTField Method (FieldDefinitionTDocument, IEnumerableTField, SearchDefinitionTField, SearchScoreDefinitionTDocument)

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.

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

Syntax

Copy

public SearchDefinition<TDocument> EmbeddedDocument<TField>(
	FieldDefinition<TDocument, IEnumerable<TField>> path,
	SearchDefinition<TField> operator,
	SearchScoreDefinition<TDocument> score = null
)

Public Function EmbeddedDocument(Of TField) ( 
	path As FieldDefinition(Of TDocument, IEnumerable(Of TField)),
	operator As SearchDefinition(Of TField),
	Optional score As SearchScoreDefinition(Of TDocument) = Nothing
) As SearchDefinition(Of TDocument)

member EmbeddedDocument : 
        path : FieldDefinition<'TDocument, IEnumerable<'TField>> * 
        operator : SearchDefinition<'TField> * 
        ?score : SearchScoreDefinition<'TDocument> 
(* Defaults:
        let _score = defaultArg score null
*)
-> SearchDefinition<'TDocument>

Parameters

path: Type: MongoDB.DriverFieldDefinitionTDocument, IEnumerableTField
The indexed field to search.
operator: Type: MongoDB.Driver.SearchSearchDefinitionTField
The operator.
score (Optional): Type: MongoDB.Driver.SearchSearchScoreDefinitionTDocument
The score modifier.

Type Parameters

TField: The type of the field.

Return Value

Type: SearchDefinitionTDocument
An embeddedDocument search definition.

Reference

SearchDefinitionBuilderTDocument Class

EmbeddedDocument Overload

MongoDB.Driver.Search Namespace