Client
in package
uses
HandlesChatWorkspaces, HandlesDumps, HandlesIndex, HandlesTasks, HandlesKeys, HandlesSnapshots, HandlesSystem, HandlesMultiSearch, HandlesBatches, HandlesNetwork, HandlesDynamicSearchRules
Table of Contents
Properties
- $batches : Batches
- $chats : ChatWorkspaces
- $dumps : Dumps
- $dynamicSearchRules : DynamicSearchRules
- $health : Health
- $http : Http
- $index : Indexes
- $keys : Keys
- $network : Network
- $snapshots : Snapshots
- $stats : Stats
- $tasks : Tasks
- $tenantToken : TenantToken
- $version : Version
Methods
- __construct() : mixed
- addRemote() : Task
- Add a remote to the network.
- addRemotesToShard() : Task
- cancelTasks() : Task
- chatWorkspace() : ChatWorkspaces
- Get a specific chat workspace instance.
- compactIndex() : Task
- createDump() : Task
- createIndex() : Task
- createKey() : Key
- createSnapshot() : Task
- deleteAllDynamicSearchRules() : Task
- Delete all dynamic search rules.
- deleteDynamicSearchRule() : Task
- Delete a dynamic search rule.
- deleteIndex() : Task
- deleteKey() : void
- deleteTasks() : Task
- generateTenantToken() : string
- getBatch() : Batch
- getBatches() : BatchesResults
- getChatWorkspaces() : ChatWorkspacesResults
- List all chat workspaces.
- getDynamicSearchRule() : DynamicSearchRule
- Get a dynamic search rule.
- getDynamicSearchRules() : DynamicSearchRulesResults
- List dynamic search rules.
- getIndex() : Index
- getIndexes() : IndexesResults
- getKey() : Key
- getKeys() : KeysResults
- getNetwork() : NetworkResults
- getRawIndex() : array{uid: non-empty-string, primaryKey: string|null, createdAt: non-empty-string, updatedAt: non-empty-string}
- getRawKeys() : RawKeys
- getTask() : Task
- getTaskDocuments() : StreamInterface
- getTasks() : TasksResults
- health() : Health
- index() : Index
- initializeNetwork() : Task
- Initialize a network with the current instance as leader.
- isHealthy() : bool
- multiSearch() : array<string|int, mixed>
- Pass `$includeMetadata` to send `Meili-Include-Metadata: true`. Available since Meilisearch v1.55.0.
- removeRemote() : Task
- Remove a remote from the network.
- removeRemotesFromShard() : Task
- renameIndex() : Task
- Rename an index instead of swapping it.
- stats() : Stats
- swapIndexes() : Task
- updateDynamicSearchRule() : Task
- Create or update a dynamic search rule.
- updateIndex() : Task
- updateKey() : Key
- version() : Version
Properties
$batches
protected
Batches
$batches
$chats
protected
ChatWorkspaces
$chats
$dumps
protected
Dumps
$dumps
$dynamicSearchRules
protected
DynamicSearchRules
$dynamicSearchRules
$health
protected
Health
$health
$http
protected
Http
$http
$index
protected
Indexes
$index
$keys
protected
Keys
$keys
$network
protected
Network
$network
$snapshots
protected
Snapshots
$snapshots
$stats
protected
Stats
$stats
$tasks
protected
Tasks
$tasks
$tenantToken
protected
TenantToken
$tenantToken
$version
protected
Version
$version
Methods
__construct()
public
__construct(string $url[, string|null $apiKey = null ][, ClientInterface|null $httpClient = null ][, RequestFactoryInterface|null $requestFactory = null ][, array<int, string> $clientAgents = [] ][, StreamFactoryInterface|null $streamFactory = null ]) : mixed
Parameters
- $url : string
- $apiKey : string|null = null
- $httpClient : ClientInterface|null = null
- $requestFactory : RequestFactoryInterface|null = null
- $clientAgents : array<int, string> = []
- $streamFactory : StreamFactoryInterface|null = null
addRemote()
Add a remote to the network.
public
addRemote(non-empty-string $name, RemoteConfig $remote) : Task
Parameters
- $name : non-empty-string
- $remote : RemoteConfig
Return values
TaskaddRemotesToShard()
public
addRemotesToShard(non-empty-string $shardName, array<int, non-empty-string> $remoteNames) : Task
Parameters
- $shardName : non-empty-string
- $remoteNames : array<int, non-empty-string>
Return values
TaskcancelTasks()
public
cancelTasks([CancelTasksQuery|null $options = null ]) : Task
Parameters
- $options : CancelTasksQuery|null = null
Return values
TaskchatWorkspace()
Get a specific chat workspace instance.
public
chatWorkspace(string $workspaceName) : ChatWorkspaces
Parameters
- $workspaceName : string
Return values
ChatWorkspacescompactIndex()
public
compactIndex(non-empty-string $uid) : Task
Parameters
- $uid : non-empty-string
Return values
TaskcreateDump()
public
createDump() : Task
Return values
TaskcreateIndex()
public
createIndex(non-empty-string $uid[, array{primaryKey?: string|null} $options = [] ]) : Task
Parameters
- $uid : non-empty-string
- $options : array{primaryKey?: string|null} = []
Return values
TaskcreateKey()
public
createKey(CreateKeyQuery $request) : Key
Parameters
- $request : CreateKeyQuery
Return values
KeycreateSnapshot()
public
createSnapshot() : Task
Return values
TaskdeleteAllDynamicSearchRules()
Delete all dynamic search rules.
public
deleteAllDynamicSearchRules() : Task
This is an EXPERIMENTAL feature, which may break without a major version.
Tags
Return values
TaskdeleteDynamicSearchRule()
Delete a dynamic search rule.
public
deleteDynamicSearchRule(non-empty-string $uid) : Task
This is an EXPERIMENTAL feature, which may break without a major version.
Parameters
- $uid : non-empty-string
-
Dynamic search rule UID
Tags
Return values
TaskdeleteIndex()
public
deleteIndex(non-empty-string $uid) : Task
Parameters
- $uid : non-empty-string
Return values
TaskdeleteKey()
public
deleteKey(string $keyOrUid) : void
Parameters
- $keyOrUid : string
deleteTasks()
public
deleteTasks([DeleteTasksQuery|null $options = null ]) : Task
Parameters
- $options : DeleteTasksQuery|null = null
Return values
TaskgenerateTenantToken()
public
generateTenantToken(string $apiKeyUid, array<string|int, mixed>|object $searchRules[, DateTimeInterface|null} $options = [] ]) : string
Parameters
- $apiKeyUid : string
- $searchRules : array<string|int, mixed>|object
- $options : DateTimeInterface|null} = []
Return values
stringgetBatch()
public
getBatch(int $uid) : Batch
Parameters
- $uid : int
Return values
BatchgetBatches()
public
getBatches([BatchesQuery|null $options = null ]) : BatchesResults
Parameters
- $options : BatchesQuery|null = null
Return values
BatchesResultsgetChatWorkspaces()
List all chat workspaces.
public
getChatWorkspaces() : ChatWorkspacesResults
Return values
ChatWorkspacesResultsgetDynamicSearchRule()
Get a dynamic search rule.
public
getDynamicSearchRule(non-empty-string $uid) : DynamicSearchRule
This is an EXPERIMENTAL feature, which may break without a major version.
Parameters
- $uid : non-empty-string
-
Dynamic search rule UID
Tags
Return values
DynamicSearchRulegetDynamicSearchRules()
List dynamic search rules.
public
getDynamicSearchRules([DynamicSearchRulesQuery|null $options = null ]) : DynamicSearchRulesResults
This is an EXPERIMENTAL feature, which may break without a major version.
Parameters
- $options : DynamicSearchRulesQuery|null = null
Tags
Return values
DynamicSearchRulesResultsgetIndex()
public
getIndex(non-empty-string $uid) : Index
Parameters
- $uid : non-empty-string
Return values
IndexgetIndexes()
public
getIndexes([IndexesQuery|null $options = null ]) : IndexesResults
Parameters
- $options : IndexesQuery|null = null
Return values
IndexesResultsgetKey()
public
getKey(non-empty-string $keyOrUid) : Key
Parameters
- $keyOrUid : non-empty-string
Return values
KeygetKeys()
public
getKeys([KeysQuery|null $options = null ]) : KeysResults
Parameters
- $options : KeysQuery|null = null
Return values
KeysResultsgetNetwork()
public
getNetwork() : NetworkResults
Return values
NetworkResultsgetRawIndex()
public
getRawIndex(non-empty-string $uid) : array{uid: non-empty-string, primaryKey: string|null, createdAt: non-empty-string, updatedAt: non-empty-string}
Parameters
- $uid : non-empty-string
Return values
array{uid: non-empty-string, primaryKey: string|null, createdAt: non-empty-string, updatedAt: non-empty-string}getRawKeys()
public
getRawKeys([array<string|int, mixed> $options = [] ]) : RawKeys
Parameters
- $options : array<string|int, mixed> = []
Return values
RawKeysgetTask()
public
getTask(int $uid) : Task
Parameters
- $uid : int
Return values
TaskgetTaskDocuments()
public
getTaskDocuments(int $uid) : StreamInterface
Parameters
- $uid : int
Return values
StreamInterfacegetTasks()
public
getTasks([TasksQuery|null $options = null ]) : TasksResults
Parameters
- $options : TasksQuery|null = null
Return values
TasksResultshealth()
public
health() : Health
Return values
Healthindex()
public
index(non-empty-string $uid) : Index
Parameters
- $uid : non-empty-string
Return values
IndexinitializeNetwork()
Initialize a network with the current instance as leader.
public
initializeNetwork(ShardConfig>} $options) : Task
Parameters
- $options : ShardConfig>}
Return values
TaskisHealthy()
public
isHealthy() : bool
Return values
boolmultiSearch()
Pass `$includeMetadata` to send `Meili-Include-Metadata: true`. Available since Meilisearch v1.55.0.
public
multiSearch([array<int, MultiSearchQuery> $queries = [] ][, MultiSearchFederation|null $federation = null ][, bool $includeMetadata = false ]) : array<string|int, mixed>
Without federation, each item of results then includes metadata.
With federation, metadata is a top-level list with one entry per query.
Parameters
- $queries : array<int, MultiSearchQuery> = []
- $federation : MultiSearchFederation|null = null
- $includeMetadata : bool = false
Tags
Return values
array<string|int, mixed>removeRemote()
Remove a remote from the network.
public
removeRemote(non-empty-string $name) : Task
Parameters
- $name : non-empty-string
Return values
TaskremoveRemotesFromShard()
public
removeRemotesFromShard(non-empty-string $shardName, array<int, non-empty-string> $remoteNames) : Task
Parameters
- $shardName : non-empty-string
- $remoteNames : array<int, non-empty-string>
Return values
TaskrenameIndex()
Rename an index instead of swapping it.
public
renameIndex(non-empty-string $fromUid, non-empty-string $toUid) : Task
Parameters
- $fromUid : non-empty-string
- $toUid : non-empty-string
Tags
Return values
Taskstats()
public
stats() : Stats
Return values
StatsswapIndexes()
public
swapIndexes(array<int, array{non-empty-string, non-empty-string}> $indexes) : Task
Parameters
- $indexes : array<int, array{non-empty-string, non-empty-string}>
Tags
Return values
TaskupdateDynamicSearchRule()
Create or update a dynamic search rule.
public
updateDynamicSearchRule(UpdateDynamicSearchRuleQuery $request) : Task
This is an EXPERIMENTAL feature, which may break without a major version.
Parameters
- $request : UpdateDynamicSearchRuleQuery
-
Partial search rule with pin and scale actions
Tags
Return values
TaskupdateIndex()
public
updateIndex(non-empty-string $uid[, array{primaryKey?: string|null, uid?: non-empty-string} $options = [] ]) : Task
Parameters
- $uid : non-empty-string
- $options : array{primaryKey?: string|null, uid?: non-empty-string} = []
Return values
TaskupdateKey()
public
updateKey(UpdateKeyQuery $request) : Key
Parameters
- $request : UpdateKeyQuery
Return values
Keyversion()
public
version() : Version