MediaWiki  master
Wikimedia\Rdbms\DatabaseSqlite Class Reference
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...
 
 buildConcat ( $stringList)
 Build a concatenation list to feed into a SQL query. More...
 
 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.
Parameters
string | string[]$fieldsName(s) of column(s) with values to compare
string | int | float | string[] | int[] | float[]$valuesValues to compare
Returns
mixed
Since
1.35
Stable to override Stable to override More...
 
 buildGroupConcatField ( $delim, $table, $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.
Parameters
string$delimGlue to bind the results together
string | array$tableTable name
string$fieldField name
string | array$condsConditions
string | array$join_condsJoin conditions
Returns
string SQL text
Since
1.23
Stable to override Stable to override More...
 
 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.
Parameters
string | string[]$fieldsName(s) of column(s) with values to compare
string | int | float | string[] | int[] | float[]$valuesValues to compare
Returns
mixed
Since
1.35
Stable to override Stable to override More...
 
 buildStringCast ( $field)
 
 buildSubstring ( $input, $startPosition, $length=null)
 Stable to override Stable to override 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
Stable to override Stable to override More...
 
 dataSeek ( $res, $row)
 
 deadlockLoop (... $args)
 No-op version of deadlockLoop. More...
 
 decodeBlob ( $b)
 
 dropTable ( $table, $fname=__METHOD__)
 Delete a table. More...
 
 duplicateTableStructure ( $oldName, $newName, $temporary=false, $fname=__METHOD__)
 
 encodeBlob ( $b)
 
 fetchObject ( $res)
 
 fetchRow ( $res)
 
 fieldInfo ( $table, $field)
 Get information about a given field Returns false if the field does not exist. More...
 
 fieldName ( $res, $n)
 
 freeResult ( $res)
 
 getDbFilePath ()
 
 getLockFileDirectory ()
 
 getServerVersion ()
 
 getSoftwareLink ()
 
 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...
 
 lock ( $lockName, $method, $timeout=5)
 Acquire a named lock.Named locks are not related to transactions
Parameters
string$lockNameName of lock to aquire
string$methodName of the calling method
int$timeoutAcquisition timeout in seconds (0 means non-blocking)
Returns
bool Success
Exceptions
DBErrorIf an error occurs, see IDatabase::query()
Stable to override Stable to override More...
 
 numFields ( $res)
 
 numRows ( $res)
 The PDO::Statement class implements the array interface so count() will work. More...
 
 serverIsReadOnly ()
 
Returns
bool Whether the DB is marked as read-only server-side
Since
1.28
Stable to override 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.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
Stable to override Stable to override More...
 
 strencode ( $s)
 
 tableExists ( $table, $fname=__METHOD__)
 Query whether a given table exists. More...
 
 tableName ( $name, $format='quoted')
 Use MySQL's naming (accounts for prefix etc) but remove surrounding backticks. More...
 
 textFieldSize ( $table, $field)
 Returns the size of a text field, or -1 for "unlimited" In SQLite this is SQLITE_MAX_LENGTH, by default 1GB. More...
 
 unionQueries ( $sqls, $all)
 
 unionSupportsOrderAndLimit ()
 
 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 IDatabase::query()
Stable to override Stable to override More...
 
 wasConnectionError ( $errno)
 Do not use this method outside of Database/DBError classes. 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 sanity 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.table, column, database) for use in a SQL queryDepending on the database this will either be backticks or "double quotes"
Parameters
string$s
Returns
string
Since
1.33
Stable to override More...
 
 affectedRows ()
 Get the number of rows affected by the last write query. More...
 
 aggregateValue ( $valuedata, $valuename='value')
 Return aggregated value alias.
Parameters
array$valuedata
string$valuename
Returns
array|string
Deprecated:
Since 1.33
Stable to override 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...
 
 assertNoOpenTransactions ()
 Assert that all explicit transactions or atomic sections have been closed. More...
 
 begin ( $fname=__METHOD__, $mode=self::TRANSACTION_EXPLICIT)
 Begin a transaction. More...
 
 bitAnd ( $fieldLeft, $fieldRight)
 
Parameters
string | int$fieldLeft
string | int$fieldRight
Returns
string
Stable to override More...
 
 bitNot ( $field)
 
Parameters
string | int$field
Returns
string
Stable to override More...
 
 bitOr ( $fieldLeft, $fieldRight)
 
Parameters
string | int$fieldLeft
string | int$fieldRight
Returns
string
Stable to override More...
 
 buildIntegerCast ( $field)
 
Parameters
string$fieldField or column to cast
Returns
string
Since
1.31
Stable to override More...
 
 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 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 );
Since
1.16
Parameters
array[] | string | LikeMatch$param
string|LikeMatch...$params
Returns
string Fully built LIKE statement
Stable to override More...
 
 buildSelectSubquery ( $table, $vars, $conds='', $fname=__METHOD__, $options=[], $join_conds=[])
 Equivalent to IDatabase::selectSQLText() except wraps the result in Subquery. More...
 
 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__, $owner=null)
 Close the database connection. More...
 
 commit ( $fname=__METHOD__, $flush=self::FLUSHING_ONE)
 Commits a transaction previously started using begin() More...
 
 conditional ( $cond, $trueVal, $falseVal)
 Returns an SQL expression for a simple conditional.This doesn't need to be overridden unless CASE isn't supported in the RDBMS.
