A TermInLangIdsAcquirer implementation using the database tables wbt_term_in_lang, wbt_text_in_lang, and wbt_text. More...

Inheritance diagram for Wikibase\Lib\Store\Sql\Terms\DatabaseTermInLangIdsAcquirer:

Collaboration diagram for Wikibase\Lib\Store\Sql\Terms\DatabaseTermInLangIdsAcquirer:

Public Member Functions
	__construct (ILBFactory $lbFactory, TypeIdsAcquirer $typeIdsAcquirer, LoggerInterface $logger=null)

	acquireTermInLangIds (array $termsArray, $callback=null)
	Acquires IDs for the given terms.

Private Member Functions
	getLoadBalancer ()

	mapToTypeIds (array $termsArray)
	replace root keys containing type names in termsArray with their respective ids in wbt_type table

	mapToTextIds (array $termsArray, ReplicaMasterAwareRecordIdsAcquirer $textIdsAcquirer)
	replace text at termsArray leaves with their ids in wbt_text table and return resulting array

	acquireTextIds (array $texts, ReplicaMasterAwareRecordIdsAcquirer $textIdsAcquirer)

	mapToTextInLangIds (array $termsArray, ReplicaMasterAwareRecordIdsAcquirer $textInLangIdsAcquirer)
	replace ( lang => [ textId, ... ] ) entries with their respective ids in wbt_text_in_lang table and return resulting array

	acquireTextInLangIds (array $langTextIds, ReplicaMasterAwareRecordIdsAcquirer $textInLangIdsAcquirer)

	mapToTermInLangIds (array $termsArray, ReplicaMasterAwareRecordIdsAcquirer $termInLangIdsAcquirer, array $idsToRestore=[])
	replace root ( type => [ textInLangId, ... ] ) entries with their respective ids in wbt_term_in_lang table and return resulting array

	acquireTermInLangIdsInner (array $typeTextInLangIds, ReplicaMasterAwareRecordIdsAcquirer $termInLangIdsAcquirer, array $idsToRestore=[])

	restoreCleanedUpIds (array $termsArray, array $termInLangIds=[])

	mapTermsArrayToTermIds (array $termsArray, array $termInLangIdsToRestore=[], $ignoreReplica=false)

	calcRecordHash (array $record)

	filterUniqueRecords (array $records)

Private Attributes
	$lbFactory

	$typeIdsAcquirer

	$logger

Detailed Description

A TermInLangIdsAcquirer implementation using the database tables wbt_term_in_lang, wbt_text_in_lang, and wbt_text.

Because the wbt_text.wbx_text column can only hold up to 255 bytes, terms longer than that (typically non-Latin descriptions) will be truncated, and different terms that only differ after the first 255 bytes will get the same term in lang ID (and thus same other ids too).

See also: md_docs_storage_terms

Copyright: GPL-2.0-or-later

Constructor & Destructor Documentation

◆ __construct()

Wikibase\Lib\Store\Sql\Terms\DatabaseTermInLangIdsAcquirer::__construct	(	ILBFactory	$lbFactory,
		TypeIdsAcquirer	$typeIdsAcquirer,
		LoggerInterface	$logger = `null`
	)

Parameters

ILBFactory	$lbFactory
TypeIdsAcquirer	$typeIdsAcquirer
LoggerInterface \| null	$logger

Member Function Documentation

◆ acquireTermInLangIds()

Wikibase\Lib\Store\Sql\Terms\DatabaseTermInLangIdsAcquirer::acquireTermInLangIds	(	array	$termsArray,
			$callback = `null`
	)

Acquires IDs for the given terms.

The acquirer guarantees that an in-parallel TermStoreCleaner will not result in deleting terms that have been acquired by this acquirer, should these two in-parallel processes happen to overlap on some existing term in lang IDs. The mechanism of achieving this guarantee is complete under the following two conditions:

External linking to acquired IDs (e.g. using them as foreign keys in other tables) must happen inside the $callback.
The in-parallel cleaner is called with set of IDs based on the absence of any links to those IDs, in the same external places where the callback links to them.

Parameters

array	$termsArray	array containing terms per type per language. Example: [ 'label' => [ 'en' => 'some label', 'de' => 'another label', ... ], 'alias' => [ 'en' => [ 'alias', 'another alias', ...], 'de' => 'de alias', ... ], ... ]
callable \| null	$callback	Called with int[] $termInLangIds right before attempting to restore any of those acquired IDs that might have been deleted by another process before `acquireTermInLangIds()` has returned.

Returns: int[] List of IDs of acquired terms in the store. Due to limitations in the underlying store, in rare cases the same ID might be returned for different terms.

Implements Wikibase\Lib\Store\Sql\Terms\TermInLangIdsAcquirer.

◆ acquireTermInLangIdsInner()

Wikibase\Lib\Store\Sql\Terms\DatabaseTermInLangIdsAcquirer::acquireTermInLangIdsInner	(	array	$typeTextInLangIds,
		ReplicaMasterAwareRecordIdsAcquirer	$termInLangIdsAcquirer,
		array	$idsToRestore = `[]`
	)

private

◆ acquireTextIds()

Wikibase\Lib\Store\Sql\Terms\DatabaseTermInLangIdsAcquirer::acquireTextIds	(	array	$texts,
		ReplicaMasterAwareRecordIdsAcquirer	$textIdsAcquirer
	)

