Meilisearch PHP | Documentation

IndexStats
in package

FinalYes

Table of Contents

Properties

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

Methods

__construct()  : mixed
fromArray()  : self
getAvgDocumentSize()  : int
getFieldDistribution()  : array<string|int, mixed>
getNumberOfDocuments()  : int
getNumberOfEmbeddedDocuments()  : int
getNumberOfEmbeddings()  : int
getRawDocumentDbSize()  : int
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

Methods

__construct()

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

fromArray()

public static fromArray(array<string|int, mixed> $data) : self
Parameters
$data : array<string|int, mixed>
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