Parameters
string | array$condSQL expression which will result in a boolean value
string$trueValSQL expression to return if true
string$falseValSQL expression to return if false
Returns
string SQL fragment
Stable to override More...
 
 connectionErrorLogger ( $errno, $errstr)
 Error handler for logging errors during database connection This method should not be used outside of Database classes. 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 where the condition is a join.MySQL overrides this to use a multi-table DELETE syntax, in other databases we use sub-selectsFor 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 IDatabase::query()
Stable to override More...
 
 doAtomicSection ( $fname, callable $callback, $cancelable=self::ATOMIC_NOT_CANCELABLE)
 Perform an atomic section of reversable SQL statements from a callback. 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().
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 IDatabase::query()
Stable to override More...
 
 explicitTrxActive ()
 
 fieldExists ( $table, $field, $fname=__METHOD__)
 Determines whether a field exists in a table. 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 DB name. 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.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.
Returns
string
Stable to override 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...
 
 getMasterPos ()
 Get the position of this master.
Returns
DBMasterPos|bool False if this is not a master
Exceptions
DBErrorIf an error occurs, see IDatabase::query()
Stable to override More...
 
 getReplicaPos ()
 Get the replication position of this replica DB.
Returns
DBMasterPos|bool False if this is not a replica DB
Exceptions
DBErrorIf an error occurs, see IDatabase::query()
Stable to override More...
 
 getScopedLockAndFlush ( $lockKey, $fname, $timeout)
 Acquire a named lock, flush any transaction, and return an RAII style unlocker object. More...
 
 getServer ()
 Get the server hostname or IP address. More...
 
 getServerInfo ()
 Get a human-readable string describing the current software version. More...
 
 getServerUptime ()
 Determines how long the server has been up.
Returns
int
Exceptions
DBError
Stable to override More...
 
 getSessionLagStatus ()
 Get the replica DB lag when the current transaction started or a general lag estimate if not transaction is active. More...
 
 getTopologyRole ()
 Get the replication topology role of this server. More...
 
 getTopologyRootMaster ()
 Get the host (or address) of the root master server for the replication topology. More...
 
 ignoreIndexClause ( $index)
 IGNORE INDEX clause. 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.
Returns
bool
Stable to override 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 the given row(s) into a table. More...
 
 insertSelect ( $destTable, $srcTable, $varMap, $conds, $fname=__METHOD__, $insertOptions=[], $selectOptions=[], $selectJoinConds=[])
 INSERT SELECT wrapper. More...
 
 isOpen ()
 
 isQuotedIdentifier ( $name)
 Returns if the given identifier looks quoted or not according to the database convention for quoting identifiers. More...
 
 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.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.
Parameters
string$sqlSQL query we will append the limit too
int$limitThe SQL limit
int | bool$offsetThe SQL offset (default false)
Returns
string
Since
1.34
Stable to override 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
Stable to override 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 IDatabase::query()
Since
1.20
Stable to override More...
 
 lockTables (array $read, array $write, $method)
 Lock specific tables. 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...
 
 masterPosWait (DBMasterPos $pos, $timeout)
 Wait for the replica DB to catch up to a given master 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
DBMasterPos$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 IDatabase::query()
Stable to override More...
 
 maxListLen ()
 Return the maximum number of items allowed in a list, or 0 for unlimited.
Returns
int
Stable to override More...
 
 namedLocksEnqueue ()
 Check to see if a named lock used by lock() use blocking queues.
Returns
bool
Since
1.26
Stable to override More...
 
 newSelectQueryBuilder ()
 Create an empty SelectQueryBuilder which can be used to run queries against this connection.
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 as soon as there is no transaction pending. More...
 
 onTransactionIdle (callable $callback, $fname=__METHOD__)
 Alias for onTransactionCommitOrIdle() for backwards-compatibility. 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 as soon as the current transaction commits or rolls back. More...
 
 pendingWriteAndCallbackCallers ()
 List the methods that have write queries or callbacks for the current transaction. More...
 
 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...
 
 pendingWriteRowsAffected ()
 Get the number of affected rows from pending write queries. More...
 
 ping (&$rtt=null)
 Ping the server and try to reconnect if it there is no connection. More...
 
 preCommitCallbacksPending ()
 
 query ( $sql, $fname=__METHOD__, $flags=self::QUERY_NORMAL)
 Run an SQL query and return the result. More...
 
 replace ( $table, $uniqueKeys, $rows, $fname=__METHOD__)
 Insert row(s) into a table, deleting all conflicting rows beforehand. 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)
 Actually consume and run any "on transaction idle/resolution" callbacks. More...
 
 runOnTransactionPreCommitCallbacks ()
 Actually consume and run any "on transaction pre-commit" callbacks. More...
 
 runTransactionListenerCallbacks ( $trigger)
 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.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().
See also
IDatabase::select()
Parameters
string | array$tableTable name
string | array$varsField names
string | array$condsConditions
string$fnameCaller function name
string | array$optionsQuery options
string | array$join_condsJoin conditions
Returns
string SQL query string
Stable to override More...
 
 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
