MediaWiki  master
Wikimedia\Rdbms\DatabaseSqlite Class Reference

This is the SQLite database abstraction layer. More...

Inheritance diagram for Wikimedia\Rdbms\DatabaseSqlite:
Collaboration diagram for Wikimedia\Rdbms\DatabaseSqlite:

Public Member Functions

 __construct (array $params)
 Additional params include: More...
 
 addQuotes ( $s)
 
 attachDatabase ( $name, $file=false, $fname=__METHOD__)
 Attaches external database to the connection handle. More...
 
 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
Stability: stable
to override
More...
 
 deadlockLoop (... $args)
 No-op version of deadlockLoop. More...
 
 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. More...
 
 getDbFilePath ()
 
 getLockFileDirectory ()
 
 getServerVersion ()
 
 getSoftwareLink ()
 
 getTopologyBasedServerId ()
 Get a non-recycled ID that uniquely identifies this server within the replication topology. More...
 
 getType ()
 
 indexInfo ( $table, $index, $fname=__METHOD__)
 Returns information about an index Returns false if the index does not exist. More...
 
 indexUnique ( $table, $index, $fname=__METHOD__)
 
 insertId ()
 This must be called after nextSequenceVal. More...
 
 lastErrno ()
 
 lastError ()
 
 listTables ( $prefix=null, $fname=__METHOD__)
 List all tables on the database. More...
 
 serverIsReadOnly ()
 
Returns
bool Whether the DB is marked as read-only server-side
Exceptions
DBErrorIf an error occurs, {
See also
query}
Since
1.28
Stability: stable
to override
More...
 
 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. More...
 
 strencode ( $s)
 
 tableExists ( $table, $fname=__METHOD__)
 Query whether a given table exists. More...
 
 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. More...
 
 wasDeadlock ()
 
 wasReadOnlyError ()
 
