Public Member Functions |
Static Public Member Functions |
Protected Member Functions |
Protected Attributes |
List of all members
Wikimedia\Rdbms\DatabaseSqlite Class Reference
This is the SQLite database abstraction layer. More...
Inherits Wikimedia\Rdbms\Database.
Collaboration diagram for Wikimedia\Rdbms\DatabaseSqlite:
Public Member Functions | |||||||||||||||||||||||||||
| __construct (array $params) | |||||||||||||||||||||||||||
| Additional params include: | |||||||||||||||||||||||||||
| addQuotes ( $s) | |||||||||||||||||||||||||||
Escape and quote a raw value string for use in a SQL query.
| |||||||||||||||||||||||||||
| 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.
| |||||||||||||||||||||||||||
| 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 () | |||||||||||||||||||||||||||
| getPrimaryKeyColumns ( $table, $fname=__METHOD__) | |||||||||||||||||||||||||||
Get the primary key columns of a table.
| |||||||||||||||||||||||||||
| getServerVersion () | |||||||||||||||||||||||||||
| getSoftwareLink () | |||||||||||||||||||||||||||
| getType () | |||||||||||||||||||||||||||
| indexInfo ( $table, $index, $fname=__METHOD__) | |||||||||||||||||||||||||||
Get information about an index into an object.
| |||||||||||||||||||||||||||
| lastErrno () | |||||||||||||||||||||||||||
| lastError () | |||||||||||||||||||||||||||
| listTables ( $prefix=null, $fname=__METHOD__) | |||||||||||||||||||||||||||
| List all tables on the database. | |||||||||||||||||||||||||||
| replace ( $table, $uniqueKeys, $rows, $fname=__METHOD__) | |||||||||||||||||||||||||||
Insert row(s) into a table, in the provided order, while deleting conflicting rows.Conflicts are determined by the provided unique indexes. Note that it is possible for the provided rows to conflict even among themselves; it is preferable for the caller to de-duplicate such input beforehand.Note some important implications of the deletion semantics:
| |||||||||||||||||||||||||||
| 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.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.
| |||||||||||||||||||||||||||
| strencode ( $s) | |||||||||||||||||||||||||||
| tableExists ( $table, $fname=__METHOD__) | |||||||||||||||||||||||||||
Query whether a given table exists.
| |||||||||||||||||||||||||||
| truncateTable ( $table, $fname=__METHOD__) | |||||||||||||||||||||||||||
Delete all data in a table and reset any sequences owned by that table.
| |||||||||||||||||||||||||||
 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.table, column, database) for use in a SQL queryDepending on the database this will either be backticks or "double quotes"
