CirrusSearch\MetaStore\MetaStoreIndex Class Reference

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. More...

Public Member Functions
	__construct (Connection $connection, Printer $out, SearchConfig $config)
	versionStore ()
	namespaceStore ()
	saneitizeJobStore ()
	stores ()
	createIfNecessary ()
	createOrUpgradeIfNecessary ()
	runtimeVersion ()
	elasticaIndex ()
	cirrusReady ()
	Check if cirrus is ready by checking if the index has been created on this cluster.
	metastoreVersion ()

Public Attributes
const	INDEX_NAME = 'mw_cirrus_metastore'
	@const string index name

Detailed Description

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. http://www.gnu.org/copyleft/gpl.html Utility class to manage a multipurpose metadata storage index for cirrus. This store is used to store persistent states related to administrative tasks (index settings upgrade, wiki namespace names, ...).

Constructor & Destructor Documentation

__construct()

CirrusSearch\MetaStore\MetaStoreIndex::__construct	(	Connection	$connection,
		Printer	$out,
		SearchConfig	$config )

Parameters

Connection	$connection
Printer	$out
SearchConfig	$config

Member Function Documentation

cirrusReady()

CirrusSearch\MetaStore\MetaStoreIndex::cirrusReady

(

)

Check if cirrus is ready by checking if the index has been created on this cluster.

Returns

bool

createIfNecessary()

CirrusSearch\MetaStore\MetaStoreIndex::createIfNecessary

(

)

Returns

\Elastica\Index|null Index on creation, or null if the index already exists.

metastoreVersion()

CirrusSearch\MetaStore\MetaStoreIndex::metastoreVersion

(

)

Returns

int the version of the meta store. 0 means that the metastore has never been created.

namespaceStore()

CirrusSearch\MetaStore\MetaStoreIndex::namespaceStore

(

)

Returns

MetaNamespaceStore

runtimeVersion()

CirrusSearch\MetaStore\MetaStoreIndex::runtimeVersion

(

)

Returns

int version of metastore index expected by runtime

saneitizeJobStore()

CirrusSearch\MetaStore\MetaStoreIndex::saneitizeJobStore

(

)

Returns

MetaSaneitizeJobStore

stores()

CirrusSearch\MetaStore\MetaStoreIndex::stores

(

)

Returns

MetaStore[]

versionStore()

CirrusSearch\MetaStore\MetaStoreIndex::versionStore

(

)

Returns

MetaVersionStore

---

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

• includes/MetaStore/MetaStoreIndex.php