MediaWiki  1.27.1
ExternalStoreDB Class Reference

DB accessable external objects. More...

Inheritance diagram for ExternalStoreDB:
Collaboration diagram for ExternalStoreDB:

Public Member Functions

 batchFetchBlobs ($cluster, array $ids)
 Fetch multiple blob items out of the database. More...
 
 batchFetchFromURLs (array $urls)
 Fetch data from given external store URLs. 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...
 
 fetchFromURL ($url)
 The provided URL is in the form of DB://cluster/id or DB://cluster/id/itemid for concatened storage. More...
 
 getLoadBalancer ($cluster)
 Get a LoadBalancer for the specified cluster. More...
 
 getMaster ($cluster)
 Get a master database connection for the specified cluster. More...
 
 getSlave ($cluster)
 Get a slave database connection for the specified cluster. More...
 
 getTable ($db)
 Get the 'blobs' table name for this database. More...
 
 store ($location, $data)
 
- Public Member Functions inherited from ExternalStoreMedium
 __construct (array $params=[])
 
 batchFetchFromURLs (array $urls)
 Fetch data from given external store URLs. More...
 
 fetchFromURL ($url)
 Fetch data from given external store URL. More...
 
 store ($location, $data)
 Insert a data item into a given location. More...
 

Protected Member Functions

 parseURL ($url)
 

Private Member Functions

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

Additional Inherited Members

- Protected Attributes inherited from ExternalStoreMedium
array $params = []
 

Detailed Description

DB accessable 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 31 of file ExternalStoreDB.php.

Member Function Documentation

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

Fetch multiple blob items out of the database.

Parameters
string$clusterA cluster name valid for use with LBFactory
array$idsA 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 233 of file ExternalStoreDB.php.

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

Referenced by 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$urlsAn array of external store URLs
Returns
array A map from url to stored content. Failed results are not represented.

Definition at line 60 of file ExternalStoreDB.php.

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

ExternalStoreDB::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.

Parameters
string$cluster
string$id
string$itemID
Returns
HistoryBlob|bool Returns false if missing
Access:
private

Definition at line 180 of file ExternalStoreDB.php.

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

Referenced by 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()

Definition at line 40 of file ExternalStoreDB.php.

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

ExternalStoreDB::getLoadBalancer (   $cluster)

Get a LoadBalancer for the specified cluster.

Parameters
string$clusterCluster name
Returns
LoadBalancer

Definition at line 108 of file ExternalStoreDB.php.

References wfGetLBFactory().

Referenced by getMaster(), and getSlave().

ExternalStoreDB::getMaster (   $cluster)

Get a master database connection for the specified cluster.

Parameters
string$clusterCluster name
Returns
IDatabase

Definition at line 145 of file ExternalStoreDB.php.

References DB_MASTER, DBO_TRX, and getLoadBalancer().

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

ExternalStoreDB::getSlave (   $cluster)

Get a slave database connection for the specified cluster.

Parameters
string$clusterCluster name
Returns
IDatabase

Definition at line 120 of file ExternalStoreDB.php.

References $wgDefaultExternalStore, array(), DB_SLAVE, DBO_TRX, getLoadBalancer(), global, and wfDebug().

Referenced by batchFetchBlobs(), and fetchBlob().

ExternalStoreDB::getTable (   $db)

Get the 'blobs' table name for this database.

Parameters
IDatabase$db
Returns
string Table name ('blobs' by default)

Definition at line 161 of file ExternalStoreDB.php.

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

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

Helper function for self::batchFetchBlobs for merging master/slave results.

Parameters
array&$retCurrent self::batchFetchBlobs return value
array&$idsMap from blob_id to requested itemIDs
mixed$resDB result from Database::select

Definition at line 272 of file ExternalStoreDB.php.

References $res, as, and unserialize().

Referenced by batchFetchBlobs().

ExternalStoreDB::parseURL (   $url)
protected
Parameters
string$url
Returns
array

Definition at line 291 of file ExternalStoreDB.php.

References $path.

Referenced by batchFetchFromURLs(), and fetchFromURL().

ExternalStoreDB::store (   $location,
  $data 
)

Definition at line 88 of file ExternalStoreDB.php.

References getMaster(), and getTable().

Referenced by CompressOld\compressPage().


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