Inheritance diagram for Wikimedia\Rdbms\DatabaseSqlite:

[legend]

Collaboration diagram for Wikimedia\Rdbms\DatabaseSqlite:

[legend]

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

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	$delim	Glue to bind the results together
string \| array	$table	Table name
string	$field	Field name
string \| array	$conds	Conditions
string \| array	$join_conds	Join conditions

Returns: string SQL text

Since: 1.23

Stability: stable: to override

More...

buildStringCast ( $field)

buildSubstring ( $input, $startPosition, $length=null)

Stability: 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

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)

dropTable ( $table, $fname=__METHOD__)

Delete a table. More...

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

DBError If 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.For example, "user" can be converted to "myschema.mydbname.user" for convenience. Appearances like user, somedb.user, somedb.someschema.user will used literally.Calling this twice will completely clear any old table aliases. Also, note that callers are responsible for making sure the schemas and databases actually exist.

Parameters

array[] $aliases Map of (table => (dbname, schema, prefix) map)

Since: 1.28

Stability: 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 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.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

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)

Parameters

string \| int	$fieldLeft
string \| int	$fieldRight

Returns: string

More...

bitNot ( $field)

Parameters

string | int $field

Returns: string

More...

bitOr ( $fieldLeft, $fieldRight)

Parameters

string \| int	$fieldLeft
string \| int	$fieldRight

Returns: string

More...

buildConcat ( $stringList)

Build a concatenation list to feed into a SQL query.

Parameters

string[] $stringList Raw SQL expression list; caller is responsible for escaping

Returns: string

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[]	$fields	Name(s) of column(s) with values to compare
string \| int \| float \| string[] \| int[] \| float[]	$values	Values to compare

Returns: mixed

Since: 1.35 in IDatabase, moved to ISQLPlatform in 1.39

More...

buildIntegerCast ( $field)

Parameters

string $field Field or column to cast

Returns: string

Since: 1.31

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[]	$fields	Name(s) of column(s) with values to compare
string \| int \| float \| string[] \| int[] \| float[]	$values	Values to compare

Returns: mixed

Since: 1.35 in IDatabase, moved to ISQLPlatform in 1.39

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 in IDatabase, moved to ISQLPlatform in 1.39

Parameters

array[] \| string \| LikeMatch	$param
	string\|LikeMatch	...$params

Returns: string Fully built LIKE statement

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__)

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.This doesn't need to be overridden unless CASE isn't supported in the RDBMS.

Parameters

string \| array	$cond	SQL condition expression (yields a boolean)
string	$caseTrueExpression	SQL expression to return when the condition is true
string	$caseFalseExpression	SQL expression to return when the condition is false

Returns: string SQL fragment

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 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	$delTable	The table to delete from.
string	$joinTable	The other table.
string	$delVar	The variable to join on, in the first table.
string	$joinVar	The variable to join on, in the second table.
array \| string	$conds	Condition array of field names mapped to variables, ANDed together in the WHERE clause
string	$fname	Calling function name (use METHOD) for logs/profiling

Exceptions

DBError If 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...

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[]	$tables	Table name(s)
string	$var	Column for which NULL values are not counted [default "*"]
array \| string	$conds	Filters on the table
string	$fname	Function name for profiling
array	$options	Options for select
array \| string	$join_conds	Join conditions

Returns: int Row count

Exceptions

DBError If 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__)

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

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|bool False if this is not a primary DB

Exceptions

DBError If an error occurs, {

See also: query}

Since: 1.37

More...

getReplicaPos ()

Get the replication position of this replica DB.

Returns: DBPrimaryPos|bool False if this is not a replica DB

Exceptions

DBError If 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...

getTopologyRole ()

Get the replication topology role of this server. More...

getTopologyRootPrimary ()

Get the readable name of the sole root primary DB 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

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	$sql	SQL query we will append the limit too
int	$limit	The SQL limit
int \| bool	$offset	The SQL offset (default false)

Returns: string

Since: 1.34 in IDatabase, moved to ISQLPlatform in 1.39

More...

listViews ( $prefix=null, $fname=__METHOD__)

Lists all the VIEWs in the database.

Parameters

string \| null	$prefix	Only show VIEWs with this prefix, eg. unit_test_
string	$fname	Name 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	$lockName	Name of lock to acquire
string	$method	Name of the calling method
int	$timeout	Acquisition timeout in seconds (0 means non-blocking)
int	$flags	Bit field of IDatabase::LOCK_* constants