- Public Member Functions inherited from Wikimedia\Rdbms\Database
 __clone ()
 Make sure that copies do not share the same client binding handle. More...
 
 __destruct ()
 Run a few simple checks and close dangling connections. More...
 
 __sleep ()
 Called by serialize. More...
 
 __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. More...
 
 addIdentifierQuotes ( $s)
 Escape a SQL identifier (e.g. More...
 
 affectedRows ()
 Get the number of rows affected by the last write query. More...
 
 anyChar ()
 Returns a token for buildLike() that denotes a '_' to be used in a LIKE query. More...
 
 anyString ()
 Returns a token for buildLike() that denotes a '' to be used in a LIKE query. More...
 
 begin ( $fname=__METHOD__, $mode=self::TRANSACTION_EXPLICIT)
 Begin a transaction. More...
 
 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. More...
 
 buildConcat ( $stringList)
 Build a concatenation list to feed into a SQL query. More...
 
 buildExcludedValue ( $column)
 Build a reference to a column value from the conflicting proposed upsert() row. More...
 
 buildGreatest ( $fields, $values)
 Build a GREATEST function statement comparing columns/values. More...
 
 buildGroupConcatField ( $delim, $table, $field, $conds='', $join_conds=[])
 Build a GROUP_CONCAT or equivalent statement for a query. More...
 
 buildIntegerCast ( $field)
 
 buildLeast ( $fields, $values)
 Build a LEAST function statement comparing columns/values. More...
 
 buildLike ( $param,... $params)
 LIKE statement wrapper. More...
 
 buildSelectSubquery ( $table, $vars, $conds='', $fname=__METHOD__, $options=[], $join_conds=[])
 Equivalent to IDatabase::selectSQLText() except wraps the result in Subquery. More...
 
 buildStringCast ( $field)
 
 buildSubstring ( $input, $startPosition, $length=null)
 
 cancelAtomic ( $fname=__METHOD__, AtomicSectionIdentifier $sectionId=null)
 Cancel an atomic section of SQL statements. More...
 
 clearFlag ( $flag, $remember=self::REMEMBER_NOTHING)
 Clear a flag for this connection. More...
 
 close ( $fname=__METHOD__)
 Close the database connection. More...
 
 commit ( $fname=__METHOD__, $flush=self::FLUSHING_ONE)
 Commits a transaction previously started using begin() More...
 
 conditional ( $cond, $caseTrueExpression, $caseFalseExpression)
 Returns an SQL expression for a simple conditional. More...
 
 connectionErrorLogger ( $errno, $errstr)
 Error handler for logging errors during database connection. More...
 
 dbSchema ( $schema=null)
 Get/set the db schema. More...
 
 decodeExpiry ( $expiry, $format=TS_MW)
 Decode an expiry time into a DBMS independent format. More...
 
 delete ( $table, $conds, $fname=__METHOD__)
 Delete all rows in a table that match a condition. More...
 
 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.
Parameters
string$delTableThe table to delete from.
string$joinTableThe other table.
string$delVarThe variable to join on, in the first table.
string$joinVarThe variable to join on, in the second table.
array | string$condsCondition array of field names mapped to variables, ANDed together in the WHERE clause
string$fnameCalling function name (use METHOD) for logs/profiling
Exceptions
DBErrorIf an error occurs, {
See also
query}
More...
 
 doAtomicSection ( $fname, callable $callback, $cancelable=self::ATOMIC_NOT_CANCELABLE)
 Perform an atomic section of reversible SQL statements from a callback. More...
 
 dropTable ( $table, $fname=__METHOD__)
 Delete a table. More...
 
 encodeExpiry ( $expiry)
 Encode an expiry time into the DBMS dependent format. More...
 
 endAtomic ( $fname=__METHOD__)
 Ends an atomic section of SQL statements. More...
 
 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.
Parameters
string | string[]$tablesTable name(s)
string$varColumn for which NULL values are not counted [default "*"]
array | string$condsFilters on the table
string$fnameFunction name for profiling
array$optionsOptions for select
array | string$join_condsJoin conditions
Returns
int Row count
Exceptions
DBErrorIf an error occurs, {
See also
query}
More...
 
 explicitTrxActive ()
 Check whether there is a transaction open at the specific request of a caller. More...
 
 factorConds ( $condsArray)
 Given an array of condition arrays representing an OR list of AND lists, for example: More...
 
 fieldExists ( $table, $field, $fname=__METHOD__)
 Determines whether a field exists in a table. More...
 
 flushSession ( $fname=__METHOD__, $flush=self::FLUSHING_ONE)
 Release important session-level state (named lock, table locks) as post-rollback cleanup. More...
 
 flushSnapshot ( $fname=__METHOD__, $flush=self::FLUSHING_ONE)
 Commit any transaction but error out if writes or callbacks are pending. More...
 
 getDBname ()
 Get the current database name; null if there isn't one. More...
 
 getDomainID ()
 Return the currently selected domain ID. More...
 
 getFlag ( $flag)
 Returns a boolean whether the flag $flag is set for this connection. More...
 
 getInfinity ()
 Find out when 'infinity' is. More...
 
 getLag ()
 Get the amount of replication lag for this database server. More...
 
 getLBInfo ( $name=null)
 Get properties passed down from the server info array of the load balancer. More...
 
 getPrimaryPos ()
 Get the position of this primary DB.
Returns
DBPrimaryPos|false False if this is not a primary DB
Exceptions
DBErrorIf an error occurs, {
See also
query}
Since
1.37
More...
 
 getReplicaPos ()
 Get the replication position of this replica DB.
Returns
DBPrimaryPos|false False if this is not a replica DB
Exceptions
DBErrorIf an error occurs, {
See also
query}
More...
 
 getScopedLockAndFlush ( $lockKey, $fname, $timeout)
 Acquire a named lock, flush any transaction, and return an RAII style unlocker object. More...
 
 getServer ()
 Get the hostname or IP address of the server. More...
 
 getServerInfo ()
 Get a human-readable string describing the current software version. More...
 
 getServerName ()
 Get the readable name for the server. More...
 
 getSessionLagStatus ()
 Get the replica DB lag when the current transaction started or a general lag estimate if not transaction is active. More...
 
 getTableAliases ()
 Return current table aliases. More...
 
 getTopologyRole ()
 Get the replication topology role of this server. More...
 
 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. More...
 
 indexExists ( $table, $index, $fname=__METHOD__)
 Determines whether an index exists. More...
 
 initConnection ()
 Initialize the connection to the database over the wire (or to local files) More...
 
 insert ( $table, $rows, $fname=__METHOD__, $options=[])
 Insert row(s) into a table, in the provided order. More...
 
 insertSelect ( $destTable, $srcTable, $varMap, $conds, $fname=__METHOD__, $insertOptions=[], $selectOptions=[], $selectJoinConds=[])
 INSERT SELECT wrapper. More...
 
 isOpen ()
 
 isQuotedIdentifier ( $name)
 
 isReadOnly ()
 
 lastDoneWrites ()
 Get the last time the connection may have been used for a write query. More...
 
 lastQuery ()
 Get the last query that sent on account of IDatabase::query() More...
 
 limitResult ( $sql, $limit, $offset=false)
 Construct a LIMIT query with optional offset. More...
 
 listViews ( $prefix=null, $fname=__METHOD__)
 Lists all the VIEWs in the database.
Parameters
string | null$prefixOnly show VIEWs with this prefix, eg. unit_test_
string$fnameName of calling function
Exceptions
RuntimeException
Returns
array
More...
 
 lock ( $lockName, $method, $timeout=5, $flags=0)
 Acquire a named lock.Named locks are not related to transactions
Parameters
string$lockNameName of lock to acquire
string$methodName of the calling method
int$timeoutAcquisition timeout in seconds (0 means non-blocking)
int$flagsBit field of IDatabase::LOCK_* constants
Returns
bool|float|null Success (bool); acquisition time (float/null) if LOCK_TIMESTAMP
Exceptions
DBErrorIf an error occurs, {
See also
query}
More...
 
 lockForUpdate ( $table, $conds='', $fname=__METHOD__, $options=[], $join_conds=[])
 Lock all rows meeting the given conditions/options FOR UPDATE. More...
 
 lockIsFree ( $lockName, $method)
 Check to see if a named lock is not locked by any thread (non-blocking)
Parameters
string$lockNameName of lock to poll
string$methodName of method calling us
Returns
bool
Exceptions
DBErrorIf an error occurs, {
See also
query}
Since
1.20
More...
 
 makeList (array $a, $mode=self::LIST_COMMA)
 Makes an encoded list of strings from an array. More...
 
 makeWhereFrom2d ( $data, $baseKey, $subKey)
 Build a partial where clause from a 2-d array such as used for LinkBatch. More...
 
 namedLocksEnqueue ()
 Check to see if a named lock used by lock() use blocking queues.
Returns
bool
Since
1.26
More...
 
 newSelectQueryBuilder ()
 Create an empty SelectQueryBuilder which can be used to run queries against this connection.
Note
A new query builder must be created per query. Query builders should not be reused since this uses a fluent interface and the state of the builder changes during the query which may cause unexpected results.
Returns
SelectQueryBuilder
More...
 
 nextSequenceValue ( $seqName)
 Deprecated method, calls should be removed. More...
 
 onAtomicSectionCancel (callable $callback, $fname=__METHOD__)
 Run a callback when the atomic section is cancelled. More...
 
 onTransactionCommitOrIdle (callable $callback, $fname=__METHOD__)
 Run a callback when the current transaction commits or now if there is none. More...
 
 onTransactionPreCommitOrIdle (callable $callback, $fname=__METHOD__)
 Run a callback before the current transaction commits or now if there is none. More...
 
 onTransactionResolution (callable $callback, $fname=__METHOD__)
 Run a callback when the current transaction commits or rolls back. More...
 
 pendingWriteAndCallbackCallers ()
 
 pendingWriteCallers ()
 Get the list of method names that did write queries for this transaction. More...
 
 pendingWriteQueryDuration ( $type=self::ESTIMATE_TOTAL)
 Get the time spend running write queries for this transaction. More...
 
 ping (&$rtt=null)
 Ping the server and try to reconnect if it there is no connection. More...
 
 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.
Parameters
DBPrimaryPos$pos
int$timeoutThe maximum number of seconds to wait for synchronisation
Returns
int|null Zero if the replica DB was past that position already, greater than zero if we waited for some period of time, less than zero if it timed out, and null on error
Exceptions
DBErrorIf an error occurs, {
See also
query}
Since
1.37
More...
 
 query ( $sql, $fname=__METHOD__, $flags=0)
 Run an SQL query statement and return the result. More...
 
 queryMulti (array $sqls, string $fname=__METHOD__, int $flags=0, ?string $summarySql=null)
 Run a batch of SQL query statements and return the results. More...
 
 replace ( $table, $uniqueKeys, $rows, $fname=__METHOD__)
 Insert row(s) into a table, in the provided order, while deleting conflicting rows. More...
 
 reportQueryError ( $error, $errno, $sql, $fname, $ignore=false)
 Report a query error. More...
 
 restoreFlags ( $state=self::RESTORE_PRIOR)
 Restore the flags to their prior state before the last setFlag/clearFlag call. More...
 
 rollback ( $fname=__METHOD__, $flush=self::FLUSHING_ONE)
 Rollback a transaction previously started using begin() More...
 
 runOnTransactionIdleCallbacks ( $trigger, array &$errors=[])
 Consume and run any "on transaction idle/resolution" callbacks. More...
 
 runOnTransactionPreCommitCallbacks ()
 
 runTransactionListenerCallbacks ( $trigger, array &$errors=[])
 Actually run any "transaction listener" callbacks. More...
 
 select ( $table, $vars, $conds='', $fname=__METHOD__, $options=[], $join_conds=[])
 Execute a SELECT query constructed using the various parameters provided. More...
 
 selectDB ( $db)
 Change the current database. More...
 
 selectDomain ( $domain)
 Set the current domain (database, schema, and table prefix) More...
 
 selectField ( $table, $var, $cond='', $fname=__METHOD__, $options=[], $join_conds=[])
 A SELECT wrapper which returns a single field from a single result row. More...
 
 selectFieldValues ( $table, $var, $cond='', $fname=__METHOD__, $options=[], $join_conds=[])
 A SELECT wrapper which returns a list of single field values from result rows. More...
 
 selectRow ( $table, $vars, $conds, $fname=__METHOD__, $options=[], $join_conds=[])
 Wrapper to IDatabase::select() that only fetches one row (via LIMIT) More...
 
 selectRowCount ( $tables, $var=' *', $conds='', $fname=__METHOD__, $options=[], $join_conds=[])
 Get the number of rows in dataset. More...
 
 selectSQLText ( $table, $vars, $conds='', $fname=__METHOD__, $options=[], $join_conds=[])
 Take the same arguments as IDatabase::select() and return the SQL it would use. More...
 
 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.
Parameters
bool | string$valueTrue for allow, false for deny, or "default" to restore the initial value
More...
 
 setFlag ( $flag, $remember=self::REMEMBER_NOTHING)
 Set a flag for this connection. More...
 
 setIndexAliases (array $aliases)
 Convert certain index names to alternative names before querying the DB. More...
 
 setLBInfo ( $nameOrArray, $value=null)
 Set the entire array or a particular key of the managing load balancer info array. More...
 
 setLogger (LoggerInterface $logger)
 Set the PSR-3 logger interface to use for query logging. More...
 
 setSchemaVars ( $vars)
 Set schema variables to be used when streaming commands from SQL files or stdin. More...
 
 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.
Parameters
array$options
Returns
void
Exceptions
DBErrorIf an error occurs, {
See also
query}
More...
 
 setTransactionListener ( $name, callable $callback=null)
 Run a callback after each time any transaction commits or rolls back. More...
 
 setTransactionManager (TransactionManager $transactionManager)
 
 setTrxEndCallbackSuppression ( $suppress)
 Whether to disable running of post-COMMIT/ROLLBACK callbacks. More...
 
 sourceFile ( $filename, callable $lineCallback=null, callable $resultCallback=null, $fname=false, callable $inputCallback=null)
 Read and execute SQL commands from a file. More...
 
 sourceStream ( $fp, callable $lineCallback=null, callable $resultCallback=null, $fname=__METHOD__, callable $inputCallback=null)
 Read and execute commands from an open file handle. More...
 
 startAtomic ( $fname=__METHOD__, $cancelable=self::ATOMIC_NOT_CANCELABLE)
 Begin an atomic section of SQL statements. More...
 
 streamStatementEnd (&$sql, &$newLine)
 Called by sourceStream() to check if we've reached a statement end. More...
 
 strreplace ( $orig, $old, $new)
 Returns a SQL expression for simple string replacement (e.g. More...
 
 tableName ( $name, $format='quoted')
 Format a table name ready for use in constructing an SQL query. More...
 
 tableNames (... $tables)
 Fetch a number of table names into an associative array. More...
 
 tableNamesN (... $tables)
 Fetch a number of table names into a zero-indexed numerical array. More...
 
 tablePrefix ( $prefix=null)
 Get/set the table prefix. More...
 
 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. More...
 
 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. More...
 
 truncate ( $tables, $fname=__METHOD__)
 Delete all data in a table(s) and reset any sequences owned by that table(s) More...
 
 trxLevel ()
 Gets the current transaction level. More...
 
 trxStatus ()
 
 trxTimestamp ()
 Get the UNIX timestamp of the time that the transaction was established. More...
 
 unionConditionPermutations ( $table, $vars, array $permute_conds, $extra_conds='', $fname=__METHOD__, $options=[], $join_conds=[])
 Construct a UNION query for permutations of conditions. More...
 
 unionQueries ( $sqls, $all)
 Construct a UNION query. More...
 
 unionSupportsOrderAndLimit ()
 Determine if the RDBMS supports ORDER BY and LIMIT for separate subqueries within UNION. More...
 
 unlock ( $lockName, $method)
 Release a lock.Named locks are not related to transactions
Parameters
string$lockNameName of lock to release
string$methodName of the calling method
Returns
bool Success
Exceptions
DBErrorIf an error occurs, {
See also
query}
More...
 
 update ( $table, $set, $conds, $fname=__METHOD__, $options=[])
 Update all rows in a table that match a given condition. More...
 
 upsert ( $table, array $rows, $uniqueKeys, array $set, $fname=__METHOD__)
 Upsert row(s) into a table, in the provided order, while updating conflicting rows. More...
 
 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
Returns
bool
Since
1.31
More...
 
 wasErrorReissuable ()
 Determines if the last query error was due to something outside of the query itself. More...
 
 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
Returns
bool
More...
 
 writesOrCallbacksPending ()
 Whether there is a transaction open with either possible write queries or unresolved pre-commit/commit/resolution callbacks pending. More...
 
 writesPending ()
 
- Public Member Functions inherited from Wikimedia\Rdbms\Platform\ISQLPlatform
 buildSubString ( $input, $startPosition, $length=null)
 Build a SUBSTRING function. More...
 

Static Public Member Functions

static generateFileName ( $dir, $dbName)
 Generates a database file name. More...
 
static getAttributes ()
 
static getFulltextSearchModule ()
 Returns version of currently supported SQLite fulltext search module or false if none present. More...
 
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. More...
 
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. More...
 

Protected Member Functions

 closeConnection ()
 Does not actually close the connection, just destroys the reference for GC to do its work. More...
 
 doBegin ( $fname='')
 Issues the BEGIN command to the database server. More...
 
 doFlushSession ( $fname)
 Reset the server-side session state for named locks and table locks. More...
 
 doHandleSessionLossPreconnect ()
 Reset any additional subclass trx* and session* fields. More...
 
 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. More...
 
 doTruncate (array $tables, $fname)
 
 fetchAffectedRowCount ()
 
 getBindingHandle ()
 
 isConnectionError ( $errno)
 Do not use this method outside of Database/DBError classes. More...
 
 isKnownStatementRollbackError ( $errno)
 
 open ( $server, $user, $password, $db, $schema, $tablePrefix)
 Open a new connection to the database (closing any existing one) More...
 
- Protected Member Functions inherited from Wikimedia\Rdbms\Database
 assertHasConnectionHandle ()
 Make sure there is an open connection handle (alive or not) More...
 
 assertIsWritablePrimary ()
 Make sure that this server is not marked as a replica nor read-only. More...
 
 commenceCriticalSection (string $fname)
 Demark the start of a critical section of session/transaction state changes. More...
 
 completeCriticalSection (string $fname, ?CriticalSectionScope $csm, Throwable $trxError=null)
 Demark the completion of a critical section of session/transaction state changes. More...
 
 doCommit ( $fname)
 Issues the COMMIT command to the database server. More...
 
 doGetLag ()
 Get the amount of replication lag for this database server. More...
 
 doInitConnection ()
 Actually connect to the database over the wire (or to local files) More...
 
 doInsertSelectGeneric ( $destTable, $srcTable, array $varMap, $conds, $fname, array $insertOptions, array $selectOptions, $selectJoinConds)
 Implementation of insertSelect() based on select() and insert() More...
 
 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. More...
 
 doMultiStatementQuery (array $sqls)
 Execute a batch of query statements, aborting remaining statements if one fails. More...
 
 doUpsert (string $table, array $rows, array $identityKey, array $set, string $fname)
 Perform an UPSERT query. More...
 
 executeQuery ( $sqls, $fname, $flags, $summarySql)
 Execute a set of queries without enforcing public (non-Database) caller restrictions. More...
 
 fieldHasBit (int $flags, int $bit)
 
 getApproximateLagStatus ()
 Get a replica DB lag estimate for this server at the start of a transaction. More...
 
 getLastPHPError ()
 
 getLogContext (array $extras=[])
 Create a log context to pass to PSR-3 logger functions. More...
 
 getReadOnlyReason ()
 
 getRecordedTransactionLagStatus ()
 Get the replica DB lag when the current transaction started. More...
 
 getTempTableWrites ( $sql, $pseudoPermanent)
 
 getTransactionRoundId ()
 
 indexName ( $index)
 
 installErrorHandler ()
 Set a custom error handler for logging errors during database connection. More...
 
 isInsertSelectSafe (array $insertOptions, array $selectOptions)
 
 isPristineTemporaryTable ( $table)
 Check if the table is both a TEMPORARY table and has not yet received CRUD operations. More...
 
 isQueryTimeoutError ( $errno)
 Checks whether the cause of the error is detected to be a timeout. More...
 
 newExceptionAfterConnectError ( $error)
 
 registerTempWrites ( $ret, array $changes)
 
 replaceLostConnection ( $lastErrno, $fname)
 Close any existing (dead) database connection and open a new connection. More...
 
 restoreErrorHandler ()
 Restore the previous error handler and return the last PHP error for this DB. More...
 

Protected Attributes

PDO null $conn
 
string null $dbDir
 Directory for SQLite database files listed under their DB name. More...
 
string null $dbPath
 Explicit path for the SQLite database file. More...
 
int $lastAffectedRowCount
 The number of rows affected as an integer. More...
 
LockManager null $lockMgr
 (hopefully on the same server as the DB) More...
 
ISQLPlatform $platform
 
string $trxMode
 Transaction mode. More...
 
- Protected Attributes inherited from Wikimedia\Rdbms\Database
int null $affectedRowCount
 Rows affected by the last query to query() or its CRUD wrappers. More...
 
string $agent
 Agent name for query profiling. More...
 
bool $cliMode
 Whether this PHP instance is for a CLI script. More...
 
object resource null $conn
 Database connection. More...
 
array< string, mixed > $connectionParams
 Connection parameters used by initConnection() and open() More...
 
string[] int[] float[] $connectionVariables
 SQL variables values to use for all new connections. More...
 
LoggerInterface $connLogger
 
CriticalSectionProvider null $csProvider
 
DatabaseDomain $currentDomain
 
string false $delimiter = ';'
 Current SQL query delimiter. More...
 
callable $deprecationLogger
 Deprecation logging callback. More...
 
callable $errorLogger
 Error logging callback. More...
 
int $flags
 Current bit field of class DBO_* constants. More...
 
array $lbInfo = []
 Current LoadBalancer tracking information. More...
 
int $nonNativeInsertSelectBatchSize
 Row batch size to use for emulated INSERT SELECT queries. More...
 
string null $password
 Password used to establish the current connection. More...
 
SQLPlatform $platform
 
callable null $profiler
 
LoggerInterface $queryLogger
 
LoggerInterface $replLogger
 
string null $server
 Server that this instance is currently connected to. More...
 
string null $serverName
 Readable name or host/IP of the database server. More...
 
array< string, array > $sessionNamedLocks = []
 Map of (name => (UNIX time,trx ID)) for current lock() mutexes. More...
 
array< string, array > $sessionTempTables = []
 Map of (name => (type,pristine,trx ID)) for current temp tables. More...
 
BagOStuff $srvCache
 APC cache. More...
 
bool $ssl
 Whether to use SSL connections. More...
 
IDatabase $topologicalPrimaryConnRef
 Lazy handle to the most authoritative primary server for the dataset. More...
 
string $topologyRole
 Replication topology role of the server; one of the class ROLE_* constants. More...
 
string null $user
 User that this instance is currently connected under the name of. More...
 
const CONN_HOST = 'host'
 Hostname or IP address to use on all connections. More...
 
const CONN_INITIAL_DB = 'dbname'
 Database name to use on initial connection. More...
 
const CONN_INITIAL_SCHEMA = 'schema'
 Schema name to use on initial connection. More...
 
const CONN_INITIAL_TABLE_PREFIX = 'tablePrefix'
 Table prefix to use on initial connection. More...
 
const CONN_PASSWORD = 'password'
 Database server password to use on all connections. More...
 
const CONN_USER = 'user'
 Database server username to use on all connections. More...
 
const DROPPED_CONN_BLAME_THRESHOLD_SEC = 3.0
 Assume that queries taking this long to yield connection loss errors are at fault. More...
 
const ERR_ABORT_QUERY = 2
 Abort query (no retries) due to a statement rollback (session/transaction intact) More...
 
const ERR_ABORT_SESSION = 8
 Abort and reset session due to server-side session-level state loss (locks, temp tables) More...
 
const ERR_ABORT_TRX = 4
 Abort any current transaction, by rolling it back, due to an error during the query. More...
 
const ERR_NONE = 0
 No errors occurred during the query. More...
 
const ERR_RETRY_QUERY = 1
 Retry query due to a connection loss detected while sending the query (session intact) More...
 

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) More...
 
- 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) More...
 

