MongoDB Atlas Search Index Definition

MongoDB Atlas Search index

Type object
File match *-index.json
Schema URL https://catalog.lintel.tools/schemas/schemastore/mongodb-atlas-search-index-definition/latest.json
Source https://www.schemastore.org/mongodb-atlas-search-index-definition.json

Validate with Lintel

npx @lintel/lintel check
Type: object

Properties

mappings object required

Specifies how to index fields at different paths for this index.

One of: object object, object object
analyzer string

Specifies the analyzer to apply to string fields when indexing. If you set this only at the top and do not specify an analyzer for the fields in the index definition, Atlas Search applies this analyzer to all the fields. To use a different analyzer for each field, you must specify a different analyzer for the field. If omitted, defaults to Standard Analyzer.

analyzers CustomAnalyzer[]

Specifies the Custom Analyzers to use in this index.

name string

Specifies a name for the index. In each namespace, names of all indexes in the namespace must be unique. If omitted, defaults to default.

searchAnalyzer string

Specifies the analyzer to apply to query text before searching with it. If omitted, defaults to Standard Analyzer.

storedSource boolean | StoredSource

Specifies fields in the documents to store for query-time look-ups using the returnedStoredSource option. You can store fields of all BSON Data Types on Atlas Search.

Value can be one of the following: true, to store all fields false, to not store any fields Object that specifies the fields to include or exclude from storage

If omitted, defaults to false.

synonyms Synonym[]

Synonym mappings to use in your index.

Definitions

CustomAnalyzer object
name string required

Name of the custom analyzer. Names must be unique within an index, and may not start with any of the following strings:

  • lucene.
  • builtin.
  • mongodb.
pattern=^(?!^lucene\.|builtin\.|mongodb\.).*
tokenizer object required

Tokenizer to use to create tokens.

1 nested properties
type string required
Values: "edgeGram" "keyword" "nGram" "regexCaptureGroup" "regexSplit" "standard" "uaxUrlEmail" "whitespace"
charFilters CharFilter[]

Array containing zero or more character filters.

tokenFilters TokenFilter[]

Array containing zero or more token filters.

Tokenizer object

Tokenizer to use to create tokens.

type string required
Values: "edgeGram" "keyword" "nGram" "regexCaptureGroup" "regexSplit" "standard" "uaxUrlEmail" "whitespace"
TokenFilter object
type string required

Human-readable label that identifies this token filter type.

Values: "asciiFolding" "daitchMokotoffSoundex" "edgeGram" "icuFolding" "icuNormalizer" "length" "lowercase" "nGram" "regex" "reverse" "shingle" "snowballStemming" "stopword" "trim"
CharFilter object
type string required

Human-readable label that identifies this character filter type.

Values: "htmlStrip" "icuNormalize" "mapping" "persian"
ignoredTags string[]

List that contains the HTML tags to exclude from filtering.

Mappings object

Specifies how to index fields at different paths for this index.

MappingsField object
type string
Values: "autocomplete" "boolean" "date" "dateFacet" "document" "embeddedDocuments" "geo" "number" "numberFacet" "objectId" "string" "stringFacet" "token" "uuid"
analyzer string
maxGrams integer
minGrams integer
tokenization string
Values: "edgeGram" "rightEdgeGram" "nGram"
foldDiacritics boolean
dynamic boolean
fields object
indexShapes boolean
representation string
Values: "int64" "double"
indexIntegers boolean
indexDoubles boolean
searchAnalyzer string
indexOptions string
Values: "docs" "freqs" "positions" "offsets"
store boolean
ignoreAbove integer
multi object
2 nested properties
type string
Values: "string"
analyzer string
norms string
Values: "include" "omit"
StoredSource object
Synonym object
name string
analyzer string
Values: "lucene.standard" "lucene.simple" "lucene.whitespace" "lucene.keyword" "lucene.arabic" "lucene.armenian" "lucene.basque" "lucene.bengali" "lucene.brazilian" "lucene.bulgarian" "lucene.catalan" "lucene.chinese" "lucene.cjk" "lucene.czech" "lucene.danish" "lucene.dutch" "lucene.english" "lucene.finnish" "lucene.french" "lucene.galician" "lucene.german" "lucene.greek" "lucene.hindi" "lucene.hungarian" "lucene.indonesian" "lucene.irish" "lucene.italian" "lucene.japanese" "lucene.korean" "lucene.latvian" "lucene.lithuanian" "lucene.morfologik" "lucene.nori" "lucene.norwegian" "lucene.persian" "lucene.portuguese" "lucene.romanian" "lucene.russian" "lucene.smartcn" "lucene.sorani" "lucene.spanish" "lucene.swedish" "lucene.thai" "lucene.turkish" "lucene.ukrainian" "nGram" "edgeGram" "daitchMokotoffSoundex" "shingle"
source object
1 nested properties
collection string