MediaWiki REL1_39
|
This is the SQLite database abstraction layer. More...
Public Member Functions | |||||||||||||||||||||
__construct (array $params) | |||||||||||||||||||||
Additional params include: | |||||||||||||||||||||
addQuotes ( $s) | |||||||||||||||||||||
attachDatabase ( $name, $file=false, $fname=__METHOD__) | |||||||||||||||||||||
Attaches external database to the connection handle. | |||||||||||||||||||||
databasesAreIndependent () | |||||||||||||||||||||
Returns true if DBs are assumed to be on potentially different servers.In systems like mysql/mariadb, different databases can easily be referenced on a single connection merely by name, even in a single query via JOIN. On the other hand, Postgres treats databases as logically separate, with different database users, requiring special mechanisms like postgres_fdw to "mount" foreign DBs. This is true even among DBs on the same server. Changing the selected database via selectDomain() requires a new connection.
| |||||||||||||||||||||
deadlockLoop (... $args) | |||||||||||||||||||||
No-op version of deadlockLoop. | |||||||||||||||||||||
decodeBlob ( $b) | |||||||||||||||||||||
doLock (string $lockName, string $method, int $timeout) | |||||||||||||||||||||
doLockIsFree (string $lockName, string $method) | |||||||||||||||||||||
doUnlock (string $lockName, string $method) | |||||||||||||||||||||
duplicateTableStructure ( $oldName, $newName, $temporary=false, $fname=__METHOD__) | |||||||||||||||||||||
encodeBlob ( $b) | |||||||||||||||||||||
fieldInfo ( $table, $field) | |||||||||||||||||||||
Get information about a given field Returns false if the field does not exist. | |||||||||||||||||||||
getDbFilePath () | |||||||||||||||||||||
getLockFileDirectory () | |||||||||||||||||||||
getServerVersion () | |||||||||||||||||||||
getSoftwareLink () | |||||||||||||||||||||
getTopologyBasedServerId () | |||||||||||||||||||||
Get a non-recycled ID that uniquely identifies this server within the replication topology. | |||||||||||||||||||||
getType () | |||||||||||||||||||||
indexInfo ( $table, $index, $fname=__METHOD__) | |||||||||||||||||||||
Returns information about an index Returns false if the index does not exist. | |||||||||||||||||||||
indexUnique ( $table, $index, $fname=__METHOD__) | |||||||||||||||||||||
insertId () | |||||||||||||||||||||
This must be called after nextSequenceVal. | |||||||||||||||||||||
lastErrno () | |||||||||||||||||||||
lastError () | |||||||||||||||||||||
listTables ( $prefix=null, $fname=__METHOD__) | |||||||||||||||||||||
List all tables on the database. | |||||||||||||||||||||
serverIsReadOnly () | |||||||||||||||||||||
| |||||||||||||||||||||
setTableAliases (array $aliases) | |||||||||||||||||||||
Make certain table names use their own database, schema, and table prefix when passed into SQL queries pre-escaped and without a qualified database name. | |||||||||||||||||||||
strencode ( $s) | |||||||||||||||||||||
tableExists ( $table, $fname=__METHOD__) | |||||||||||||||||||||
Query whether a given table exists. | |||||||||||||||||||||
textFieldSize ( $table, $field) | |||||||||||||||||||||
Returns the size of a text field, or -1 for "unlimited" In SQLite this is SQLITE_MAX_LENGTH, by default 1 GB. | |||||||||||||||||||||
wasDeadlock () | |||||||||||||||||||||
wasReadOnlyError () | |||||||||||||||||||||
Public Member Functions inherited from Wikimedia\Rdbms\Database | |||||||||||||||||||||
__clone () | |||||||||||||||||||||
Make sure that copies do not share the same client binding handle. | |||||||||||||||||||||
__destruct () | |||||||||||||||||||||
Run a few simple checks and close dangling connections. | |||||||||||||||||||||
__sleep () | |||||||||||||||||||||
Called by serialize. | |||||||||||||||||||||
__toString () | |||||||||||||||||||||
Get a debugging string that mentions the database type, the ID of this instance, and the ID of any underlying connection resource or driver object if one is present. | |||||||||||||||||||||
addIdentifierQuotes ( $s) | |||||||||||||||||||||
Escape a SQL identifier (e.g. | |||||||||||||||||||||
affectedRows () | |||||||||||||||||||||
Get the number of rows affected by the last write query. | |||||||||||||||||||||
anyChar () | |||||||||||||||||||||
Returns a token for buildLike() that denotes a '_' to be used in a LIKE query. | |||||||||||||||||||||
anyString () | |||||||||||||||||||||
Returns a token for buildLike() that denotes a '' to be used in a LIKE query. | |||||||||||||||||||||
begin ( $fname=__METHOD__, $mode=self::TRANSACTION_EXPLICIT) | |||||||||||||||||||||
Begin a transaction. | |||||||||||||||||||||
bitAnd ( $fieldLeft, $fieldRight) | |||||||||||||||||||||
bitNot ( $field) | |||||||||||||||||||||
bitOr ( $fieldLeft, $fieldRight) | |||||||||||||||||||||
buildConcat ( $stringList) | |||||||||||||||||||||
Build a concatenation list to feed into a SQL query. | |||||||||||||||||||||
buildExcludedValue ( $column) | |||||||||||||||||||||
Build a reference to a column value from the conflicting proposed upsert() row. | |||||||||||||||||||||
buildGreatest ( $fields, $values) | |||||||||||||||||||||
Build a GREATEST function statement comparing columns/values. | |||||||||||||||||||||
buildGroupConcatField ( $delim, $table, $field, $conds='', $join_conds=[]) | |||||||||||||||||||||
Build a GROUP_CONCAT or equivalent statement for a query. | |||||||||||||||||||||
buildIntegerCast ( $field) | |||||||||||||||||||||
buildLeast ( $fields, $values) | |||||||||||||||||||||
Build a LEAST function statement comparing columns/values. | |||||||||||||||||||||
buildLike ( $param,... $params) | |||||||||||||||||||||
LIKE statement wrapper. | |||||||||||||||||||||
buildSelectSubquery ( $table, $vars, $conds='', $fname=__METHOD__, $options=[], $join_conds=[]) | |||||||||||||||||||||
Equivalent to IDatabase::selectSQLText() except wraps the result in Subquery. | |||||||||||||||||||||
buildStringCast ( $field) | |||||||||||||||||||||
buildSubstring ( $input, $startPosition, $length=null) | |||||||||||||||||||||
cancelAtomic ( $fname=__METHOD__, AtomicSectionIdentifier $sectionId=null) | |||||||||||||||||||||
Cancel an atomic section of SQL statements. | |||||||||||||||||||||
clearFlag ( $flag, $remember=self::REMEMBER_NOTHING) | |||||||||||||||||||||
Clear a flag for this connection. | |||||||||||||||||||||
close ( $fname=__METHOD__) | |||||||||||||||||||||
Close the database connection. | |||||||||||||||||||||
commit ( $fname=__METHOD__, $flush=self::FLUSHING_ONE) | |||||||||||||||||||||
Commits a transaction previously started using begin() | |||||||||||||||||||||
conditional ( $cond, $caseTrueExpression, $caseFalseExpression) | |||||||||||||||||||||
Returns an SQL expression for a simple conditional. | |||||||||||||||||||||
connectionErrorLogger ( $errno, $errstr) | |||||||||||||||||||||
Error handler for logging errors during database connection. | |||||||||||||||||||||
dbSchema ( $schema=null) | |||||||||||||||||||||
Get/set the db schema. | |||||||||||||||||||||
decodeExpiry ( $expiry, $format=TS_MW) | |||||||||||||||||||||
Decode an expiry time into a DBMS independent format. | |||||||||||||||||||||
delete ( $table, $conds, $fname=__METHOD__) | |||||||||||||||||||||
Delete all rows in a table that match a condition. | |||||||||||||||||||||
deleteJoin ( $delTable, $joinTable, $delVar, $joinVar, $conds, $fname=__METHOD__) | |||||||||||||||||||||
Delete all rows in a table that match a condition which includes a join.For safety, an empty $conds will not delete everything. If you want to delete all rows where the join condition matches, set $conds=IDatabase::ALL_ROWS.DO NOT put the join condition in $conds.
| |||||||||||||||||||||
doAtomicSection ( $fname, callable $callback, $cancelable=self::ATOMIC_NOT_CANCELABLE) | |||||||||||||||||||||
Perform an atomic section of reversible SQL statements from a callback. | |||||||||||||||||||||
dropTable ( $table, $fname=__METHOD__) | |||||||||||||||||||||
Delete a table. | |||||||||||||||||||||
encodeExpiry ( $expiry) | |||||||||||||||||||||
Encode an expiry time into the DBMS dependent format. | |||||||||||||||||||||
endAtomic ( $fname=__METHOD__) | |||||||||||||||||||||
Ends an atomic section of SQL statements. | |||||||||||||||||||||
estimateRowCount ( $tables, $var=' *', $conds='', $fname=__METHOD__, $options=[], $join_conds=[]) | |||||||||||||||||||||
Estimate the number of rows in dataset.MySQL allows you to estimate the number of rows that would be returned by a SELECT query, using EXPLAIN SELECT. The estimate is provided using index cardinality statistics, and is notoriously inaccurate, especially when large numbers of rows have recently been added or deleted.For DBMSs that don't support fast result size estimation, this function will actually perform the SELECT COUNT(*).Takes the same arguments as IDatabase::select().New callers should use newSelectQueryBuilder with SelectQueryBuilder::estimateRowCount instead, which is more readable and less error-prone.
| |||||||||||||||||||||
explicitTrxActive () | |||||||||||||||||||||
Check whether there is a transaction open at the specific request of a caller. | |||||||||||||||||||||
factorConds ( $condsArray) | |||||||||||||||||||||
Given an array of condition arrays representing an OR list of AND lists, for example: | |||||||||||||||||||||
fieldExists ( $table, $field, $fname=__METHOD__) | |||||||||||||||||||||
Determines whether a field exists in a table. | |||||||||||||||||||||
flushSession ( $fname=__METHOD__, $flush=self::FLUSHING_ONE) | |||||||||||||||||||||
Release important session-level state (named lock, table locks) as post-rollback cleanup. | |||||||||||||||||||||
flushSnapshot ( $fname=__METHOD__, $flush=self::FLUSHING_ONE) | |||||||||||||||||||||
Commit any transaction but error out if writes or callbacks are pending. | |||||||||||||||||||||
getDBname () | |||||||||||||||||||||
Get the current database name; null if there isn't one. | |||||||||||||||||||||
getDomainID () | |||||||||||||||||||||
Return the currently selected domain ID. | |||||||||||||||||||||
getFlag ( $flag) | |||||||||||||||||||||
Returns a boolean whether the flag $flag is set for this connection. | |||||||||||||||||||||
getInfinity () | |||||||||||||||||||||
Find out when 'infinity' is. | |||||||||||||||||||||
getLag () | |||||||||||||||||||||
Get the amount of replication lag for this database server. | |||||||||||||||||||||
getLBInfo ( $name=null) | |||||||||||||||||||||
Get properties passed down from the server info array of the load balancer. | |||||||||||||||||||||
getPrimaryPos () | |||||||||||||||||||||
Get the position of this primary DB.
| |||||||||||||||||||||
getReplicaPos () | |||||||||||||||||||||
Get the replication position of this replica DB.
| |||||||||||||||||||||
getScopedLockAndFlush ( $lockKey, $fname, $timeout) | |||||||||||||||||||||
Acquire a named lock, flush any transaction, and return an RAII style unlocker object. | |||||||||||||||||||||
getServer () | |||||||||||||||||||||
Get the hostname or IP address of the server. | |||||||||||||||||||||
getServerInfo () | |||||||||||||||||||||
Get a human-readable string describing the current software version. | |||||||||||||||||||||
getServerName () | |||||||||||||||||||||
Get the readable name for the server. | |||||||||||||||||||||
getSessionLagStatus () | |||||||||||||||||||||
Get the replica DB lag when the current transaction started or a general lag estimate if not transaction is active. | |||||||||||||||||||||
getTableAliases () | |||||||||||||||||||||
Return current table aliases. | |||||||||||||||||||||
getTopologyRole () | |||||||||||||||||||||
Get the replication topology role of this server. | |||||||||||||||||||||
implicitOrderby () | |||||||||||||||||||||
Returns true if this database does an implicit order by when the column has an index For example: SELECT page_title FROM page LIMIT 1. | |||||||||||||||||||||
indexExists ( $table, $index, $fname=__METHOD__) | |||||||||||||||||||||
Determines whether an index exists. | |||||||||||||||||||||
initConnection () | |||||||||||||||||||||
Initialize the connection to the database over the wire (or to local files) | |||||||||||||||||||||
insert ( $table, $rows, $fname=__METHOD__, $options=[]) | |||||||||||||||||||||
Insert row(s) into a table, in the provided order. | |||||||||||||||||||||
insertSelect ( $destTable, $srcTable, $varMap, $conds, $fname=__METHOD__, $insertOptions=[], $selectOptions=[], $selectJoinConds=[]) | |||||||||||||||||||||
INSERT SELECT wrapper. | |||||||||||||||||||||
isOpen () | |||||||||||||||||||||
isQuotedIdentifier ( $name) | |||||||||||||||||||||
isReadOnly () | |||||||||||||||||||||
lastDoneWrites () | |||||||||||||||||||||
Get the last time the connection may have been used for a write query. | |||||||||||||||||||||
lastQuery () | |||||||||||||||||||||
Get the last query that sent on account of IDatabase::query() | |||||||||||||||||||||
limitResult ( $sql, $limit, $offset=false) | |||||||||||||||||||||
Construct a LIMIT query with optional offset. | |||||||||||||||||||||
listViews ( $prefix=null, $fname=__METHOD__) | |||||||||||||||||||||
Lists all the VIEWs in the database.
| |||||||||||||||||||||
lock ( $lockName, $method, $timeout=5, $flags=0) | |||||||||||||||||||||
Acquire a named lock.Named locks are not related to transactions
| |||||||||||||||||||||
lockForUpdate ( $table, $conds='', $fname=__METHOD__, $options=[], $join_conds=[]) | |||||||||||||||||||||
Lock all rows meeting the given conditions/options FOR UPDATE. | |||||||||||||||||||||
lockIsFree ( $lockName, $method) | |||||||||||||||||||||
Check to see if a named lock is not locked by any thread (non-blocking)
| |||||||||||||||||||||
makeList (array $a, $mode=self::LIST_COMMA) | |||||||||||||||||||||
Makes an encoded list of strings from an array. | |||||||||||||||||||||
makeWhereFrom2d ( $data, $baseKey, $subKey) | |||||||||||||||||||||
Build a partial where clause from a 2-d array such as used for LinkBatch. | |||||||||||||||||||||
namedLocksEnqueue () | |||||||||||||||||||||
Check to see if a named lock used by lock() use blocking queues.
| |||||||||||||||||||||
newSelectQueryBuilder () | |||||||||||||||||||||
Get a SelectQueryBuilder bound to this connection. | |||||||||||||||||||||
nextSequenceValue ( $seqName) | |||||||||||||||||||||
Deprecated method, calls should be removed. | |||||||||||||||||||||
onAtomicSectionCancel (callable $callback, $fname=__METHOD__) | |||||||||||||||||||||
Run a callback when the atomic section is cancelled. | |||||||||||||||||||||
onTransactionCommitOrIdle (callable $callback, $fname=__METHOD__) | |||||||||||||||||||||
Run a callback when the current transaction commits or now if there is none. | |||||||||||||||||||||
onTransactionPreCommitOrIdle (callable $callback, $fname=__METHOD__) | |||||||||||||||||||||
Run a callback before the current transaction commits or now if there is none. | |||||||||||||||||||||
onTransactionResolution (callable $callback, $fname=__METHOD__) | |||||||||||||||||||||
Run a callback when the current transaction commits or rolls back. | |||||||||||||||||||||
pendingWriteAndCallbackCallers () | |||||||||||||||||||||
pendingWriteCallers () | |||||||||||||||||||||
Get the list of method names that did write queries for this transaction. | |||||||||||||||||||||
pendingWriteQueryDuration ( $type=self::ESTIMATE_TOTAL) | |||||||||||||||||||||
Get the time spend running write queries for this transaction. | |||||||||||||||||||||
ping (&$rtt=null) | |||||||||||||||||||||
Ping the server and try to reconnect if it there is no connection. | |||||||||||||||||||||
primaryPosWait (DBPrimaryPos $pos, $timeout) | |||||||||||||||||||||
Wait for the replica DB to catch up to a given primary DB position.Note that this does not start any new transactions. If any existing transaction is flushed, and this is called, then queries will reflect the point the DB was synced up to (on success) without interference from REPEATABLE-READ snapshots.
| |||||||||||||||||||||
query ( $sql, $fname=__METHOD__, $flags=0) | |||||||||||||||||||||
Run an SQL query statement and return the result. | |||||||||||||||||||||
queryMulti (array $sqls, string $fname=__METHOD__, int $flags=0, ?string $summarySql=null) | |||||||||||||||||||||
Run a batch of SQL query statements and return the results. | |||||||||||||||||||||
replace ( $table, $uniqueKeys, $rows, $fname=__METHOD__) | |||||||||||||||||||||
Insert row(s) into a table, in the provided order, while deleting conflicting rows. | |||||||||||||||||||||
reportQueryError ( $error, $errno, $sql, $fname, $ignore=false) | |||||||||||||||||||||
Report a query error. | |||||||||||||||||||||
restoreFlags ( $state=self::RESTORE_PRIOR) | |||||||||||||||||||||
Restore the flags to their prior state before the last setFlag/clearFlag call. | |||||||||||||||||||||
rollback ( $fname=__METHOD__, $flush=self::FLUSHING_ONE) | |||||||||||||||||||||
Rollback a transaction previously started using begin() | |||||||||||||||||||||
runOnTransactionIdleCallbacks ( $trigger, array &$errors=[]) | |||||||||||||||||||||
Consume and run any "on transaction idle/resolution" callbacks. | |||||||||||||||||||||
runOnTransactionPreCommitCallbacks () | |||||||||||||||||||||
runTransactionListenerCallbacks ( $trigger, array &$errors=[]) | |||||||||||||||||||||
Actually run any "transaction listener" callbacks. | |||||||||||||||||||||
select ( $table, $vars, $conds='', $fname=__METHOD__, $options=[], $join_conds=[]) | |||||||||||||||||||||
Execute a SELECT query constructed using the various parameters provided. | |||||||||||||||||||||
selectDB ( $db) | |||||||||||||||||||||
Change the current database. | |||||||||||||||||||||
selectDomain ( $domain) | |||||||||||||||||||||
Set the current domain (database, schema, and table prefix) | |||||||||||||||||||||
selectField ( $table, $var, $cond='', $fname=__METHOD__, $options=[], $join_conds=[]) | |||||||||||||||||||||
A SELECT wrapper which returns a single field from a single result row. | |||||||||||||||||||||
selectFieldValues ( $table, $var, $cond='', $fname=__METHOD__, $options=[], $join_conds=[]) | |||||||||||||||||||||
A SELECT wrapper which returns a list of single field values from result rows. | |||||||||||||||||||||
selectRow ( $table, $vars, $conds, $fname=__METHOD__, $options=[], $join_conds=[]) | |||||||||||||||||||||
Wrapper to IDatabase::select() that only fetches one row (via LIMIT) | |||||||||||||||||||||
selectRowCount ( $tables, $var=' *', $conds='', $fname=__METHOD__, $options=[], $join_conds=[]) | |||||||||||||||||||||
Get the number of rows in dataset. | |||||||||||||||||||||
selectSQLText ( $table, $vars, $conds='', $fname=__METHOD__, $options=[], $join_conds=[]) | |||||||||||||||||||||
Take the same arguments as IDatabase::select() and return the SQL it would use. | |||||||||||||||||||||
sessionLocksPending () | |||||||||||||||||||||
setBigSelects ( $value=true) | |||||||||||||||||||||
Allow or deny "big selects" for this session only.This is done by setting the sql_big_selects session variable.This is a MySQL-specific feature.
| |||||||||||||||||||||
setFlag ( $flag, $remember=self::REMEMBER_NOTHING) | |||||||||||||||||||||
Set a flag for this connection. | |||||||||||||||||||||
setIndexAliases (array $aliases) | |||||||||||||||||||||
Convert certain index names to alternative names before querying the DB. | |||||||||||||||||||||
setLBInfo ( $nameOrArray, $value=null) | |||||||||||||||||||||
Set the entire array or a particular key of the managing load balancer info array. | |||||||||||||||||||||
setLogger (LoggerInterface $logger) | |||||||||||||||||||||
Set the PSR-3 logger interface to use for query logging. | |||||||||||||||||||||
setSchemaVars ( $vars) | |||||||||||||||||||||
Set schema variables to be used when streaming commands from SQL files or stdin. | |||||||||||||||||||||
setSessionOptions (array $options) | |||||||||||||||||||||
Override database's default behavior.$options include: 'connTimeout' : Set the connection timeout value in seconds. May be useful for very long batch queries such as full-wiki dumps, where a single query reads out over hours or days.
| |||||||||||||||||||||
setTransactionListener ( $name, callable $callback=null) | |||||||||||||||||||||
Run a callback after each time any transaction commits or rolls back. | |||||||||||||||||||||
setTransactionManager (TransactionManager $transactionManager) | |||||||||||||||||||||
setTrxEndCallbackSuppression ( $suppress) | |||||||||||||||||||||
Whether to disable running of post-COMMIT/ROLLBACK callbacks. | |||||||||||||||||||||
sourceFile ( $filename, callable $lineCallback=null, callable $resultCallback=null, $fname=false, callable $inputCallback=null) | |||||||||||||||||||||
Read and execute SQL commands from a file. | |||||||||||||||||||||
sourceStream ( $fp, callable $lineCallback=null, callable $resultCallback=null, $fname=__METHOD__, callable $inputCallback=null) | |||||||||||||||||||||
Read and execute commands from an open file handle. | |||||||||||||||||||||
startAtomic ( $fname=__METHOD__, $cancelable=self::ATOMIC_NOT_CANCELABLE) | |||||||||||||||||||||
Begin an atomic section of SQL statements. | |||||||||||||||||||||
streamStatementEnd (&$sql, &$newLine) | |||||||||||||||||||||
Called by sourceStream() to check if we've reached a statement end. | |||||||||||||||||||||
strreplace ( $orig, $old, $new) | |||||||||||||||||||||
Returns a SQL expression for simple string replacement (e.g. | |||||||||||||||||||||
tableName ( $name, $format='quoted') | |||||||||||||||||||||
Format a table name ready for use in constructing an SQL query. | |||||||||||||||||||||
tableNames (... $tables) | |||||||||||||||||||||
Fetch a number of table names into an associative array. | |||||||||||||||||||||
tableNamesN (... $tables) | |||||||||||||||||||||
Fetch a number of table names into a zero-indexed numerical array. | |||||||||||||||||||||
tablePrefix ( $prefix=null) | |||||||||||||||||||||
Get/set the table prefix. | |||||||||||||||||||||
timestamp ( $ts=0) | |||||||||||||||||||||
Convert a timestamp in one of the formats accepted by ConvertibleTimestamp to the format used for inserting into timestamp fields in this DBMS. | |||||||||||||||||||||
timestampOrNull ( $ts=null) | |||||||||||||||||||||
Convert a timestamp in one of the formats accepted by ConvertibleTimestamp to the format used for inserting into timestamp fields in this DBMS. | |||||||||||||||||||||
truncate ( $tables, $fname=__METHOD__) | |||||||||||||||||||||
Delete all data in a table(s) and reset any sequences owned by that table(s) | |||||||||||||||||||||
trxLevel () | |||||||||||||||||||||
Gets the current transaction level. | |||||||||||||||||||||
trxStatus () | |||||||||||||||||||||
trxTimestamp () | |||||||||||||||||||||
Get the UNIX timestamp of the time that the transaction was established. | |||||||||||||||||||||
unionConditionPermutations ( $table, $vars, array $permute_conds, $extra_conds='', $fname=__METHOD__, $options=[], $join_conds=[]) | |||||||||||||||||||||
Construct a UNION query for permutations of conditions. | |||||||||||||||||||||
unionQueries ( $sqls, $all) | |||||||||||||||||||||
Construct a UNION query. | |||||||||||||||||||||
unionSupportsOrderAndLimit () | |||||||||||||||||||||
Determine if the RDBMS supports ORDER BY and LIMIT for separate subqueries within UNION. | |||||||||||||||||||||
unlock ( $lockName, $method) | |||||||||||||||||||||
Release a lock.Named locks are not related to transactions
| |||||||||||||||||||||
update ( $table, $set, $conds, $fname=__METHOD__, $options=[]) | |||||||||||||||||||||
Update all rows in a table that match a given condition. | |||||||||||||||||||||
upsert ( $table, array $rows, $uniqueKeys, array $set, $fname=__METHOD__) | |||||||||||||||||||||
Upsert row(s) into a table, in the provided order, while updating conflicting rows. | |||||||||||||||||||||
wasConnectionLoss () | |||||||||||||||||||||
Determines if the last query error was due to a dropped connection.Note that during a connection loss, the prior transaction will have been lost
| |||||||||||||||||||||
wasErrorReissuable () | |||||||||||||||||||||
Determines if the last query error was due to something outside of the query itself. | |||||||||||||||||||||
wasLockTimeout () | |||||||||||||||||||||
Determines if the last failure was due to a lock timeout.Note that during a lock wait timeout, the prior transaction will have been lost
| |||||||||||||||||||||
writesOrCallbacksPending () | |||||||||||||||||||||
Whether there is a transaction open with either possible write queries or unresolved pre-commit/commit/resolution callbacks pending. | |||||||||||||||||||||
writesPending () | |||||||||||||||||||||
Public Member Functions inherited from Wikimedia\Rdbms\Platform\ISQLPlatform | |||||||||||||||||||||
buildSubString ( $input, $startPosition, $length=null) | |||||||||||||||||||||
Build a SUBSTRING function. | |||||||||||||||||||||
Static Public Member Functions | |
static | generateFileName ( $dir, $dbName) |
Generates a database file name. | |
static | getAttributes () |
static | getFulltextSearchModule () |
Returns version of currently supported SQLite fulltext search module or false if none present. | |
static | newStandaloneInstance ( $filename, array $p=[]) |
Static Public Member Functions inherited from Wikimedia\Rdbms\Database | |
static | attributesFromType ( $dbType, $driver=null) |
static | factory ( $type, $params=[], $connect=self::NEW_CONNECTED) |
Construct a Database subclass instance given a database type and parameters. | |
static | getCacheSetOptions (?IDatabase ... $dbs) |
Merge the result of getSessionLagStatus() for several DBs using the most pessimistic values to estimate the lag of any data derived from them in combination. | |
Protected Member Functions | |
closeConnection () | |
Does not actually close the connection, just destroys the reference for GC to do its work. | |
doBegin ( $fname='') | |
Issues the BEGIN command to the database server. | |
doFlushSession ( $fname) | |
Reset the server-side session state for named locks and table locks. | |
doHandleSessionLossPreconnect () | |
Reset any additional subclass trx* and session* fields. | |
doReplace ( $table, array $identityKey, array $rows, $fname) | |
doSelectDomain (DatabaseDomain $domain) | |
doSingleStatementQuery (string $sql) | |
Run a query and return a QueryStatus instance with the query result information. | |
doTruncate (array $tables, $fname) | |
fetchAffectedRowCount () | |
getBindingHandle () | |
isConnectionError ( $errno) | |
Do not use this method outside of Database/DBError classes. | |
isKnownStatementRollbackError ( $errno) | |
open ( $server, $user, $password, $db, $schema, $tablePrefix) | |
Open a new connection to the database (closing any existing one) | |
Protected Member Functions inherited from Wikimedia\Rdbms\Database | |
assertHasConnectionHandle () | |
Make sure there is an open connection handle (alive or not) | |
assertIsWritablePrimary () | |
Make sure that this server is not marked as a replica nor read-only. | |
commenceCriticalSection (string $fname) | |
Demark the start of a critical section of session/transaction state changes. | |
completeCriticalSection (string $fname, ?CriticalSectionScope $csm, Throwable $trxError=null) | |
Demark the completion of a critical section of session/transaction state changes. | |
doCommit ( $fname) | |
Issues the COMMIT command to the database server. | |
doGetLag () | |
Get the amount of replication lag for this database server. | |
doInitConnection () | |
Actually connect to the database over the wire (or to local files) | |
doInsertSelectGeneric ( $destTable, $srcTable, array $varMap, $conds, $fname, array $insertOptions, array $selectOptions, $selectJoinConds) | |
Implementation of insertSelect() based on select() and insert() | |
doInsertSelectNative ( $destTable, $srcTable, array $varMap, $conds, $fname, array $insertOptions, array $selectOptions, $selectJoinConds) | |
Native server-side implementation of insertSelect() for situations where we don't want to select everything into memory. | |
doMultiStatementQuery (array $sqls) | |
Execute a batch of query statements, aborting remaining statements if one fails. | |
doUpsert (string $table, array $rows, array $identityKey, array $set, string $fname) | |
Perform an UPSERT query. | |
executeQuery ( $sqls, $fname, $flags, $summarySql) | |
Execute a set of queries without enforcing public (non-Database) caller restrictions. | |
fieldHasBit (int $flags, int $bit) | |
getApproximateLagStatus () | |
Get a replica DB lag estimate for this server at the start of a transaction. | |
getLastPHPError () | |
getLogContext (array $extras=[]) | |
Create a log context to pass to PSR-3 logger functions. | |
getReadOnlyReason () | |
getRecordedTransactionLagStatus () | |
Get the replica DB lag when the current transaction started. | |
getTempTableWrites ( $sql, $pseudoPermanent) | |
getTransactionRoundId () | |
indexName ( $index) | |
installErrorHandler () | |
Set a custom error handler for logging errors during database connection. | |
isInsertSelectSafe (array $insertOptions, array $selectOptions) | |
isPristineTemporaryTable ( $table) | |
Check if the table is both a TEMPORARY table and has not yet received CRUD operations. | |
isQueryTimeoutError ( $errno) | |
Checks whether the cause of the error is detected to be a timeout. | |
newExceptionAfterConnectError ( $error) | |
registerTempWrites ( $ret, array $changes) | |
replaceLostConnection ( $lastErrno, $fname) | |
Close any existing (dead) database connection and open a new connection. | |
restoreErrorHandler () | |
Restore the previous error handler and return the last PHP error for this DB. | |
Protected Attributes | |
PDO null | $conn |
string null | $dbDir |
Directory for SQLite database files listed under their DB name. | |
string null | $dbPath |
Explicit path for the SQLite database file. | |
int | $lastAffectedRowCount |
The number of rows affected as an integer. | |
LockManager null | $lockMgr |
(hopefully on the same server as the DB) | |
ISQLPlatform | $platform |
string | $trxMode |
Transaction mode. | |
Protected Attributes inherited from Wikimedia\Rdbms\Database | |
int null | $affectedRowCount |
Rows affected by the last query to query() or its CRUD wrappers. | |
string | $agent |
Agent name for query profiling. | |
bool | $cliMode |
Whether this PHP instance is for a CLI script. | |
object resource null | $conn |
Database connection. | |
array< string, mixed > | $connectionParams |
Connection parameters used by initConnection() and open() | |
string[] int[] float[] | $connectionVariables |
SQL variables values to use for all new connections. | |
LoggerInterface | $connLogger |
CriticalSectionProvider null | $csProvider |
DatabaseDomain | $currentDomain |
string false | $delimiter = ';' |
Current SQL query delimiter. | |
callable | $deprecationLogger |
Deprecation logging callback. | |
callable | $errorLogger |
Error logging callback. | |
int | $flags |
Current bit field of class DBO_* constants. | |
array | $lbInfo = [] |
Current LoadBalancer tracking information. | |
int | $nonNativeInsertSelectBatchSize |
Row batch size to use for emulated INSERT SELECT queries. | |
string null | $password |
Password used to establish the current connection. | |
SQLPlatform | $platform |
callable null | $profiler |
LoggerInterface | $queryLogger |
LoggerInterface | $replLogger |
string null | $server |
Server that this instance is currently connected to. | |
string null | $serverName |
Readable name or host/IP of the database server. | |
array< string, array > | $sessionNamedLocks = [] |
Map of (name => (UNIX time,trx ID)) for current lock() mutexes. | |
array< string, array > | $sessionTempTables = [] |
Map of (name => (type,pristine,trx ID)) for current temp tables. | |
BagOStuff | $srvCache |
APC cache. | |
bool | $ssl |
Whether to use SSL connections. | |
IDatabase | $topologicalPrimaryConnRef |
Lazy handle to the most authoritative primary server for the dataset. | |
string | $topologyRole |
Replication topology role of the server; one of the class ROLE_* constants. | |
string null | $user |
User that this instance is currently connected under the name of. | |
const | CONN_HOST = 'host' |
Hostname or IP address to use on all connections. | |
const | CONN_INITIAL_DB = 'dbname' |
Database name to use on initial connection. | |
const | CONN_INITIAL_SCHEMA = 'schema' |
Schema name to use on initial connection. | |
const | CONN_INITIAL_TABLE_PREFIX = 'tablePrefix' |
Table prefix to use on initial connection. | |
const | CONN_PASSWORD = 'password' |
Database server password to use on all connections. | |
const | CONN_USER = 'user' |
Database server username to use on all connections. | |
const | DROPPED_CONN_BLAME_THRESHOLD_SEC = 3.0 |
Assume that queries taking this long to yield connection loss errors are at fault. | |
const | ERR_ABORT_QUERY = 2 |
Abort query (no retries) due to a statement rollback (session/transaction intact) | |
const | ERR_ABORT_SESSION = 8 |
Abort and reset session due to server-side session-level state loss (locks, temp tables) | |
const | ERR_ABORT_TRX = 4 |
Abort any current transaction, by rolling it back, due to an error during the query. | |
const | ERR_NONE = 0 |
No errors occurred during the query. | |
const | ERR_RETRY_QUERY = 1 |
Retry query due to a connection loss detected while sending the query (session intact) | |
Additional Inherited Members | |
Public Attributes inherited from Wikimedia\Rdbms\IDatabase | |
const | LOCK_TIMESTAMP = 1 |
Flag to return the lock acquisition timestamp (null if not acquired) | |
Public Attributes inherited from Wikimedia\Rdbms\Platform\ISQLPlatform | |
const | QUERY_PSEUDO_PERMANENT = 2 |
Track a TEMPORARY table CREATE as if it was for a permanent table (for testing) | |
This is the SQLite database abstraction layer.
See docs/sqlite.txt for development notes about MediaWiki's sqlite schema.
Definition at line 39 of file DatabaseSqlite.php.
Wikimedia\Rdbms\DatabaseSqlite::__construct | ( | array | $params | ) |
Additional params include:
array | $params |
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 85 of file DatabaseSqlite.php.
Wikimedia\Rdbms\DatabaseSqlite::addQuotes | ( | $s | ) |
string | int | float | null | bool | Blob | $s |
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 685 of file DatabaseSqlite.php.
References $s.
Wikimedia\Rdbms\DatabaseSqlite::attachDatabase | ( | $name, | |
$file = false, | |||
$fname = __METHOD__ ) |
Attaches external database to the connection handle.
string | $name | Database name to be used in queries like SELECT foo FROM dbname.table |
bool | string | $file | Database file name. If omitted, will be generated using $name and configured data directory |
string | $fname | Calling function name |
Definition at line 366 of file DatabaseSqlite.php.
References $file.
|
protected |
Does not actually close the connection, just destroys the reference for GC to do its work.
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 274 of file DatabaseSqlite.php.
Wikimedia\Rdbms\DatabaseSqlite::databasesAreIndependent | ( | ) |
Returns true if DBs are assumed to be on potentially different servers.In systems like mysql/mariadb, different databases can easily be referenced on a single connection merely by name, even in a single query via JOIN. On the other hand, Postgres treats databases as logically separate, with different database users, requiring special mechanisms like postgres_fdw to "mount" foreign DBs. This is true even among DBs on the same server. Changing the selected database via selectDomain() requires a new connection.
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 914 of file DatabaseSqlite.php.
Wikimedia\Rdbms\DatabaseSqlite::deadlockLoop | ( | $args | ) |
No-op version of deadlockLoop.
mixed | ...$args |
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 720 of file DatabaseSqlite.php.
References $args.
Wikimedia\Rdbms\DatabaseSqlite::decodeBlob | ( | $b | ) |
Blob | string | $b |
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 668 of file DatabaseSqlite.php.
|
protected |
Issues the BEGIN command to the database server.
string | $fname |
DBError |
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 640 of file DatabaseSqlite.php.
|
protected |
Reset the server-side session state for named locks and table locks.
Connection and query errors will be suppressed and logged
string | $fname |
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 926 of file DatabaseSqlite.php.
|
protected |
Reset any additional subclass trx* and session* fields.
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 918 of file DatabaseSqlite.php.
Wikimedia\Rdbms\DatabaseSqlite::doLock | ( | string | $lockName, |
string | $method, | ||
int | $timeout ) |
string | $lockName | |
string | $method | |
int | $timeout |
DBError |
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 731 of file DatabaseSqlite.php.
Wikimedia\Rdbms\DatabaseSqlite::doLockIsFree | ( | string | $lockName, |
string | $method ) |
string | $lockName | |
string | $method |
DBError |
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 726 of file DatabaseSqlite.php.
|
protected |
string | $table | |
string[] | $identityKey | List of columns defining a unique key |
array | $rows | Non-empty list of rows |
string | $fname |
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 536 of file DatabaseSqlite.php.
|
protected |
DatabaseDomain | $domain |
DBConnectionError | |
DBError |
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 391 of file DatabaseSqlite.php.
References Wikimedia\Rdbms\DatabaseDomain\getDatabase(), Wikimedia\Rdbms\DatabaseDomain\getSchema(), and Wikimedia\Rdbms\DatabaseDomain\getTablePrefix().
|
protected |
Run a query and return a QueryStatus instance with the query result information.
This is meant to handle the basic command of actually sending a query to the server via the driver. No implicit transaction, reconnection, nor retry logic should happen here. The higher level query() method is designed to handle those sorts of concerns. This method should not trigger such higher level methods.
The lastError() and lastErrno() methods should meaningfully reflect what error, if any, occurred during the last call to this method. Methods like executeQuery(), query(), select(), insert(), update(), delete(), and upsert() implement their calls to doQuery() such that an immediately subsequent call to lastError()/lastErrno() meaningfully reflects any error that occurred during that public query method call.
For SELECT queries, the result field contains either:
For non-SELECT queries, the result field contains either:
string | $sql | Single-statement SQL query |
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 377 of file DatabaseSqlite.php.
|
protected |
string[] | $tables | |
string | $fname |
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 870 of file DatabaseSqlite.php.
Wikimedia\Rdbms\DatabaseSqlite::doUnlock | ( | string | $lockName, |
string | $method ) |
string | $lockName | |
string | $method |
DBError |
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 743 of file DatabaseSqlite.php.
Wikimedia\Rdbms\DatabaseSqlite::duplicateTableStructure | ( | $oldName, | |
$newName, | |||
$temporary = false, | |||
$fname = __METHOD__ ) |
string | $oldName | |
string | $newName | |
bool | $temporary | |
string | $fname |
RuntimeException |
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 755 of file DatabaseSqlite.php.
References $res.
Wikimedia\Rdbms\DatabaseSqlite::encodeBlob | ( | $b | ) |
string | $b |
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 660 of file DatabaseSqlite.php.
|
protected |
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 465 of file DatabaseSqlite.php.
Wikimedia\Rdbms\DatabaseSqlite::fieldInfo | ( | $table, | |
$field ) |
Get information about a given field Returns false if the field does not exist.
string | $table | |
string | $field |
Implements Wikimedia\Rdbms\IMaintainableDatabase.
Definition at line 624 of file DatabaseSqlite.php.
References $res.
|
static |
Generates a database file name.
Explicitly public for installer.
string | $dir | Directory where database resides |
string | bool | $dbName | Database name (or false from Database::factory, validated here) |
DBUnexpectedError |
Definition at line 289 of file DatabaseSqlite.php.
Referenced by Wikimedia\Rdbms\DatabaseSqlite\getDbFilePath(), and Wikimedia\Rdbms\DatabaseSqlite\open().
|
static |
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 108 of file DatabaseSqlite.php.
References true.
|
protected |
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 936 of file DatabaseSqlite.php.
Wikimedia\Rdbms\DatabaseSqlite::getDbFilePath | ( | ) |
DBUnexpectedError |
Definition at line 236 of file DatabaseSqlite.php.
References Wikimedia\Rdbms\DatabaseSqlite\generateFileName(), and Wikimedia\Rdbms\Database\getDBname().
|
static |
Returns version of currently supported SQLite fulltext search module or false if none present.
Definition at line 333 of file DatabaseSqlite.php.
Wikimedia\Rdbms\DatabaseSqlite::getLockFileDirectory | ( | ) |
Definition at line 243 of file DatabaseSqlite.php.
Wikimedia\Rdbms\DatabaseSqlite::getServerVersion | ( | ) |
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 608 of file DatabaseSqlite.php.
Wikimedia\Rdbms\DatabaseSqlite::getSoftwareLink | ( | ) |
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 601 of file DatabaseSqlite.php.
Wikimedia\Rdbms\DatabaseSqlite::getTopologyBasedServerId | ( | ) |
Get a non-recycled ID that uniquely identifies this server within the replication topology.
A replication topology defines which servers can originate changes to a given dataset and how those changes propagate among database servers. It is assumed that the server only participates in the replication of a single relevant dataset.
DBQueryError |
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 585 of file DatabaseSqlite.php.
Wikimedia\Rdbms\DatabaseSqlite::getType | ( | ) |
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 138 of file DatabaseSqlite.php.
Wikimedia\Rdbms\DatabaseSqlite::indexInfo | ( | $table, | |
$index, | |||
$fname = __METHOD__ ) |
Returns information about an index Returns false if the index does not exist.
string | $table | |
string | $index | |
string | $fname |
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 495 of file DatabaseSqlite.php.
References $res.
Wikimedia\Rdbms\DatabaseSqlite::indexUnique | ( | $table, | |
$index, | |||
$fname = __METHOD__ ) |
string | $table | |
string | $index | |
string | $fname |
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 515 of file DatabaseSqlite.php.
Wikimedia\Rdbms\DatabaseSqlite::insertId | ( | ) |
This must be called after nextSequenceVal.
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 431 of file DatabaseSqlite.php.
|
protected |
Do not use this method outside of Database/DBError classes.
int | string | $errno |
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 573 of file DatabaseSqlite.php.
|
protected |
int | string | $errno |
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 577 of file DatabaseSqlite.php.
Wikimedia\Rdbms\DatabaseSqlite::lastErrno | ( | ) |
Wikimedia\Rdbms\DatabaseSqlite::lastError | ( | ) |
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 439 of file DatabaseSqlite.php.
Wikimedia\Rdbms\DatabaseSqlite::listTables | ( | $prefix = null, | |
$fname = __METHOD__ ) |
List all tables on the database.
string | null | $prefix | Only show tables with this prefix, e.g. mw_ |
string | $fname | Calling function name |
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 847 of file DatabaseSqlite.php.
|
static |
string | $filename | |
array | $p | Options map; supports:
|
Definition at line 124 of file DatabaseSqlite.php.
|
protected |
Open a new connection to the database (closing any existing one)
string | null | $server | Server host/address and optional port { |
string | null | $user | User name { |
string | null | $password | User password { |
string | null | $db | Database name |
string | null | $schema | Database schema name |
string | $tablePrefix |
DBConnectionError |
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 142 of file DatabaseSqlite.php.
References Wikimedia\Rdbms\DatabaseSqlite\$dbPath, Wikimedia\Rdbms\Database\$flags, $path, Wikimedia\Rdbms\Database\close(), Wikimedia\Rdbms\DatabaseSqlite\generateFileName(), Wikimedia\Rdbms\Database\getFlag(), Wikimedia\Rdbms\Database\getLogContext(), Wikimedia\Rdbms\Database\newExceptionAfterConnectError(), Wikimedia\Rdbms\Database\query(), and true.
Wikimedia\Rdbms\DatabaseSqlite::serverIsReadOnly | ( | ) |
DBError | If an error occurs, { |
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 590 of file DatabaseSqlite.php.
References $path.
Wikimedia\Rdbms\DatabaseSqlite::setTableAliases | ( | array | $aliases | ) |
Make certain table names use their own database, schema, and table prefix when passed into SQL queries pre-escaped and without a qualified database name.
For example, "user" can be converted to "myschema.mydbname.user" for convenience. Appearances like user
, somedb.user, somedb.someschema.user will used literally.
Calling this twice will completely clear any old table aliases. Also, note that callers are responsible for making sure the schemas and databases actually exist.
array[] | $aliases | Map of (table => (dbname, schema, prefix) map) |
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 892 of file DatabaseSqlite.php.
Wikimedia\Rdbms\DatabaseSqlite::strencode | ( | $s | ) |
string | $s |
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 652 of file DatabaseSqlite.php.
References $s.
Wikimedia\Rdbms\DatabaseSqlite::tableExists | ( | $table, | |
$fname = __METHOD__ ) |
Query whether a given table exists.
string | $table | |
string | $fname |
DBError | If an error occurs, { |
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 469 of file DatabaseSqlite.php.
Wikimedia\Rdbms\DatabaseSqlite::textFieldSize | ( | $table, | |
$field ) |
Returns the size of a text field, or -1 for "unlimited" In SQLite this is SQLITE_MAX_LENGTH, by default 1 GB.
No way to query it though.
string | $table | |
string | $field |
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 555 of file DatabaseSqlite.php.
Wikimedia\Rdbms\DatabaseSqlite::wasDeadlock | ( | ) |
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 562 of file DatabaseSqlite.php.
Wikimedia\Rdbms\DatabaseSqlite::wasReadOnlyError | ( | ) |
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 569 of file DatabaseSqlite.php.
|
protected |
Definition at line 51 of file DatabaseSqlite.php.
|
protected |
Directory for SQLite database files listed under their DB name.
Definition at line 41 of file DatabaseSqlite.php.
|
protected |
Explicit path for the SQLite database file.
Definition at line 43 of file DatabaseSqlite.php.
Referenced by Wikimedia\Rdbms\DatabaseSqlite\open().
|
protected |
The number of rows affected as an integer.
Definition at line 48 of file DatabaseSqlite.php.
|
protected |
(hopefully on the same server as the DB)
Definition at line 54 of file DatabaseSqlite.php.
|
protected |
Definition at line 76 of file DatabaseSqlite.php.
|
protected |
Transaction mode.
Definition at line 45 of file DatabaseSqlite.php.