Detailed Description

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.

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)
    Parameters
    array$params

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 85 of file DatabaseSqlite.php.

Member Function Documentation

◆ addQuotes()

Wikimedia\Rdbms\DatabaseSqlite::addQuotes (   $s)
Parameters
string | int | float | null | bool | Blob$s
Returns
string

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 680 of file DatabaseSqlite.php.

References $s.

◆ attachDatabase()

Wikimedia\Rdbms\DatabaseSqlite::attachDatabase (   $name,
  $file = false,
  $fname = __METHOD__ 
)

Attaches external database to the connection handle.

See also
https://sqlite.org/lang_attach.html
Parameters
string$nameDatabase name to be used in queries like SELECT foo FROM dbname.table
bool | string$fileDatabase file name. If omitted, will be generated using $name and configured data directory
string$fnameCalling function name
Returns
IResultWrapper

Definition at line 366 of file DatabaseSqlite.php.

References $file.

◆ closeConnection()

Wikimedia\Rdbms\DatabaseSqlite::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 274 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
Stability: stable
to override

Stability: stable
to override

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 910 of file DatabaseSqlite.php.

◆ deadlockLoop()

Wikimedia\Rdbms\DatabaseSqlite::deadlockLoop (   $args)

No-op version of deadlockLoop.

Parameters
mixed...$args
Returns
mixed

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 715 of file DatabaseSqlite.php.