Returns: bool|float|null Success (bool); acquisition time (float/null) if LOCK_TIMESTAMP

Exceptions

DBError If 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	$lockName	Name of lock to poll
string	$method	Name of method calling us

Returns: bool

Exceptions

DBError If 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.

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

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

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	$timeout	The 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

DBError If an error occurs, {

See also: query}

Since: 1.37

More...

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, array &$errors=[])

Consume and run any "on transaction idle/resolution" callbacks. More...

runOnTransactionPreCommitCallbacks ()

Consume and run any "on transaction pre-commit" callbacks. More...

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.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	$table	Table name
string \| array	$vars	Field names
string \| array	$conds	Conditions
string	$fname	Caller function name
string \| array	$options	Query options
string \| array	$join_conds	Join conditions

Returns: string SQL query string

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 $value True 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.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

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

DBError If 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.REPLACE() in mysql)

Parameters

string	$orig	Column to modify
string	$old	Column to seek
string	$new	Column to replace with

Returns: string

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

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

Get the status of the current transaction. More...

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.This is used for providing overload point for other DB abstractions not compatible with the MySQL syntax.

Parameters

array	$sqls	SQL statements to combine
bool	$all	Either IDatabase::UNION_ALL or IDatabase::UNION_DISTINCT

Returns: string SQL fragment

More...

unionSupportsOrderAndLimit ()

Determine if the RDBMS supports ORDER BY and LIMIT for separate subqueries within UNION.

Returns: bool

More...

unlock ( $lockName, $method)

Release a lock.Named locks are not related to transactions

Parameters

string	$lockName	Name of lock to release
string	$method	Name of the calling method

Returns: bool Success

Exceptions

DBError If 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 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

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\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 ... $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...

	doQuery ( $sql)

	doReplace ( $table, array $identityKey, array $rows, $fname)

	doSelectDomain (DatabaseDomain $domain)

	doTruncate (array $tables, $fname)

	fetchAffectedRowCount ()

	getBindingHandle ()

	isConnectionError ( $errno)
	Do not use this method outside of Database/DBError classes. More...

	isKnownStatementRollbackError ( $errno)

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

	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, $password, $db, $schema, $tablePrefix)
	Open a new connection to the database (closing any existing one) More...

	replaceVars ( $s)

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

	assertIsWritablePrimary ()
	Make sure that this server is not marked as a replica nor read-only. More...

	assertValidUpsertRowArray (array $rows, array $identityKey)

	assertValidUpsertSetArray (array $set, array $identityKey, array $rows)

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

	doDropTable ( $table, $fname)

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

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

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

	doUpsert (string $table, array $rows, array $identityKey, array $set, string $fname)

	executeQuery ( $sql, $fname, $flags)
	Execute a query, retrying it if there is a recoverable connection loss. More...

	extractSingleFieldFromList ( $var)

	fieldHasBit (int $flags, int $bit)

	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 primary DB 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)

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

	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)

	normalizeJoinType (string $joinType)
	Validate and normalize a join type. More...

	normalizeOptions ( $options)

	normalizeRowArray (array $rowOrRows)

	normalizeUpsertParams ( $uniqueKeys, &$rows)
	Validate and normalize parameters to upsert() or replace() More...

	qualifiedTableComponents ( $name)
	Get the table components needed for a query given the currently selected database. More...

	registerTempWrites ( $ret, array $changes)

	relationSchemaQualifier ()

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

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

Static Protected Member Functions
static	getAttributes ()

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

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 null	$password
	Password used to establish the current connection. More...

ISQLPlatform	$platform

callable null	$profiler

LoggerInterface	$queryLogger

LoggerInterface	$replLogger

array null	$schemaVars
	Current variables use for schema element placeholders. More...

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

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 primary server for the replication topology. 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...

Private Member Functions
	attachDatabasesFromTableAliases ()
	Issue ATTATCH statements for all unattached foreign DBs in table aliases. More...

	getDefaultPragmas ()

	makeLockManager ()
	Initialize/reset the LockManager instance. More...

	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

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

Detailed Description

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

References Wikimedia\Rdbms\DatabaseSqlite\generateDatabaseName(), and Wikimedia\Rdbms\DatabaseSqlite\makeLockManager().

Member Function Documentation

◆ addQuotes()

Wikimedia\Rdbms\DatabaseSqlite::addQuotes ( $s )

Parameters

