Class EmbeddedSearchIndexDefinitionBase

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, or an array of embedded (nested) documents.

public abstract class EmbeddedSearchIndexDefinitionBase : SearchIndexDefinitionWithFields, ISearchIndexDefinition

Inheritance

object

SearchIndexDefinitionBase

SearchIndexDefinitionWithFields

EmbeddedSearchIndexDefinitionBase

Implements

ISearchIndexDefinition

Derived

EmbeddedArraySearchIndexDefinition

EmbeddedSearchIndexDefinition

Inherited Members

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.ToStoredSource()

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, or "embeddedDocuments" for an embedded (nested) array of documents.

Methods

ToBson()

Generates BSON for the part of the index definition representing the embedded document(s).