Interface IndexOptions

Options for creating an index.

interface IndexOptions {
    bin: string;
    context?: Context;
    datatype?: indexDataType;
    index: string;
    ns: string;
    set: string;
    type?: indexType;
}

Properties

bin context? datatype? index ns set type?

Properties

bin

bin: string

The name of the bin which values are to be indexed.

Optionalcontext

context?: Context

The cdt.Context on which the index is to be created.

Optionaldatatype

datatype?: indexDataType

The data type of the index to be created, e.g. Numeric, String or Geo. Not necessary to specify when using APIs such as Client#createIntegerIndex, Client#createStringIndex, or Client#createBlobIndex.

index

index: string

The name of the index to be created.

ns

ns: string

The namespace on which the index is to be created.

set

set: string

The set on which the index is to be created.

Optionaltype

type?: indexType

Type of index to be created based on the type of values stored in the bin. This option needs to be specified if the bin to be indexed contains list or map values and the individual entries of the list or keys/values of the map should be indexed.

See indexType for accepted values.

Settings

Member Visibility

On This Page

Properties
MMNEPVFCICPMFPCPTTAAATR