CirrusSearch\Maintenance\DumpIndex Class Reference

Dump an index from elasticsearch. More...

Inheritance diagram for CirrusSearch\Maintenance\DumpIndex:

Collaboration diagram for CirrusSearch\Maintenance\DumpIndex:

Public Member Functions
	execute ()
	write (array $document)
	outputIndented ( $message)
	output ( $message, $channel=null)
	outputProgress ( $docsDumped, $limit)
	public because php 5.3 does not support accessing private methods in a closure.
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.
	error ( $err, $die=0)

Protected Member Functions
	getClient ()
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

Dump an index from elasticsearch.

Constructor & Destructor Documentation

__construct()

CirrusSearch\Maintenance\DumpIndex::__construct

(

)

Reimplemented from CirrusSearch\Maintenance\Maintenance.

Member Function Documentation

getClient()

CirrusSearch\Maintenance\DumpIndex::getClient ( )

protected

Returns

Elastica\Client

output()

CirrusSearch\Maintenance\DumpIndex::output	(		$message,
			$channel = null )

Parameters

string	$message
string | null	$channel

Reimplemented from CirrusSearch\Maintenance\Maintenance.

outputIndented()

CirrusSearch\Maintenance\DumpIndex::outputIndented

(

$message

)

Parameters

string

$message

Reimplemented from CirrusSearch\Maintenance\Maintenance.

outputProgress()

CirrusSearch\Maintenance\DumpIndex::outputProgress	(		$docsDumped,
			$limit )

public because php 5.3 does not support accessing private methods in a closure.

Parameters

int	$docsDumped
int	$limit

write()

CirrusSearch\Maintenance\DumpIndex::write

(

array

$document

)

Parameters

array

$document

Valid elasticsearch document to write to stdout

---

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

• maintenance/DumpIndex.php