DumpGenerator generates a dump of a given set of entities, excluding redirects. More...

Inheritance diagram for Wikibase\Repo\Dumpers\DumpGenerator:

Public Member Functions
	__construct ( $out, EntityPrefetcher $entityPrefetcher)

	setLimit ( $limit)
	Set maximum number of entities produced. More...

	setBatchSize ( $batchSize)
	Sets the batch size for processing. More...

	setProgressReporter (MessageReporter $progressReporter)

	setExceptionHandler (ExceptionHandler $exceptionHandler)

	setShardingFilter ( $shardingFactor, $shard)
	Set the sharding factor and desired shard. More...

	setEntityTypesFilter ( $types)
	Set the entity types to be included in the output. More...

	generateDump (EntityIdPager $idPager)
	Generates a dump, writing to the file handle provided to the constructor. More...

Protected Member Functions
	writeToDump ( $data)
	Writers the given string to the output provided to the constructor. More...

	preDump ()
	Do something before dumping data. More...

	postDump ()
	Do something after dumping data. More...

	preBatchDump ( $entities)
	Do something before dumping a batch of entities. More...

	preEntityDump ( $dumpCount)
	Do something before dumping entity. More...

	postEntityDump ( $dumpCount)
	Do something after dumping entity. More...

	generateDumpForEntityId (EntityId $entityId)
	Produce dump data for specific entity. More...

Protected Attributes
	$batchSize = 100

	$out

	$shardingFactor = 1

	$shard = 0

	$progressReporter

	$exceptionHandler

	$entityPrefetcher

	$entityTypes

	$limit = 0

Private Member Functions
	idMatchesFilters (EntityId $entityId)

	idMatchesShard (EntityId $entityId)

	idMatchesType (EntityId $entityId)

	dumpEntities (array $entityIds, &$dumpCount)
	Dump list of entities. More...

Detailed Description

DumpGenerator generates a dump of a given set of entities, excluding redirects.

Copyright: GPL-2.0-or-later

Author: Daniel Kinzler

Constructor & Destructor Documentation

◆ __construct()

Wikibase\Repo\Dumpers\DumpGenerator::__construct	(		$out,
		EntityPrefetcher	$entityPrefetcher
	)

Parameters

resource	$out
EntityPrefetcher	$entityPrefetcher

Exceptions

InvalidArgumentException

Member Function Documentation

◆ dumpEntities()

Wikibase\Repo\Dumpers\DumpGenerator::dumpEntities	(	array	$entityIds,
		&	$dumpCount
	)

private

Dump list of entities.

Parameters

EntityId[]	$entityIds
int	&$dumpCount	The number of entities already dumped (will be updated).

◆ generateDump()

Wikibase\Repo\Dumpers\DumpGenerator::generateDump ( EntityIdPager $idPager )

Generates a dump, writing to the file handle provided to the constructor.

Parameters

EntityIdPager $idPager

◆ generateDumpForEntityId()

Wikibase\Repo\Dumpers\DumpGenerator::generateDumpForEntityId ( EntityId $entityId )

abstractprotected

Produce dump data for specific entity.

Parameters

EntityId $entityId

Exceptions

EntityLookupException
StorageException

Returns: string|null

Reimplemented in Wikibase\Repo\Dumpers\RdfDumpGenerator, and Wikibase\Repo\Dumpers\JsonDumpGenerator.

◆ idMatchesFilters()

Wikibase\Repo\Dumpers\DumpGenerator::idMatchesFilters ( EntityId $entityId )

private

◆ idMatchesShard()

Wikibase\Repo\Dumpers\DumpGenerator::idMatchesShard ( EntityId $entityId )

private

◆ idMatchesType()

Wikibase\Repo\Dumpers\DumpGenerator::idMatchesType ( EntityId $entityId )

private

◆ postDump()

Wikibase\Repo\Dumpers\DumpGenerator::postDump ( )

protected

Do something after dumping data.

Reimplemented in Wikibase\Repo\Dumpers\RdfDumpGenerator, and Wikibase\Repo\Dumpers\JsonDumpGenerator.

◆ postEntityDump()

Wikibase\Repo\Dumpers\DumpGenerator::postEntityDump ( $dumpCount )

protected

Do something after dumping entity.

Parameters

int $dumpCount

◆ preBatchDump()

