Meilisearch PHP | Documentation

BatchStats
in package

FinalYes
Tags
phpstan-import-type

RawBatchEmbedderRequests from BatchEmbedderRequests

Keys in progressTrace and internalDatabaseSizes are intentionally open-ended (engine-defined step/db names that can change); values are duration/size strings.

phpstan-type

RawWriteChannelCongestion array{ attempts: non-negative-int, blocking_attempts: non-negative-int, blocking_ratio: float }

RawBatchStats array{ totalNbTasks: non-negative-int, status: array<non-empty-string, non-negative-int>, types: array<non-empty-string, non-negative-int>, indexUids: array<non-empty-string, non-negative-int>, progressTrace?: array<non-empty-string, non-empty-string>, writeChannelCongestion?: RawWriteChannelCongestion|null, internalDatabaseSizes?: array<non-empty-string, non-empty-string>, embedderRequests?: RawBatchEmbedderRequests }

Table of Contents

Properties

$embedderRequests  : BatchEmbedderRequests|null
$indexUids  : array<string|int, mixed>
$internalDatabaseSizes  : array<string|int, mixed>|null
$progressTrace  : array<string|int, mixed>|null
$status  : array<string|int, mixed>
$totalNbTasks  : int
$types  : array<string|int, mixed>
$writeChannelCongestion  : array<string|int, mixed>|null

Methods

__construct()  : mixed
fromArray()  : self
getEmbedderRequests()  : BatchEmbedderRequests|null
getIndexUids()  : array<string|int, mixed>
getInternalDatabaseSizes()  : array<non-empty-string, non-empty-string>|null
getProgressTrace()  : array<non-empty-string, non-empty-string>|null
getStatus()  : array<string|int, mixed>
getTotalNbTasks()  : int
getTypes()  : array<string|int, mixed>
getWriteChannelCongestion()  : RawWriteChannelCongestion|null

Properties

$indexUids read-only

private array<string|int, mixed> $indexUids

$internalDatabaseSizes read-only

private array<string|int, mixed>|null $internalDatabaseSizes = null

$progressTrace read-only

private array<string|int, mixed>|null $progressTrace = null

$status read-only

private array<string|int, mixed> $status

$totalNbTasks read-only

private int $totalNbTasks

$types read-only

private array<string|int, mixed> $types

$writeChannelCongestion read-only

private array<string|int, mixed>|null $writeChannelCongestion = null

Methods

__construct()

public __construct(int $totalNbTasks, array<string|int, mixed> $status, array<string|int, mixed> $types, array<string|int, mixed> $indexUids[, array<non-empty-string, non-empty-string>|null $progressTrace = null ][, RawWriteChannelCongestion|null $writeChannelCongestion = null ][, array<non-empty-string, non-empty-string>|null $internalDatabaseSizes = null ][, BatchEmbedderRequests|null $embedderRequests = null ]) : mixed
Parameters
$totalNbTasks : int
$status : array<string|int, mixed>
$types : array<string|int, mixed>
$indexUids : array<string|int, mixed>
$progressTrace : array<non-empty-string, non-empty-string>|null = null
$writeChannelCongestion : RawWriteChannelCongestion|null = null
$internalDatabaseSizes : array<non-empty-string, non-empty-string>|null = null
$embedderRequests : BatchEmbedderRequests|null = null

fromArray()

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

getIndexUids()

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

getInternalDatabaseSizes()

public getInternalDatabaseSizes() : array<non-empty-string, non-empty-string>|null
Return values
array<non-empty-string, non-empty-string>|null

getProgressTrace()

public getProgressTrace() : array<non-empty-string, non-empty-string>|null
Return values
array<non-empty-string, non-empty-string>|null

getStatus()

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

getTotalNbTasks()

public getTotalNbTasks() : int
Return values
int

getTypes()

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

getWriteChannelCongestion()

public getWriteChannelCongestion() : RawWriteChannelCongestion|null
Return values
RawWriteChannelCongestion|null
On this page

Search results