CirrusSearch\ExternalIndex Class Reference

Represents an external index referenced by the OtherIndex functionality. More...

Public Member Functions
	__construct (SearchConfig $config, $indexName)
	getGroupAndIndexName ()
	getIndexName ()
	getCrossClusterName ()
	getSearchIndex ( $sourceCrossClusterName)
	getBoosts ()

Detailed Description

Represents an external index referenced by the OtherIndex functionality.

Typically sourced from $wgCirrusSearchExtraIndex.

Constructor & Destructor Documentation

__construct()

CirrusSearch\ExternalIndex::__construct	(	SearchConfig	$config,
			$indexName )

Parameters

Searchconfig	$config
string	$indexName	Name of index on external clusters. Can include a group prefix (e.g. "cluster_group:index_name")

Member Function Documentation

getBoosts()

CirrusSearch\ExternalIndex::getBoosts

(

)

Returns

array Two item array first containing a wiki name and second a map from template name to weight for that template.

getCrossClusterName()

CirrusSearch\ExternalIndex::getCrossClusterName

(

)

Returns

string|null The group external index writes must be sent to, null to send to current group.

getGroupAndIndexName()

CirrusSearch\ExternalIndex::getGroupAndIndexName

(

)

Returns

string Name of index on external clusters. Can include a group prefix when required.

getIndexName()

CirrusSearch\ExternalIndex::getIndexName

(

)

Returns

string The name of the external index.

getSearchIndex()

CirrusSearch\ExternalIndex::getSearchIndex

(

$sourceCrossClusterName

)

Parameters

string | null

$sourceCrossClusterName

Name of the cluster as configured in the cross-cluster search settings, null for simple&deprecated configs.

Returns

string The name of the index to search. Includes cross-cluster identifier if necessary.

---

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

• includes/ExternalIndex.php