References $args.

◆ decodeBlob()

Wikimedia\Rdbms\DatabaseSqlite::decodeBlob (   $b)
Parameters
Blob | string$b
Returns
string

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 668 of file DatabaseSqlite.php.

◆ doBegin()

Wikimedia\Rdbms\DatabaseSqlite::doBegin (   $fname = '')
protected

Issues the BEGIN command to the database server.

See also
Database::begin()
Stability: stable
to override
Parameters
string$fname
Exceptions
DBError

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 640 of file DatabaseSqlite.php.

◆ doFlushSession()

Wikimedia\Rdbms\DatabaseSqlite::doFlushSession (   $fname)
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 922 of file DatabaseSqlite.php.

◆ doHandleSessionLossPreconnect()

Wikimedia\Rdbms\DatabaseSqlite::doHandleSessionLossPreconnect ( )
protected

Reset any additional subclass trx* and session* fields.

Stability: stable
to override

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 914 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
Stability: stable
to override

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 726 of file DatabaseSqlite.php.

References LockManager\LOCK_EX.

◆ doLockIsFree()

Wikimedia\Rdbms\DatabaseSqlite::doLockIsFree ( string  $lockName,
string  $method 
)
See also
lockIsFree()
Parameters
string$lockName
string$method
Returns
bool Success
Exceptions
DBError
Stability: stable
to override

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 721 of file DatabaseSqlite.php.

