Meilisearch PHP | Documentation

HandlesNetwork

Tags
phpstan-import-type

RemoteConfig from NetworkResults

phpstan-import-type

ShardConfig from \Meilisearch\Endpoints\Network

Table of Contents

Properties

$network  : Network

Methods

addRemote()  : Task
Add a remote to the network.
addRemotesToShard()  : Task
getNetwork()  : NetworkResults
initializeNetwork()  : Task
Initialize a network with the current instance as leader.
removeRemote()  : Task
Remove a remote from the network.
removeRemotesFromShard()  : Task

Properties

Methods

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
Task

addRemotesToShard()

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
Task

initializeNetwork()

Initialize a network with the current instance as leader.

public initializeNetwork(ShardConfig>} $options) : Task
Parameters
$options : ShardConfig>}
Return values
Task

removeRemote()

Remove a remote from the network.

public removeRemote(non-empty-string $name) : Task
Parameters
$name : non-empty-string
Return values
Task

removeRemotesFromShard()

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
Task

        
On this page

Search results