Type Alias IndexStatsDescription

IndexStatsDescription: {
    dimension?: number;
    indexFullness?: number;
    namespaces?: { [key: string]: IndexStatsNamespaceSummary };
    totalRecordCount?: number;
}

An index description returned from Index.describeIndexStats

Type declaration

  • Optionaldimension?: number

    The dimension of the index.

  • OptionalindexFullness?: number

    A number indicating the percentage of available storage consumed by your index.

    See

  • Optionalnamespaces?: { [key: string]: IndexStatsNamespaceSummary }

    A map whose keys are the names of namespaces and whose values are a namespace summary including the total record count in that namespace.

    See

    Using namespaces

  • OptionaltotalRecordCount?: number

    The total number of records that have been upserted to your index.

Settings

Member Visibility