CirrusSearch\Assignment\MultiClusterAssignment Class Reference

Inheritance diagram for CirrusSearch\Assignment\MultiClusterAssignment:

Collaboration diagram for CirrusSearch\Assignment\MultiClusterAssignment:

Public Member Functions
	__construct (SearchConfig $config)
	uniqueId ( $cluster)
	getWritableClusters (string $updateGroup)
	getAllKnownClusters ()
	canWriteToCluster ( $cluster, $updateGroup)
	Check if a cluster is configured to accept writes.
	hasCluster (string $cluster)
	Check if a cluster is defined.
	getSearchCluster ()
	getCrossClusterName ()
	getServerList ( $replica=null)

Member Function Documentation

canWriteToCluster()

CirrusSearch\Assignment\MultiClusterAssignment::canWriteToCluster	(		$cluster,
			$updateGroup )

Check if a cluster is configured to accept writes.

Parameters

string	$cluster
string	$updateGroup	UpdateGroup::* constant

Returns

bool

Implements CirrusSearch\Assignment\ClusterAssignment.

getAllKnownClusters()

CirrusSearch\Assignment\MultiClusterAssignment::getAllKnownClusters

(

)

Returns

string[] List all known cluster groups

Implements CirrusSearch\Assignment\ClusterAssignment.

getCrossClusterName()

CirrusSearch\Assignment\MultiClusterAssignment::getCrossClusterName

(

)

Returns

string Name to prefix indices with when using cross-cluster-search.

Implements CirrusSearch\Assignment\ClusterAssignment.

getSearchCluster()

CirrusSearch\Assignment\MultiClusterAssignment::getSearchCluster

(

)

Returns

string Name of the default search cluster.

Implements CirrusSearch\Assignment\ClusterAssignment.

getServerList()

CirrusSearch\Assignment\MultiClusterAssignment::getServerList

(

$replica = null

)

Parameters

string | null

$replica

Returns

string[]|array[]

Implements CirrusSearch\Assignment\ClusterAssignment.

getWritableClusters()

CirrusSearch\Assignment\MultiClusterAssignment::getWritableClusters

(

string

$updateGroup

)

Parameters

string

$updateGroup

UpdateGroup::* constant

Returns

string[] List of CirrusSearch cluster names to write to.

Implements CirrusSearch\Assignment\ClusterAssignment.

hasCluster()

CirrusSearch\Assignment\MultiClusterAssignment::hasCluster

(

string

$cluster

)

Check if a cluster is defined.

Parameters

string

$cluster

Returns

bool

Implements CirrusSearch\Assignment\ClusterAssignment.

uniqueId()

CirrusSearch\Assignment\MultiClusterAssignment::uniqueId

(

$cluster

)

Parameters

string

$cluster

Name of requested cluster

Returns

string Uniquely identifies the connection properties.

Implements CirrusSearch\Assignment\ClusterAssignment.

---

The documentation for this class was generated from the following file:

• includes/Assignment/MultiClusterAssignment.php