ExternalStore Class Reference

Constructor class for key/value blob data kept in external repositories. More...

Static Public Member Functions
static	batchFetchFromURLs (array $urls)
	Fetch data from multiple URLs with a minimum of round trips.
static	defaultStoresAreReadOnly ()
static	fetchFromURL ( $url, array $params=[])
	Fetch data from given URL.
static	getStoreObject ( $proto, array $params=[])
	Get an external store object of the given type, with the given parameters.
static	insert ( $url, $data, array $params=[])
	Store a data item to an external store, identified by a partial URL The protocol part is used to identify the class, the rest is passed to the class itself as a parameter.
static	insertToDefault ( $data, array $params=[])
	Like insert() above, but does more of the work for us.
static	insertToForeignDefault ( $data, $wiki)
static	insertWithFallback (array $tryStores, $data, array $params=[])
	Like insert() above, but does more of the work for us.

Detailed Description

Constructor class for key/value blob data kept in external repositories.

Objects in external stores are defined by a special URL. The URL is of the form "<store protocol>://<location>/<object name>". The protocol is used to determine what ExternalStoreMedium class is used. The location identifies particular storage instances or database clusters for store class to use.

When an object is inserted into a store, the calling code uses a partial URL of the form "<store protocol>://<location>" and receives the full object URL on success. This is useful since object names can be sequential IDs, UUIDs, or hashes. Callers are not responsible for unique name generation.

External repositories might be populated by maintenance/async scripts, thus partial moving of data may be possible, as well as the possibility to have any storage format (i.e. for archives).

Definition at line 48 of file ExternalStore.php.

Member Function Documentation

batchFetchFromURLs()

static ExternalStore::batchFetchFromURLs ( array $urls )

static

Fetch data from multiple URLs with a minimum of round trips.

Parameters

array

$urls

The URLs of the text to get

Returns

array Map from url to its data. Data is either string when found or false on failure.

Exceptions

MWException

Definition at line 97 of file ExternalStore.php.

References $urls, and and().

defaultStoresAreReadOnly()

static ExternalStore::defaultStoresAreReadOnly ( )

static

Returns

bool Whether all the default insertion stores are marked as read-only

Since

1.31

Definition at line 226 of file ExternalStore.php.

References $wgDefaultExternalStore, array(), and list.

Referenced by MediaWiki\Storage\SqlBlobStore\isReadOnly().

fetchFromURL()

static ExternalStore::fetchFromURL ( $url, array $params = [] )

static

Fetch data from given URL.

Parameters

string	$url	The URL of the text to get
array	$params	Associative array of ExternalStoreMedium parameters

Returns

string|bool The text stored or false on error

Exceptions

MWException

Definition at line 70 of file ExternalStore.php.

References $params, and list.

Referenced by MediaWiki\Storage\SqlBlobStore\expandBlob().

getStoreObject()

static ExternalStore::getStoreObject ( $proto, array $params = [] )

static

Get an external store object of the given type, with the given parameters.

Parameters

string	$proto	Type of external storage, should be a value in $wgExternalStores
array	$params	Associative array of ExternalStoreMedium parameters

Returns

ExternalStoreMedium|bool The store class or false on error

Definition at line 56 of file ExternalStore.php.

References $params.

insert()

static ExternalStore::insert ( $url, $data, array $params = [] )

static

Store a data item to an external store, identified by a partial URL The protocol part is used to identify the class, the rest is passed to the class itself as a parameter.

Parameters

string	$url	A partial external store URL ("<store type>://<location>")
string	$data
array	$params	Associative array of ExternalStoreMedium parameters

Returns

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

Exceptions

MWException

Definition at line 135 of file ExternalStore.php.

References $data, $params, and list.

insertToDefault()

static ExternalStore::insertToDefault ( $data, array $params = [] )

static

Like insert() above, but does more of the work for us.

This function does not need a url param, it builds it by itself. It also fails-over to the next possible clusters provided by $wgDefaultExternalStore.

Parameters

string	$data
array	$params	Map of ExternalStoreMedium::__construct context parameters

Returns

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

Exceptions

MWException

Definition at line 165 of file ExternalStore.php.

References $data, $params, $wgDefaultExternalStore, and array().

Referenced by MediaWiki\Storage\SqlBlobStore\storeBlob().

insertToForeignDefault()

static ExternalStore::insertToForeignDefault ( $data, $wiki )

static

Parameters

string	$data
string	$wiki

Returns

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

Exceptions

MWException

Definition at line 251 of file ExternalStore.php.

References $data.

insertWithFallback()

static ExternalStore::insertWithFallback ( array $tryStores, $data, array $params = [] )

static

Like insert() above, but does more of the work for us.

This function does not need a url param, it builds it by itself. It also fails-over to the next possible clusters as provided in the first parameter.

Parameters

array	$tryStores	Refer to $wgDefaultExternalStore
string	$data
array	$params	Map of ExternalStoreMedium::__construct context parameters

Returns

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

Exceptions

MWException

Definition at line 183 of file ExternalStore.php.

References $data, $params, and(), list, wfDebug(), and wfDebugLog().

---

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

• includes/externalstore/ExternalStore.php