◆ doReplace()

Wikimedia\Rdbms\DatabaseSqlite::doReplace (   $table,
array  $identityKey,
array  $rows,
  $fname 
)
protected
Parameters
string$table
string[]$identityKeyList of columns defining a unique key
array$rowsNon-empty list of rows
string$fname
See also
Database::replace()
Stability: stable
to override
Since
1.35

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 536 of file DatabaseSqlite.php.

◆ doSelectDomain()

Wikimedia\Rdbms\DatabaseSqlite::doSelectDomain ( DatabaseDomain  $domain)
protected
Stability: stable
to override
Parameters
DatabaseDomain$domain
Exceptions
DBConnectionError
DBError
Since
1.32

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().

◆ doSingleStatementQuery()

Wikimedia\Rdbms\DatabaseSqlite::doSingleStatementQuery ( string  $sql)
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$sqlSingle-statement SQL query
Returns
QueryStatus
Since
1.39

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 377 of file DatabaseSqlite.php.

◆ doTruncate()

Wikimedia\Rdbms\DatabaseSqlite::doTruncate ( array  $tables,
  $fname 
)
protected
See also
Database::truncate()
Stability: stable
to override
Parameters
string[]$tables
string$fname

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 866 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
Stability: stable
to override

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 738 of file DatabaseSqlite.php.