private

◆ acquireTextInLangIds()

Wikibase\Lib\Store\Sql\Terms\DatabaseTermInLangIdsAcquirer::acquireTextInLangIds	(	array	$langTextIds,
		ReplicaMasterAwareRecordIdsAcquirer	$textInLangIdsAcquirer
	)

private

◆ calcRecordHash()

Wikibase\Lib\Store\Sql\Terms\DatabaseTermInLangIdsAcquirer::calcRecordHash ( array $record )

private

◆ filterUniqueRecords()

Wikibase\Lib\Store\Sql\Terms\DatabaseTermInLangIdsAcquirer::filterUniqueRecords ( array $records )

private

◆ getLoadBalancer()

Wikibase\Lib\Store\Sql\Terms\DatabaseTermInLangIdsAcquirer::getLoadBalancer ( )

private

◆ mapTermsArrayToTermIds()

Wikibase\Lib\Store\Sql\Terms\DatabaseTermInLangIdsAcquirer::mapTermsArrayToTermIds	(	array	$termsArray,
		array	$termInLangIdsToRestore = `[]`,
			$ignoreReplica = `false`
	)

private

◆ mapToTermInLangIds()

Wikibase\Lib\Store\Sql\Terms\DatabaseTermInLangIdsAcquirer::mapToTermInLangIds	(	array	$termsArray,
		ReplicaMasterAwareRecordIdsAcquirer	$termInLangIdsAcquirer,
		array	$idsToRestore = `[]`
	)

private

replace root ( type => [ textInLangId, ... ] ) entries with their respective ids in wbt_term_in_lang table and return resulting array

Parameters

array	$termsArray	text in lang ids per type [ 'type' => [ <textInLangId1>, <textInLangId2>, ... ], ... ]
ReplicaMasterAwareRecordIdsAcquirer	$termInLangIdsAcquirer
array	$idsToRestore

Returns: array [ <termInLang1>, <termInLang2>, ... ]

◆ mapToTextIds()

Wikibase\Lib\Store\Sql\Terms\DatabaseTermInLangIdsAcquirer::mapToTextIds	(	array	$termsArray,
		ReplicaMasterAwareRecordIdsAcquirer	$textIdsAcquirer
	)

private

replace text at termsArray leaves with their ids in wbt_text table and return resulting array

Parameters

array	$termsArray	terms per type per language: [ 'type' => [ [ 'language' => 'term' \| [ 'term1', 'term2', ... ] ], ... ], ... ]
ReplicaMasterAwareRecordIdsAcquirer	$textIdsAcquirer

Returns: array [ 'type' => [ [ 'language' => [ <textId1>, <textId2>, ... ] ], ... ], ... ]

◆ mapToTextInLangIds()

Wikibase\Lib\Store\Sql\Terms\DatabaseTermInLangIdsAcquirer::mapToTextInLangIds	(	array	$termsArray,
		ReplicaMasterAwareRecordIdsAcquirer	$textInLangIdsAcquirer
	)

private

replace ( lang => [ textId, ... ] ) entries with their respective ids in wbt_text_in_lang table and return resulting array

Parameters

array	$termsArray	text ids per type per language [ 'type' => [ [ 'language' => [ <textId1>, <textId2>, ... ] ], ... ], ... ]
ReplicaMasterAwareRecordIdsAcquirer	$textInLangIdsAcquirer

Returns: array [ 'type' => [ <textInLangId1>, <textInLangId2>, ... ], ... ]

◆ mapToTypeIds()

Wikibase\Lib\Store\Sql\Terms\DatabaseTermInLangIdsAcquirer::mapToTypeIds ( array $termsArray )

private

replace root keys containing type names in termsArray with their respective ids in wbt_type table

Parameters

array $termsArray terms per type per language: [ 'type1' => [ ... ], 'type2' => [ ... ], ... ]

Returns: array [ <typeId1> => [ ... ], <typeId2> => [ ... ], ... ]

◆ restoreCleanedUpIds()

Wikibase\Lib\Store\Sql\Terms\DatabaseTermInLangIdsAcquirer::restoreCleanedUpIds	(	array	$termsArray,
		array	$termInLangIds = `[]`
	)

private

Member Data Documentation

◆ $lbFactory

Wikibase\Lib\Store\Sql\Terms\DatabaseTermInLangIdsAcquirer::$lbFactory

private

◆ $logger

Wikibase\Lib\Store\Sql\Terms\DatabaseTermInLangIdsAcquirer::$logger

private

◆ $typeIdsAcquirer

Wikibase\Lib\Store\Sql\Terms\DatabaseTermInLangIdsAcquirer::$typeIdsAcquirer

private

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

lib/includes/Store/Sql/Terms/DatabaseTermInLangIdsAcquirer.php

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ acquireTermInLangIds()

◆ acquireTermInLangIdsInner()

◆ acquireTextIds()

◆ acquireTextInLangIds()

◆ calcRecordHash()

◆ filterUniqueRecords()

◆ getLoadBalancer()

◆ mapTermsArrayToTermIds()

◆ mapToTermInLangIds()

◆ mapToTextIds()

◆ mapToTextInLangIds()

◆ mapToTypeIds()

◆ restoreCleanedUpIds()

Member Data Documentation

◆ $lbFactory

◆ $logger

◆ $typeIdsAcquirer