Interface IndexDescription

interface IndexDescription {
    2dsphereIndexVersion?: number;
    background?: boolean;
    bits?: number;
    bucketSize?: number;
    collation?: CollationOptions;
    default_language?: string;
    expireAfterSeconds?: number;
    hidden?: boolean;
    key: {
        [key: string]: IndexDirection;
    } | Map<string, IndexDirection>;
    language_override?: string;
    max?: number;
    min?: number;
    name?: string;
    partialFilterExpression?: Document;
    sparse?: boolean;
    storageEngine?: Document;
    textIndexVersion?: number;
    unique?: boolean;
    version?: number;
    weights?: Document;
    wildcardProjection?: Document;
}

Hierarchy

  • Pick<CreateIndexesOptions,
        | "background"
        | "unique"
        | "partialFilterExpression"
        | "sparse"
        | "hidden"
        | "expireAfterSeconds"
        | "storageEngine"
        | "version"
        | "weights"
        | "default_language"
        | "language_override"
        | "textIndexVersion"
        | "2dsphereIndexVersion"
        | "bits"
        | "min"
        | "max"
        | "bucketSize"
        | "wildcardProjection">
    • IndexDescription

Properties

2dsphereIndexVersion? background? bits? bucketSize? collation? default_language? expireAfterSeconds? hidden? key language_override? max? min? name? partialFilterExpression? sparse? storageEngine? textIndexVersion? unique? version? weights? wildcardProjection?

Properties

Optional2dsphereIndexVersion

2dsphereIndexVersion?: number

Optionalbackground

background?: boolean

Creates the index in the background, yielding whenever possible.

Optionalbits

bits?: number

OptionalbucketSize

bucketSize?: number

Optionalcollation

collation?: CollationOptions

Optionaldefault_language

default_language?: string

OptionalexpireAfterSeconds

expireAfterSeconds?: number

Allows you to expire data on indexes applied to a data (MongoDB 2.2 or higher)

Optionalhidden

hidden?: boolean

Specifies that the index should exist on the target collection but should not be used by the query planner when executing operations. (MongoDB 4.4 or higher)

key

key: {
    [key: string]: IndexDirection;
} | Map<string, IndexDirection>

Optionallanguage_override

language_override?: string

Optionalmax

max?: number

For geospatial indexes set the high bound for the co-ordinates.

Optionalmin

min?: number

For geospatial indexes set the lower bound for the co-ordinates.

Optionalname

name?: string

OptionalpartialFilterExpression

partialFilterExpression?: Document

Creates a partial index based on the given filter object (MongoDB 3.2 or higher)

Optionalsparse

sparse?: boolean

Creates a sparse index.

OptionalstorageEngine

storageEngine?: Document

Allows users to configure the storage engine on a per-index basis when creating an index. (MongoDB 3.0 or higher)

OptionaltextIndexVersion

textIndexVersion?: number

Optionalunique

unique?: boolean

Creates an unique index.

Optionalversion

version?: number

Specifies the index version number, either 0 or 1.

Optionalweights

weights?: Document

OptionalwildcardProjection

wildcardProjection?: Document

Settings

Member Visibility

On This Page

Properties