The AtlasSearchIndexConfig custom resource configures your Atlas Search index for a collection. When you create the AtlasSearchIndexConfig custom resource, Atlas Kubernetes Operator tries to create or update an index for a collection.
Examples
The following example shows an AtlasSearchIndexConfig custom resource specification configured for the lucene.standard analyzer method.
apiVersion: atlas.mongodb.com/v1 kind: AtlasSearchIndexConfig metadata: name: atlassearchindexconfig-sample namespace: mongodb-atlas-system spec: analyzer: lucene.standard searchAnalyzer: lucene.standard
Parameters
This section describes the key AtlasSearchIndexConfig custom resource parameters available.
spec.deploymentSpec.searchIndexes[n].search.searchIndexConfigRefType: object
Conditional
Required for
vectorSearchindexes.An object with the following fields that describe a search index configuration:
FieldTypeDescriptionanalyzer
string
Specific pre-defined method chosen to convert database field text into searchable words. This conversion reduces the text of fields into the smallest units of text. These units are called a term or token.
analyzers
array
List of user-defined methods to convert database field text into searchable words. List of
AtlasSearchIndexAnalyzerobjects.SearchAnalyzer
string
Method applied to identify words when searching this index.
storedSource
boolean | object
Flag that indicates whether to store all fields (true) on Atlas Search. By default, Atlas doesn't store (false) the fields on Atlas Search. Alternatively, you can specify an object that only contains the list of fields to store (include) or not store (exclude) on Atlas Search.