Stable to override 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.Note that this applies to indexes regardless of the table they belong to.This can be employed when an index was renamed X => Y in code, but the new Y-named indexes were not yet built on all DBs. After all the Y-named ones are added by the DBA, the aliases can be removed, and then the old X-named indexes dropped.
Parameters
string[]$aliases
Since
1.31
Stable to override 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 IDatabase::query()
Stable to override More...
 
 setTransactionListener ( $name, callable $callback=null)
 Run a callback after each time any transaction commits or rolls back. More...
 
 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.REPLACE() in mysql)
Parameters
string$origColumn to modify
string$oldColumn to seek
string$newColumn to replace with
Returns
string
Stable to override More...
 
 tableLocksHaveTransactionScope ()
 Checks if table locks acquired by lockTables() are transaction-bound in their scope. More...
 
 tableNames (... $tables)
 Fetch a number of table names into an array This is handy when you need to construct SQL for joins. More...
 
 tableNamesN (... $tables)
 Fetch a number of table names into an zero-indexed numerical array This is handy when you need to construct SQL for joins. 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.The result is unquoted, and needs to be passed through addQuotes() before it can be included in raw SQL.
Parameters
string | int$ts
Returns
string
Stable to override 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...
 
 unlockTables ( $method)
 Unlock all tables locked via lockTables() 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 the given row(s) into a table. More...
 
 useIndexClause ( $index)
 USE INDEX clause. 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
Stable to override 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
Stable to override 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\IDatabase
 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 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 $db1, IDatabase $db2=null)
 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...
 
 doHandleSessionLossPreconnect ()
 Reset any additional subclass trx* and session* fields Stable to override. More...
 
 doQuery ( $sql)
 SQLite doesn't allow buffered results or data seeking etc, so we'll use fetchAll as the result. More...
 
 doReplace ( $table, array $uniqueKeys, array $rows, $fname)
 
 doSelectDomain (DatabaseDomain $domain)
 Stable to override. More...
 
 doTruncate (array $tables, $fname)
 
 fetchAffectedRowCount ()
 
 getBindingHandle ()
 
 isTransactableQuery ( $sql)
 Determine whether a SQL statement is sensitive to isolation level. More...
 
 isWriteQuery ( $sql, $flags)
 Determine whether a query writes to the DB. More...
 
 makeInsertNonConflictingVerbAndOptions ()
 Stable to override. More...
 
 makeSelectOptions (array $options)
 Returns an optional USE INDEX clause to go after the table, and a string to go at the end of the query. More...
 
 makeUpdateOptionsArray ( $options)
 
 open ( $server, $user, $pass, $dbName, $schema, $tablePrefix)
 Open a new connection to the database (closing any existing one) More...
 
 replaceVars ( $s)
 
 wasKnownStatementRollbackError ()
 Stable to override. More...
 
