DB accessible external objects. More...

Inheritance diagram for ExternalStoreDB:

Collaboration diagram for ExternalStoreDB:

Public Member Functions
	batchFetchFromURLs (array $urls)
	Fetch data from given external store URLs. More...

	fetchFromURL ( $url)
	The provided URL is in the form of DB://cluster/id or DB://cluster/id/itemid for concatened storage. More...

	getMaster ( $cluster)
	Get a master database connection for the specified cluster. More...

	getSlave ( $cluster)
	Get a replica DB connection for the specified cluster. More...

	getTable ( $db)
	Get the 'blobs' table name for this database. More...

	isReadOnly ( $location)
	Check if a given location is read-only. More...

	store ( $location, $data)
	Insert a data item into a given location. More...

Public Member Functions inherited from ExternalStoreMedium
	__construct (array $params=[])

Protected Member Functions
	parseURL ( $url)

Private Member Functions
	batchFetchBlobs ( $cluster, array $ids)
	Fetch multiple blob items out of the database. More...

	fetchBlob ( $cluster, $id, $itemID)
	Fetch a blob item out of the database; a cache of the last-loaded blob will be kept so that multiple loads out of a multi-item blob can avoid redundant database access and decompression. More...

	getDomainId (array $server)

	getLoadBalancer ( $cluster)
	Get a LoadBalancer for the specified cluster. More...

	mergeBatchResult (array &$ret, array &$ids, $res)
	Helper function for self::batchFetchBlobs for merging master/replica DB results. More...

Additional Inherited Members
Protected Attributes inherited from ExternalStoreMedium
array	$params = []

Detailed Description

DB accessible external objects.

In this system, each store "location" maps to a database "cluster". The clusters must be defined in the normal LBFactory configuration.

Definition at line 38 of file ExternalStoreDB.php.

Member Function Documentation

◆ batchFetchBlobs()

ExternalStoreDB::batchFetchBlobs	(		$cluster,
		array	$ids
	)

private

Fetch multiple blob items out of the database.

Parameters

string	$cluster	A cluster name valid for use with LBFactory
array	$ids	A map from the blob_id's to look for to the requested itemIDs in the blobs

Returns: array A map from the blob_id's requested to their content. Unlocated ids are not represented

Definition at line 274 of file ExternalStoreDB.php.

References $dbr, $res, $ret, getMaster(), getSlave(), getTable(), mergeBatchResult(), and wfDebugLog().

Referenced by batchFetchFromURLs().

◆ batchFetchFromURLs()

ExternalStoreDB::batchFetchFromURLs ( array $urls )

Fetch data from given external store URLs.

The provided URLs are in the form of DB://cluster/id or DB://cluster/id/itemid for concatened storage.

Parameters

array $urls An array of external store URLs

Returns: array A map from url to stored content. Failed results are not represented.

Reimplemented from ExternalStoreMedium.

Definition at line 67 of file ExternalStoreDB.php.

References $blob, $res, $ret, as, batchFetchBlobs(), list, and parseURL().

◆ fetchBlob()

ExternalStoreDB::fetchBlob	(	$cluster,
		$id,
		$itemID
	)

private

Fetch a blob item out of the database; a cache of the last-loaded blob will be kept so that multiple loads out of a multi-item blob can avoid redundant database access and decompression.

Parameters

string	$cluster
string	$id
string	$itemID

Returns: HistoryBlob|bool Returns false if missing

Definition at line 217 of file ExternalStoreDB.php.

References $dbr, $ret, false, getMaster(), getSlave(), getTable(), unserialize(), and wfDebugLog().

Referenced by fetchFromURL().

◆ fetchFromURL()

ExternalStoreDB::fetchFromURL ( $url )

The provided URL is in the form of DB://cluster/id or DB://cluster/id/itemid for concatened storage.

Parameters

string $url

Returns: string|bool False if missing

See also: ExternalStoreMedium::fetchFromURL()

Reimplemented from ExternalStoreMedium.

Definition at line 47 of file ExternalStoreDB.php.