Wikibase\Repo\Dumpers\DumpGenerator::preBatchDump ( $entities )

protected

Do something before dumping a batch of entities.

Parameters

EntityId[] $entities

◆ preDump()

Wikibase\Repo\Dumpers\DumpGenerator::preDump ( )

protected

Do something before dumping data.

Reimplemented in Wikibase\Repo\Dumpers\RdfDumpGenerator, and Wikibase\Repo\Dumpers\JsonDumpGenerator.

◆ preEntityDump()

Wikibase\Repo\Dumpers\DumpGenerator::preEntityDump ( $dumpCount )

protected

Do something before dumping entity.

Parameters

int $dumpCount

Reimplemented in Wikibase\Repo\Dumpers\JsonDumpGenerator.

◆ setBatchSize()

Wikibase\Repo\Dumpers\DumpGenerator::setBatchSize ( $batchSize )

Sets the batch size for processing.

The batch size is used as the limit when listing IDs via the EntityIdPager::getNextBatchOfIds() method, and also controls the interval of progress reports.

Parameters

int $batchSize

Exceptions

InvalidArgumentException

◆ setEntityTypesFilter()

Wikibase\Repo\Dumpers\DumpGenerator::setEntityTypesFilter ( $types )

Set the entity types to be included in the output.

Parameters

string[] | null $types The desired types (use null for any type).

◆ setExceptionHandler()

Wikibase\Repo\Dumpers\DumpGenerator::setExceptionHandler ( ExceptionHandler $exceptionHandler )

◆ setLimit()

Wikibase\Repo\Dumpers\DumpGenerator::setLimit ( $limit )

Set maximum number of entities produced.

Parameters

int $limit

◆ setProgressReporter()

Wikibase\Repo\Dumpers\DumpGenerator::setProgressReporter ( MessageReporter $progressReporter )

◆ setShardingFilter()

Wikibase\Repo\Dumpers\DumpGenerator::setShardingFilter	(	$shardingFactor,
		$shard
	)

Set the sharding factor and desired shard.

For instance, to generate four dumps in parallel, use setShardingFilter( 4, 0 ) for the first dump, setShardingFilter( 4, 1 ) for the second dump, etc.

Parameters

int	$shardingFactor
int	$shard

Exceptions

InvalidArgumentException

◆ writeToDump()

Wikibase\Repo\Dumpers\DumpGenerator::writeToDump ( $data )

protected

Writers the given string to the output provided to the constructor.

Parameters

string $data

Member Data Documentation

◆ $batchSize

Wikibase\Repo\Dumpers\DumpGenerator::$batchSize = 100

protected

◆ $entityPrefetcher

Wikibase\Repo\Dumpers\DumpGenerator::$entityPrefetcher

protected

◆ $entityTypes

Wikibase\Repo\Dumpers\DumpGenerator::$entityTypes

protected

◆ $exceptionHandler

Wikibase\Repo\Dumpers\DumpGenerator::$exceptionHandler

protected

◆ $limit

Wikibase\Repo\Dumpers\DumpGenerator::$limit = 0

protected

◆ $out

Wikibase\Repo\Dumpers\DumpGenerator::$out

protected

◆ $progressReporter

Wikibase\Repo\Dumpers\DumpGenerator::$progressReporter

protected

◆ $shard

Wikibase\Repo\Dumpers\DumpGenerator::$shard = 0

protected

◆ $shardingFactor

Wikibase\Repo\Dumpers\DumpGenerator::$shardingFactor = 1

protected

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

repo/includes/Dumpers/DumpGenerator.php

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ dumpEntities()

◆ generateDump()

◆ generateDumpForEntityId()

◆ idMatchesFilters()

◆ idMatchesShard()

◆ idMatchesType()

◆ postDump()

◆ postEntityDump()

◆ preBatchDump()

◆ preDump()

◆ preEntityDump()

◆ setBatchSize()

◆ setEntityTypesFilter()

◆ setExceptionHandler()

◆ setLimit()

◆ setProgressReporter()

◆ setShardingFilter()

◆ writeToDump()

Member Data Documentation

◆ $batchSize

◆ $entityPrefetcher

◆ $entityTypes

◆ $exceptionHandler

◆ $limit

◆ $out

◆ $progressReporter

◆ $shard

◆ $shardingFactor