Type alias GenericIndex

GenericIndex: {
    figures?: Record<string, any>;
    id: string;
    name: string;
    progress?: number;
    sparse: boolean;
    unique: boolean;
}

Shared attributes of all index types.

Type declaration

  • Optional figures?: Record<string, any>

    Additional stats about this index.

  • id: string

    A unique identifier for this index.

  • name: string

    A unique name for this index.

  • Optional progress?: number

    Progress of this index if it is still being created.

  • sparse: boolean

    Whether documents not containing at least one of the attribute paths are omitted by this index.

  • unique: boolean

    Whether this index enforces uniqueness for values of its attribute paths.

Settings

Theme