References $ret, fetchBlob(), list, and parseURL().

◆ getDomainId()

ExternalStoreDB::getDomainId ( array $server )

private

Parameters

array $server Master DB server configuration array for LoadBalancer

Returns: string|bool Database domain ID or false

Definition at line 170 of file ExternalStoreDB.php.

Referenced by getMaster(), getSlave(), and isReadOnly().

◆ getLoadBalancer()

ExternalStoreDB::getLoadBalancer ( $cluster )

private

Get a LoadBalancer for the specified cluster.

Parameters

string $cluster Cluster name

Returns: ILoadBalancer

Definition at line 120 of file ExternalStoreDB.php.

Referenced by getMaster(), getSlave(), and isReadOnly().

◆ getMaster()

ExternalStoreDB::getMaster ( $cluster )

Get a master database connection for the specified cluster.

Parameters

string $cluster Cluster name

Returns: MaintainableDBConnRef

Definition at line 156 of file ExternalStoreDB.php.

References DB_MASTER, DBO_TRX, getDomainId(), and getLoadBalancer().

Referenced by batchFetchBlobs(), fetchBlob(), and store().

◆ getSlave()

ExternalStoreDB::getSlave ( $cluster )

Get a replica DB connection for the specified cluster.

Parameters

string $cluster Cluster name

Returns: DBConnRef

Definition at line 131 of file ExternalStoreDB.php.

References $wgDefaultExternalStore, array(), DB_REPLICA, DBO_TRX, getDomainId(), getLoadBalancer(), and wfDebug().

Referenced by batchFetchBlobs(), and fetchBlob().

◆ getTable()

ExternalStoreDB::getTable ( $db )

Get the 'blobs' table name for this database.

Parameters

IDatabase $db

Returns: string Table name ('blobs' by default)

Definition at line 199 of file ExternalStoreDB.php.

Referenced by batchFetchBlobs(), fetchBlob(), and store().

◆ isReadOnly()

ExternalStoreDB::isReadOnly ( $location )

Check if a given location is read-only.

Parameters

string $location The location name

Returns: bool Whether this location is read-only

Since: 1.31

Reimplemented from ExternalStoreMedium.

Definition at line 108 of file ExternalStoreDB.php.

References false, getDomainId(), and getLoadBalancer().

◆ mergeBatchResult()

ExternalStoreDB::mergeBatchResult	(	array &	$ret,
		array &	$ids,
			$res
	)

private

Helper function for self::batchFetchBlobs for merging master/replica DB results.

Parameters

array	&$ret	Current self::batchFetchBlobs return value
array	&$ids	Map from blob_id to requested itemIDs
mixed	$res	DB result from Database::select

Definition at line 313 of file ExternalStoreDB.php.

References $res, $ret, as, captcha-old\count, and unserialize().

Referenced by batchFetchBlobs().

◆ parseURL()

ExternalStoreDB::parseURL ( $url )

protected

Parameters

string $url

Returns: array

Definition at line 332 of file ExternalStoreDB.php.

References $path.

Referenced by batchFetchFromURLs(), and fetchFromURL().

◆ store()

ExternalStoreDB::store	(	$location,
		$data
	)

Insert a data item into a given location.

Parameters

string	$location	The location name
string	$data	The data item

Returns: string|bool The URL of the stored data item, or false on error

Exceptions

MWException

Reimplemented from ExternalStoreMedium.

Definition at line 95 of file ExternalStoreDB.php.

References $data, getMaster(), and getTable().

Referenced by CompressOld\compressPage().

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

includes/externalstore/ExternalStoreDB.php

Public Member Functions

Protected Member Functions

Private Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ batchFetchBlobs()

◆ batchFetchFromURLs()

◆ fetchBlob()

◆ fetchFromURL()

◆ getDomainId()

◆ getLoadBalancer()

◆ getMaster()

◆ getSlave()

◆ getTable()

◆ isReadOnly()

◆ mergeBatchResult()

◆ parseURL()

◆ store()