Meilisearch PHP | Documentation

IndexStats
in package

FinalYes
Tags
phpstan-type

RawIndexStats array{ numberOfDocuments: non-negative-int, rawDocumentDbSize: non-negative-int, avgDocumentSize: non-negative-int, isIndexing: bool, numberOfEmbeddings: non-negative-int, numberOfEmbeddedDocuments: non-negative-int, fieldDistribution: array<non-empty-string, non-negative-int>, indexSize: non-negative-int, usedIndexSize: non-negative-int }

Table of Contents

Properties

$avgDocumentSize  : int
$fieldDistribution  : array<string|int, mixed>
$indexSize  : int
$isIndexing  : bool
$numberOfDocuments  : int
$numberOfEmbeddedDocuments  : int
$numberOfEmbeddings  : int
$rawDocumentDbSize  : int
$usedIndexSize  : int

Methods

__construct()  : mixed
fromArray()  : self
getAvgDocumentSize()  : int
getFieldDistribution()  : array<string|int, mixed>
getIndexSize()  : int
Size of the index database, in bytes.
getNumberOfDocuments()  : int
getNumberOfEmbeddedDocuments()  : int
getNumberOfEmbeddings()  : int
getRawDocumentDbSize()  : int
getUsedIndexSize()  : int
Size of the used pages of the index database, in bytes.
isIndexing()  : bool

Properties

$avgDocumentSize read-only

private int $avgDocumentSize

$fieldDistribution read-only

private array<string|int, mixed> $fieldDistribution

$numberOfDocuments read-only

private int $numberOfDocuments

$numberOfEmbeddedDocuments read-only

private int $numberOfEmbeddedDocuments

$numberOfEmbeddings read-only

private int $numberOfEmbeddings

$rawDocumentDbSize read-only

private int $rawDocumentDbSize

$usedIndexSize read-only

private int $usedIndexSize

Methods

__construct()

public __construct(int $numberOfDocuments, int $rawDocumentDbSize, int $avgDocumentSize, bool $isIndexing, int $numberOfEmbeddings, int $numberOfEmbeddedDocuments, array<string|int, mixed> $fieldDistribution, int $indexSize, int $usedIndexSize) : mixed
Parameters
$numberOfDocuments : int
$rawDocumentDbSize : int
$avgDocumentSize : int
$isIndexing : bool
$numberOfEmbeddings : int
$numberOfEmbeddedDocuments : int
$fieldDistribution : array<string|int, mixed>
$indexSize : int
$usedIndexSize : int

fromArray()

public static fromArray(RawIndexStats $data) : self
Parameters
$data : RawIndexStats
Return values
self

getAvgDocumentSize()

public getAvgDocumentSize() : int
Return values
int

getFieldDistribution()

public getFieldDistribution() : array<string|int, mixed>
Return values
array<string|int, mixed>

getNumberOfDocuments()

public getNumberOfDocuments() : int
Return values
int

getNumberOfEmbeddedDocuments()

public getNumberOfEmbeddedDocuments() : int
Return values
int

getNumberOfEmbeddings()

public getNumberOfEmbeddings() : int
Return values
int

getRawDocumentDbSize()

public getRawDocumentDbSize() : int
Return values
int

isIndexing()

public isIndexing() : bool
Return values
bool
On this page

Search results