Returns: string

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 726 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	$name	Database name to be used in queries like SELECT foo FROM dbname.table
bool \| string	$file	Database file name. If omitted, will be generated using $name and configured data directory
string	$fname	Calling function name

Returns: IResultWrapper

Definition at line 348 of file DatabaseSqlite.php.

References $file.

◆ attachDatabasesFromTableAliases()

Wikimedia\Rdbms\DatabaseSqlite::attachDatabasesFromTableAliases ( )

private

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

Definition at line 1039 of file DatabaseSqlite.php.

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

◆ 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	$delim	Glue to bind the results together
string \| array	$table	Table name
string	$field	Field name
string \| array	$conds	Conditions
string \| array	$join_conds	Join conditions

Returns: string SQL text

Since: 1.23

Stability: stable: to override

Stability: stable: to override

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 863 of file DatabaseSqlite.php.

◆ buildStringCast()

Wikimedia\Rdbms\DatabaseSqlite::buildStringCast ( $field )

Parameters

string $field Field or column to cast

Returns: string

Since: 1.28

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 769 of file DatabaseSqlite.php.

◆ buildSubstring()

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

Stability: stable: to override

Stability: stable: to override

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 755 of file DatabaseSqlite.php.

◆ 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 256 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 1051 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 779 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 714 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 686 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 1063 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 1055 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 847 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 842 of file DatabaseSqlite.php.

◆ doQuery()

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

protected

Parameters

string $sql

Returns: IResultWrapper|bool

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 375 of file DatabaseSqlite.php.

References $res.

◆ doReplace()

Wikimedia\Rdbms\DatabaseSqlite::doReplace	(		$table,
		array	$identityKey,
		array	$rows,
			$fname
	)

protected

Parameters

string	$table
string[]	$identityKey	List of columns defining a unique key
array	$rows	Non-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 582 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 385 of file DatabaseSqlite.php.

References Wikimedia\Rdbms\DatabaseDomain\getDatabase(), Wikimedia\Rdbms\DatabaseDomain\getSchema(), and Wikimedia\Rdbms\DatabaseDomain\getTablePrefix().

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

References LockManager\LOCK_EX.

◆ dropTable()

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

Delete a table.

Parameters

string	$table
string	$fname

Returns: bool Whether the table already existed

Exceptions

DBError If an error occurs

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 995 of file DatabaseSqlite.php.

◆ duplicateTableStructure()

Wikimedia\Rdbms\DatabaseSqlite::duplicateTableStructure	(	$oldName,
		$newName,
		$temporary = `false`,
		$fname = `__METHOD__`
	)

Parameters

string	$oldName
string	$newName
bool	$temporary
string	$fname

Returns: bool|IResultWrapper

Exceptions

RuntimeException

Reimplemented from Wikimedia\Rdbms\Database.

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

◆ fetchAffectedRowCount()

Wikimedia\Rdbms\DatabaseSqlite::fetchAffectedRowCount ( )

protected

Returns: int

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 470 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|bool False on failure

Implements Wikimedia\Rdbms\IMaintainableDatabase.

Definition at line 670 of file DatabaseSqlite.php.

References $res.

◆ generateDatabaseName()

static Wikimedia\Rdbms\DatabaseSqlite::generateDatabaseName ( $path )

staticprivate

Parameters

string $path

Returns: string

Definition at line 290 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	$dir	Directory where database resides
string \| bool	$dbName	Database name (or false from Database::factory, validated here)

Returns: string

Exceptions

DBUnexpectedError

Definition at line 271 of file DatabaseSqlite.php.

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

◆ getAttributes()

static Wikimedia\Rdbms\DatabaseSqlite::getAttributes ( )

staticprotected

Stability: stable: to override

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

Since: 1.31

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 100 of file DatabaseSqlite.php.

References true.

◆ getBindingHandle()

Wikimedia\Rdbms\DatabaseSqlite::getBindingHandle ( )

protected

Returns: PDO

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 1073 of file DatabaseSqlite.php.

◆ getDbFilePath()

Wikimedia\Rdbms\DatabaseSqlite::getDbFilePath ( )

Returns: string|null SQLite DB file path

Exceptions

DBUnexpectedError

Since: 1.25

Definition at line 218 of file DatabaseSqlite.php.

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

Referenced by SqliteMaintenance\backup(), and SqliteMaintenance\vacuum().

◆ getDefaultPragmas()

Wikimedia\Rdbms\DatabaseSqlite::getDefaultPragmas ( )