- Protected Member Functions inherited from Wikimedia\Rdbms\Database
 assertBuildSubstringParams ( $startPosition, $length)
 Check type and bounds for parameters to self::buildSubstring() More...
 
 assertConditionIsNotEmpty ( $conds, string $fname, bool $deprecate)
 Check type and bounds conditions parameters for update. More...
 
 assertHasConnectionHandle ()
 Make sure there is an open connection handle (alive or not) as a sanity check. More...
 
 assertIsWritableMaster ()
 Make sure that this server is not marked as a replica nor read-only as a sanity check. More...
 
 buildSuperlative ( $sqlfunc, $fields, $values)
 Build a superlative function statement comparing columns/values. More...
 
 doCommit ( $fname)
 Issues the COMMIT command to the database server. More...
 
 doDropTable ( $table, $fname)
 
 doGetLag ()
 Stable to override More...
 
 doInitConnection ()
 Actually connect to the database over the wire (or to local files) More...
 
 doInsert ( $table, array $rows, $fname)
 
 doInsertNonConflicting ( $table, array $rows, $fname)
 
 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...
 
 doLockTables (array $read, array $write, $method)
 Helper function for lockTables() that handles the actual table locking. More...
 
 doReleaseSavepoint ( $identifier, $fname)
 Release a savepoint. More...
 
 doRollback ( $fname)
 Issues the ROLLBACK command to the database server. More...
 
 doRollbackToSavepoint ( $identifier, $fname)
 Rollback to a savepoint. More...
 
 doSavepoint ( $identifier, $fname)
 Create a savepoint. More...
 
 doUnlockTables ( $method)
 Helper function for unlockTables() that handles the actual table unlocking. More...
 
 doUpsert ( $table, array $rows, array $uniqueKeys, array $set, $fname)
 
 escapeLikeInternal ( $s, $escapeChar='`')
 Stable to override. More...
 
 executeQuery ( $sql, $fname, $flags)
 Execute a query, retrying it if there is a recoverable connection loss. More...
 
 extractSingleFieldFromList ( $var)
 
 fieldHasBit ( $field, $flags)
 
 fieldNamesWithAlias ( $fields)
 Gets an array of aliased field names. More...
 
 fieldNameWithAlias ( $name, $alias=false)
 Get an aliased field name e.g. More...
 
 getApproximateLagStatus ()
 Get a replica DB lag estimate for this server at the start of a transaction. More...
 
 getDefaultSchemaVars ()
 Get schema variables to use if none have been set via setSchemaVars(). More...
 
 getLastPHPError ()
 
 getLazyMasterHandle ()
 Get a handle to the master server of the cluster to which this server belongs. More...
 
 getLogContext (array $extras=[])
 Create a log context to pass to PSR-3 logger functions. More...
 
 getQueryVerb ( $sql)
 
 getReadOnlyReason ()
 
 getRecordedTransactionLagStatus ()
 Get the replica DB lag when the current transaction started. More...
 
 getSchemaVars ()
 Get schema variables. More...
 
 getTempTableWrites ( $sql, $pseudoPermanent)
 
 getTransactionRoundId ()
 
 indexName ( $index)
 Allows for index remapping in queries where this is not consistent across DBMS. More...
 
 installErrorHandler ()
 Set a custom error handler for logging errors during database connection. More...
 
 isFlagInOptions ( $option, array $options)
 
 isInsertSelectSafe (array $insertOptions, array $selectOptions)
 Stable to override. More...
 
 isPristineTemporaryTable ( $table)
 Check if the table is both a TEMPORARY table and has not yet received CRUD operations. More...
 
 makeConditionCollidesUponKeys (array $rows, array $uniqueKeys)
 
 makeGroupByWithHaving ( $options)
 Returns an optional GROUP BY with an optional HAVING. More...
 
 makeInsertLists (array $rows)
 Make SQL lists of columns, row tuples for INSERT/VALUES expressions. More...
 
 makeOrderBy ( $options)
 Returns an optional ORDER BY. More...
 
 makeUpdateOptions ( $options)
 Make UPDATE options for the Database::update function. More...
 
 newExceptionAfterConnectError ( $error)
 
 normalizeConditions ( $conds, $fname)
 
 normalizeOptions ( $options)
 
 normalizeRowArray (array $rowOrRows)
 
 normalizeUpsertKeys ( $uniqueKeys)
 
 qualifiedTableComponents ( $name)
 Get the table components needed for a query given the currently selected database. More...
 
 registerTempWrites ( $ret, array $changes)
 
 relationSchemaQualifier ()
 Stable to override. More...
 
 replaceLostConnection ( $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...
 
 resultObject ( $result)
 Take a query result and wrap it in an iterable result wrapper if necessary. More...
 
 tableNamesWithIndexClauseOrJOIN ( $tables, $use_index=[], $ignore_index=[], $join_conds=[])
 Get the aliased table name clause for a FROM clause which might have a JOIN and/or USE INDEX or IGNORE INDEX clause. More...
 
 tableNameWithAlias ( $table, $alias=false)
 Get an aliased table name. More...
 
 wasQueryTimeout ( $error, $errno)
 Checks whether the cause of the error is detected to be a timeout. More...
 

Static Protected Member Functions

static getAttributes ()
 Stable to override. More...
 

Protected Attributes

PDO $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...
 
FSLockManager $lockMgr
 (hopefully on the same server as the DB) More...
 
string $trxMode
 Transaction mode. More...
 
- Protected Attributes inherited from Wikimedia\Rdbms\Database
integer 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 $connectionParams
 Parameters used by initConnection() to establish a connection. More...
 
string[] int[] float[] $connectionVariables
 SQL variables values to use for all new connections. More...
 
LoggerInterface $connLogger
 
DatabaseDomain $currentDomain
 
string $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...
 
string[] $indexAliases = []
 Current map of (index alias => index) More...
 
array $lbInfo = []
 Current LoadBalancer tracking information. More...
 
int $nonNativeInsertSelectBatchSize
 Row batch size to use for emulated INSERT SELECT queries. More...
 
string $password
 Password used to establish the current connection. More...
 
callable null $profiler
 
LoggerInterface $queryLogger
 
LoggerInterface $replLogger
 
array null $schemaVars
 Current variables use for schema element placeholders. More...
 
string $server
 Server that this instance is currently connected to. More...
 
array $sessionDirtyTempTables = []
 Map of (table name => 1) for current TEMPORARY tables. More...
 
array $sessionNamedLocks = []
 Map of (name => 1) for locks obtained via lock() More...
 
array $sessionTempTables = []
 Map of (table name => 1) for current TEMPORARY tables. More...
 
BagOStuff $srvCache
 APC cache. More...
 
array[] $tableAliases = []
 Current map of (table => (dbname, schema, prefix) map) More...
 
string $topologyRole
 Replication topology role of the server; one of the class ROLE_* constants. More...
 
string null $topologyRootMaster
 Host (or address) of the root master server for the replication topology. More...
 
TransactionProfiler $trxProfiler
 
string $user
 User that this instance is currently connected under the name of. More...
 

Private Member Functions

 attachDatabasesFromTableAliases ()
 Issue ATTATCH statements for all unattached foreign DBs in table aliases. More...
 
 getDefaultPragmas ()
 
 rewriteIgnoreKeyword ( $options)
 

Static Private Member Functions

static generateDatabaseName ( $path)
 
static isProcessMemoryPath ( $path)
 

Private Attributes

array $sessionAttachedDbs = []
 List of shared database already attached to this connection. More...
 
string null $version
 

Static Private Attributes

static string[][] $VALID_PRAGMAS
 
static string[] $VALID_TRX_MODES = [ '', 'DEFERRED', 'IMMEDIATE', 'EXCLUSIVE' ]
 See https://www.sqlite.org/lang_transaction.html. More...
 

Additional Inherited Members

- Static Protected Attributes inherited from Wikimedia\Rdbms\Database
static int $DBO_MUTABLE
 Bit field of all DBO_* flags that can be changed after connection. More...
 
static string[] $MUTABLE_FLAGS
 List of DBO_* flags that can be changed after connection. More...
 

Detailed Description

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

References Wikimedia\Rdbms\DatabaseSqlite\generateDatabaseName(), Wikimedia\Rdbms\Database\getDomainID(), and Wikimedia\Rdbms\DatabaseSqlite\getLockFileDirectory().

Member Function Documentation

◆ addQuotes()

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

References $file, Wikimedia\Rdbms\DatabaseSqlite\addQuotes(), Wikimedia\Rdbms\DatabaseSqlite\generateFileName(), and Wikimedia\Rdbms\Database\query().

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

◆ attachDatabasesFromTableAliases()

Wikimedia\Rdbms\DatabaseSqlite::attachDatabasesFromTableAliases ( )
private

Issue ATTATCH statements for all unattached foreign DBs in table aliases.

Definition at line 1145 of file DatabaseSqlite.php.

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

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

◆ buildConcat()

Wikimedia\Rdbms\DatabaseSqlite::buildConcat (   $stringList)

Build a concatenation list to feed into a SQL query.

Parameters
string[]$stringList
Returns
string

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 969 of file DatabaseSqlite.php.

◆ buildGreatest()

Wikimedia\Rdbms\DatabaseSqlite::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.

Parameters
string | string[]$fieldsName(s) of column(s) with values to compare
string | int | float | string[] | int[] | float[]$valuesValues to compare
Returns
mixed
Since
1.35
Stable to override Stable to override

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 981 of file DatabaseSqlite.php.

References Wikimedia\Rdbms\Database\buildSuperlative().

◆ buildGroupConcatField()

Wikimedia\Rdbms\DatabaseSqlite::buildGroupConcatField (   $delim,
  $table,
  $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.

Parameters
string$delimGlue to bind the results together
string | array$tableTable name
string$fieldField name
string | array$condsConditions
string | array$join_condsJoin conditions
Returns
string SQL text
Since
1.23
Stable to override Stable to override

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 973 of file DatabaseSqlite.php.

References Wikimedia\Rdbms\DatabaseSqlite\addQuotes(), and Wikimedia\Rdbms\Database\selectSQLText().

◆ buildLeast()

Wikimedia\Rdbms\DatabaseSqlite::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.

Parameters
string | string[]$fieldsName(s) of column(s) with values to compare
string | int | float | string[] | int[] | float[]$valuesValues to compare
Returns
mixed
Since
1.35
Stable to override Stable to override

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 985 of file DatabaseSqlite.php.

References Wikimedia\Rdbms\Database\buildSuperlative().

◆ buildStringCast()

Wikimedia\Rdbms\DatabaseSqlite::buildStringCast (   $field)
Parameters
string$fieldField or column to cast
Returns
string
Since
1.28

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 874 of file DatabaseSqlite.php.

◆ buildSubstring()

Wikimedia\Rdbms\DatabaseSqlite::buildSubstring (   $input,
  $startPosition,
  $length = null 
)

Stable to override Stable to override

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 860 of file DatabaseSqlite.php.

References Wikimedia\Rdbms\Database\assertBuildSubstringParams().

◆ 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 247 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
Stable to override Stable to override

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 1157 of file DatabaseSqlite.php.

◆ dataSeek()

Wikimedia\Rdbms\DatabaseSqlite::dataSeek (   $res,
  $row 
)
Parameters
IResultWrapper | array$res
int$row

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 531 of file DatabaseSqlite.php.

References $res, and Wikimedia\Rdbms\ResultWrapper\unwrap().

◆ deadlockLoop()

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

No-op version of deadlockLoop.

Parameters
mixed...$args
Returns
mixed

Reimplemented from Wikimedia\Rdbms\Database.

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

◆ doBegin()

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

Issues the BEGIN command to the database server.

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

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 791 of file DatabaseSqlite.php.

References Wikimedia\Rdbms\Database\query().

◆ doHandleSessionLossPreconnect()

Wikimedia\Rdbms\DatabaseSqlite::doHandleSessionLossPreconnect ( )
protected

Reset any additional subclass trx* and session* fields Stable to override.

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 1161 of file DatabaseSqlite.php.

◆ doQuery()

Wikimedia\Rdbms\DatabaseSqlite::doQuery (   $sql)
protected

SQLite doesn't allow buffered results or data seeking etc, so we'll use fetchAll as the result.

Parameters
string$sql
Returns
bool|IResultWrapper

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 366 of file DatabaseSqlite.php.

References $res, Wikimedia\Rdbms\DatabaseSqlite\getBindingHandle(), and Wikimedia\Rdbms\ResultWrapper\unwrap().

◆ doReplace()

Wikimedia\Rdbms\DatabaseSqlite::doReplace (   $table,
array  $uniqueKeys,
array  $rows,
  $fname 
)
protected
See also
Database::replace() Stable to override
Parameters
string$table
string[][]$uniqueKeysNon-empty list of unique keys
array$rowsNon-empty list of rows
string$fname
Since
1.35

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 681 of file DatabaseSqlite.php.

References Wikimedia\Rdbms\Database\makeInsertLists(), Wikimedia\Rdbms\Database\query(), and Wikimedia\Rdbms\DatabaseSqlite\tableName().

◆ doSelectDomain()

Wikimedia\Rdbms\DatabaseSqlite::doSelectDomain ( DatabaseDomain  $domain)
protected

◆ doTruncate()

Wikimedia\Rdbms\DatabaseSqlite::doTruncate ( array  $tables,
  $fname 
)
protected

◆ dropTable()

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

Delete a table.

Parameters
string$table
string$fname
Returns
bool Whether the table already existed
Exceptions
DBErrorIf an error occurs

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 1101 of file DatabaseSqlite.php.

References Wikimedia\Rdbms\Database\query(), Wikimedia\Rdbms\DatabaseSqlite\tableExists(), and Wikimedia\Rdbms\DatabaseSqlite\tableName().

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

References $res, Wikimedia\Rdbms\Database\addIdentifierQuotes(), Wikimedia\Rdbms\DatabaseSqlite\addQuotes(), Wikimedia\Rdbms\DatabaseSqlite\fetchObject(), and Wikimedia\Rdbms\Database\query().

◆ encodeBlob()

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

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 811 of file DatabaseSqlite.php.

◆ fetchAffectedRowCount()

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

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 569 of file DatabaseSqlite.php.

References Wikimedia\Rdbms\DatabaseSqlite\$lastAffectedRowCount.

◆ fetchObject()

Wikimedia\Rdbms\DatabaseSqlite::fetchObject (   $res)
Parameters
IResultWrapper | array$res
Returns
stdClass|bool

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 392 of file DatabaseSqlite.php.

References $res, and Wikimedia\Rdbms\ResultWrapper\unwrap().

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

◆ fetchRow()

Wikimedia\Rdbms\DatabaseSqlite::fetchRow (   $res)
Parameters
IResultWrapper | mixed$res
Returns
array|bool

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 415 of file DatabaseSqlite.php.

References $res, and Wikimedia\Rdbms\ResultWrapper\unwrap().

◆ 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|bool False on failure

Implements Wikimedia\Rdbms\IMaintainableDatabase.

Definition at line 778 of file DatabaseSqlite.php.

References $res, Wikimedia\Rdbms\DatabaseSqlite\addQuotes(), Wikimedia\Rdbms\Database\query(), and Wikimedia\Rdbms\DatabaseSqlite\tableName().

◆ fieldName()

Wikimedia\Rdbms\DatabaseSqlite::fieldName (   $res,
  $n 
)
Parameters
IResultWrapper$res
int$n
Returns
bool

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 460 of file DatabaseSqlite.php.

References $keys, $res, and Wikimedia\Rdbms\ResultWrapper\unwrap().

◆ freeResult()

Wikimedia\Rdbms\DatabaseSqlite::freeResult (   $res)
Parameters
IResultWrapper | mixed$res

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 382 of file DatabaseSqlite.php.

References $res.

◆ generateDatabaseName()

static Wikimedia\Rdbms\DatabaseSqlite::generateDatabaseName (   $path)
staticprivate
Parameters
string$path
Returns
string

Definition at line 279 of file DatabaseSqlite.php.

References $path.

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

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

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

◆ getAttributes()

static Wikimedia\Rdbms\DatabaseSqlite::getAttributes ( )
staticprotected

Stable to override.

Returns
array Map of (Database::ATTR_* constant => value)
Since
1.31

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 103 of file DatabaseSqlite.php.

References true.

◆ getBindingHandle()

Wikimedia\Rdbms\DatabaseSqlite::getBindingHandle ( )
protected

◆ getDbFilePath()

Wikimedia\Rdbms\DatabaseSqlite::getDbFilePath ( )

◆ getDefaultPragmas()

Wikimedia\Rdbms\DatabaseSqlite::getDefaultPragmas ( )
private
Returns
array Map of (name => value) for default values to set via PRAGMA

Definition at line 211 of file DatabaseSqlite.php.

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

◆ getFulltextSearchModule()

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

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

Returns
string

Definition at line 304 of file DatabaseSqlite.php.

References Wikimedia\Rdbms\DatabaseSqlite\newStandaloneInstance().

◆ getLockFileDirectory()

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

Definition at line 233 of file DatabaseSqlite.php.

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

◆ getServerVersion()

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

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 762 of file DatabaseSqlite.php.

References Wikimedia\Rdbms\DatabaseSqlite\$version, and Wikimedia\Rdbms\DatabaseSqlite\getBindingHandle().

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

◆ getType()

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

Implements Wikimedia\Rdbms\IDatabase.

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

References $res, Wikimedia\Rdbms\DatabaseSqlite\addQuotes(), Wikimedia\Rdbms\Database\indexName(), and Wikimedia\Rdbms\Database\query().

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

References Wikimedia\Rdbms\Database\indexName(), and Wikimedia\Rdbms\Database\selectRow().

◆ insertId()

Wikimedia\Rdbms\DatabaseSqlite::insertId ( )

This must be called after nextSequenceVal.

Returns
int

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 522 of file DatabaseSqlite.php.

References Wikimedia\Rdbms\DatabaseSqlite\getBindingHandle().

◆ isProcessMemoryPath()

static Wikimedia\Rdbms\DatabaseSqlite::isProcessMemoryPath (   $path)
staticprivate
Parameters
string$path
Returns
bool

Definition at line 296 of file DatabaseSqlite.php.

References $path.

◆ isTransactableQuery()

Wikimedia\Rdbms\DatabaseSqlite::isTransactableQuery (   $sql)
protected

Determine whether a SQL statement is sensitive to isolation level.

A SQL statement is considered transactable if its result could vary depending on the transaction isolation level. Operational commands such as 'SET' and 'SHOW' are not considered to be transactable.

Main purpose: Used by query() to decide whether to begin a transaction before the current query (in DBO_TRX mode, on by default).

Stable to override

Parameters
string$sql
Returns
bool

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 352 of file DatabaseSqlite.php.

References Wikimedia\Rdbms\Database\getQueryVerb().

◆ isWriteQuery()

Wikimedia\Rdbms\DatabaseSqlite::isWriteQuery (   $sql,
  $flags 
)
protected

Determine whether a query writes to the DB.

When in doubt, this returns true.

Main use cases:

  • Subsequent web requests should not need to wait for replication from the master position seen by this web request, unless this request made changes to the master. This is handled by ChronologyProtector by checking doneWrites() at the end of the request. doneWrites() returns true if any query set lastWriteTime; which query() does based on isWriteQuery().
  • Reject write queries to replica DBs, in query().
Parameters
string$sql
int$flagsQuery flags to query()
Returns
bool

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 348 of file DatabaseSqlite.php.

References Wikimedia\Rdbms\Database\$flags.

◆ lastErrno()

Wikimedia\Rdbms\DatabaseSqlite::lastErrno ( )

◆ lastError()

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

Implements Wikimedia\Rdbms\IDatabase.

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

References Wikimedia\Rdbms\Database\query().

◆ lock()

Wikimedia\Rdbms\DatabaseSqlite::lock (   $lockName,
  $method,
  $timeout = 5 
)

Acquire a named lock.Named locks are not related to transactions

Parameters
string$lockNameName of lock to aquire
string$methodName of the calling method
int$timeoutAcquisition timeout in seconds (0 means non-blocking)
Returns
bool Success
Exceptions
DBErrorIf an error occurs, see IDatabase::query()
Stable to override Stable to override

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 947 of file DatabaseSqlite.php.

References LockManager\LOCK_EX.

◆ makeInsertNonConflictingVerbAndOptions()

Wikimedia\Rdbms\DatabaseSqlite::makeInsertNonConflictingVerbAndOptions ( )
protected

Stable to override.

Returns
string[] ("INSERT"-style SQL verb, "ON CONFLICT"-style clause or "")
Since
1.35

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 677 of file DatabaseSqlite.php.

◆ makeSelectOptions()

Wikimedia\Rdbms\DatabaseSqlite::makeSelectOptions ( array  $options)
protected

Returns an optional USE INDEX clause to go after the table, and a string to go at the end of the query.

See also
Database::select()

Stable to override

Parameters
array$optionsAssociative array of options to be turned into an SQL query, valid keys are listed in the function.
Returns
array

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 640 of file DatabaseSqlite.php.

◆ makeUpdateOptionsArray()

Wikimedia\Rdbms\DatabaseSqlite::makeUpdateOptionsArray (   $options)
protected
Parameters
array$options
Returns
array

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 655 of file DatabaseSqlite.php.

References Wikimedia\Rdbms\DatabaseSqlite\rewriteIgnoreKeyword().

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

References Wikimedia\Rdbms\Database\factory().

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

◆ numFields()

Wikimedia\Rdbms\DatabaseSqlite::numFields (   $res)
Parameters
IResultWrapper$res
Returns
int

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 444 of file DatabaseSqlite.php.

References $res, and Wikimedia\Rdbms\ResultWrapper\unwrap().

◆ numRows()

Wikimedia\Rdbms\DatabaseSqlite::numRows (   $res)

The PDO::Statement class implements the array interface so count() will work.

Parameters
IResultWrapper | array | false$res
Returns
int

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 433 of file DatabaseSqlite.php.

References $res, and Wikimedia\Rdbms\ResultWrapper\unwrap().

◆ open()

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

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

Parameters
string | null$serverDatabase server host
string | null$userDatabase user name
string | null$passwordDatabase user password
string | null$dbNameDatabase name
string | null$schemaDatabase schema name
string$tablePrefixTable prefix
Exceptions
DBConnectionError

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 136 of file DatabaseSqlite.php.

References Wikimedia\Rdbms\DatabaseSqlite\$dbPath, Wikimedia\Rdbms\Database\$flags, $path, Wikimedia\Rdbms\DatabaseSqlite\attachDatabasesFromTableAliases(), Wikimedia\Rdbms\Database\close(), DBO_DEFAULT, DBO_PERSISTENT, DBO_TRX, Wikimedia\Rdbms\DatabaseSqlite\generateFileName(), Wikimedia\Rdbms\DatabaseSqlite\getDefaultPragmas(), Wikimedia\Rdbms\Database\getFlag(), Wikimedia\Rdbms\Database\getLogContext(), Wikimedia\Rdbms\Database\newExceptionAfterConnectError(), and Wikimedia\Rdbms\Database\query().

◆ replaceVars()

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

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 894 of file DatabaseSqlite.php.

References $s.

◆ rewriteIgnoreKeyword()

Wikimedia\Rdbms\DatabaseSqlite::rewriteIgnoreKeyword (   $options)
private
Parameters
array$options
Returns
array

Definition at line 666 of file DatabaseSqlite.php.

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

◆ serverIsReadOnly()

Wikimedia\Rdbms\DatabaseSqlite::serverIsReadOnly ( )

Returns
bool Whether the DB is marked as read-only server-side
Since
1.28
Stable to override Stable to override

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 744 of file DatabaseSqlite.php.

References $path, Wikimedia\Rdbms\Database\assertHasConnectionHandle(), and Wikimedia\Rdbms\DatabaseSqlite\getDbFilePath().

◆ 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
Stable to override Stable to override

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 1135 of file DatabaseSqlite.php.

References Wikimedia\Rdbms\DatabaseSqlite\attachDatabasesFromTableAliases(), and Wikimedia\Rdbms\Database\isOpen().

◆ strencode()

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

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 803 of file DatabaseSqlite.php.

References $s, and Wikimedia\Rdbms\DatabaseSqlite\addQuotes().

◆ 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 IDatabase::query()

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 573 of file DatabaseSqlite.php.

References $res, Wikimedia\Rdbms\DatabaseSqlite\addQuotes(), Wikimedia\Rdbms\Database\query(), Wikimedia\Rdbms\DatabaseSqlite\tableName(), and true.

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

◆ tableName()

Wikimedia\Rdbms\DatabaseSqlite::tableName (   $name,
  $format = 'quoted' 
)

Use MySQL's naming (accounts for prefix etc) but remove surrounding backticks.

Parameters
string$name
string$format
Returns
string

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 508 of file DatabaseSqlite.php.

Referenced by Wikimedia\Rdbms\DatabaseSqlite\doReplace(), Wikimedia\Rdbms\DatabaseSqlite\doTruncate(), Wikimedia\Rdbms\DatabaseSqlite\dropTable(), Wikimedia\Rdbms\DatabaseSqlite\fieldInfo(), and Wikimedia\Rdbms\DatabaseSqlite\tableExists().

◆ 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 1GB.

No way to query it though.

Parameters
string$table
string$field
Returns
int

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 696 of file DatabaseSqlite.php.

◆ unionQueries()

Wikimedia\Rdbms\DatabaseSqlite::unionQueries (   $sqls,
  $all 
)
Parameters
string[]$sqls
bool$allWhether to "UNION ALL" or not
Returns
string

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 712 of file DatabaseSqlite.php.

◆ unionSupportsOrderAndLimit()

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

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 703 of file DatabaseSqlite.php.

◆ unlock()

Wikimedia\Rdbms\DatabaseSqlite::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 IDatabase::query()
Stable to override Stable to override

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 959 of file DatabaseSqlite.php.

References LockManager\LOCK_EX.

◆ wasConnectionError()

Wikimedia\Rdbms\DatabaseSqlite::wasConnectionError (   $errno)

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

Stable to override

Parameters
int | string$errno
Returns
bool Whether the given query error was a connection drop

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 732 of file DatabaseSqlite.php.

◆ wasDeadlock()

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

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 721 of file DatabaseSqlite.php.

References Wikimedia\Rdbms\DatabaseSqlite\lastErrno().

◆ wasKnownStatementRollbackError()

Wikimedia\Rdbms\DatabaseSqlite::wasKnownStatementRollbackError ( )
protected

Stable to override.

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 foriegn key violations
Since
1.31

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 736 of file DatabaseSqlite.php.

◆ wasReadOnlyError()

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

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 728 of file DatabaseSqlite.php.

References Wikimedia\Rdbms\DatabaseSqlite\lastErrno().

Member Data Documentation

◆ $conn

PDO Wikimedia\Rdbms\DatabaseSqlite::$conn
protected

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

◆ $dbPath

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

Explicit path for the SQLite database file.

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

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

◆ $lockMgr

FSLockManager Wikimedia\Rdbms\DatabaseSqlite::$lockMgr
protected

(hopefully on the same server as the DB)

Definition at line 52 of file DatabaseSqlite.php.

◆ $sessionAttachedDbs

array Wikimedia\Rdbms\DatabaseSqlite::$sessionAttachedDbs = []
private

List of shared database already attached to this connection.

Definition at line 58 of file DatabaseSqlite.php.

◆ $trxMode

string Wikimedia\Rdbms\DatabaseSqlite::$trxMode
protected

Transaction mode.

Definition at line 43 of file DatabaseSqlite.php.

◆ $VALID_PRAGMAS

string [][] Wikimedia\Rdbms\DatabaseSqlite::$VALID_PRAGMAS
staticprivate
Initial value:
= [
'synchronous' => [ 'EXTRA', 'FULL', 'NORMAL', 'OFF' ],
'temp_store' => [ 'FILE', 'MEMORY' ]
]

Definition at line 64 of file DatabaseSqlite.php.

◆ $VALID_TRX_MODES

string [] Wikimedia\Rdbms\DatabaseSqlite::$VALID_TRX_MODES = [ '', 'DEFERRED', 'IMMEDIATE', 'EXCLUSIVE' ]
staticprivate

◆ $version

string null Wikimedia\Rdbms\DatabaseSqlite::$version
private

Definition at line 55 of file DatabaseSqlite.php.

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


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