Meilisearch JavaScript

Appearance

Meilisearch JS / index / IndexStats

Type Alias: IndexStats<Q> ​

IndexStats<Q> = object

Defined in: src/types/types.ts:825

Stats of one index

See ​

https://www.meilisearch.com/docs/reference/api/indexes/get-stats-of-index

Type Parameters ​

Q ​

Q extends StatsQuery | undefined = undefined

Stats query whose sizeFormat selects the size field type

Properties ​

avgDocumentSize ​

avgDocumentSize: StatsFieldSize<Q>

Defined in: src/types/types.ts:843

Average size of a document in the documents database

fieldDistribution ​

fieldDistribution: FieldDistribution

Defined in: src/types/types.ts:835

Number of documents containing each field

indexSize ​

indexSize: StatsFieldSize<Q>

Defined in: src/types/types.ts:829

Size of the index database

internalDatabaseSizes? ​

optional internalDatabaseSizes?: Record<string, StatsFieldSize<Q>>

Defined in: src/types/types.ts:850

On-disk size of each internal database

Present when StatsQuery.showInternalDatabaseSizes is true. Keys can change between Meilisearch versions. Values use sizeFormat.

isIndexing ​

isIndexing: boolean

Defined in: src/types/types.ts:833

Whether the index is currently indexing

numberOfDocuments ​

numberOfDocuments: number

Defined in: src/types/types.ts:827

Number of documents in the index

numberOfEmbeddedDocuments ​

numberOfEmbeddedDocuments: number

Defined in: src/types/types.ts:837

Number of documents that contain embeddings

numberOfEmbeddings ​

numberOfEmbeddings: number

Defined in: src/types/types.ts:839

Number of embeddings in the index

rawDocumentDbSize ​

rawDocumentDbSize: StatsFieldSize<Q>

Defined in: src/types/types.ts:841

Size of the documents database

usedIndexSize ​

usedIndexSize: StatsFieldSize<Q>

Defined in: src/types/types.ts:831

Size of the used pages of the index database