MediaWiki\FileRepo\IForeignRepoWithDB Interface Reference

A foreign repo that allows for direct access to the foreign MW database. More...

Inherited by MediaWiki\FileRepo\ForeignDBRepo, and MediaWiki\FileRepo\ForeignDBViaLBRepo.

Public Member Functions
	getPrimaryDB ()
	Get a connection to the primary DB for the foreign repo.
	getReplicaDB ()
	Get a connection to the replica DB for the foreign repo.

Detailed Description

A foreign repo that allows for direct access to the foreign MW database.

Extension file repos should implement this if they support making DB queries against the foreign repos. Media handler extensions (e.g. TimedMediaHandler) can look for this interface if they need to look up additional information.

An extension will typically implement this by extending the LocalRepo class and overriding these methods. If the foreign repo is meant to be non-writable, the extension should additionally override LocalRepo::assertWritableRepo() and throw an exception – see ForeignDBRepo and ForeignDBViaLBRepo for examples.

Since

1.41

Stability: stable

to implement

Definition at line 42 of file IForeignRepoWithDB.php.

Member Function Documentation

getPrimaryDB()

MediaWiki\FileRepo\IForeignRepoWithDB::getPrimaryDB

(

)

Get a connection to the primary DB for the foreign repo.

Returns

IDatabase

Since

1.41

Implemented in MediaWiki\FileRepo\ForeignDBRepo, and MediaWiki\FileRepo\ForeignDBViaLBRepo.

getReplicaDB()

MediaWiki\FileRepo\IForeignRepoWithDB::getReplicaDB

(

)

Get a connection to the replica DB for the foreign repo.

Returns

IReadableDatabase

Since

1.41

Implemented in MediaWiki\FileRepo\ForeignDBRepo, and MediaWiki\FileRepo\ForeignDBViaLBRepo.

---

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

• includes/filerepo/IForeignRepoWithDB.php