MediaWiki  1.27.2
IDatabase.php
Go to the documentation of this file.
1 <?php
2 
35 interface IDatabase {
43  public function getServerInfo();
44 
66  public function bufferResults( $buffer = null );
67 
76  public function trxLevel();
77 
87  public function trxTimestamp();
88 
94  public function tablePrefix( $prefix = null );
95 
101  public function dbSchema( $schema = null );
102 
112  public function getLBInfo( $name = null );
113 
122  public function setLBInfo( $name, $value = null );
123 
129  public function implicitGroupby();
130 
137  public function implicitOrderby();
138 
143  public function lastQuery();
144 
151  public function doneWrites();
152 
160  public function lastDoneWrites();
161 
166  public function writesPending();
167 
174  public function writesOrCallbacksPending();
175 
184  public function pendingWriteQueryDuration();
185 
192  public function pendingWriteCallers();
193 
198  public function isOpen();
199 
211  public function setFlag( $flag );
212 
224  public function clearFlag( $flag );
225 
236  public function getFlag( $flag );
237 
244  public function getProperty( $name );
245 
249  public function getWikiID();
250 
256  public function getType();
257 
268  public function open( $server, $user, $password, $dbName );
269 
280  public function fetchObject( $res );
281 
291  public function fetchRow( $res );
292 
299  public function numRows( $res );
300 
308  public function numFields( $res );
309 
318  public function fieldName( $res, $n );
319 
332  public function insertId();
333 
341  public function dataSeek( $res, $row );
342 
349  public function lastErrno();
350 
357  public function lastError();
358 
368  public function fieldInfo( $table, $field );
369 
376  public function affectedRows();
377 
386  public function getSoftwareLink();
387 
394  public function getServerVersion();
395 
403  public function close();
404 
409  public function reportConnectionError( $error = 'Unknown error' );
410 
433  public function query( $sql, $fname = __METHOD__, $tempIgnore = false );
434 
446  public function reportQueryError( $error, $errno, $sql, $fname, $tempIgnore = false );
447 
455  public function freeResult( $res );
456 
474  public function selectField(
475  $table, $var, $cond = '', $fname = __METHOD__, $options = []
476  );
477 
496  public function selectFieldValues(
497  $table, $var, $cond = '', $fname = __METHOD__, $options = []
498  );
499 
649  public function select(
650  $table, $vars, $conds = '', $fname = __METHOD__,
651  $options = [], $join_conds = []
652  );
653 
670  public function selectSQLText(
671  $table, $vars, $conds = '', $fname = __METHOD__,
672  $options = [], $join_conds = []
673  );
674 
689  public function selectRow( $table, $vars, $conds, $fname = __METHOD__,
690  $options = [], $join_conds = []
691  );
692 
713  public function estimateRowCount(
714  $table, $vars = '*', $conds = '', $fname = __METHOD__, $options = []
715  );
716 
734  public function selectRowCount(
735  $tables, $vars = '*', $conds = '', $fname = __METHOD__, $options = [], $join_conds = []
736  );
737 
746  public function fieldExists( $table, $field, $fname = __METHOD__ );
747 
758  public function indexExists( $table, $index, $fname = __METHOD__ );
759 
767  public function tableExists( $table, $fname = __METHOD__ );
768 
777  public function indexUnique( $table, $index );
778 
812  public function insert( $table, $a, $fname = __METHOD__, $options = [] );
813 
832  public function update( $table, $values, $conds, $fname = __METHOD__, $options = [] );
833 
848  public function makeList( $a, $mode = LIST_COMMA );
849 
860  public function makeWhereFrom2d( $data, $baseKey, $subKey );
861 
866  public function bitNot( $field );
867 
873  public function bitAnd( $fieldLeft, $fieldRight );
874 
880  public function bitOr( $fieldLeft, $fieldRight );
881 
888  public function buildConcat( $stringList );
889 
906  public function buildGroupConcatField(
907  $delim, $table, $field, $conds = '', $join_conds = []
908  );
909 
916  public function selectDB( $db );
917 
922  public function getDBname();
923 
928  public function getServer();
929 
936  public function addQuotes( $s );
937 
954  public function buildLike();
955 
961  public function anyChar();
962 
968  public function anyString();
969 
981  public function nextSequenceValue( $seqName );
982 
1005  public function replace( $table, $uniqueIndexes, $rows, $fname = __METHOD__ );
1006 
1041  public function upsert(
1042  $table, array $rows, array $uniqueIndexes, array $set, $fname = __METHOD__
1043  );
1044 
1065  public function deleteJoin( $delTable, $joinTable, $delVar, $joinVar, $conds,
1066  $fname = __METHOD__
1067  );
1068 
1079  public function delete( $table, $conds, $fname = __METHOD__ );
1080 
1107  public function insertSelect( $destTable, $srcTable, $varMap, $conds,
1108  $fname = __METHOD__,
1109  $insertOptions = [], $selectOptions = []
1110  );
1111 
1117  public function unionSupportsOrderAndLimit();
1118 
1127  public function unionQueries( $sqls, $all );
1128 
1138  public function conditional( $cond, $trueVal, $falseVal );
1139 
1150  public function strreplace( $orig, $old, $new );
1151 
1158  public function getServerUptime();
1159 
1166  public function wasDeadlock();
1167 
1174  public function wasLockTimeout();
1175 
1183  public function wasErrorReissuable();
1184 
1191  public function wasReadOnlyError();
1192 
1202  public function masterPosWait( DBMasterPos $pos, $timeout );
1203 
1209  public function getSlavePos();
1210 
1216  public function getMasterPos();
1217 
1234  public function onTransactionIdle( $callback );
1235 
1249  public function onTransactionPreCommitOrIdle( $callback );
1250 
1275  public function startAtomic( $fname = __METHOD__ );
1276 
1288  public function endAtomic( $fname = __METHOD__ );
1289 
1316  public function doAtomicSection( $fname, $callback );
1317 
1333  public function begin( $fname = __METHOD__ );
1334 
1353  public function commit( $fname = __METHOD__, $flush = '' );
1354 
1369  public function rollback( $fname = __METHOD__, $flush = '' );
1370 
1379  public function listTables( $prefix = null, $fname = __METHOD__ );
1380 
1392  public function timestamp( $ts = 0 );
1393 
1407  public function timestampOrNull( $ts = null );
1408 
1414  public function ping();
1415 
1425  public function getLag();
1426 
1440  public function getSessionLagStatus();
1441 
1447  public function maxListLen();
1448 
1458  public function encodeBlob( $b );
1459 
1468  public function decodeBlob( $b );
1469 
1480  public function setSessionOptions( array $options );
1481 
1489  public function setSchemaVars( $vars );
1490 
1499  public function lockIsFree( $lockName, $method );
1500 
1511  public function lock( $lockName, $method, $timeout = 5 );
1512 
1525  public function unlock( $lockName, $method );
1526 
1544  public function getScopedLockAndFlush( $lockKey, $fname, $timeout );
1545 
1552  public function namedLocksEnqueue();
1553 
1561  public function getInfinity();
1562 
1569  public function encodeExpiry( $expiry );
1570 
1578  public function decodeExpiry( $expiry, $format = TS_MW );
1579 
1589  public function setBigSelects( $value = true );
1590 
1595  public function isReadOnly();
1596 }
lastDoneWrites()
Returns the last time the connection may have been used for write queries.
setSchemaVars($vars)
Set variables to be used in sourceFile/sourceStream, in preference to the ones in $GLOBALS...
anyString()
Returns a token for buildLike() that denotes a '' to be used in a LIKE query.
insert($table, $a, $fname=__METHOD__, $options=[])
INSERT wrapper, inserts an array into a table.
selectRow($table, $vars, $conds, $fname=__METHOD__, $options=[], $join_conds=[])
Single row SELECT wrapper.
the array() calling protocol came about after MediaWiki 1.4rc1.
wasErrorReissuable()
Determines if the last query error was something that should be dealt with by pinging the connection ...
dbSchema($schema=null)
Get/set the db schema.
getDBname()
Get the current DB name.
lastQuery()
Return the last query that went through IDatabase::query()
makeList($a, $mode=LIST_COMMA)
Makes an encoded list of strings from an array.
indexExists($table, $index, $fname=__METHOD__)
Determines whether an index exists Usually throws a DBQueryError on failure If errors are explicitly ...
begin($fname=__METHOD__)
Begin a transaction.
close()
Closes a database connection.
open($server, $user, $password, $dbName)
Open a connection to the database.
isOpen()
Is a connection to the database open?
query($sql, $fname=__METHOD__, $tempIgnore=false)
Run an SQL query and return the result.
getMasterPos()
Get the position of this master.
unionQueries($sqls, $all)
Construct a UNION query This is used for providing overload point for other DB abstractions not compa...
getServerInfo()
A string describing the current software version, and possibly other details in a user-friendly way...
lock($lockName, $method, $timeout=5)
Acquire a named lock.
$value
getServerVersion()
A string describing the current software version, like from mysql_get_server_info().
fieldName($res, $n)
Get a field name in a result object.
bitAnd($fieldLeft, $fieldRight)
trxTimestamp()
Get the UNIX timestamp of the time that the transaction was established.
tableExists($table, $fname=__METHOD__)
Query whether a given table exists.
lastError()
Get a description of the last error.
selectDB($db)
Change the current database.
An object representing a master or slave position in a replicated setup.
upsert($table, array $rows, array $uniqueIndexes, array $set, $fname=__METHOD__)
INSERT ON DUPLICATE KEY UPDATE wrapper, upserts an array into a table.
fieldInfo($table, $field)
mysql_fetch_field() wrapper Returns false if the field doesn't exist
timestamp($ts=0)
Convert a timestamp in one of the formats accepted by wfTimestamp() to the format used for inserting ...
ping()
Ping the server and try to reconnect if it there is no connection.
getType()
Get the type of the DBMS, as it appears in $wgDBtype.
lastErrno()
Get the last error number.
getInfinity()
Find out when 'infinity' is.
masterPosWait(DBMasterPos $pos, $timeout)
Wait for the slave to catch up to a given master position.
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist e g Watchlist & $tables
Definition: hooks.txt:965
trxLevel()
Gets the current transaction level.
estimateRowCount($table, $vars= '*', $conds= '', $fname=__METHOD__, $options=[])
Estimate the number of rows in dataset.
maxListLen()
Return the maximum number of items allowed in a list, or 0 for unlimited.
affectedRows()
Get the number of rows affected by the last write query.
setLBInfo($name, $value=null)
Set the LB info array, or a member of it.
dataSeek($res, $row)
Change the position of the cursor in a result object.
lockIsFree($lockName, $method)
Check to see if a named lock is available (non-blocking)
makeWhereFrom2d($data, $baseKey, $subKey)
Build a partial where clause from a 2-d array such as used for LinkBatch.
reportConnectionError($error= 'Unknown error')
wasLockTimeout()
Determines if the last failure was due to a lock timeout STUB.
onTransactionIdle($callback)
Run an anonymous function as soon as there is no transaction pending.
getSessionLagStatus()
Get the slave lag when the current transaction started or a general lag estimate if not transaction i...
listTables($prefix=null, $fname=__METHOD__)
List all tables on the database.
pendingWriteQueryDuration()
Get the time spend running write queries for this transaction.
getLag()
Get slave lag.
selectSQLText($table, $vars, $conds= '', $fname=__METHOD__, $options=[], $join_conds=[])
The equivalent of IDatabase::select() except that the constructed SQL is returned, instead of being immediately executed.
timestampOrNull($ts=null)
Convert a timestamp in one of the formats accepted by wfTimestamp() to the format used for inserting ...
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist e g Watchlist removed from all revisions and log entries to which it was applied This gives extensions a chance to take it off their books as the deletion has already been partly carried out by this point or something similar the user will be unable to create the tag set and then return false from the hook function Ensure you consume the ChangeTagAfterDelete hook to carry out custom deletion actions as context called by AbstractContent::getParserOutput May be used to override the normal model specific rendering of page content as context as context $options
Definition: hooks.txt:1004
selectFieldValues($table, $var, $cond= '', $fname=__METHOD__, $options=[])
A SELECT wrapper which returns a list of single field values from result rows.
fetchObject($res)
Fetch the next row from the given result object, in object form.
const LIST_COMMA
Definition: Defines.php:192
freeResult($res)
Free a result object returned by query() or select().
unlock($lockName, $method)
Release a lock.
$res
Definition: database.txt:21
setFlag($flag)
Set a flag for this connection.
namedLocksEnqueue()
Check to see if a named lock used by lock() use blocking queues.
buildGroupConcatField($delim, $table, $field, $conds= '', $join_conds=[])
Build a GROUP_CONCAT or equivalent statement for a query.
bufferResults($buffer=null)
Turns buffering of SQL result sets on (true) or off (false).
writesOrCallbacksPending()
Returns true if there is a transaction open with possible write queries or transaction pre-commit/idl...
onTransactionPreCommitOrIdle($callback)
Run an anonymous function before the current transaction commits or now if there is none...
selectField($table, $var, $cond= '', $fname=__METHOD__, $options=[])
A SELECT wrapper which returns a single field from a single result row.
clearFlag($flag)
Clear a flag for this connection.
$buffer
selectRowCount($tables, $vars= '*', $conds= '', $fname=__METHOD__, $options=[], $join_conds=[])
Get the number of rows in dataset.
endAtomic($fname=__METHOD__)
Ends an atomic section of SQL statements.
bitOr($fieldLeft, $fieldRight)
getFlag($flag)
Returns a boolean whether the flag $flag is set for this connection.
deleteJoin($delTable, $joinTable, $delVar, $joinVar, $conds, $fname=__METHOD__)
DELETE where the condition is a join.
wasDeadlock()
Determines if the last failure was due to a deadlock STUB.
fieldExists($table, $field, $fname=__METHOD__)
Determines whether a field exists in a table.
decodeExpiry($expiry, $format=TS_MW)
Decode an expiry time into a DBMS independent format.
buildConcat($stringList)
Build a concatenation list to feed into a SQL query.
replace($table, $uniqueIndexes, $rows, $fname=__METHOD__)
REPLACE query wrapper.
startAtomic($fname=__METHOD__)
Begin an atomic section of statements.
fetchRow($res)
Fetch the next row from the given result object, in associative array form.
please add to it if you re going to add events to the MediaWiki code where normally authentication against an external auth plugin would be creating a local account $user
Definition: hooks.txt:242
numRows($res)
Get the number of rows in a result object.
getServerUptime()
Determines how long the server has been up STUB.
const TS_MW
MediaWiki concatenated string timestamp (YYYYMMDDHHMMSS)
commit($fname=__METHOD__, $flush= '')
Commits a transaction previously started using begin().
strreplace($orig, $old, $new)
Returns a comand for str_replace function in SQL query.
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
Definition: injection.txt:35
anyChar()
Returns a token for buildLike() that denotes a '_' to be used in a LIKE query.
buildLike()
LIKE statement wrapper, receives a variable-length argument list with parts of pattern to match conta...
doneWrites()
Returns true if the connection may have been used for write queries.
implicitOrderby()
Returns true if this database does an implicit order by when the column has an index For example: SEL...
if(!defined( 'MEDIAWIKI')) $fname
This file is not a valid entry point, perform no further processing unless MEDIAWIKI is defined...
Definition: Setup.php:35
nextSequenceValue($seqName)
Returns an appropriately quoted sequence value for inserting a new row.
getSoftwareLink()
Returns a wikitext link to the DB's website, e.g., return "[http://www.mysql.com/ MySQL]"; Should at ...
bitNot($field)
pendingWriteCallers()
Get the list of method names that did write queries for this transaction.
insertId()
Get the inserted value of an auto-increment row.
doAtomicSection($fname, $callback)
Run a callback to do an atomic set of updates for this database.
insertSelect($destTable, $srcTable, $varMap, $conds, $fname=__METHOD__, $insertOptions=[], $selectOptions=[])
INSERT SELECT wrapper.
getServer()
Get the server hostname or IP address.
unionSupportsOrderAndLimit()
Returns true if current database backend supports ORDER BY or LIMIT for separate subqueries within th...
encodeExpiry($expiry)
Encode an expiry time into the DBMS dependent format.
tablePrefix($prefix=null)
Get/set the table prefix.
getLBInfo($name=null)
Get properties passed down from the server info array of the load balancer.
encodeBlob($b)
Some DBMSs have a special format for inserting into blob fields, they don't allow simple quoted strin...
addQuotes($s)
Adds quotes and backslashes.
rollback($fname=__METHOD__, $flush= '')
Rollback a transaction previously started using begin().
decodeBlob($b)
Some DBMSs return a special placeholder object representing blob fields in result objects...
setBigSelects($value=true)
Allow or deny "big selects" for this session only.
select($table, $vars, $conds= '', $fname=__METHOD__, $options=[], $join_conds=[])
Execute a SELECT query constructed using the various parameters provided.
getSlavePos()
Get the replication position of this slave.
indexUnique($table, $index)
Determines if a given index is unique.
reportQueryError($error, $errno, $sql, $fname, $tempIgnore=false)
Report a query error.
static configuration should be added through ResourceLoaderGetConfigVars instead & $vars
Definition: hooks.txt:1996
conditional($cond, $trueVal, $falseVal)
Returns an SQL expression for a simple conditional.
numFields($res)
Get the number of fields in a result object.
getProperty($name)
General read-only accessor.
implicitGroupby()
Returns true if this database does an implicit sort when doing GROUP BY.
getScopedLockAndFlush($lockKey, $fname, $timeout)
Acquire a named lock, flush any transaction, and return an RAII style unlocker object.
update($table, $values, $conds, $fname=__METHOD__, $options=[])
UPDATE wrapper.
wasReadOnlyError()
Determines if the last failure was due to the database being read-only.
Basic database interface for live and lazy-loaded DB handles.
Definition: IDatabase.php:35
Allows to change the fields on the form that will be generated $name
Definition: hooks.txt:310
setSessionOptions(array $options)
Override database's default behavior.