| |||||||||||||||||||||||||||
| affectedRows () | |||||||||||||||||||||||||||
Get the number of rows affected by the last query method call.This method should only be called when all the following hold true:
| |||||||||||||||||||||||||||
| andExpr (array $conds) | |||||||||||||||||||||||||||
See Expression::__construct()
| |||||||||||||||||||||||||||
| 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.Only call this from code with outer transaction scope. See https://www.mediawiki.org/wiki/Database_transactions for details. Nesting of transactions is not supported.Note that when the DBO_TRX flag is set (which is usually the case for web requests, but not for maintenance scripts), any previous database query will have started a transaction automatically.Nesting of transactions is not supported. Attempts to nest transactions will cause a warning, unless the current transaction was started automatically because of the DBO_TRX flag.
| |||||||||||||||||||||||||||
| bitAnd ( $fieldLeft, $fieldRight) | |||||||||||||||||||||||||||
| |||||||||||||||||||||||||||
| bitNot ( $field) | |||||||||||||||||||||||||||
| |||||||||||||||||||||||||||
| bitOr ( $fieldLeft, $fieldRight) | |||||||||||||||||||||||||||
| |||||||||||||||||||||||||||
| buildComparison (string $op, array $conds) | |||||||||||||||||||||||||||
Build a condition comparing multiple values, for use with indexes that cover multiple fields, common when e.g.paging through results or doing batch operations.For example, you might be displaying a list of people ordered alphabetically by their last and first name, split across multiple pages. The first page of the results ended at Jane Doe. When building the query for the next page, you would use: $queryBuilder->where( $db->buildComparison( '>', [ 'last' => 'Doe', 'first' => 'Jane' ] ) ); This will return people whose last name follows Doe, or whose last name is Doe and first name follows Jane.Note that the order of keys in the associative array $conds is significant, and must match the order of fields used by the index.When comparing a single value, prefer using the expression builder: $db->expr( 'key', '<=', $val ) // equivalent to: $db->buildComparison( '<=', [ 'key' => $val ] ) 'key <= ' . $db->addQuotes( $val )
| |||||||||||||||||||||||||||
| 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.The reference comes in the form of an alias, function, or parenthesized SQL expression. It can be used in upsert() SET expressions to handle the merging of column values between each conflicting pair of existing and proposed rows. Such proposed rows are said to have been "excluded" from insertion in favor of updating the existing row.This is useful for multi-row upserts() since the proposed values cannot just be included as literals in the SET expressions.
| |||||||||||||||||||||||||||
| buildGreatest ( $fields, $values) | |||||||||||||||||||||||||||
Build a GREATEST function statement comparing columns/values.Integer and float values in $values will not be quotedIf $fields is an array, then each value with a string key is treated as an expression (which must be manually quoted); such string keys do not appear in the SQL and are only descriptive aliases.
| |||||||||||||||||||||||||||
| buildGroupConcat ( $field, $delim) | |||||||||||||||||||||||||||
Build a GROUP_CONCAT expression.
| |||||||||||||||||||||||||||
| buildGroupConcatField ( $delim, $tables, $field, $conds='', $join_conds=[]) | |||||||||||||||||||||||||||
Build a GROUP_CONCAT or equivalent statement for a query.This is useful for combining a field for several rows into a single string. NULL values will not appear in the output, duplicated values will appear, and the resulting delimiter-separated values have no defined sort order. Code using the results may need to use the PHP unique() or sort() methods.
| |||||||||||||||||||||||||||
| buildIntegerCast ( $field) | |||||||||||||||||||||||||||
| |||||||||||||||||||||||||||
| buildLeast ( $fields, $values) | |||||||||||||||||||||||||||
Build a LEAST function statement comparing columns/values.Integer and float values in $values will not be quotedIf $fields is an array, then each value with a string key is treated as an expression (which must be manually quoted); such string keys do not appear in the SQL and are only descriptive aliases.
| |||||||||||||||||||||||||||
| buildLike ( $param,... $params) | |||||||||||||||||||||||||||
LIKE statement wrapper.This takes a variable-length argument list with parts of pattern to match containing either string literals that will be escaped or tokens returned by anyChar() or anyString(). Alternatively, the function could be provided with an array of the aforementioned parameters.Example: $dbr->buildLike( 'My_page_title/', $dbr->anyString() )
returns a LIKE clause that searches for subpages of 'My page title'.Alternatively: $pattern = [ 'My_page_title/', $dbr->anyString() ];
$query .= $dbr->buildLike( $pattern );
| |||||||||||||||||||||||||||
| buildSelectSubquery ( $tables, $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.This will roll back only the statements executed since the start of the most recent atomic section, and close that section. If a transaction was open before the corresponding startAtomic() call, any statements before that call are not rolled back and the transaction remains open. If the corresponding startAtomic() implicitly started a transaction, that transaction is rolled back.
Note that a call to IDatabase::rollback() will also roll back any open atomic sections.
| |||||||||||||||||||||||||||
| clearFlag ( $flag, $remember=self::REMEMBER_NOTHING) | |||||||||||||||||||||||||||
Clear a flag for this connection.
| |||||||||||||||||||||||||||
| close ( $fname=__METHOD__) | |||||||||||||||||||||||||||
Close the database connection.This should only be called after any transactions have been resolved, aside from read-only automatic transactions (assuming no callbacks are registered). If a transaction is still open anyway, it will be rolled back.
| |||||||||||||||||||||||||||
| commit ( $fname=__METHOD__, $flush=self::FLUSHING_ONE) | |||||||||||||||||||||||||||
Commits a transaction previously started using begin()If no transaction is in progress, a warning is issued.Only call this from code with outer transaction scope. See https://www.mediawiki.org/wiki/Database_transactions for details. Nesting of transactions is not supported.
| |||||||||||||||||||||||||||
| conditional ( $cond, $caseTrueExpression, $caseFalseExpression) | |||||||||||||||||||||||||||
Returns an SQL expression for a simple conditional.This doesn't need to be overridden unless CASE isn't supported in the RDBMS.
| |||||||||||||||||||||||||||
| 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.This operation will be seen by affectedRows()/insertId() as one query statement, regardless of how many statements are actually sent by the class implementation.
| |||||||||||||||||||||||||||
| 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.This operation will be seen by affectedRows()/insertId() as one query statement, regardless of how many statements are actually sent by the class implementation.
| |||||||||||||||||||||||||||
| doAtomicSection ( $fname, callable $callback, $cancelable=self::ATOMIC_NOT_CANCELABLE) | |||||||||||||||||||||||||||
Perform an atomic section of reversible SQL statements from a callback.The $callback takes the following arguments:
$dbw->doAtomicSection( __METHOD__, function ( $dbw ) use ( $record ) {
// Create new record metadata row
$dbw->insert( 'records', $record->toArray(), __METHOD__ );
// Figure out where to store the data based on the new row's ID
$path = $this->recordDirectory . '/' . $dbw->insertId();
// Write the record data to the storage system;
// blob store throws StoreFailureException on failure
$this->blobStore->create( $path, $record->getJSON() );
// Try to cleanup files orphaned by transaction rollback
$dbw->onTransactionResolution(
function ( $type ) use ( $path ) {
if ( $type === IDatabase::TRIGGER_ROLLBACK ) {
$this->blobStore->delete( $path );
}
},
__METHOD__
);
}, $dbw::ATOMIC_CANCELABLE );
$dbw->startAtomic( __METHOD__ );
// ...various SQL writes happen...
try {
$recordStore->save( $record );
} catch ( StoreFailureException $e ) {
// ...various SQL writes happen...
}
// ...various SQL writes happen...
$dbw->endAtomic( __METHOD__ );
| |||||||||||||||||||||||||||
| 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.Ends the next section of atomic SQL statements and commits the transaction if necessary.
| |||||||||||||||||||||||||||
| 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.Explicit transactions are spawned by begin(), startAtomic(), and doAtomicSection(). Note that explicit transactions should not be confused with explicit transaction rounds.
| |||||||||||||||||||||||||||
| expr (string $field, string $op, $value) | |||||||||||||||||||||||||||
See Expression::__construct()
| |||||||||||||||||||||||||||
| factorConds ( $condsArray) | |||||||||||||||||||||||||||
Given an array of condition arrays representing an OR list of AND lists, for example:(A=1 AND B=2) OR (A=1 AND B=3)produce an SQL expression in which the conditions are factored:(A=1 AND (B=2 OR B=3))We also use IN() to simplify further:(A=1 AND (B IN (2,3))More compactly, in boolean algebra notation, a sum of products, e.g. AB + AC is factored to produce A(B+C). Factoring proceeds recursively to reduce expressions with any number of variables, for example AEP + AEQ + AFP + AFQ = A(E(P+Q) + F(P+Q))The algorithm is simple and will not necessarily find the shortest possible expression. For the best results, fields should be given in a consistent order, and the fields with values likely to be shared should be leftmost in the associative arrays.
| |||||||||||||||||||||||||||
| 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.This should only be called by a load balancer or if the handle is not attached to one. Also, there must be no chance that a future caller will still be expecting some of the lost session state.Connection and query errors will be suppressed and logged
| |||||||||||||||||||||||||||
| flushSnapshot ( $fname=__METHOD__, $flush=self::FLUSHING_ONE) | |||||||||||||||||||||||||||
Commit any transaction but error out if writes or callbacks are pending.This is intended for clearing out REPEATABLE-READ snapshots so that callers can see a new point-in-time of the database. This is useful when one of many transaction rounds finished and significant time will pass in the script's lifetime. It is also useful to call on a replica server after waiting on replication to catch up to the primary server.
| |||||||||||||||||||||||||||
| getDBname () | |||||||||||||||||||||||||||
Get the current database name; null if there isn't one.
| |||||||||||||||||||||||||||
| getDomainID () | |||||||||||||||||||||||||||
Return the currently selected domain ID.Null components (database/schema) might change once a connection is established
| |||||||||||||||||||||||||||
| getFlag ( $flag) | |||||||||||||||||||||||||||
Returns a boolean whether the flag $flag is set for this connection.
| |||||||||||||||||||||||||||
| getInfinity () | |||||||||||||||||||||||||||
Find out when 'infinity' is.Most DBMSes support this. This is a special keyword for timestamps in PostgreSQL, and works with CHAR(14) as well because "i" sorts after all numbers.
| |||||||||||||||||||||||||||
| getLag () | |||||||||||||||||||||||||||
Get the seconds of replication lag on this database server.Callers should avoid using this method while a transaction is active
| |||||||||||||||||||||||||||
| getLBInfo ( $name=null) | |||||||||||||||||||||||||||
Get properties passed down from the server info array of the load balancer.
| |||||||||||||||||||||||||||
| getPrimaryPos () | |||||||||||||||||||||||||||
Get the replication position of this primary DB server.
| |||||||||||||||||||||||||||
| getScopedLockAndFlush ( $lockKey, $fname, $timeout) | |||||||||||||||||||||||||||
Acquire a named lock, flush any transaction, and return an RAII style unlocker object.Only call this from outer transaction scope and when only one DB server will be affected. See https://www.mediawiki.org/wiki/Database_transactions for details.This is suitable for transactions that need to be serialized using cooperative locks, where each transaction can see each others' changes. Any transaction is flushed to clear out stale REPEATABLE-READ snapshot data. Once the returned object falls out of PHP scope, the lock will be released unless a transaction is active. If one is active, then the lock will be released when it either commits or rolls back.If the lock acquisition failed, then no transaction flush happens, and null is returned.
| |||||||||||||||||||||||||||
| getServer () | |||||||||||||||||||||||||||
Get the hostname or IP address of the server.
| |||||||||||||||||||||||||||
| getServerInfo () | |||||||||||||||||||||||||||
Get a human-readable string describing the current software version.Use getServerVersion() to get machine-friendly information.
| |||||||||||||||||||||||||||
| getServerName () | |||||||||||||||||||||||||||
Get the readable name for the server.
| |||||||||||||||||||||||||||
| getSessionLagStatus () | |||||||||||||||||||||||||||
Get a cached estimate of the seconds of replication lag on this database server, using the estimate obtained at the start of the current transaction if one is active.This is useful when transactions might use snapshot isolation (e.g. REPEATABLE-READ in innodb), so the "real" lag of that data is this lag plus transaction duration. If they don't, it is still safe to be pessimistic. In AUTOCOMMIT mode, this still gives an indication of the staleness of subsequent reads.
| |||||||||||||||||||||||||||
| getTableAliases () | |||||||||||||||||||||||||||
Return current table aliases.
| |||||||||||||||||||||||||||
| 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.
| |||||||||||||||||||||||||||
| indexUnique ( $table, $index, $fname=__METHOD__) | |||||||||||||||||||||||||||
Determines if a given index is unique.
| |||||||||||||||||||||||||||
| 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.This operation will be seen by affectedRows()/insertId() as one query statement, regardless of how many statements are actually sent by the class implementation.
| |||||||||||||||||||||||||||
| insertId () | |||||||||||||||||||||||||||
Get the sequence-based ID assigned by the last query method call.This method should only be called when all the following hold true:
| |||||||||||||||||||||||||||
| insertSelect ( $destTable, $srcTable, $varMap, $conds, $fname=__METHOD__, $insertOptions=[], $selectOptions=[], $selectJoinConds=[]) | |||||||||||||||||||||||||||
INSERT SELECT wrapper.
This operation will be seen by affectedRows()/insertId() as one query statement, regardless of how many statements are actually sent by the class implementation.
| |||||||||||||||||||||||||||
| isOpen () | |||||||||||||||||||||||||||
| |||||||||||||||||||||||||||
| isQuotedIdentifier ( $name) | |||||||||||||||||||||||||||
| isReadOnly () | |||||||||||||||||||||||||||
Check if this DB server is marked as read-only according to load balancer info.
| |||||||||||||||||||||||||||
| lastDoneWrites () | |||||||||||||||||||||||||||
Get the last time that the connection was used to commit a write.
| |||||||||||||||||||||||||||
| limitResult ( $sql, $limit, $offset=false) | |||||||||||||||||||||||||||
Construct a LIMIT query with optional offset.The SQL should be adjusted so that only the first $limit rows are returned. If $offset is provided as well, then the first $offset rows should be discarded, and the next $limit rows should be returned. If the result of the query is not ordered, then the rows to be returned are theoretically arbitrary.$sql is expected to be a SELECT, if that makes a difference.
| |||||||||||||||||||||||||||
| 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.These can be used to make conjunctions or disjunctions on SQL condition strings derived from an array ({
Example usage: $sql = $db->makeList( [
'rev_page' => $id,
$db->makeList( [ 'rev_minor' => 1, 'rev_len < 500' ], $db::LIST_OR )
], $db::LIST_AND );
This would set $sql to "rev_page = '$id' AND (rev_minor = 1 OR rev_len < 500)"
| |||||||||||||||||||||||||||
| makeWhereFrom2d ( $data, $baseKey, $subKey) | |||||||||||||||||||||||||||
| Build a "OR" condition with pairs from a two-dimensional array.The associative array should have integer keys relating to the $baseKey field. The nested array should have string keys for the $subKey field. The inner values are ignored, and are typically boolean true.Example usage: $data = [
2 => [
'Foo' => true,
'Bar' => true,
],
3 => [
'Quux' => true,
],
];
// (page_namespace = 2 AND page_title IN ('Foo','Bar'))
// OR (page_namespace = 3 AND page_title = 'Quux')
| |||||||||||||||||||||||||||
| newDeleteQueryBuilder () | |||||||||||||||||||||||||||
| Get a DeleteQueryBuilder bound to this connection. | |||||||||||||||||||||||||||
| newInsertQueryBuilder () | |||||||||||||||||||||||||||
| Get a InsertQueryBuilder bound to this connection. | |||||||||||||||||||||||||||
| newReplaceQueryBuilder () | |||||||||||||||||||||||||||
| Get a ReplaceQueryBuilder bound to this connection. | |||||||||||||||||||||||||||
| newSelectQueryBuilder () | |||||||||||||||||||||||||||
| Get a SelectQueryBuilder bound to this connection. | |||||||||||||||||||||||||||
| newUnionQueryBuilder () | |||||||||||||||||||||||||||
| Get a UnionQueryBuilder bound to this connection. | |||||||||||||||||||||||||||
| newUpdateQueryBuilder () | |||||||||||||||||||||||||||
| Get an UpdateQueryBuilder bound to this connection. | |||||||||||||||||||||||||||
| onTransactionCommitOrIdle (callable $callback, $fname=__METHOD__) | |||||||||||||||||||||||||||
Run a callback when the current transaction commits or now if there is none.If there is a transaction and it is rolled back, then the callback is cancelled.When transaction round mode (DBO_TRX) is set, the callback will run at the end of the round, just after all peer transactions COMMIT. If the transaction round is rolled back, then the callback is cancelled.This IDatabase instance will start off in auto-commit mode when the callback starts. The use of other IDatabase handles from the callback should be avoided unless they are known to be in auto-commit mode. Callbacks that create transactions via begin() or startAtomic() must have matching calls to commit()/endAtomic().Use this method only for the following purposes:
| |||||||||||||||||||||||||||
| onTransactionPreCommitOrIdle (callable $callback, $fname=__METHOD__) | |||||||||||||||||||||||||||
Run a callback before the current transaction commits or now if there is none.If there is a transaction and it is rolled back, then the callback is cancelled.When transaction round mode (DBO_TRX) is set, the callback will run at the end of the round, just after all peer transactions COMMIT. If the transaction round is rolled back, then the callback is cancelled.If there is no current transaction, one will be created to wrap the callback. Callbacks cannot use begin()/commit() to manage transactions. The use of other IDatabase handles from the callback should be avoided.Use this method only for the following purposes:
| |||||||||||||||||||||||||||
| onTransactionResolution (callable $callback, $fname=__METHOD__) | |||||||||||||||||||||||||||
Run a callback when the current transaction commits or rolls back.An error is thrown if no transaction is pending.When transaction round mode (DBO_TRX) is set, the callback will run at the end of the round, just after all peer transactions COMMIT/ROLLBACK.This IDatabase instance will start off in auto-commit mode when the callback starts. The use of other IDatabase handles from the callback should be avoided unless they are known to be in auto-commit mode. Callbacks that create transactions via begin() or startAtomic() must have matching calls to commit()/endAtomic().Use this method only for the following purposes:
| |||||||||||||||||||||||||||
| orExpr (array $conds) | |||||||||||||||||||||||||||
See Expression::__construct()
| |||||||||||||||||||||||||||
| 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.High values could be due to scanning, updates, locking, and such.
| |||||||||||||||||||||||||||
| ping () | |||||||||||||||||||||||||||
Ping the server and try to reconnect if it there is no connection.
| |||||||||||||||||||||||||||
| primaryPosWait (DBPrimaryPos $pos, $timeout) | |||||||||||||||||||||||||||
Wait for the replica server to catch up to a given primary server position.Note that this does not start any new transactions.Callers might want to flush any existing transaction before invoking this method. Upon success, this assures that replica server queries will reflect all changes up to the given position, without interference from prior REPEATABLE-READ snapshots.
| |||||||||||||||||||||||||||
| query ( $sql, $fname=__METHOD__, $flags=0) | |||||||||||||||||||||||||||
Run an SQL query statement and return the result.If a connection loss is detected, then an attempt to reconnect will be made. For queries that involve no larger transactions or locks, they will be re-issued for convenience, provided the connection was re-established.In new code, the query wrappers select(), insert(), update(), delete(), etc. should be used where possible, since they give much better DBMS independence and automatically quote or validate user input in a variety of contexts. This function is generally only useful for queries which are explicitly DBMS-dependent and are unsupported by the query wrappers, such as CREATE TABLE.However, the query wrappers themselves should call this function.Callers should avoid the use of statements like BEGIN, COMMIT, and ROLLBACK. Methods like startAtomic(), endAtomic(), and cancelAtomic() can be used instead.
| |||||||||||||||||||||||||||
| 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()Only call this from code with outer transaction scope. See https://www.mediawiki.org/wiki/Database_transactions for details. Nesting of transactions is not supported. If a serious unexpected error occurs, throwing an Exception is preferable, using a pre-installed error handler to trigger rollback (in any case, failure to issue COMMIT will cause rollback server-side).Query, connection, and onTransaction* callback errors will be suppressed and logged.
| |||||||||||||||||||||||||||
| 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 ( $tables, $vars, $conds='', $fname=__METHOD__, $options=[], $join_conds=[]) | |||||||||||||||||||||||||||
Execute a SELECT query constructed using the various parameters provided.New callers should use newSelectQueryBuilder with SelectQueryBuilder::fetchResultSet instead, which is more readable and less error-prone.
Each table reference assigns a table name to a specified collection of rows for the context of the query (e.g. field expressions, WHERE clause, GROUP BY clause, HAVING clause, etc...). Use of multiple table references implies a JOIN.If a string is given, it must hold the name of the table having the specified collection of rows. If an array is given, each entry must be one of the following:
$join_conds like[ 'b2' => [ 'JOIN', 'b_id = b2_id' ], 'nestedB' => [ 'LEFT JOIN', 'b_a = a_id' ] ]will produce SQL something likeFROM tableA LEFT JOIN (tableB JOIN tableB2 AS b2 ON (b_id = b2_id)) ON (b_a = a_id)All of the table names given here are automatically run through Database::tableName(), which causes the table prefix (if any) to be added, and various other table name mappings to be performed.Do not use untrusted user input as a table name. Alias names should not have characters outside of the Basic multilingual plane.
May be either a field name or an array of field names. The field names can be complete fragments of SQL, for direct inclusion into the SELECT query. If an array is given, field aliases can be specified, for example:[ 'maxrev' => 'MAX(rev_id)' ]This includes an expression with the alias "maxrev" in the query.If an expression is given, care must be taken to ensure that it is DBMS-independent.Untrusted user input must not be passed to this parameter.
May be either a string containing a single condition, or an array of conditions. If an array is given, the conditions constructed from each element are combined with AND.Array elements may take one of two forms:
// $conds... 'rev_actor = actor_id', use (see below for $join_conds): // $join_conds... 'actor' => [ 'JOIN', 'rev_actor = actor_id' ],
Optional: Array of query options. Boolean options are specified by including them in the array as a string value with a numeric key, for example:[ 'FOR UPDATE' ]The supported options are:
Optional associative array of table-specific join conditions. Simple conditions can also be specified in the regular $conds, but this is strongly discouraged in favor of the more explicit syntax here.The key of the array contains the table name or alias. The value is an array with two elements, numbered 0 and 1. The first gives the type of join, the second is the same as the $conds parameter. Thus it can be an SQL fragment, or an array where the string keys are equality and the numeric keys are SQL fragments all AND'd together. For example:[ 'page' => [ 'LEFT JOIN', 'page_latest=rev_id' ] ]
| |||||||||||||||||||||||||||
| selectDomain ( $domain) | |||||||||||||||||||||||||||
Set the current domain (database, schema, and table prefix)This will throw an error for some database types if the database is unspecifiedThis should only be called by a load balancer or if the handle is not attached to one
| |||||||||||||||||||||||||||
| selectField ( $tables, $var, $cond='', $fname=__METHOD__, $options=[], $join_conds=[]) | |||||||||||||||||||||||||||
A SELECT wrapper which returns a single field from a single result row.If no result rows are returned from the query, false is returned.New callers should use newSelectQueryBuilder with SelectQueryBuilder::fetchField instead, which is more readable and less error-prone.
| |||||||||||||||||||||||||||
| selectFieldValues ( $tables, $var, $cond='', $fname=__METHOD__, $options=[], $join_conds=[]) | |||||||||||||||||||||||||||
A SELECT wrapper which returns a list of single field values from result rows.If no result rows are returned from the query, an empty array is returned.New callers should use newSelectQueryBuilder with SelectQueryBuilder::fetchFieldValues instead, which is more readable and less error-prone.
| |||||||||||||||||||||||||||
| selectRow ( $tables, $vars, $conds, $fname=__METHOD__, $options=[], $join_conds=[]) | |||||||||||||||||||||||||||
Wrapper to IDatabase::select() that only fetches one row (via LIMIT)If the query returns no rows, false is returned.This method is convenient for fetching a row based on a unique key condition.New callers should use newSelectQueryBuilder with SelectQueryBuilder::fetchRow instead, which is more readable and less error-prone.
| |||||||||||||||||||||||||||
| selectRowCount ( $tables, $var=' *', $conds='', $fname=__METHOD__, $options=[], $join_conds=[]) | |||||||||||||||||||||||||||
Get the number of rows in dataset.This is useful when trying to do COUNT(*) but with a LIMIT for performance.Takes the same arguments as IDatabase::select().New callers should use newSelectQueryBuilder with SelectQueryBuilder::fetchRowCount instead, which is more readable and less error-prone.
| |||||||||||||||||||||||||||
| selectSQLText ( $tables, $vars, $conds='', $fname=__METHOD__, $options=[], $join_conds=[]) | |||||||||||||||||||||||||||
Take the same arguments as IDatabase::select() and return the SQL it would use.This can be useful for making UNION queries, where the SQL text of each query is needed. In general, however, callers outside of Database classes should just use select().
| |||||||||||||||||||||||||||
| sessionLocksPending () | |||||||||||||||||||||||||||
| setFlag ( $flag, $remember=self::REMEMBER_NOTHING) | |||||||||||||||||||||||||||
Set a flag for this connection.
| |||||||||||||||||||||||||||
| setLBInfo ( $nameOrArray, $value=null) | |||||||||||||||||||||||||||
Set the entire array or a particular key of the managing load balancer info array.Keys matching the IDatabase::LB_* constants are also used internally by subclasses
| |||||||||||||||||||||||||||
| setLogger (LoggerInterface $logger) | |||||||||||||||||||||||||||
| Set the PSR-3 logger interface to use. | |||||||||||||||||||||||||||
| setSchemaVars ( $vars) | |||||||||||||||||||||||||||
Set schema variables to be used when streaming commands from SQL files or stdin.Variables appear as SQL comments and are substituted by their corresponding values
| |||||||||||||||||||||||||||
| setSessionOptions (array $options) | |||||||||||||||||||||||||||
| Override database's default behavior. | |||||||||||||||||||||||||||
| setTransactionListener ( $name, ?callable $callback=null) | |||||||||||||||||||||||||||
Run a callback after each time any transaction commits or rolls back.The callback takes two arguments:
| |||||||||||||||||||||||||||
| 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.Returns true on success, error string or exception on failure (depending on object's error ignore settings).
| |||||||||||||||||||||||||||
| sourceStream ( $fp, ?callable $lineCallback=null, ?callable $resultCallback=null, $fname=__METHOD__, ?callable $inputCallback=null) | |||||||||||||||||||||||||||
Read and execute commands from an open file handle.Returns true on success, error string or exception on failure (depending on object's error ignore settings).
| |||||||||||||||||||||||||||
| startAtomic ( $fname=__METHOD__, $cancelable=self::ATOMIC_NOT_CANCELABLE) | |||||||||||||||||||||||||||
Begin an atomic section of SQL statements.Start an implicit transaction if no transaction is already active, set a savepoint (if $cancelable is ATOMIC_CANCELABLE), and track the given section name to enforce that the transaction is not committed prematurely. The end of the section must be signified exactly once, either by endAtomic() or cancelAtomic(). Sections can have layers of inner sections (sub-sections), but all sections must be ended in order of innermost to outermost. Transactions cannot be started or committed until all atomic sections are closed.ATOMIC_CANCELABLE is useful when the caller needs to handle specific failure cases by discarding the section's writes. This should not be used for failures when:
Example usage: // Start a transaction if there isn't one already
$dbw->startAtomic( __METHOD__ );
// Serialize these thread table updates
$dbw->select( 'thread', '1', [ 'td_id' => $tid ], __METHOD__, 'FOR UPDATE' );
// Add a new comment for the thread
$dbw->insert( 'comment', $row, __METHOD__ );
$cid = $db->insertId();
// Update thread reference to last comment
$dbw->update( 'thread', [ 'td_latest' => $cid ], [ 'td_id' => $tid ], __METHOD__ );
// Demark the end of this conceptual unit of updates
$dbw->endAtomic( __METHOD__ );
// Start a transaction if there isn't one already
$sectionId = $dbw->startAtomic( __METHOD__, $dbw::ATOMIC_CANCELABLE );
// Create new record metadata row
$dbw->insert( 'records', $row, __METHOD__ );
// Figure out where to store the data based on the new row's ID
$path = $recordDirectory . '/' . $dbw->insertId();
// Write the record data to the storage system
if ( $status->isOK() ) {
// Try to cleanup files orphaned by transaction rollback
$dbw->onTransactionResolution(
function ( $type ) use ( $fileBackend, $path ) {
if ( $type === IDatabase::TRIGGER_ROLLBACK ) {
$fileBackend->delete( [ 'src' => $path ] );
}
},
__METHOD__
);
// Demark the end of this conceptual unit of updates
$dbw->endAtomic( __METHOD__ );
} else {
// Discard these writes from the transaction (preserving prior writes)
$dbw->cancelAtomic( __METHOD__, $sectionId );
}
| |||||||||||||||||||||||||||
| 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.REPLACE() in mysql)
| |||||||||||||||||||||||||||
| tableName (string $name, $format='quoted') | |||||||||||||||||||||||||||
Format a table name ready for use in constructing an SQL query.This does two important things: it quotes the table names to clean them up, and it adds a table prefix if only given a table name with no quotes.All functions of this object which require a table name call this function themselves. Pass the canonical name to such functions. This is only needed when calling query() directly.The provided name should not qualify the database nor the schema, unless the name is of the form "information_schema.<identifier>". Unlike information_schema tables, regular tables can receive writes and are subject to configuration regarding table aliases, virtual domains, and LBFactory sharding. Callers needing to access remote databases should use appropriate connection factory methods.
| |||||||||||||||||||||||||||
| tableNamesN (... $tables) | |||||||||||||||||||||||||||
Fetch a number of table names into a zero-indexed numerical array.Much like tableName(), this is only needed when calling query() directly. You should prefer calling other methods, or using SelectQueryBuilder.Theoretical example (which really does not require raw SQL): [ $user, $watchlist ] = $dbr->tableNamesN( 'user', 'watchlist' );
$sql = "SELECT wl_namespace,wl_title FROM $watchlist,$user
WHERE wl_user=user_id AND wl_user=$nameWithQuotes";
| |||||||||||||||||||||||||||
| 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.The result is unquoted, and needs to be passed through addQuotes() before it can be included in raw SQL.
| |||||||||||||||||||||||||||
| 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.If NULL is input, it is passed through, allowing NULL values to be inserted into timestamp fields.The result is unquoted, and needs to be passed through addQuotes() before it can be included in raw SQL.
| |||||||||||||||||||||||||||
| trxLevel () | |||||||||||||||||||||||||||
Gets the current transaction level.Historically, transactions were allowed to be "nested". This is no longer supported, so this function really only returns a boolean.
| |||||||||||||||||||||||||||
| trxStatus () | |||||||||||||||||||||||||||
| trxTimestamp () | |||||||||||||||||||||||||||
Get the UNIX timestamp of the time that the transaction was established.This can be used to reason about the staleness of SELECT data in REPEATABLE-READ transaction isolation level. Callers can assume that if a view-snapshot isolation is used, then the data read by SQL queries is at least up to date to that point (possibly more up-to-date since the first SELECT defines the snapshot).
| |||||||||||||||||||||||||||
| unionQueries ( $sqls, $all, $options=[]) | |||||||||||||||||||||||||||
Construct a UNION query.This is used for providing overload point for other DB abstractions not compatible with the MySQL syntax.
| |||||||||||||||||||||||||||
| 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.This operation will be seen by affectedRows()/insertId() as one query statement, regardless of how many statements are actually sent by the class implementation.
| |||||||||||||||||||||||||||
| upsert ( $table, array $rows, $uniqueKeys, array $set, $fname=__METHOD__) | |||||||||||||||||||||||||||
Upsert row(s) into a table, in the provided order, while updating conflicting rows.Conflicts are determined by the provided unique indexes. Note that it is possible for the provided rows to conflict even among themselves; it is preferable for the caller to de-duplicate such input beforehand.This operation will be seen by affectedRows()/insertId() as one query statement, regardless of how many statements are actually sent by the class implementation.
| |||||||||||||||||||||||||||
| writesOrCallbacksPending () | |||||||||||||||||||||||||||
Whether there is a transaction open with either possible write queries or unresolved pre-commit/commit/resolution callbacks pending.This does not count recurring callbacks, e.g. from setTransactionListener().
| |||||||||||||||||||||||||||
| 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 | getCacheSetOptions (?IReadableDatabase ... $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.Connection and query errors will be suppressed and logged
| |||||||||||||||||||||
| doHandleSessionLossPreconnect () | |||||||||||||||||||||
| Reset any additional subclass trx* and session* fields. | |||||||||||||||||||||
| doSelectDomain (DatabaseDomain $domain) | |||||||||||||||||||||
| |||||||||||||||||||||
| doSingleStatementQuery (string $sql) | |||||||||||||||||||||
| Run a query and return a QueryStatus instance with the query result information. | |||||||||||||||||||||
| getBindingHandle () | |||||||||||||||||||||
| getInsertIdColumnForUpsert ( $table) | |||||||||||||||||||||
| |||||||||||||||||||||
| isConnectionError ( $errno) | |||||||||||||||||||||
Do not use this method outside of Database/DBError classes.
| |||||||||||||||||||||
| isKnownStatementRollbackError ( $errno) | |||||||||||||||||||||
| |||||||||||||||||||||
| lastInsertId () | |||||||||||||||||||||
Get a row ID from the last insert statement to implicitly assign one within the session.If the statement involved assigning sequence IDs to multiple rows, then the return value will be any one of those values (database-specific). If the statement was an "UPSERT" and some existing rows were updated, then the result will either reflect only IDs of created rows or it will reflect IDs of both created and updated rows (this is database-specific).The result is unspecified if the statement gave an error.
| |||||||||||||||||||||
| 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) | |||||||||||||||||||||
| checkInsertWarnings (Query $query, $fname) | |||||||||||||||||||||
| Check for warnings after performing an INSERT query, and throw exceptions if necessary. | |||||||||||||||||||||
| 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. | |||||||||||||||||||||
| 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. | |||||||||||||||||||||
| executeQuery ( $sql, $fname, $flags) | |||||||||||||||||||||
| Execute a query without enforcing public (non-Database) caller restrictions. | |||||||||||||||||||||
| getLastPHPError () | |||||||||||||||||||||
| getLogContext (array $extras=[]) | |||||||||||||||||||||
| Create a log context to pass to PSR-3 logger functions. | |||||||||||||||||||||
| getReadOnlyReason () | |||||||||||||||||||||
| getTransactionRoundFname () | |||||||||||||||||||||
| getValueTypesForWithClause ( $table) | |||||||||||||||||||||
| installErrorHandler () | |||||||||||||||||||||
| Set a custom error handler for logging errors during database connection. | |||||||||||||||||||||
| isInsertSelectSafe (array $insertOptions, array $selectOptions, $fname) | |||||||||||||||||||||
| isQueryTimeoutError ( $errno) | |||||||||||||||||||||
| Checks whether the cause of the error is detected to be a timeout. | |||||||||||||||||||||
| newExceptionAfterConnectError ( $error) | |||||||||||||||||||||
| registerTempTables (Query $query) | |||||||||||||||||||||
| Register creation and dropping of temporary tables. | |||||||||||||||||||||
| 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. | |
| LockManager null | $lockMgr |
| (hopefully on the same server as the DB) | |
| SQLPlatform | $platform |
| string | $trxMode |
| Transaction mode. | |
| Protected Attributes inherited from Wikimedia\Rdbms\Database | |
| 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. | |
| int null | $connectTimeout |
| Maximum seconds to wait on connection attempts. | |
| CriticalSectionProvider null | $csProvider |
| DatabaseDomain | $currentDomain |
| string false | $delimiter = ';' |
| Current SQL query delimiter. | |
| callable | $deprecationLogger |
| Deprecation logging callback. | |
| callable | $errorLogger |
| Error logging callback. | |
| DatabaseFlags | $flagsHolder |
| array | $lbInfo = [] |
| Current LoadBalancer tracking information. | |
| LoggerInterface | $logger |
| int | $nonNativeInsertSelectBatchSize |
| Row batch size to use for emulated INSERT SELECT queries. | |
| callable null | $profiler |
| int null | $receiveTimeout |
| Maximum seconds to wait on receiving query results. | |
| string null | $serverName |
| Readable name or host/IP of the database server. | |
| array< string, array > | $sessionNamedLocks = [] |
| Map of (lock name => (UNIX time,trx ID)) | |
| bool | $ssl |
| Whether to use SSL connections. | |
| bool | $strictWarnings |
| Whether to check for warnings. | |
| array< string, array< string, $sessionTempTables=[];protected int $lastQueryAffectedRows=0;protected int|null $lastQueryInsertId;protected int|null $lastEmulatedAffectedRows;protected int|null $lastEmulatedInsertId;protected string $lastConnectError='';private float $lastPing=0.0;private float|null $lastWriteTime;private string|false $lastPhpError=false;private int|null $csmId;private string|null $csmFname;private Exception|null $csmError;public const ATTR_DB_IS_FILE='db-is-file';public const ATTR_DB_LEVEL_LOCKING='db-level-locking';public const ATTR_SCHEMAS_AS_TABLE_GROUPS='supports-schemas';public const NEW_UNCONNECTED=0;public const NEW_CONNECTED=1;protected const ERR_NONE=0;protected const ERR_RETRY_QUERY=1;protected const ERR_ABORT_QUERY=2;protected const ERR_ABORT_TRX=4;protected const ERR_ABORT_SESSION=8;protected const DROPPED_CONN_BLAME_THRESHOLD_SEC=3.0;=private const NOT_APPLICABLE 'n/a';private const PING_TTL=1.0;private const PING_QUERY='SELECT 1 AS ping';protected const CONN_HOST='host';protected const CONN_USER='user';protected const CONN_PASSWORD='password';protected const CONN_INITIAL_DB='dbname';protected const CONN_INITIAL_SCHEMA='schema';protected const CONN_INITIAL_TABLE_PREFIX='tablePrefix';protected SQLPlatform $platform;protected ReplicationReporter $replicationReporter;public function __construct(array $params) { $this->logger=$params[ 'logger'] ?? new NullLogger();$this-> | transactionManager |
| TempTableInfo>> Map of (DB name => table name => info) | |
Additional Inherited Members | |
| Public Attributes inherited from Wikimedia\Rdbms\Database | |
| if(is_string( $params['sqlMode'] ?? null)) | $flags = (int)$params['flags'] |
| $this | agent = (string)$params['agent'] |
| $this | cliMode = (bool)$params['cliMode'] |
| $this | connectionParams |
| $this | connectionVariables = $params['variables'] ?? [] |
| $this | connectTimeout = $params['connectTimeout'] ?? null |
| $this | csProvider = $params['criticalSectionProvider'] ?? null |
| $this | currentDomain |
| $this | deprecationLogger = $params['deprecationLogger'] |
| $this | errorLogger = $params['errorLogger'] |
| $this | flagsHolder = new DatabaseFlags( $flags ) |
| $this | lbInfo = $params['lbInfo'] ?? [] |
| $this | nonNativeInsertSelectBatchSize = $params['nonNativeInsertSelectBatchSize'] ?? 10000 |
| $this | platform |
| $this | profiler = is_callable( $params['profiler'] ) ? $params['profiler'] : null |
| $this | receiveTimeout = $params['receiveTimeout'] ?? null |
| $this | serverName = $params['serverName'] |
| $this | ssl = $params['ssl'] ?? (bool)( $flags & self::DBO_SSL ) |
| $this | strictWarnings = !empty( $params['strictWarnings'] ) |
| $this | tracer = $params['tracer'] ?? new NoopTracer() |
| Public Attributes inherited from Wikimedia\Rdbms\IDatabase | |
| const | ATOMIC_CANCELABLE = 'cancelable' |
| Atomic section is cancelable. | |
| const | ATOMIC_NOT_CANCELABLE = '' |
| Atomic section is not cancelable. | |
| const | ESTIMATE_DB_APPLY = 'apply' |
| Estimate time to apply (scanning, applying) | |
| const | ESTIMATE_TOTAL = 'total' |
| Estimate total time (RTT, scanning, waiting on locks, applying) | |
| const | FLUSHING_ALL_PEERS = 'flush' |
| Commit/rollback is from the owning connection manager for the IDatabase handle. | |
| const | FLUSHING_INTERNAL = 'flush-internal' |
| Commit/rollback is from the IDatabase handle internally. | |
| const | FLUSHING_ONE = '' |
| Commit/rollback is from outside the IDatabase handle and connection manager. | |
| const | LB_READ_ONLY_REASON = 'readOnlyReason' |
| Field for getLBInfo()/setLBInfo(); configured read-only mode explanation or false. | |
| const | LB_TRX_ROUND_FNAME = 'trxRoundOwner' |
| Field for getLBInfo()/setLBInfo(); relevant transaction round owner name or null. | |
| const | LB_TRX_ROUND_ID = self::LB_TRX_ROUND_FNAME |
| Alias to LB_TRX_ROUND_FNAME. | |
| const | LB_TRX_ROUND_LEVEL = 'trxRoundLevel' |
| Field for getLBInfo()/setLBInfo(); relevant transaction round level (1 or 0) | |
| const | LOCK_TIMESTAMP = 1 |
| Flag to return the lock acquisition timestamp (null if not acquired) | |
| const | ROLE_STATIC_CLONE = 'static-clone' |
| Replica server within a static dataset. | |
| const | ROLE_STREAMING_MASTER = 'streaming-master' |
| Primary server than can stream writes to replica servers. | |
| const | ROLE_STREAMING_REPLICA = 'streaming-replica' |
| Replica server that receives writes from a primary server. | |
| const | ROLE_UNKNOWN = 'unknown' |
| Server with unknown topology role. | |
| const | TRANSACTION_EXPLICIT = '' |
| Transaction is requested by regular caller outside of the DB layer. | |
| const | TRANSACTION_INTERNAL = 'implicit' |
| Transaction is requested internally via DBO_TRX/startAtomic() | |
| const | TRIGGER_CANCEL = 4 |
| Callback triggered by atomic section cancel (ROLLBACK TO SAVEPOINT) | |
| const | TRIGGER_COMMIT = 2 |
| Callback triggered by COMMIT. | |
| const | TRIGGER_IDLE = 1 |
| Callback triggered immediately due to no active transaction. | |
| const | TRIGGER_ROLLBACK = 3 |
| Callback triggered by ROLLBACK. | |
| Public Attributes inherited from Wikimedia\Rdbms\IReadableDatabase | |
| const | UNION_ALL = true |
| Parameter to unionQueries() for UNION ALL. | |
| const | UNION_DISTINCT = false |
| Parameter to unionQueries() for UNION DISTINCT. | |
| Public Attributes inherited from Wikimedia\Rdbms\Platform\ISQLPlatform | |
| const | ALL_ROWS = '*' |
| Unconditional update/delete of whole table. | |
| const | CALLER_SUBQUERY = 'subquery' |
| Special value for ->caller() / $fname parameter used when providing a caller is not expected, because we're formatting a subquery that won't be executed directly. | |
| const | CALLER_UNKNOWN = 'unknown' |
| Special value for ->caller() / $fname parameter used when a caller is not provided. | |
| const | LIST_AND = 1 |
| Combine list with AND clauses. | |
| const | LIST_COMMA = 0 |
| Combine list with comma delimiters. | |
| const | LIST_NAMES = 3 |
| Treat as field name and do not apply value escaping. | |
| const | LIST_OR = 4 |
| Combine list with OR clauses. | |
| const | LIST_SET = 2 |
| Convert map into a SET clause. | |
| const | QUERY_CHANGE_LOCKS = 512 |
| Query is a command for advisory locks. | |
| const | QUERY_CHANGE_NONE = 32 |
| Query is a read-only Data Query Language query. | |
| const | QUERY_CHANGE_ROWS = 128 |
| Query is a Data Manipulation Language command (INSERT, DELETE, LOCK, ...) | |
| const | QUERY_CHANGE_SCHEMA = 256 |
| Query is a Data Definition Language command. | |
| const | QUERY_CHANGE_TRX = 64 |
| Query is a Transaction Control Language command (BEGIN, USE, SET, ...) | |
| const | QUERY_IGNORE_DBO_TRX = 8 |
| Ignore the current presence of any DBO_TRX flag. | |
| const | QUERY_NO_RETRY = 16 |
| Do not try to retry the query if the connection was lost. | |
| const | QUERY_NORMAL = 0 |
| Idiom for "no special flags". | |
| const | QUERY_PSEUDO_PERMANENT = 2 |
| Track a TEMPORARY table CREATE as if it was for a permanent table (for testing) | |
| const | QUERY_REPLICA_ROLE = 4 |
| Enforce that a query does not make effective writes. | |
| const | QUERY_SILENCE_ERRORS = 1 |
| Ignore query errors and return false when they happen. | |
| Public Attributes inherited from Wikimedia\Rdbms\Database\IDatabaseFlags | |
| const | DBO_COMPRESS = 512 |
| Enable compression in connection protocol. | |
| const | DBO_DDLMODE = 128 |
| Schema file mode; was used by Oracle. | |
| const | DBO_DEBUG = 1 |
| Enable debug logging of all SQL queries. | |
| const | DBO_DEFAULT = 16 |
| Join load balancer transaction rounds (which control DBO_TRX) in non-CLI mode. | |
| const | DBO_GAUGE = 1024 |
| Optimize connection for guaging server state (e.g. | |
| const | DBO_IGNORE = 4 |
| Unused since 1.31. | |
| const | DBO_NOBUFFER = 2 |
| Unused since 1.34. | |
| const | DBO_PERSISTENT = 32 |
| Use DB persistent connections if possible. | |
| const | DBO_SSL = 256 |
| Enable SSL/TLS in connection protocol. | |
| const | DBO_SYSDBA = 64 |
| DBA session mode; was used by Oracle. | |
| const | DBO_TRX = 8 |
| Automatically start a transaction before running a query if none is active. | |
| const | REMEMBER_NOTHING = '' |
| Do not remember the prior flags. | |
| const | REMEMBER_PRIOR = 'remember' |
| Remember the prior flags. | |
| const | RESTORE_INITIAL = 'initial' |
| Restore to the initial flag state. | |
| const | RESTORE_PRIOR = 'prior' |
| Restore to the prior flag state. | |
Detailed Description
This is the SQLite database abstraction layer.
See docs/sqlite.txt for development notes about MediaWiki's sqlite schema.
Definition at line 26 of file DatabaseSqlite.php.
Constructor & Destructor Documentation
◆ __construct()
| Wikimedia\Rdbms\DatabaseSqlite::__construct | ( | array | $params | ) |
Additional params include:
- dbDirectory : directory containing the DB and the lock file directory
- dbFilePath : use this to force the path of the DB file
- trxMode : one of (deferred, immediate, exclusive)
Definition at line 70 of file DatabaseSqlite.php.
References Wikimedia\Rdbms\Database\currentDomain, Wikimedia\Rdbms\Database\errorLogger, and Wikimedia\Rdbms\Database\platform.
Member Function Documentation
◆ addQuotes()
| Wikimedia\Rdbms\DatabaseSqlite::addQuotes | ( | $s | ) |
Escape and quote a raw value string for use in a SQL query.
- Parameters
-
?scalar | RawSQLValue | Blob $s
- Returns
- string
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 654 of file DatabaseSqlite.php.
◆ attachDatabase()
| Wikimedia\Rdbms\DatabaseSqlite::attachDatabase | ( | $name, | |
| $file = false, | |||
| $fname = __METHOD__ ) |
Attaches external database to the connection handle.
- Parameters
-
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
- Returns
- IResultWrapper
Definition at line 369 of file DatabaseSqlite.php.
◆ closeConnection()
|
protected |
Does not actually close the connection, just destroys the reference for GC to do its work.
- Returns
- bool
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 277 of file DatabaseSqlite.php.
◆ databasesAreIndependent()
| 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.
- Returns
- bool
- Since
- 1.29
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 891 of file DatabaseSqlite.php.
◆ decodeBlob()
| Wikimedia\Rdbms\DatabaseSqlite::decodeBlob | ( | $b | ) |
- Parameters
-
Blob | string $b
- Returns
- string
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 640 of file DatabaseSqlite.php.
◆ doBegin()
|
protected |
Issues the BEGIN command to the database server.
- See also
- Database::begin()
- Parameters
-
string $fname
- Exceptions
-
DBError
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 610 of file DatabaseSqlite.php.
◆ doFlushSession()
|
protected |
Reset the server-side session state for named locks and table locks.Connection and query errors will be suppressed and logged
- Parameters
-
string $fname
- Since
- 1.38
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 904 of file DatabaseSqlite.php.
◆ doHandleSessionLossPreconnect()
|
protected |
Reset any additional subclass trx* and session* fields.
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 895 of file DatabaseSqlite.php.
◆ doLock()
| Wikimedia\Rdbms\DatabaseSqlite::doLock | ( | string | $lockName, |
| string | $method, | ||
| int | $timeout ) |
- See also
- lock()
- Parameters
-
string $lockName string $method int $timeout
- Returns
- float|null UNIX timestamp of lock acquisition; null on failure
- Exceptions
-
DBError
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 693 of file DatabaseSqlite.php.
◆ doLockIsFree()
| Wikimedia\Rdbms\DatabaseSqlite::doLockIsFree | ( | string | $lockName, |
| string | $method ) |
- See also
- lockIsFree()
- Parameters
-
string $lockName string $method
- Returns
- bool Success
- Exceptions
-
DBError
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 687 of file DatabaseSqlite.php.
◆ doSelectDomain()
|
protected |
- Parameters
-
DatabaseDomain $domain
- Exceptions
-
DBConnectionError DBError
- Since
- 1.32
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 392 of file DatabaseSqlite.php.
References Wikimedia\Rdbms\DatabaseDomain\getDatabase(), Wikimedia\Rdbms\DatabaseDomain\getSchema(), and Wikimedia\Rdbms\DatabaseDomain\getTablePrefix().
◆ doSingleStatementQuery()
|
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:
- a) A driver-specific IResultWrapper describing the query results
- b) False, on any query failure
For non-SELECT queries, the result field contains either:
- a) A driver-specific IResultWrapper, only on success
- b) True, only on success (e.g. no meaningful result other than "OK")
- c) False, on any query failure
- Parameters
-
string $sql Single-statement SQL query
- Returns
- QueryStatus
- Since
- 1.39
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 380 of file DatabaseSqlite.php.
◆ doUnlock()
| Wikimedia\Rdbms\DatabaseSqlite::doUnlock | ( | string | $lockName, |
| string | $method ) |
- See also
- unlock()
- Parameters
-
string $lockName string $method
- Returns
- bool Success
- Exceptions
-
DBError
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 706 of file DatabaseSqlite.php.
◆ duplicateTableStructure()
| Wikimedia\Rdbms\DatabaseSqlite::duplicateTableStructure | ( | $oldName, | |
| $newName, | |||
| $temporary = false, | |||
| $fname = __METHOD__ ) |
- Parameters
-
string $oldName string $newName bool $temporary string $fname
- Returns
- bool|IResultWrapper
- Exceptions
-
RuntimeException
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 718 of file DatabaseSqlite.php.
◆ encodeBlob()
| Wikimedia\Rdbms\DatabaseSqlite::encodeBlob | ( | $b | ) |
- Parameters
-
string $b
- Returns
- Blob
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 632 of file DatabaseSqlite.php.
◆ fieldInfo()
| Wikimedia\Rdbms\DatabaseSqlite::fieldInfo | ( | $table, | |
| $field ) |
Get information about a given field Returns false if the field does not exist.
- Parameters
-
string $table string $field
- Returns
- SQLiteField|false False on failure
Implements Wikimedia\Rdbms\IMaintainableDatabase.
Definition at line 591 of file DatabaseSqlite.php.
◆ generateFileName()
|
static |
Generates a database file name.
Explicitly public for installer.
- Parameters
-
string $dir Directory where database resides string | null $dbName Database name (or null from Database::factory, validated here)
- Returns
- string
- Exceptions
-
DBUnexpectedError
Definition at line 292 of file DatabaseSqlite.php.
Referenced by Wikimedia\Rdbms\DatabaseSqlite\getDbFilePath(), and Wikimedia\Rdbms\DatabaseSqlite\open().
◆ getAttributes()
|
static |
- Returns
- array Map of (Database::ATTR_* constant => value)
- Since
- 1.31
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 99 of file DatabaseSqlite.php.
◆ getBindingHandle()
|
protected |
- Returns
- PDO
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 914 of file DatabaseSqlite.php.
◆ getDbFilePath()
| Wikimedia\Rdbms\DatabaseSqlite::getDbFilePath | ( | ) |
- Returns
- string|null SQLite DB file path
- Exceptions
-
DBUnexpectedError
- Since
- 1.25
Definition at line 239 of file DatabaseSqlite.php.
References Wikimedia\Rdbms\DatabaseSqlite\generateFileName(), and Wikimedia\Rdbms\Database\getDBname().
◆ getFulltextSearchModule()
|
static |
Returns version of currently supported SQLite fulltext search module or false if none present.
- Returns
- string|false
Definition at line 336 of file DatabaseSqlite.php.
References Wikimedia\Rdbms\Platform\ISQLPlatform\QUERY_SILENCE_ERRORS.
◆ getInsertIdColumnForUpsert()
|
protected |
- Parameters
-
string $table The unqualified name of a table
- Returns
- string|null The AUTO_INCREMENT/SERIAL column; null if not needed
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 919 of file DatabaseSqlite.php.
◆ getLockFileDirectory()
| Wikimedia\Rdbms\DatabaseSqlite::getLockFileDirectory | ( | ) |
- Returns
- string|null Lock file directory
Definition at line 246 of file DatabaseSqlite.php.
◆ getPrimaryKeyColumns()
| Wikimedia\Rdbms\DatabaseSqlite::getPrimaryKeyColumns | ( | $table, | |
| $fname = __METHOD__ ) |
Get the primary key columns of a table.
- Access: internal
- to be used by updater only
- Parameters
-
string $table The unqualified name of a table string $fname Calling function name
- Returns
- string[]
- Exceptions
-
DBError If an error occurs, {
- See also
- query}
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 500 of file DatabaseSqlite.php.
◆ getServerVersion()
| Wikimedia\Rdbms\DatabaseSqlite::getServerVersion | ( | ) |
- Returns
- string Version information from the database
Implements Wikimedia\Rdbms\IReadableDatabase.
Definition at line 575 of file DatabaseSqlite.php.
◆ getSoftwareLink()
| Wikimedia\Rdbms\DatabaseSqlite::getSoftwareLink | ( | ) |
- Returns
- string Wikitext of a link to the server software's web site
Implements Wikimedia\Rdbms\IReadableDatabase.
Definition at line 568 of file DatabaseSqlite.php.
◆ getType()
| Wikimedia\Rdbms\DatabaseSqlite::getType | ( | ) |
- Returns
- string
Implements Wikimedia\Rdbms\IReadableDatabase.
Definition at line 129 of file DatabaseSqlite.php.
◆ indexInfo()
| Wikimedia\Rdbms\DatabaseSqlite::indexInfo | ( | $table, | |
| $index, | |||
| $fname = __METHOD__ ) |
Get information about an index into an object.
- Parameters
-
string $table The unqualified name of a table string $index Index name string $fname Calling function name
- Returns
- array<string,mixed>|false Index info map; false if it does not exist
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 480 of file DatabaseSqlite.php.
◆ isConnectionError()
|
protected |
Do not use this method outside of Database/DBError classes.
- Parameters
-
int | string $errno
- Returns
- bool Whether the given query error was a connection drop
- Since
- 1.38
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 543 of file DatabaseSqlite.php.
◆ isKnownStatementRollbackError()
|
protected |
- Parameters
-
int | string $errno
- Returns
- bool Whether it is known that the last query error only caused statement rollback
- Note
- This is for backwards compatibility for callers catching DBError exceptions in order to ignore problems like duplicate key errors or foreign key violations
- Since
- 1.39
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 548 of file DatabaseSqlite.php.
◆ lastErrno()
| Wikimedia\Rdbms\DatabaseSqlite::lastErrno | ( | ) |
- Returns
- int
Implements Wikimedia\Rdbms\IReadableDatabase.
Definition at line 449 of file DatabaseSqlite.php.
◆ lastError()
| Wikimedia\Rdbms\DatabaseSqlite::lastError | ( | ) |
- Returns
- string
Implements Wikimedia\Rdbms\IReadableDatabase.
Definition at line 436 of file DatabaseSqlite.php.
◆ lastInsertId()
|
protected |
Get a row ID from the last insert statement to implicitly assign one within the session.If the statement involved assigning sequence IDs to multiple rows, then the return value will be any one of those values (database-specific). If the statement was an "UPSERT" and some existing rows were updated, then the result will either reflect only IDs of created rows or it will reflect IDs of both created and updated rows (this is database-specific).The result is unspecified if the statement gave an error.
- Returns
- int Sequence ID, 0 (if none)
- Exceptions
-
DBError
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 428 of file DatabaseSqlite.php.
◆ listTables()
| Wikimedia\Rdbms\DatabaseSqlite::listTables | ( | $prefix = null, | |
| $fname = __METHOD__ ) |
List all tables on the database.
- Parameters
-
string | null $prefix Only show tables with this prefix, e.g. mw_ string $fname Calling function name
- Returns
- array
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 819 of file DatabaseSqlite.php.
◆ newStandaloneInstance()
|
static |
- Parameters
-
string $filename array $p Options map; supports: - flags : (same as __construct counterpart)
- trxMode : (same as __construct counterpart)
- dbDirectory : (same as __construct counterpart)
- Returns
- DatabaseSqlite
- Since
- 1.25
Definition at line 115 of file DatabaseSqlite.php.
◆ open()
|
protected |
Open a new connection to the database (closing any existing one)
- Parameters
-
string | null $server Server host/address and optional port {
- See also
- connectionParams}
- Parameters
-
string | null $user User name {
- See also
- connectionParams}
- Parameters
-
string | null $password User password {
- See also
- connectionParams}
- Parameters
-
string | null $db Database name string | null $schema Database schema name string $tablePrefix
- Exceptions
-
DBConnectionError
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 134 of file DatabaseSqlite.php.
References Wikimedia\Rdbms\DatabaseSqlite\$dbPath, $path, Wikimedia\Rdbms\Database\close(), Wikimedia\Rdbms\Database\connectionVariables, Wikimedia\Rdbms\Database\currentDomain, Wikimedia\Rdbms\DatabaseSqlite\generateFileName(), Wikimedia\Rdbms\Database\getFlag(), Wikimedia\Rdbms\Database\getLogContext(), Wikimedia\Rdbms\Database\newExceptionAfterConnectError(), Wikimedia\Rdbms\Database\platform, and Wikimedia\Rdbms\Database\query().
◆ replace()
| Wikimedia\Rdbms\DatabaseSqlite::replace | ( | $table, | |
| $uniqueKeys, | |||
| $rows, | |||
| $fname = __METHOD__ ) |
Insert row(s) into a table, in the provided order, while deleting conflicting rows.Conflicts are determined by the provided unique indexes. Note that it is possible for the provided rows to conflict even among themselves; it is preferable for the caller to de-duplicate such input beforehand.Note some important implications of the deletion semantics:
- If the table has an AUTOINCREMENT column and $rows omit that column, then any conflicting existing rows will be replaced with newer having higher values for that column, even if nothing else changed.
- There might be worse contention than upsert() due to the use of gap-locking. This does not apply to RDBMS types that use predicate locking nor those that just lock the whole table or databases anyway.
- Access: internal
- callers outside of rdbms library should use ReplaceQueryBuilder instead.
- Parameters
-
string $table The unqualified name of a table string | string[] | string[][] $uniqueKeys Column name or non-empty list of column name lists that define all applicable unique keys on the table. There must only be one such key. Each unique key on the table is "applicable" unless either: - It involves an AUTOINCREMENT column for which no values are assigned in $rows
- It involves a UUID column for which newly generated UUIDs are assigned in $rows
array | array[] $rows Row(s) to insert, in the form of either: - A string-keyed map of (column name => value) defining a new row. Values are treated as literals and quoted appropriately; null is interpreted as NULL. Columns belonging to a key in $uniqueKeys must be defined here and non-null.
- An integer-keyed list of such string-keyed maps, defining a list of new rows. The keys in each map must be identical to each other and in the same order. The rows must not collide with each other.
string $fname Calling function name (use METHOD) for logs/profiling
- Exceptions
-
DBError If an error occurs, {
- See also
- query}
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 523 of file DatabaseSqlite.php.
◆ serverIsReadOnly()
| Wikimedia\Rdbms\DatabaseSqlite::serverIsReadOnly | ( | ) |
- Returns
- bool Whether this DB server is running in server-side read-only mode
- Exceptions
-
DBError If an error occurs, {
- See also
- query}
- Since
- 1.28
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 557 of file DatabaseSqlite.php.
References $path.
◆ setTableAliases()
| 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.
- Parameters
-
array[] $aliases Map of (unqualified name of table => (dbname, schema, prefix) map)
- Since
- 1.28 in IDatabase, moved to ISQLPlatform in 1.39
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 868 of file DatabaseSqlite.php.
◆ strencode()
| Wikimedia\Rdbms\DatabaseSqlite::strencode | ( | $s | ) |
- Parameters
-
string $s
- Returns
- string
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 624 of file DatabaseSqlite.php.
◆ tableExists()
| Wikimedia\Rdbms\DatabaseSqlite::tableExists | ( | $table, | |
| $fname = __METHOD__ ) |
Query whether a given table exists.
- Parameters
-
string $table The unqualified name of a table string $fname
- Returns
- bool
- Exceptions
-
DBError If an error occurs, {
- See also
- query}
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 462 of file DatabaseSqlite.php.
◆ truncateTable()
| Wikimedia\Rdbms\DatabaseSqlite::truncateTable | ( | $table, | |
| $fname = __METHOD__ ) |
Delete all data in a table and reset any sequences owned by that table.
- Parameters
-
string $table The unqualified name of a table string $fname
- Exceptions
-
DBError If an error occurs
- Since
- 1.42
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 844 of file DatabaseSqlite.php.
Member Data Documentation
◆ $conn
|
protected |
Definition at line 35 of file DatabaseSqlite.php.
◆ $dbDir
|
protected |
Directory for SQLite database files listed under their DB name.
Definition at line 28 of file DatabaseSqlite.php.
◆ $dbPath
|
protected |
Explicit path for the SQLite database file.
Definition at line 30 of file DatabaseSqlite.php.
Referenced by Wikimedia\Rdbms\DatabaseSqlite\open().
◆ $lockMgr
|
protected |
(hopefully on the same server as the DB)
Definition at line 38 of file DatabaseSqlite.php.
◆ $platform
|
protected |
Initial value:
=[[,,,],[,],,,]
private const VALID_PRAGMAS
'synchronous' => 'EXTRA' 'FULL' 'NORMAL' 'OFF'
'temp_store' => 'FILE' 'MEMORY'
'mmap_size' => 'integer'
'cache_size' => 'integer'
Definition at line 62 of file DatabaseSqlite.php.
◆ $trxMode
|
protected |
Transaction mode.
Definition at line 32 of file DatabaseSqlite.php.
The documentation for this class was generated from the following file:
- includes/libs/Rdbms/Database/DatabaseSqlite.php
