Wikibase\Repo\Dumpers\RdfDumpGenerator Class Reference

RdfDumpGenerator generates an RDF dump of a given set of entities, excluding redirects. More...

Inheritance diagram for Wikibase\Repo\Dumpers\RdfDumpGenerator:

Collaboration diagram for Wikibase\Repo\Dumpers\RdfDumpGenerator:

Public Member Functions
	__construct ( $out, EntityRevisionLookup $lookup, RdfBuilder $rdfBuilder, EntityPrefetcher $entityPrefetcher)
	setTimestamp (int $timestamp)
Public Member Functions inherited from Wikibase\Repo\Dumpers\DumpGenerator
	__construct ( $out, EntityPrefetcher $entityPrefetcher)
	setLimit (int $limit)
	Set maximum number of entities produced.
	setBatchSize (int $batchSize)
	Sets the batch size for processing.
	setProgressReporter (MessageReporter $progressReporter)
	setExceptionHandler (ExceptionHandler $exceptionHandler)
	setShardingFilter ( $shardingFactor, $shard)
	Set the sharding factor and desired shard.
	setEntityTypesFilter (?array $types)
	Set the entity types to be included in the output.
	setBatchCallback (callable $callback)
	Set a callback that is called once per batch, at the beginning of each batch.
	generateDump (EntityIdPager $idPager)
	Generates a dump, writing to the file handle provided to the constructor.

Static Public Member Functions
static	createDumpGenerator (string $format, $output, string $flavor, EntityRevisionLookup $entityRevisionLookup, EntityPrefetcher $entityPrefetcher, ?BNodeLabeler $labeler, RdfBuilderFactory $rdfBuilderFactory)

Protected Member Functions
	preDump ()
	Do something before dumping data.
	postDump ()
	Do something after dumping data.
	generateDumpForEntityId (EntityId $entityId)
	Produces RDF dump of the entity.
Protected Member Functions inherited from Wikibase\Repo\Dumpers\DumpGenerator
	writeToDump (string $data)
	Writers the given string to the output provided to the constructor.
	preBatchDump (array $entities)
	Do something before dumping a batch of entities.
	preEntityDump (int $dumpCount)
	Do something before dumping entity.
	postEntityDump (int $dumpCount)
	Do something after dumping entity.

Static Private Member Functions
static	getRdfWriter (string $name, BNodeLabeler $labeler=null)
static	getFlavorFlags (string $flavorName)
	Get the producer setting for the given flavor.

Private Attributes
	$rdfBuilder
	$entityRevisionLookup
	$timestamp = 0

Additional Inherited Members
Protected Attributes inherited from Wikibase\Repo\Dumpers\DumpGenerator
int	$batchSize = 100
	$out
int	$shardingFactor = 1
int	$shard = 0
MessageReporter	$progressReporter
ExceptionHandler	$exceptionHandler
EntityPrefetcher	$entityPrefetcher
array	$entityTypes = null
int	$limit = 0
	Entity count limit - dump will generate this many.

Detailed Description

RdfDumpGenerator generates an RDF dump of a given set of entities, excluding redirects.

Copyright

GPL-2.0-or-later

Author

Daniel Kinzler

Stas Malyshev

Constructor & Destructor Documentation

__construct()

Wikibase\Repo\Dumpers\RdfDumpGenerator::__construct	(		$out,
		EntityRevisionLookup	$lookup,
		RdfBuilder	$rdfBuilder,
		EntityPrefetcher	$entityPrefetcher )

Parameters

resource	$out
EntityRevisionLookup	$lookup	Must not resolve redirects
RdfBuilder	$rdfBuilder
EntityPrefetcher	$entityPrefetcher

Member Function Documentation

createDumpGenerator()

static Wikibase\Repo\Dumpers\RdfDumpGenerator::createDumpGenerator ( string $format, $output, string $flavor, EntityRevisionLookup $entityRevisionLookup, EntityPrefetcher $entityPrefetcher, ?BNodeLabeler $labeler, RdfBuilderFactory $rdfBuilderFactory )

static

Parameters

string	$format
resource	$output
string	$flavor	Either "full" or "truthy"
EntityRevisionLookup	$entityRevisionLookup
EntityPrefetcher	$entityPrefetcher
BNodeLabeler | null	$labeler
RdfBuilderFactory	$rdfBuilderFactory

Exceptions

UnknownFlavorException

Returns

static

generateDumpForEntityId()

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

protected

Produces RDF dump of the entity.

Parameters

EntityId

$entityId

Exceptions

EntityLookupException
StorageException

Returns

string|null RDF

Reimplemented from Wikibase\Repo\Dumpers\DumpGenerator.

getFlavorFlags()

static Wikibase\Repo\Dumpers\RdfDumpGenerator::getFlavorFlags ( string $flavorName )

staticprivate

Get the producer setting for the given flavor.

Exceptions

UnknownFlavorException

getRdfWriter()

static Wikibase\Repo\Dumpers\RdfDumpGenerator::getRdfWriter ( string $name, BNodeLabeler $labeler = null )

staticprivate

postDump()

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

protected

Do something after dumping data.

Reimplemented from Wikibase\Repo\Dumpers\DumpGenerator.

preDump()

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

protected

Do something before dumping data.

Reimplemented from Wikibase\Repo\Dumpers\DumpGenerator.

setTimestamp()

Wikibase\Repo\Dumpers\RdfDumpGenerator::setTimestamp

(

int

$timestamp

)

Member Data Documentation

$entityRevisionLookup

Wikibase\Repo\Dumpers\RdfDumpGenerator::$entityRevisionLookup

private

$rdfBuilder

Wikibase\Repo\Dumpers\RdfDumpGenerator::$rdfBuilder

private

$timestamp

Wikibase\Repo\Dumpers\RdfDumpGenerator::$timestamp = 0

private

---

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

• repo/includes/Dumpers/RdfDumpGenerator.php