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

Inheritance diagram for CirrusSearch\Maintenance\UpdateSearchIndexConfig:

Collaboration diagram for CirrusSearch\Maintenance\UpdateSearchIndexConfig:

Public Member Functions
	execute ()

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)

Protected Member Functions
	clustersToWriteTo ()
	Convenience method to interperet the 'all' cluster as a request to run against each of the known clusters.

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.

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

CirrusSearch\Maintenance\UpdateSearchIndexConfig::__construct ( )

CirrusSearch\Maintenance\UpdateSearchIndexConfig::clustersToWriteTo ( )

protected

Convenience method to interperet the 'all' cluster as a request to run against each of the known clusters.

CirrusSearch\Maintenance\UpdateSearchIndexConfig::execute ( )

Returns: bool|null @suppress PhanUndeclaredMethod runChild technically returns a \Maintenance instance but only \CirrusSearch\Maintenance\Maintenance classes have the done method. Just allow it since we know what type of maint class is being created

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