private

Returns: array Map of (name => value) for default values to set via PRAGMA

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

◆ getLockFileDirectory()

Wikimedia\Rdbms\DatabaseSqlite::getLockFileDirectory ( )

Returns: string|null Lock file directory

Definition at line 225 of file DatabaseSqlite.php.

◆ getServerVersion()

Wikimedia\Rdbms\DatabaseSqlite::getServerVersion ( )

Returns: string Version information from the database

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 654 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 647 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 631 of file DatabaseSqlite.php.

◆ getType()

Wikimedia\Rdbms\DatabaseSqlite::getType ( )

Returns: string

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 130 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 500 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 520 of file DatabaseSqlite.php.

◆ insertId()

Wikimedia\Rdbms\DatabaseSqlite::insertId ( )

This must be called after nextSequenceVal.

Returns: int

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 436 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 619 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 623 of file DatabaseSqlite.php.

◆ isProcessMemoryPath()

static Wikimedia\Rdbms\DatabaseSqlite::isProcessMemoryPath ( $path )

staticprivate

Parameters

string $path

Returns: bool

Definition at line 307 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).

Stability: stable: to override

Parameters

string $sql

Returns: bool

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 363 of file DatabaseSqlite.php.

◆ 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 primary position seen by this web request, unless this request made changes to the primary DB. 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	SQL query
int	$flags	Query flags to query()

Returns: bool

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 359 of file DatabaseSqlite.php.

◆ lastErrno()

Wikimedia\Rdbms\DatabaseSqlite::lastErrno ( )

Returns: int

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 456 of file DatabaseSqlite.php.

◆ lastError()

Wikimedia\Rdbms\DatabaseSqlite::lastError ( )

Returns: string

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 444 of file DatabaseSqlite.php.

◆ listTables()

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

List all tables on the database.

Parameters

string \| null	$prefix	Only show tables with this prefix, e.g. mw_
string	$fname	Calling function name

Returns: array

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 972 of file DatabaseSqlite.php.

◆ makeInsertNonConflictingVerbAndOptions()

Wikimedia\Rdbms\DatabaseSqlite::makeInsertNonConflictingVerbAndOptions ( )

protected

Stability: 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 578 of file DatabaseSqlite.php.

◆ makeLockManager()

Wikimedia\Rdbms\DatabaseSqlite::makeLockManager ( )

private

Initialize/reset the LockManager instance.

Returns: LockManager

Definition at line 240 of file DatabaseSqlite.php.

References Wikimedia\Rdbms\Database\getDomainID().

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

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

Stability: stable: to override

Parameters

array $options Associative 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 541 of file DatabaseSqlite.php.

◆ makeUpdateOptionsArray()

Wikimedia\Rdbms\DatabaseSqlite::makeUpdateOptionsArray ( $options )

protected

Parameters

array $options

Returns: array

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 556 of file DatabaseSqlite.php.

◆ newStandaloneInstance()

static Wikimedia\Rdbms\DatabaseSqlite::newStandaloneInstance	(		$filename,
		array	$p = `[]`
	)

static

Parameters

string	$filename
array	$p	Options map; supports: flags : (same as __construct counterpart) trxMode : (same as __construct counterpart) dbDirectory : (same as __construct counterpart)

Returns: DatabaseSqlite

Since: 1.25

Definition at line 116 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 $server Server host/address and optional port {

See also: connectionParams}

Parameters

string | null $user User name {

See also: connectionParams}

Parameters

string | null $password User password {

See also: connectionParams}

Parameters

string \| null	$db	Database name
string \| null	$schema	Database schema name
string	$tablePrefix

Exceptions

DBConnectionError

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 134 of file DatabaseSqlite.php.

◆ replaceVars()

Wikimedia\Rdbms\DatabaseSqlite::replaceVars ( $s )

protected

Parameters

string $s

Returns: string

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 789 of file DatabaseSqlite.php.

References $s.

◆ rewriteIgnoreKeyword()

Wikimedia\Rdbms\DatabaseSqlite::rewriteIgnoreKeyword ( $options )

private

Parameters

array $options

Returns: array

Definition at line 567 of file DatabaseSqlite.php.

◆ serverIsReadOnly()

Wikimedia\Rdbms\DatabaseSqlite::serverIsReadOnly ( )

Returns: bool Whether the DB is marked as read-only server-side

Exceptions

DBError If 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 636 of file DatabaseSqlite.php.

References $path.

◆ setTableAliases()

