Class SearchIndexStringDefinition
- Namespace
- MongoDB.EntityFrameworkCore.Metadata.Search.Definitions
- Assembly
- MongoDB.EntityFrameworkCore.dll
A MongoDB search definition for the "string" type.
public class SearchIndexStringDefinition : SearchIndexDefinitionBase, ISearchIndexDefinition- Inheritance
-
SearchIndexStringDefinition
- Implements
- Inherited Members
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
- AlternateAnalyzers
The names of alternate analyzer to use for string indexing.
- AlternateSimilarityAlgorithms
The names of alternate similarity algorithms to use for string indexing.
- AnalyzerName
The name of the analyzer to use for string indexing.
- IgnoreAbove
The maximum number of characters in the value of the field to index.
- IncludeFieldLength
A flag that specifies whether to include or omit the field length in the result when scoring.
- IndexAmount
The amount of information to store for the indexed field.
- SearchAnalyzerName
Configures the name of the analyzer to use for string searches with this index.
- SimilarityAlgorithm
The similarity algorithms to use when scoring for string indexes.
- StoreDocumentText
A flag that indicates whether to store the exact document text as well as the analyzed values in the index.
Methods
- ToBson()
Generates the BSON for this part of the index definition.