References LockManager\LOCK_EX.

◆ 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 750 of file DatabaseSqlite.php.

References $res.

◆ encodeBlob()

Wikimedia\Rdbms\DatabaseSqlite::encodeBlob (   $b)
Parameters
string$b
Returns
Blob

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 660 of file DatabaseSqlite.php.

◆ fetchAffectedRowCount()

Wikimedia\Rdbms\DatabaseSqlite::fetchAffectedRowCount ( )
protected
Returns
int

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 465 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 624 of file DatabaseSqlite.php.

References $res.

◆ generateFileName()

static Wikimedia\Rdbms\DatabaseSqlite::generateFileName (   $dir,
  $dbName 
)
static

Generates a database file name.

Explicitly public for installer.

Parameters
string$dirDirectory where database resides
string | bool$dbNameDatabase name (or false from Database::factory, validated here)
Returns
string
Exceptions
DBUnexpectedError

Definition at line 289 of file DatabaseSqlite.php.

Referenced by Wikimedia\Rdbms\DatabaseSqlite\getDbFilePath(), and Wikimedia\Rdbms\DatabaseSqlite\open().

◆ getAttributes()

static Wikimedia\Rdbms\DatabaseSqlite::getAttributes ( )
static
Stability: stable
to override
Returns
array Map of (Database::ATTR_* constant => value)
Since
1.31

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 108 of file DatabaseSqlite.php.