Wikimedia\Rdbms\DatabaseSqlite::setTableAliases ( array $aliases )

Make certain table names use their own database, schema, and table prefix when passed into SQL queries pre-escaped and without a qualified database name.For example, "user" can be converted to "myschema.mydbname.user" for convenience. Appearances like user, somedb.user, somedb.someschema.user will used literally.Calling this twice will completely clear any old table aliases. Also, note that callers are responsible for making sure the schemas and databases actually exist.

Parameters

array[] $aliases Map of (table => (dbname, schema, prefix) map)

Since: 1.28

Stability: stable: to override

Stability: stable: to override

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 1029 of file DatabaseSqlite.php.

◆ strencode()

Wikimedia\Rdbms\DatabaseSqlite::strencode ( $s )

Parameters

string $s

Returns: string

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 698 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

DBError If an error occurs, {

See also: query}

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 474 of file DatabaseSqlite.php.

References $res, and true.

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

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

◆ wasDeadlock()

Wikimedia\Rdbms\DatabaseSqlite::wasDeadlock ( )

Returns: bool

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 608 of file DatabaseSqlite.php.

◆ wasReadOnlyError()

Wikimedia\Rdbms\DatabaseSqlite::wasReadOnlyError ( )

Returns: bool

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 615 of file DatabaseSqlite.php.

Member Data Documentation

◆ $conn

PDO null Wikimedia\Rdbms\DatabaseSqlite::$conn

protected

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

◆ $dbPath

string null Wikimedia\Rdbms\DatabaseSqlite::$dbPath

protected

Explicit path for the SQLite database file.

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

◆ $lockMgr

LockManager null Wikimedia\Rdbms\DatabaseSqlite::$lockMgr

protected

(hopefully on the same server as the DB)

Definition at line 53 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'

Definition at line 73 of file DatabaseSqlite.php.

◆ $sessionAttachedDbs

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

private

List of shared database already attached to this connection.

Definition at line 59 of file DatabaseSqlite.php.

◆ $trxMode

string Wikimedia\Rdbms\DatabaseSqlite::$trxMode

protected

Transaction mode.

Definition at line 44 of file DatabaseSqlite.php.

◆ $version

string null Wikimedia\Rdbms\DatabaseSqlite::$version

private

Definition at line 56 of file DatabaseSqlite.php.

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

includes/libs/rdbms/database/DatabaseSqlite.php

Public Member Functions

Static Public Member Functions

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Private Member Functions

Static Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addQuotes()

◆ attachDatabase()

◆ attachDatabasesFromTableAliases()

◆ buildGroupConcatField()

◆ buildStringCast()

◆ buildSubstring()

◆ closeConnection()

◆ databasesAreIndependent()

◆ deadlockLoop()

◆ decodeBlob()

◆ doBegin()

◆ doFlushSession()

◆ doHandleSessionLossPreconnect()

◆ doLock()

◆ doLockIsFree()

◆ doQuery()

◆ doReplace()

◆ doSelectDomain()

◆ doTruncate()

◆ doUnlock()

◆ dropTable()

◆ duplicateTableStructure()

◆ encodeBlob()

◆ fetchAffectedRowCount()

◆ fieldInfo()

◆ generateDatabaseName()

◆ generateFileName()

◆ getAttributes()

◆ getBindingHandle()

◆ getDbFilePath()

◆ getDefaultPragmas()

◆ getFulltextSearchModule()

◆ getLockFileDirectory()

◆ getServerVersion()

◆ getSoftwareLink()

◆ getTopologyBasedServerId()

◆ getType()

◆ indexInfo()

◆ indexUnique()

◆ insertId()

◆ isConnectionError()

◆ isKnownStatementRollbackError()

◆ isProcessMemoryPath()

◆ isTransactableQuery()

◆ isWriteQuery()

◆ lastErrno()

◆ lastError()

◆ listTables()

◆ makeInsertNonConflictingVerbAndOptions()

◆ makeLockManager()

◆ makeSelectOptions()

◆ makeUpdateOptionsArray()

◆ newStandaloneInstance()

◆ open()

◆ replaceVars()

◆ rewriteIgnoreKeyword()

◆ serverIsReadOnly()

◆ setTableAliases()

◆ strencode()

◆ tableExists()

◆ tableName()

◆ textFieldSize()

◆ wasDeadlock()

◆ wasReadOnlyError()

Member Data Documentation

◆ $conn

◆ $dbDir