CirrusSearch
Elasticsearch-powered search for MediaWiki
|
Cirrus helpful extensions to Maintenance. More...
Public Member Functions | |
finalSetup (SettingsBuilder $settingsBuilder=null) | |
runChild ( $maintClass, $classFile=null) | |
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 | |
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 | |
static | $indent = null |
Cirrus helpful extensions to Maintenance.
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
|
protected |
Disable all pool counters and cirrus query logs.
Only useful for maint scripts
Ideally this method could be run in the constructor but apparently globals are reset just before the call to execute()
CirrusSearch\Maintenance\Maintenance::error | ( | $err, | |
$die = 0 ) |
string | $err | |
int | $die | deprecated, do not use |
Implements CirrusSearch\Maintenance\Printer.
Reimplemented in CirrusSearch\Maintenance\SaneitizeJobs.
|
protected |
Provides support for backward compatible CLI options.
Requires either one or neither of the two options to be provided.
string | $current | The current option to request |
string | $bc | The old option to provide BC support for |
bool | $required | True if the option must be provided. When false and no option is provided null is returned. |
CirrusSearch\Maintenance\Maintenance::getConnection | ( | $cluster = null | ) |
string | null | $cluster |
|
protected |
Create metastore only if the alias does not already exist.
CirrusSearch\Maintenance\Maintenance::output | ( | $message, | |
$channel = null ) |
string | $message | |
string | null | $channel |
Implements CirrusSearch\Maintenance\Printer.
Reimplemented in CirrusSearch\Maintenance\DumpIndex.
CirrusSearch\Maintenance\Maintenance::outputIndented | ( | $message | ) |
Implements CirrusSearch\Maintenance\Printer.
Reimplemented in CirrusSearch\Maintenance\DumpIndex.
CirrusSearch\Maintenance\Maintenance::runChild | ( | $maintClass, | |
$classFile = null ) |
string | $maintClass | |
string | null | $classFile |
|
protected |
Helper method for Status returning methods, such as via ConfigUtils.
Status | $status |