References true.

◆ getBindingHandle()

Wikimedia\Rdbms\DatabaseSqlite::getBindingHandle ( )
protected
Returns
PDO

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 932 of file DatabaseSqlite.php.

◆ getDbFilePath()

Wikimedia\Rdbms\DatabaseSqlite::getDbFilePath ( )
Returns
string|null SQLite DB file path
Exceptions
DBUnexpectedError
Since
1.25

Definition at line 236 of file DatabaseSqlite.php.

References Wikimedia\Rdbms\DatabaseSqlite\generateFileName(), and Wikimedia\Rdbms\Database\getDBname().

◆ getFulltextSearchModule()

static Wikimedia\Rdbms\DatabaseSqlite::getFulltextSearchModule ( )
static

Returns version of currently supported SQLite fulltext search module or false if none present.

Returns
string|false

Definition at line 333 of file DatabaseSqlite.php.

◆ getLockFileDirectory()

Wikimedia\Rdbms\DatabaseSqlite::getLockFileDirectory ( )
Returns
string|null Lock file directory

Definition at line 243 of file DatabaseSqlite.php.

◆ getServerVersion()

Wikimedia\Rdbms\DatabaseSqlite::getServerVersion ( )
Returns
string Version information from the database

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 608 of file DatabaseSqlite.php.

Referenced by SqliteInstaller\checkPrerequisites().

◆ getSoftwareLink()

Wikimedia\Rdbms\DatabaseSqlite::getSoftwareLink ( )
Returns
string Wikitext of a link to the server software's web site

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 601 of file DatabaseSqlite.php.

◆ getTopologyBasedServerId()

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.

Returns
string|null 32, 64, or 128 bit integer ID; null if not applicable or unknown
Exceptions
DBQueryError
Since
1.37

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 585 of file DatabaseSqlite.php.

◆ getType()

Wikimedia\Rdbms\DatabaseSqlite::getType ( )
Returns
string

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 138 of file DatabaseSqlite.php.

◆ indexInfo()

Wikimedia\Rdbms\DatabaseSqlite::indexInfo (   $table,
  $index,
  $fname = __METHOD__ 
)

Returns information about an index Returns false if the index does not exist.

  • if errors are explicitly ignored, returns NULL on failure
Parameters
string$table
string$index
string$fname
Returns
array|false

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 495 of file DatabaseSqlite.php.

References $res.

◆ indexUnique()

Wikimedia\Rdbms\DatabaseSqlite::indexUnique (   $table,
  $index,
  $fname = __METHOD__ 
)
Parameters
string$table
string$index
string$fname
Returns
bool|null

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 515 of file DatabaseSqlite.php.

◆ insertId()

Wikimedia\Rdbms\DatabaseSqlite::insertId ( )

This must be called after nextSequenceVal.

Returns
int

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 431 of file DatabaseSqlite.php.

◆ isConnectionError()

Wikimedia\Rdbms\DatabaseSqlite::isConnectionError (   $errno)
protected

Do not use this method outside of Database/DBError classes.

Stability: stable
to override
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 573 of file DatabaseSqlite.php.

◆ isKnownStatementRollbackError()

Wikimedia\Rdbms\DatabaseSqlite::isKnownStatementRollbackError (   $errno)
protected
Stability: stable
to override
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 577 of file DatabaseSqlite.php.

◆ lastErrno()

