Reports index aliases that CirrusSearch owns for this wiki. More...
Inheritance diagram for CirrusSearch\Maintenance\ExpectedIndices:
Collaboration diagram for CirrusSearch\Maintenance\ExpectedIndices:
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) | |
Additional Inherited Members | |
| 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. | |
| Static Protected Attributes inherited from CirrusSearch\Maintenance\Maintenance | |
| static | $indent = null |
Detailed Description
Reports index aliases that CirrusSearch owns for this wiki.
This information can be used as part of a more complete solution to account for the indices that should exist on an elasticsearch cluster. The output here is strictly related to the configuration of CirrusSearch and does not reference state of any live cluster.
CirrusSearch almost always refers to indices by alias, the only time when CirrusSearch owns an index without an alias is during index creation and reindexing. A reasonable proxy to detect this would be updates in the last few minutes. If CirrusSearch owns an index but does not have an alias yet it will be under constant indexing load.
Constructor & Destructor Documentation
◆ __construct()
| CirrusSearch\Maintenance\ExpectedIndices::__construct | ( | ) |
Reimplemented from CirrusSearch\Maintenance\Maintenance.
The documentation for this class was generated from the following file:
- maintenance/ExpectedIndices.php
