Class EmbeddedSearchIndexDefinition

Namespace

MongoDB.EntityFrameworkCore.Metadata.Search.Definitions

Assembly

MongoDB.EntityFrameworkCore.dll

Defines a MongoDB search index part that contains field mappings for an embedded (nested) document.

public class EmbeddedSearchIndexDefinition : EmbeddedSearchIndexDefinitionBase, ISearchIndexDefinition

Inheritance

object

SearchIndexDefinitionBase

SearchIndexDefinitionWithFields

EmbeddedSearchIndexDefinitionBase

EmbeddedSearchIndexDefinition

Implements

ISearchIndexDefinition

Inherited Members

EmbeddedSearchIndexDefinitionBase.ToBson()

SearchIndexDefinitionWithFields.EntityType

SearchIndexDefinitionWithFields.ContainingElementName

SearchIndexDefinitionWithFields.FieldDefinitions

SearchIndexDefinitionWithFields.IsDynamic

SearchIndexDefinitionWithFields.TypeSetName

SearchIndexDefinitionWithFields.IncludeAll

SearchIndexDefinitionWithFields.IncludedFieldNames

SearchIndexDefinitionWithFields.ExcludedFieldNames

SearchIndexDefinitionWithFields.ToDynamicBson()

SearchIndexDefinitionWithFields.GetOrAddFieldDefinition<TDefinition>(IMutablePropertyBase)

SearchIndexDefinitionWithFields.GetOrAddFieldDefinition<TDefinition>(string)

SearchIndexDefinitionWithFields.AddFieldsToDocument(BsonDocument)

SearchIndexDefinitionBase.Name

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Remarks

This type is typically used by the database provider. It is only needed by applications when reading metadata from EF Core. Use HasSearchIndex(EntityTypeBuilder, string?) or one of its overloads to configure a MongoDB search index.

Properties

EmbeddingType

Returns "document" for a single embedded (nested) document.

Methods

ToStoredSource()

Returns null, because embedded document stored source is defined at the top level.