Wikimedia\Rdbms\DatabaseSqlite::lastErrno ( )
Returns
int

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 451 of file DatabaseSqlite.php.

◆ lastError()

Wikimedia\Rdbms\DatabaseSqlite::lastError ( )
Returns
string

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 439 of file DatabaseSqlite.php.

◆ listTables()

Wikimedia\Rdbms\DatabaseSqlite::listTables (   $prefix = null,
  $fname = __METHOD__ 
)

List all tables on the database.

Parameters
string | null$prefixOnly show tables with this prefix, e.g. mw_
string$fnameCalling function name
Returns
array

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 843 of file DatabaseSqlite.php.

◆ newStandaloneInstance()

static Wikimedia\Rdbms\DatabaseSqlite::newStandaloneInstance (   $filename,
array  $p = [] 
)
static
Parameters
string$filename
array$pOptions 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 124 of file DatabaseSqlite.php.

References Wikimedia\Rdbms\Database\factory().

◆ open()

Wikimedia\Rdbms\DatabaseSqlite::open (   $server,
  $user,
  $password,
  $db,
  $schema,
  $tablePrefix 
)
protected

Open a new connection to the database (closing any existing one)

Parameters
string | null$serverServer host/address and optional port {
See also
connectionParams}
Parameters
string | null$userUser name {
See also
connectionParams}
Parameters
string | null$passwordUser password {
See also
connectionParams}
Parameters
string | null$dbDatabase name
string | null$schemaDatabase schema name
string$tablePrefix
Exceptions
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(), DBO_DEFAULT, DBO_PERSISTENT, DBO_TRX, Wikimedia\Rdbms\DatabaseSqlite\generateFileName(), Wikimedia\Rdbms\Database\getFlag(), Wikimedia\Rdbms\Database\getLogContext(), Wikimedia\Rdbms\Database\newExceptionAfterConnectError(), Wikimedia\Rdbms\Database\query(), and true.

◆ serverIsReadOnly()

Wikimedia\Rdbms\DatabaseSqlite::serverIsReadOnly ( )

Returns
bool Whether the DB is marked as read-only server-side
Exceptions
DBErrorIf an error occurs, {
See also
query}
Since
1.28
Stability: stable
to override

Stability: stable
to override

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 590 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[]$aliasesMap 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 888 of file DatabaseSqlite.php.

◆ strencode()

Wikimedia\Rdbms\DatabaseSqlite::strencode (   $s)
Parameters
string$s
Returns
string

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 652 of file DatabaseSqlite.php.

References $s.

◆ tableExists()

Wikimedia\Rdbms\DatabaseSqlite::tableExists (   $table,
  $fname = __METHOD__ 
)

Query whether a given table exists.

Parameters
string$table
string$fname
Returns
bool
Exceptions
DBErrorIf an error occurs, {
See also
query}

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 469 of file DatabaseSqlite.php.

References $res, and true.

◆ textFieldSize()

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.

Parameters
string$table
string$field
Returns
int

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 555 of file DatabaseSqlite.php.

◆ wasDeadlock()

Wikimedia\Rdbms\DatabaseSqlite::wasDeadlock ( )
Returns
bool

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 562 of file DatabaseSqlite.php.

◆ wasReadOnlyError()

Wikimedia\Rdbms\DatabaseSqlite::wasReadOnlyError ( )
Returns
bool

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 569 of file DatabaseSqlite.php.

Member Data Documentation

◆ $conn

PDO null Wikimedia\Rdbms\DatabaseSqlite::$conn
protected

Definition at line 51 of file DatabaseSqlite.php.

◆ $dbDir

string null Wikimedia\Rdbms\DatabaseSqlite::$dbDir
protected

Directory for SQLite database files listed under their DB name.

Definition at line 41 of file DatabaseSqlite.php.

◆ $dbPath

string null Wikimedia\Rdbms\DatabaseSqlite::$dbPath
protected

Explicit path for the SQLite database file.

Definition at line 43 of file DatabaseSqlite.php.

Referenced by Wikimedia\Rdbms\DatabaseSqlite\open().

◆ $lastAffectedRowCount

int Wikimedia\Rdbms\DatabaseSqlite::$lastAffectedRowCount
protected

The number of rows affected as an integer.

Definition at line 48 of file DatabaseSqlite.php.

◆ $lockMgr

LockManager null Wikimedia\Rdbms\DatabaseSqlite::$lockMgr
protected

(hopefully on the same server as the DB)

Definition at line 54 of file DatabaseSqlite.php.

◆ $platform

ISQLPlatform Wikimedia\Rdbms\DatabaseSqlite::$platform
protected
Initial value:
=[[,,,],[,],]
private const VALID_PRAGMAS
'synchronous' => 'EXTRA' 'FULL' 'NORMAL' 'OFF'
'temp_store' => 'FILE' 'MEMORY'
'mmap_size' => 'integer'

Definition at line 76 of file DatabaseSqlite.php.

◆ $trxMode

string Wikimedia\Rdbms\DatabaseSqlite::$trxMode
protected

Transaction mode.

Definition at line 45 of file DatabaseSqlite.php.


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