CirrusSearch\Maintenance\UpdateOneSearchIndexConfig Class Reference

Update the elasticsearch configuration for this index. More...

Inheritance diagram for CirrusSearch\Maintenance\UpdateOneSearchIndexConfig:

Collaboration diagram for CirrusSearch\Maintenance\UpdateOneSearchIndexConfig:

Public Member Functions
	execute ()
	validateAllAlias ()
	validateIndexHasChanged ()
	getIndex ()
Public Member Functions inherited from CirrusSearch\Maintenance\Maintenance
	finalSetup (SettingsBuilder $settingsBuilder)
	createChild (string $maintClass, ?string $classFile=null)
	@inheritDoc
	getConnection ( $cluster=null)
	getSearchConfig ()
	getMetaStore (?Connection $conn=null)
	loadSpecialVars ()
	Execute a callback function at the end of initialisation.
	done ()
	Call to signal that execution of this maintenance script is complete so the next one gets the right indentation.
	output ( $message, $channel=null)
	outputIndented ( $message)
	error ( $err, $die=0)

Static Public Member Functions
static	addSharedOptions ( $maintenance)

Protected Member Functions
	validateShardAllocation ()
	initMappingConfigBuilder ()
	getSpecificIndexName ()
	getIndexAliasName ()
	getIndexName ()
	getOldIndex ()
	fatalError ( $msg, $exitCode=1)
	Output a message and terminate the current script.
Protected Member Functions inherited from CirrusSearch\Maintenance\Maintenance
	disablePoolCountersAndLogging ()
	Disable all pool counters and cirrus query logs.
	maybeCreateMetastore ()
	Create metastore only if the alias does not already exist.
	requireCirrusReady ()
	getBackCompatOption (string $current, string $bc, bool $required=true)
	Provides support for backward compatible CLI options.
	unwrap (Status $status)
	Helper method for Status returning methods, such as via ConfigUtils.

Protected Attributes
	$bannedPlugins
	$optimizeIndexForExperimentalHighlighter
	$refreshInterval
	$masterTimeout

Additional Inherited Members
Static Protected Attributes inherited from CirrusSearch\Maintenance\Maintenance
static	$indent = null

Detailed Description

Update the elasticsearch configuration for this index.

Constructor & Destructor Documentation

__construct()

CirrusSearch\Maintenance\UpdateOneSearchIndexConfig::__construct

(

)

Reimplemented from CirrusSearch\Maintenance\Maintenance.

Member Function Documentation

addSharedOptions()

static CirrusSearch\Maintenance\UpdateOneSearchIndexConfig::addSharedOptions ( $maintenance )

static

Parameters

Maintenance

$maintenance

execute()

CirrusSearch\Maintenance\UpdateOneSearchIndexConfig::execute

(

)

@suppress PhanUndeclaredMethod ExceptionInterface has no methods

fatalError()

CirrusSearch\Maintenance\UpdateOneSearchIndexConfig::fatalError ( $msg, $exitCode = 1 )

protected

Output a message and terminate the current script.

Parameters

string	$msg	Error Message
int	$exitCode	PHP exit status. Should be in range 1-254

Returns

never

getIndex()

CirrusSearch\Maintenance\UpdateOneSearchIndexConfig::getIndex

(

)

Returns

\Elastica\Index being updated

getIndexAliasName()

CirrusSearch\Maintenance\UpdateOneSearchIndexConfig::getIndexAliasName ( )

protected

Returns

string name of the index type being updated

getIndexName()

CirrusSearch\Maintenance\UpdateOneSearchIndexConfig::getIndexName ( )

protected

Returns

string

getOldIndex()

CirrusSearch\Maintenance\UpdateOneSearchIndexConfig::getOldIndex ( )

protected

Returns

\Elastica\Index

getSpecificIndexName()

CirrusSearch\Maintenance\UpdateOneSearchIndexConfig::getSpecificIndexName ( )

protected

Returns

string name of the index being updated

initMappingConfigBuilder()

CirrusSearch\Maintenance\UpdateOneSearchIndexConfig::initMappingConfigBuilder ( )

protected

Exceptions

ConfigException

---

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

• maintenance/UpdateOneSearchIndexConfig.php