Defining MongoDB Indexes

The following properties are applicable to MongoDB Indexes object in the model explorer.

Tab

Section

Property

Description

Additional Information

General

 

Index Members   Specifies the fields that are included in the index  
Selected Index Members

 

Field

Specifies the fields that are included in the index

 

Sort Order Specifies the sort order of the index

Ascending: Indicates that the indexes are sorted in ascending order

Descending: Indicates that the indexes are sorted in descending order

Index Type Specifies the index type of the selected field TEXT: Indicates whether to search queries based on a string

2DSPHERE: Indicates whether to search queries calculated on a spherical plane

2D: Indicates whether to search queries stored as a point on two-dimension plane

HASHED: Indicates whether to search strings with the hash value

CLUSTERED: Indicates whether to search queries based on clustered index

Weight

Specifies the weight of the selected field

This option is applicable only when the Index Type is set to TEXT.

Options

 

Partial Filter Expression   Specifies partialFilterExpression options for partial indexes

 

Wildcard Index Expression   Specifies wildcard index expression options for wildcard indexes

 

More Index options   Specifies other index options other than partial filter expressions and wildcard index expressions

 

Wildcard Index Projection

 

Specifies to include of exclude fields from a wildcard index

 

Index Options Locale Specifies the ICU locale of the collation  
Case Level Specifies whether the case comparison is included at strength level 1 or 2

 

Case First Specifies the sort order for tertiary level comparison for the collation

UPPER: Indicates that indexes with uppercase is sorted before lowercase

LOWER: Indicates that indexes with lowercase is sorted before upper case

OFF: Indicates that the sorting is similar to Lower with minor difference. For more information, refer to the MongoDB documentation.

Strength Specifies the strength of the comparison level for the collation

1: Indicates that the collation performs primary level comparison and only the base characters are considered for comparison

2: Indicates that the collation performs secondary level comparison and considers both base characters and diacritics for comparison

3: Indicates that the collation performs tertiary level comparison and considers base characters, diacritics, cases and variants for comparison

4: Indicates that the collation performs quaternary level comparison and considers punctuations for comparison

5: Indicates that the collation performs identical level comparison and uses it as a tiebreaker when all other levels are equal

Numeric Ordering

Specifies whether the numeric strings are compared as numbers or strings

 
Alternative Specifies whether the collation must consider whitespace and punctuation as base characters for comparison

Non-Ignorable: Indicates that the whitespace and punctuation re considered as base characters for comparison

Shifted: Indicates that the whitespace and punctuation are not considered as base characters for comparison

MaxVariable

Specifies up to which characters are not considered as base characters when Alternative is set to Shifted

PUNCT: Indicates that both whitespace and punctuation are not considered as base characters

SPACE: Indicates that whitespace is not considered as base characters

Backwards Specifies whether strings with diacritic are compared from back to front

 

More Options

 

Create TTL Specifies the TTL value in seconds for TTL index  

Hidden Index

Specifies whether the indexes are hidden to the query planner