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

Inherits Wikimedia\Rdbms\Database.

Collaboration diagram for Wikimedia\Rdbms\DatabaseSqlite:

[legend]

Public Member Functions

__construct (array $params)

Additional params include:

addQuotes ( $s)

Escape and quote a raw value string for use in a SQL query.

attachDatabase ( $name, $file=false, $fname=__METHOD__)

Attaches external database to the connection handle.

databasesAreIndependent ()

Returns true if DBs are assumed to be on potentially different servers.

decodeBlob ( $b)

doLock (string $lockName, string $method, int $timeout)

doLockIsFree (string $lockName, string $method)

doUnlock (string $lockName, string $method)

duplicateTableStructure ( $oldName, $newName, $temporary=false, $fname=__METHOD__)

encodeBlob ( $b)

fieldInfo ( $table, $field)

Get information about a given field Returns false if the field does not exist.

getDbFilePath ()

getLockFileDirectory ()

getServerVersion ()

getSoftwareLink ()

getType ()

indexInfo ( $table, $index, $fname=__METHOD__)

Get information about an index into an object.

lastErrno ()

lastError ()

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

List all tables on the database.

replace ( $table, $uniqueKeys, $rows, $fname=__METHOD__)

Insert row(s) into a table, in the provided order, while deleting conflicting rows.

serverIsReadOnly ()

Returns: bool Whether this DB server is running in server-side read-only mode

Exceptions

DBError If an error occurs, {

See also: query}

Since: 1.28

setTableAliases (array $aliases)

Make certain table names use their own database, schema, and table prefix when passed into SQL queries pre-escaped and without a qualified database name.

strencode ( $s)

tableExists ( $table, $fname=__METHOD__)

Query whether a given table exists.

truncateTable ( $table, $fname=__METHOD__)

Delete all data in a table and reset any sequences owned by that table.

Public Member Functions inherited from Wikimedia\Rdbms\Database

__clone ()

Make sure that copies do not share the same client binding handle.

__destruct ()

Run a few simple checks and close dangling connections.

__sleep ()

Called by serialize.

__toString ()

Get a debugging string that mentions the database type, the ID of this instance, and the ID of any underlying connection resource or driver object if one is present.

addIdentifierQuotes ( $s)

Escape a SQL identifier (e.g.

affectedRows ()

Get the number of rows affected by the last query method call.

andExpr (array $conds)

See Expression::__construct()

anyChar ()

Returns a token for buildLike() that denotes a '_' to be used in a LIKE query.

anyString ()

Returns a token for buildLike() that denotes a '' to be used in a LIKE query.

begin ( $fname=__METHOD__, $mode=self::TRANSACTION_EXPLICIT)

Begin a transaction.

bitAnd ( $fieldLeft, $fieldRight)

bitNot ( $field)

bitOr ( $fieldLeft, $fieldRight)

buildComparison (string $op, array $conds)

Build a condition comparing multiple values, for use with indexes that cover multiple fields, common when e.g.

buildConcat ( $stringList)

Build a concatenation list to feed into a SQL query.

buildExcludedValue ( $column)

Build a reference to a column value from the conflicting proposed upsert() row.

buildGreatest ( $fields, $values)

Build a GREATEST function statement comparing columns/values.

buildGroupConcatField ( $delim, $tables, $field, $conds='', $join_conds=[])

Build a GROUP_CONCAT or equivalent statement for a query.

buildIntegerCast ( $field)

buildLeast ( $fields, $values)

Build a LEAST function statement comparing columns/values.

buildLike ( $param,... $params)

LIKE statement wrapper.

buildSelectSubquery ( $tables, $vars, $conds='', $fname=__METHOD__, $options=[], $join_conds=[])

Equivalent to IDatabase::selectSQLText() except wraps the result in Subquery.

buildStringCast ( $field)

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

cancelAtomic ( $fname=__METHOD__, ?AtomicSectionIdentifier $sectionId=null)

Cancel an atomic section of SQL statements.

clearFlag ( $flag, $remember=self::REMEMBER_NOTHING)

Clear a flag for this connection.

close ( $fname=__METHOD__)

Close the database connection.

commit ( $fname=__METHOD__, $flush=self::FLUSHING_ONE)

Commits a transaction previously started using begin()

conditional ( $cond, $caseTrueExpression, $caseFalseExpression)

Returns an SQL expression for a simple conditional.

connectionErrorLogger ( $errno, $errstr)

Error handler for logging errors during database connection.

dbSchema ( $schema=null)

Get/set the db schema.

decodeExpiry ( $expiry, $format=TS_MW)

Decode an expiry time into a DBMS independent format.

delete ( $table, $conds, $fname=__METHOD__)

Delete all rows in a table that match a condition.

deleteJoin ( $delTable, $joinTable, $delVar, $joinVar, $conds, $fname=__METHOD__)

Delete all rows in a table that match a condition which includes a join.

doAtomicSection ( $fname, callable $callback, $cancelable=self::ATOMIC_NOT_CANCELABLE)

Perform an atomic section of reversible SQL statements from a callback.

dropTable ( $table, $fname=__METHOD__)

Delete a table.

encodeExpiry ( $expiry)

Encode an expiry time into the DBMS dependent format.

endAtomic ( $fname=__METHOD__)

Ends an atomic section of SQL statements.

estimateRowCount ( $tables, $var=' *', $conds='', $fname=__METHOD__, $options=[], $join_conds=[])

Estimate the number of rows in dataset.MySQL allows you to estimate the number of rows that would be returned by a SELECT query, using EXPLAIN SELECT. The estimate is provided using index cardinality statistics, and is notoriously inaccurate, especially when large numbers of rows have recently been added or deleted.For DBMSs that don't support fast result size estimation, this function will actually perform the SELECT COUNT(*).Takes the same arguments as IDatabase::select().New callers should use newSelectQueryBuilder with SelectQueryBuilder::estimateRowCount instead, which is more readable and less error-prone.

Access: internal

Parameters

string | string[] $tables Table reference(s), using the unqualified name of tables or of the form "information_schema.<identifier>". {

See also: select} for details.

Parameters

string	$var	Column for which NULL values are not counted [default "*"] @phpcs:ignore Generic.Files.LineLength
	string\|IExpression\|array<string,?scalar\|non-empty-array<int,?scalar>\|RawSQLValue>\|array<int,string\|IExpression>	$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}

explicitTrxActive ()

Check whether there is a transaction open at the specific request of a caller.

expr (string $field, string $op, $value)

See Expression::__construct()

factorConds ( $condsArray)

Given an array of condition arrays representing an OR list of AND lists, for example:

fieldExists ( $table, $field, $fname=__METHOD__)

Determines whether a field exists in a table.

flushSession ( $fname=__METHOD__, $flush=self::FLUSHING_ONE)

Release important session-level state (named lock, table locks) as post-rollback cleanup.

flushSnapshot ( $fname=__METHOD__, $flush=self::FLUSHING_ONE)

Commit any transaction but error out if writes or callbacks are pending.

getDBname ()

Get the current database name; null if there isn't one.

getDomainID ()

Return the currently selected domain ID.

getFlag ( $flag)

Returns a boolean whether the flag $flag is set for this connection.

getInfinity ()

Find out when 'infinity' is.

getLag ()

Get the seconds of replication lag on this database server.

getLBInfo ( $name=null)

Get properties passed down from the server info array of the load balancer.

getPrimaryPos ()

Get the replication position of this primary DB server.

getScopedLockAndFlush ( $lockKey, $fname, $timeout)

Acquire a named lock, flush any transaction, and return an RAII style unlocker object.

getServer ()

Get the hostname or IP address of the server.

getServerInfo ()

Get a human-readable string describing the current software version.

getServerName ()

Get the readable name for the server.

getSessionLagStatus ()

Get a cached estimate of the seconds of replication lag on this database server, using the estimate obtained at the start of the current transaction if one is active.

getTableAliases ()

Return current table aliases.

implicitOrderby ()

Returns true if this database does an implicit order by when the column has an index For example: SELECT page_title FROM page LIMIT 1.

indexExists ( $table, $index, $fname=__METHOD__)

Determines whether an index exists.

indexUnique ( $table, $index, $fname=__METHOD__)

Determines if a given index is unique.

initConnection ()

Initialize the connection to the database over the wire (or to local files)

insert ( $table, $rows, $fname=__METHOD__, $options=[])

Insert row(s) into a table, in the provided order.

insertId ()

Get the sequence-based ID assigned by the last query method call.

insertSelect ( $destTable, $srcTable, $varMap, $conds, $fname=__METHOD__, $insertOptions=[], $selectOptions=[], $selectJoinConds=[])

INSERT SELECT wrapper.

isOpen ()

isQuotedIdentifier ( $name)

isReadOnly ()

Check if this DB server is marked as read-only according to load balancer info.

lastDoneWrites ()

Get the last time that the connection was used to commit a write.

limitResult ( $sql, $limit, $offset=false)

Construct a LIMIT query with optional offset.

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}

lockForUpdate ( $table, $conds='', $fname=__METHOD__, $options=[], $join_conds=[])

Lock all rows meeting the given conditions/options FOR UPDATE.

lockIsFree ( $lockName, $method)

Check to see if a named lock is not locked by any thread (non-blocking)

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

makeList (array $a, $mode=self::LIST_COMMA)

Makes an encoded list of strings from an array.

makeWhereFrom2d ( $data, $baseKey, $subKey)

Build a "OR" condition with pairs from a two-dimensional array.

newDeleteQueryBuilder ()

Get a DeleteQueryBuilder bound to this connection.

newInsertQueryBuilder ()

Get a InsertQueryBuilder bound to this connection.

newReplaceQueryBuilder ()

Get a ReplaceQueryBuilder bound to this connection.

newSelectQueryBuilder ()

Get a SelectQueryBuilder bound to this connection.

newUnionQueryBuilder ()

Get a UnionQueryBuilder bound to this connection.

newUpdateQueryBuilder ()

Get an UpdateQueryBuilder bound to this connection.

onTransactionCommitOrIdle (callable $callback, $fname=__METHOD__)

Run a callback when the current transaction commits or now if there is none.

onTransactionPreCommitOrIdle (callable $callback, $fname=__METHOD__)

Run a callback before the current transaction commits or now if there is none.

onTransactionResolution (callable $callback, $fname=__METHOD__)

Run a callback when the current transaction commits or rolls back.

orExpr (array $conds)

See Expression::__construct()

pendingWriteAndCallbackCallers ()

pendingWriteCallers ()

Get the list of method names that did write queries for this transaction.

pendingWriteQueryDuration ( $type=self::ESTIMATE_TOTAL)

Get the time spend running write queries for this transaction.

ping ()

Ping the server and try to reconnect if it there is no connection.

primaryPosWait (DBPrimaryPos $pos, $timeout)

Wait for the replica server to catch up to a given primary server position.

query ( $sql, $fname=__METHOD__, $flags=0)

Run an SQL query statement and return the result.

reportQueryError ( $error, $errno, $sql, $fname, $ignore=false)

Report a query error.

restoreFlags ( $state=self::RESTORE_PRIOR)

Restore the flags to their prior state before the last setFlag/clearFlag call.

rollback ( $fname=__METHOD__, $flush=self::FLUSHING_ONE)

Rollback a transaction previously started using begin()

runOnTransactionIdleCallbacks ( $trigger, array &$errors=[])

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

runOnTransactionPreCommitCallbacks ()

runTransactionListenerCallbacks ( $trigger, array &$errors=[])

Actually run any "transaction listener" callbacks.

select ( $tables, $vars, $conds='', $fname=__METHOD__, $options=[], $join_conds=[])

Execute a SELECT query constructed using the various parameters provided.

selectDomain ( $domain)

Set the current domain (database, schema, and table prefix)

selectField ( $tables, $var, $cond='', $fname=__METHOD__, $options=[], $join_conds=[])

A SELECT wrapper which returns a single field from a single result row.

selectFieldValues ( $tables, $var, $cond='', $fname=__METHOD__, $options=[], $join_conds=[])

A SELECT wrapper which returns a list of single field values from result rows.

selectRow ( $tables, $vars, $conds, $fname=__METHOD__, $options=[], $join_conds=[])

Wrapper to IDatabase::select() that only fetches one row (via LIMIT)

selectRowCount ( $tables, $var=' *', $conds='', $fname=__METHOD__, $options=[], $join_conds=[])

Get the number of rows in dataset.

selectSQLText ( $tables, $vars, $conds='', $fname=__METHOD__, $options=[], $join_conds=[])

Take the same arguments as IDatabase::select() and return the SQL it would use.

sessionLocksPending ()

setFlag ( $flag, $remember=self::REMEMBER_NOTHING)

Set a flag for this connection.

setIndexAliases (array $aliases)

Convert certain index names to alternative names before querying the DB.

setLBInfo ( $nameOrArray, $value=null)

Set the entire array or a particular key of the managing load balancer info array.

setLogger (LoggerInterface $logger)

Set the PSR-3 logger interface to use.

setSchemaVars ( $vars)

Set schema variables to be used when streaming commands from SQL files or stdin.

setSessionOptions (array $options)

Override database's default behavior.

setTransactionListener ( $name, ?callable $callback=null)

Run a callback after each time any transaction commits or rolls back.

setTransactionManager (TransactionManager $transactionManager)

setTrxEndCallbackSuppression ( $suppress)

Whether to disable running of post-COMMIT/ROLLBACK callbacks.

sourceFile ( $filename, ?callable $lineCallback=null, ?callable $resultCallback=null, $fname=false, ?callable $inputCallback=null)

Read and execute SQL commands from a file.

sourceStream ( $fp, ?callable $lineCallback=null, ?callable $resultCallback=null, $fname=__METHOD__, ?callable $inputCallback=null)

Read and execute commands from an open file handle.

startAtomic ( $fname=__METHOD__, $cancelable=self::ATOMIC_NOT_CANCELABLE)

Begin an atomic section of SQL statements.

streamStatementEnd (&$sql, &$newLine)

Called by sourceStream() to check if we've reached a statement end.

strreplace ( $orig, $old, $new)

Returns a SQL expression for simple string replacement (e.g.

tableName (string $name, $format='quoted')

Format a table name ready for use in constructing an SQL query.

tableNamesN (... $tables)

Fetch a number of table names into a zero-indexed numerical array.

tablePrefix ( $prefix=null)

Get/set the table prefix.

timestamp ( $ts=0)

Convert a timestamp in one of the formats accepted by ConvertibleTimestamp to the format used for inserting into timestamp fields in this DBMS.

timestampOrNull ( $ts=null)

Convert a timestamp in one of the formats accepted by ConvertibleTimestamp to the format used for inserting into timestamp fields in this DBMS.

trxLevel ()

Gets the current transaction level.

trxStatus ()

trxTimestamp ()

Get the UNIX timestamp of the time that the transaction was established.

unionQueries ( $sqls, $all, $options=[])

Construct a UNION query.

unionSupportsOrderAndLimit ()

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

unlock ( $lockName, $method)

Release a lock.Named locks are not related to transactions

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}

update ( $table, $set, $conds, $fname=__METHOD__, $options=[])

Update all rows in a table that match a given condition.

upsert ( $table, array $rows, $uniqueKeys, array $set, $fname=__METHOD__)

Upsert row(s) into a table, in the provided order, while updating conflicting rows.

writesOrCallbacksPending ()

Whether there is a transaction open with either possible write queries or unresolved pre-commit/commit/resolution callbacks pending.

writesPending ()

Public Member Functions inherited from Wikimedia\Rdbms\Platform\ISQLPlatform

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

Build a SUBSTRING function.

Static Public Member Functions
static	generateFileName ( $dir, $dbName)
	Generates a database file name.

static	getAttributes ()

static	getFulltextSearchModule ()
	Returns version of currently supported SQLite fulltext search module or false if none present.

static	newStandaloneInstance ( $filename, array $p=[])

Static Public Member Functions inherited from Wikimedia\Rdbms\Database
static	getCacheSetOptions (?IReadableDatabase ... $dbs)
	Merge the result of getSessionLagStatus() for several DBs using the most pessimistic values to estimate the lag of any data derived from them in combination.

Protected Member Functions
	closeConnection ()
	Does not actually close the connection, just destroys the reference for GC to do its work.

	doBegin ( $fname='')
	Issues the BEGIN command to the database server.

	doFlushSession ( $fname)
	Reset the server-side session state for named locks and table locks.

	doHandleSessionLossPreconnect ()
	Reset any additional subclass trx* and session* fields.

	doSelectDomain (DatabaseDomain $domain)

	doSingleStatementQuery (string $sql)
	Run a query and return a QueryStatus instance with the query result information.

	getBindingHandle ()

	getInsertIdColumnForUpsert ( $table)

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

	isKnownStatementRollbackError ( $errno)

	lastInsertId ()
	Get a row ID from the last insert statement to implicitly assign one within the session.

	open ( $server, $user, $password, $db, $schema, $tablePrefix)
	Open a new connection to the database (closing any existing one)

Protected Member Functions inherited from Wikimedia\Rdbms\Database
	assertHasConnectionHandle ()
	Make sure there is an open connection handle (alive or not)

	checkInsertWarnings (Query $query, $fname)
	Check for warnings after performing an INSERT query, and throw exceptions if necessary.

	commenceCriticalSection (string $fname)
	Demark the start of a critical section of session/transaction state changes.

	completeCriticalSection (string $fname, ?CriticalSectionScope $csm, ?Throwable $trxError=null)
	Demark the completion of a critical section of session/transaction state changes.

	doInsertSelectNative ( $destTable, $srcTable, array $varMap, $conds, $fname, array $insertOptions, array $selectOptions, $selectJoinConds)
	Native server-side implementation of insertSelect() for situations where we don't want to select everything into memory.

	executeQuery ( $sql, $fname, $flags)
	Execute a query without enforcing public (non-Database) caller restrictions.

	getLastPHPError ()

	getLogContext (array $extras=[])
	Create a log context to pass to PSR-3 logger functions.

	getReadOnlyReason ()

	getTransactionRoundFname ()

	getValueTypesForWithClause ( $table)

	installErrorHandler ()
	Set a custom error handler for logging errors during database connection.

	isInsertSelectSafe (array $insertOptions, array $selectOptions, $fname)

	isQueryTimeoutError ( $errno)
	Checks whether the cause of the error is detected to be a timeout.

	newExceptionAfterConnectError ( $error)

	registerTempTables (Query $query)
	Register creation and dropping of temporary tables.

	replaceLostConnection ( $lastErrno, $fname)
	Close any existing (dead) database connection and open a new connection.

	restoreErrorHandler ()
	Restore the previous error handler and return the last PHP error for this DB.

Protected Attributes
PDO null	$conn

string null	$dbDir
	Directory for SQLite database files listed under their DB name.

string null	$dbPath
	Explicit path for the SQLite database file.

LockManager null	$lockMgr
	(hopefully on the same server as the DB)

SQLPlatform	$platform

string	$trxMode
	Transaction mode.

Protected Attributes inherited from Wikimedia\Rdbms\Database
string	$agent
	Agent name for query profiling.

bool	$cliMode
	Whether this PHP instance is for a CLI script.

object resource null	$conn
	Database connection.

array< string, mixed >	$connectionParams
	Connection parameters used by initConnection() and open()

string[] int[] float[]	$connectionVariables
	SQL variables values to use for all new connections.

int null	$connectTimeout
	Maximum seconds to wait on connection attempts.

CriticalSectionProvider null	$csProvider

DatabaseDomain	$currentDomain

string false	$delimiter = ';'
	Current SQL query delimiter.

callable	$deprecationLogger
	Deprecation logging callback.

callable	$errorLogger
	Error logging callback.

DatabaseFlags	$flagsHolder

array	$lbInfo = []
	Current LoadBalancer tracking information.

LoggerInterface	$logger

int	$nonNativeInsertSelectBatchSize
	Row batch size to use for emulated INSERT SELECT queries.

callable null	$profiler

int null	$receiveTimeout
	Maximum seconds to wait on receiving query results.

string null	$serverName
	Readable name or host/IP of the database server.

array< string, array >	$sessionNamedLocks = []
	Map of (lock name => (UNIX time,trx ID))

bool	$ssl
	Whether to use SSL connections.

bool	$strictWarnings
	Whether to check for warnings.

array< string, array< string, $sessionTempTables=[];protected int $lastQueryAffectedRows=0;protected int\|null $lastQueryInsertId;protected int\|null $lastEmulatedAffectedRows;protected int\|null $lastEmulatedInsertId;protected string $lastConnectError='';private float $lastPing=0.0;private float\|null $lastWriteTime;private string\|false $lastPhpError=false;private int\|null $csmId;private string\|null $csmFname;private DBUnexpectedError\|null $csmError;public const ATTR_DB_IS_FILE='db-is-file';public const ATTR_DB_LEVEL_LOCKING='db-level-locking';public const ATTR_SCHEMAS_AS_TABLE_GROUPS='supports-schemas';public const NEW_UNCONNECTED=0;public const NEW_CONNECTED=1;protected const ERR_NONE=0;protected const ERR_RETRY_QUERY=1;protected const ERR_ABORT_QUERY=2;protected const ERR_ABORT_TRX=4;protected const ERR_ABORT_SESSION=8;protected const DROPPED_CONN_BLAME_THRESHOLD_SEC=3.0;=private const NOT_APPLICABLE 'n/a';private const PING_TTL=1.0;private const PING_QUERY='SELECT 1 AS ping';protected const CONN_HOST='host';protected const CONN_USER='user';protected const CONN_PASSWORD='password';protected const CONN_INITIAL_DB='dbname';protected const CONN_INITIAL_SCHEMA='schema';protected const CONN_INITIAL_TABLE_PREFIX='tablePrefix';protected SQLPlatform $platform;protected ReplicationReporter $replicationReporter;public function __construct(array $params) { $this->logger=$params[ 'logger'] ?? new NullLogger();$this->	transactionManager
	TempTableInfo>> Map of (DB name => table name => info)

Additional Inherited Members
Public Attributes inherited from Wikimedia\Rdbms\Database
if(is_string( $params['sqlMode'] ?? null))	$flags = (int)$params['flags']

$this	agent = (string)$params['agent']

$this	cliMode = (bool)$params['cliMode']

$this	connectionParams

$this	connectionVariables = $params['variables'] ?? []

$this	connectTimeout = $params['connectTimeout'] ?? null

$this	csProvider = $params['criticalSectionProvider'] ?? null

$this	currentDomain

$this	deprecationLogger = $params['deprecationLogger']

$this	errorLogger = $params['errorLogger']

$this	flagsHolder = new DatabaseFlags( $flags )

$this	lbInfo = $params['lbInfo'] ?? []

$this	nonNativeInsertSelectBatchSize = $params['nonNativeInsertSelectBatchSize'] ?? 10000

$this	platform

$this	profiler = is_callable( $params['profiler'] ) ? $params['profiler'] : null

$this	receiveTimeout = $params['receiveTimeout'] ?? null

$this	serverName = $params['serverName']

$this	ssl = $params['ssl'] ?? (bool)( $flags & self::DBO_SSL )

$this	strictWarnings = !empty( $params['strictWarnings'] )

$this	tracer = $params['tracer'] ?? new NoopTracer()

Public Attributes inherited from Wikimedia\Rdbms\IDatabase
const	ATOMIC_CANCELABLE = 'cancelable'
	Atomic section is cancelable.

const	ATOMIC_NOT_CANCELABLE = ''
	Atomic section is not cancelable.

const	ESTIMATE_DB_APPLY = 'apply'
	Estimate time to apply (scanning, applying)

const	ESTIMATE_TOTAL = 'total'
	Estimate total time (RTT, scanning, waiting on locks, applying)

const	FLUSHING_ALL_PEERS = 'flush'
	Commit/rollback is from the owning connection manager for the IDatabase handle.

const	FLUSHING_INTERNAL = 'flush-internal'
	Commit/rollback is from the IDatabase handle internally.

const	FLUSHING_ONE = ''
	Commit/rollback is from outside the IDatabase handle and connection manager.

const	LB_READ_ONLY_REASON = 'readOnlyReason'
	Field for getLBInfo()/setLBInfo(); configured read-only mode explanation or false.

const	LB_TRX_ROUND_FNAME = 'trxRoundOwner'
	Field for getLBInfo()/setLBInfo(); relevant transaction round owner name or null.

const	LB_TRX_ROUND_ID = self::LB_TRX_ROUND_FNAME
	Alias to LB_TRX_ROUND_FNAME.

const	LB_TRX_ROUND_LEVEL = 'trxRoundLevel'
	Field for getLBInfo()/setLBInfo(); relevant transaction round level (1 or 0)

const	LOCK_TIMESTAMP = 1
	Flag to return the lock acquisition timestamp (null if not acquired)

const	ROLE_STATIC_CLONE = 'static-clone'
	Replica server within a static dataset.

const	ROLE_STREAMING_MASTER = 'streaming-master'
	Primary server than can stream writes to replica servers.

const	ROLE_STREAMING_REPLICA = 'streaming-replica'
	Replica server that receives writes from a primary server.

const	ROLE_UNKNOWN = 'unknown'
	Server with unknown topology role.

const	TRANSACTION_EXPLICIT = ''
	Transaction is requested by regular caller outside of the DB layer.

const	TRANSACTION_INTERNAL = 'implicit'
	Transaction is requested internally via DBO_TRX/startAtomic()

const	TRIGGER_CANCEL = 4
	Callback triggered by atomic section cancel (ROLLBACK TO SAVEPOINT)

const	TRIGGER_COMMIT = 2
	Callback triggered by COMMIT.

const	TRIGGER_IDLE = 1
	Callback triggered immediately due to no active transaction.

const	TRIGGER_ROLLBACK = 3
	Callback triggered by ROLLBACK.

Public Attributes inherited from Wikimedia\Rdbms\IReadableDatabase
const	UNION_ALL = true
	Parameter to unionQueries() for UNION ALL.

const	UNION_DISTINCT = false
	Parameter to unionQueries() for UNION DISTINCT.

Public Attributes inherited from Wikimedia\Rdbms\Platform\ISQLPlatform
const	ALL_ROWS = '*'
	Unconditional update/delete of whole table.

const	CALLER_SUBQUERY = 'subquery'
	Special value for ->caller() / $fname parameter used when providing a caller is not expected, because we're formatting a subquery that won't be executed directly.

const	CALLER_UNKNOWN = 'unknown'
	Special value for ->caller() / $fname parameter used when a caller is not provided.

const	LIST_AND = 1
	Combine list with AND clauses.

const	LIST_COMMA = 0
	Combine list with comma delimiters.

const	LIST_NAMES = 3
	Treat as field name and do not apply value escaping.

const	LIST_OR = 4
	Combine list with OR clauses.

const	LIST_SET = 2
	Convert map into a SET clause.

const	QUERY_CHANGE_LOCKS = 512
	Query is a command for advisory locks.

const	QUERY_CHANGE_NONE = 32
	Query is a read-only Data Query Language query.

const	QUERY_CHANGE_ROWS = 128
	Query is a Data Manipulation Language command (INSERT, DELETE, LOCK, ...)

const	QUERY_CHANGE_SCHEMA = 256
	Query is a Data Definition Language command.

const	QUERY_CHANGE_TRX = 64
	Query is a Transaction Control Language command (BEGIN, USE, SET, ...)

const	QUERY_IGNORE_DBO_TRX = 8
	Ignore the current presence of any DBO_TRX flag.

const	QUERY_NO_RETRY = 16
	Do not try to retry the query if the connection was lost.

const	QUERY_NORMAL = 0
	Idiom for "no special flags".

const	QUERY_PSEUDO_PERMANENT = 2
	Track a TEMPORARY table CREATE as if it was for a permanent table (for testing)

const	QUERY_REPLICA_ROLE = 4
	Enforce that a query does not make effective writes.

const	QUERY_SILENCE_ERRORS = 1
	Ignore query errors and return false when they happen.

Public Attributes inherited from Wikimedia\Rdbms\Database\IDatabaseFlags
const	DBO_COMPRESS = 512
	Enable compression in connection protocol.

const	DBO_DDLMODE = 128
	Schema file mode; was used by Oracle.

const	DBO_DEBUG = 1
	Enable debug logging of all SQL queries.

const	DBO_DEFAULT = 16
	Join load balancer transaction rounds (which control DBO_TRX) in non-CLI mode.

const	DBO_GAUGE = 1024
	Optimize connection for guaging server state (e.g.

const	DBO_IGNORE = 4
	Unused since 1.31.

const	DBO_NOBUFFER = 2
	Unused since 1.34.

const	DBO_PERSISTENT = 32
	Use DB persistent connections if possible.

const	DBO_SSL = 256
	Enable SSL/TLS in connection protocol.

const	DBO_SYSDBA = 64
	DBA session mode; was used by Oracle.

const	DBO_TRX = 8
	Automatically start a transaction before running a query if none is active.

const	REMEMBER_NOTHING = ''
	Do not remember the prior flags.

const	REMEMBER_PRIOR = 'remember'
	Remember the prior flags.

const	RESTORE_INITIAL = 'initial'
	Restore to the initial flag state.

const	RESTORE_PRIOR = 'prior'
	Restore to the prior flag state.

Detailed Description

This is the SQLite database abstraction layer.

See docs/sqlite.txt for development notes about MediaWiki's sqlite schema.

Definition at line 40 of file DatabaseSqlite.php.

Constructor & Destructor Documentation

◆ __construct()

Wikimedia\Rdbms\DatabaseSqlite::__construct ( array $params )

Additional params include:

dbDirectory : directory containing the DB and the lock file directory
dbFilePath : use this to force the path of the DB file
trxMode : one of (deferred, immediate, exclusive)

Definition at line 84 of file DatabaseSqlite.php.

References Wikimedia\Rdbms\Database\currentDomain, Wikimedia\Rdbms\Database\errorLogger, and Wikimedia\Rdbms\Database\platform.

Member Function Documentation

◆ addQuotes()

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

Escape and quote a raw value string for use in a SQL query.

Parameters

?scalar | RawSQLValue | Blob $s

Returns: string

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 634 of file DatabaseSqlite.php.

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

◆ databasesAreIndependent()

Wikimedia\Rdbms\DatabaseSqlite::databasesAreIndependent ( )

Returns true if DBs are assumed to be on potentially different servers.

In systems like mysql/mariadb, different databases can easily be referenced on a single connection merely by name, even in a single query via JOIN. On the other hand, Postgres treats databases as logically separate, with different database users, requiring special mechanisms like postgres_fdw to "mount" foreign DBs. This is true even among DBs on the same server. Changing the selected database via selectDomain() requires a new connection.

Returns: bool

Since: 1.29

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 866 of file DatabaseSqlite.php.

◆ decodeBlob()

Wikimedia\Rdbms\DatabaseSqlite::decodeBlob ( $b )

Parameters

Blob | string $b

Returns: string

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 621 of file DatabaseSqlite.php.

◆ doBegin()

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

protected

Issues the BEGIN command to the database server.

See also: Database::begin()

Parameters

string $fname

Exceptions

DBError

Reimplemented from Wikimedia\Rdbms\Database.

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

◆ doHandleSessionLossPreconnect()

Wikimedia\Rdbms\DatabaseSqlite::doHandleSessionLossPreconnect ( )

protected

Reset any additional subclass trx* and session* fields.

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 870 of file DatabaseSqlite.php.

◆ doLock()

Wikimedia\Rdbms\DatabaseSqlite::doLock	(	string	$lockName,
		string	$method,
		int	$timeout )

See also: lock()

Parameters

string	$lockName
string	$method
int	$timeout

Returns: float|null UNIX timestamp of lock acquisition; null on failure

Exceptions

DBError

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 671 of file DatabaseSqlite.php.

◆ doLockIsFree()

Wikimedia\Rdbms\DatabaseSqlite::doLockIsFree	(	string	$lockName,
		string	$method )

See also: lockIsFree()

Parameters

string	$lockName
string	$method

Returns: bool Success

Exceptions

DBError

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 666 of file DatabaseSqlite.php.

◆ doSelectDomain()

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

protected

Parameters

DatabaseDomain $domain

Exceptions

DBConnectionError
DBError

Since: 1.32

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 403 of file DatabaseSqlite.php.

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

◆ doSingleStatementQuery()

Wikimedia\Rdbms\DatabaseSqlite::doSingleStatementQuery ( string $sql )

protected

Run a query and return a QueryStatus instance with the query result information.

This is meant to handle the basic command of actually sending a query to the server via the driver. No implicit transaction, reconnection, nor retry logic should happen here. The higher level query() method is designed to handle those sorts of concerns. This method should not trigger such higher level methods.

The lastError() and lastErrno() methods should meaningfully reflect what error, if any, occurred during the last call to this method. Methods like executeQuery(), query(), select(), insert(), update(), delete(), and upsert() implement their calls to doQuery() such that an immediately subsequent call to lastError()/lastErrno() meaningfully reflects any error that occurred during that public query method call.

For SELECT queries, the result field contains either:

a) A driver-specific IResultWrapper describing the query results
b) False, on any query failure

For non-SELECT queries, the result field contains either:

a) A driver-specific IResultWrapper, only on success
b) True, only on success (e.g. no meaningful result other than "OK")
c) False, on any query failure

Parameters

string $sql Single-statement SQL query

Returns: QueryStatus

Since: 1.39

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 392 of file DatabaseSqlite.php.

◆ doUnlock()

Wikimedia\Rdbms\DatabaseSqlite::doUnlock	(	string	$lockName,
		string	$method )

See also: unlock()

Parameters

string	$lockName
string	$method

Returns: bool Success

Exceptions

DBError

Reimplemented from Wikimedia\Rdbms\Database.

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

◆ encodeBlob()

Wikimedia\Rdbms\DatabaseSqlite::encodeBlob ( $b )

Parameters

string $b

Returns: Blob

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 613 of file DatabaseSqlite.php.

◆ fieldInfo()

Wikimedia\Rdbms\DatabaseSqlite::fieldInfo	(		$table,
			$field )

Get information about a given field Returns false if the field does not exist.

Parameters

string	$table
string	$field

Returns: SQLiteField|false False on failure

Implements Wikimedia\Rdbms\IMaintainableDatabase.

Definition at line 573 of file DatabaseSqlite.php.

◆ 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 \| null	$dbName	Database name (or null from Database::factory, validated here)

Returns: string

Exceptions

DBUnexpectedError

Definition at line 304 of file DatabaseSqlite.php.

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

◆ getAttributes()

static Wikimedia\Rdbms\DatabaseSqlite::getAttributes ( )

static

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

Since: 1.31

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 112 of file DatabaseSqlite.php.

◆ getBindingHandle()

Wikimedia\Rdbms\DatabaseSqlite::getBindingHandle ( )

protected

Returns: PDO

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 888 of file DatabaseSqlite.php.

◆ getDbFilePath()

Wikimedia\Rdbms\DatabaseSqlite::getDbFilePath ( )

Returns: string|null SQLite DB file path

Exceptions

DBUnexpectedError

Since: 1.25

Definition at line 251 of file DatabaseSqlite.php.

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

◆ getFulltextSearchModule()

static Wikimedia\Rdbms\DatabaseSqlite::getFulltextSearchModule ( )

static

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

Returns: string|false

Definition at line 348 of file DatabaseSqlite.php.

References Wikimedia\Rdbms\Platform\ISQLPlatform\QUERY_SILENCE_ERRORS.

◆ getInsertIdColumnForUpsert()

Wikimedia\Rdbms\DatabaseSqlite::getInsertIdColumnForUpsert ( $table )

protected

Parameters

string $table The unqualified name of a table

Returns: string|null The AUTO_INCREMENT/SERIAL column; null if not needed

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 892 of file DatabaseSqlite.php.

◆ getLockFileDirectory()

Wikimedia\Rdbms\DatabaseSqlite::getLockFileDirectory ( )

Returns: string|null Lock file directory

Definition at line 258 of file DatabaseSqlite.php.

◆ getServerVersion()

Wikimedia\Rdbms\DatabaseSqlite::getServerVersion ( )

Returns: string Version information from the database

Implements Wikimedia\Rdbms\IReadableDatabase.

Definition at line 557 of file DatabaseSqlite.php.

◆ getSoftwareLink()

Wikimedia\Rdbms\DatabaseSqlite::getSoftwareLink ( )

Returns: string Wikitext of a link to the server software's web site

Implements Wikimedia\Rdbms\IReadableDatabase.

Definition at line 550 of file DatabaseSqlite.php.

◆ getType()

Wikimedia\Rdbms\DatabaseSqlite::getType ( )

Returns: string

Implements Wikimedia\Rdbms\IReadableDatabase.

Definition at line 142 of file DatabaseSqlite.php.

◆ indexInfo()

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

Get information about an index into an object.

Parameters

string	$table	The unqualified name of a table
string	$index	Index name
string	$fname	Calling function name

Returns: array<string,mixed>|false Index info map; false if it does not exist

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 488 of file DatabaseSqlite.php.

◆ isConnectionError()

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

protected

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

Parameters

int | string $errno

Returns: bool Whether the given query error was a connection drop

Since: 1.38

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 527 of file DatabaseSqlite.php.

◆ isKnownStatementRollbackError()

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

protected

Parameters

int | string $errno

Returns: bool Whether it is known that the last query error only caused statement rollback

Note: This is for backwards compatibility for callers catching DBError exceptions in order to ignore problems like duplicate key errors or foreign key violations

Since: 1.39

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 531 of file DatabaseSqlite.php.

◆ lastErrno()

Wikimedia\Rdbms\DatabaseSqlite::lastErrno ( )

Returns: int

Implements Wikimedia\Rdbms\IReadableDatabase.

Definition at line 459 of file DatabaseSqlite.php.

◆ lastError()

Wikimedia\Rdbms\DatabaseSqlite::lastError ( )

Returns: string

Implements Wikimedia\Rdbms\IReadableDatabase.

Definition at line 446 of file DatabaseSqlite.php.

◆ lastInsertId()

Wikimedia\Rdbms\DatabaseSqlite::lastInsertId ( )

protected

Get a row ID from the last insert statement to implicitly assign one within the session.

If the statement involved assigning sequence IDs to multiple rows, then the return value will be any one of those values (database-specific). If the statement was an "UPSERT" and some existing rows were updated, then the result will either reflect only IDs of created rows or it will reflect IDs of both created and updated rows (this is database-specific).

The result is unspecified if the statement gave an error.

Returns: int Sequence ID, 0 (if none)

Exceptions

DBError

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 438 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 796 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 128 of file DatabaseSqlite.php.

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

References Wikimedia\Rdbms\DatabaseSqlite\$dbPath, $path, Wikimedia\Rdbms\Database\close(), Wikimedia\Rdbms\Database\connectionVariables, Wikimedia\Rdbms\Database\currentDomain, Wikimedia\Rdbms\DatabaseSqlite\generateFileName(), Wikimedia\Rdbms\Database\getFlag(), Wikimedia\Rdbms\Database\getLogContext(), Wikimedia\Rdbms\Database\newExceptionAfterConnectError(), Wikimedia\Rdbms\Database\platform, and Wikimedia\Rdbms\Database\query().

◆ replace()

Wikimedia\Rdbms\DatabaseSqlite::replace	(	$table,
		$uniqueKeys,
		$rows,
		$fname = __METHOD__ )

Insert row(s) into a table, in the provided order, while deleting conflicting rows.

Conflicts are determined by the provided unique indexes. Note that it is possible for the provided rows to conflict even among themselves; it is preferable for the caller to de-duplicate such input beforehand.

Note some important implications of the deletion semantics:

If the table has an AUTOINCREMENT column and $rows omit that column, then any conflicting existing rows will be replaced with newer having higher values for that column, even if nothing else changed.
There might be worse contention than upsert() due to the use of gap-locking. This does not apply to RDBMS types that use predicate locking nor those that just lock the whole table or databases anyway.

This operation will be seen by affectedRows()/insertId() as one query statement, regardless of how many statements are actually sent by the class implementation.

Access: internal: callers outside of rdbms library should use ReplaceQueryBuilder instead.

Parameters

string	$table	The unqualified name of a table
string \| string[] \| string[][]	$uniqueKeys	Column name or non-empty list of column name lists that define all applicable unique keys on the table. There must only be one such key. Each unique key on the table is "applicable" unless either: It involves an AUTOINCREMENT column for which no values are assigned in $rows It involves a UUID column for which newly generated UUIDs are assigned in $rows
array \| array[]	$rows	Row(s) to insert, in the form of either: A string-keyed map of (column name => value) defining a new row. Values are treated as literals and quoted appropriately; null is interpreted as NULL. Columns belonging to a key in $uniqueKeys must be defined here and non-null. An integer-keyed list of such string-keyed maps, defining a list of new rows. The keys in each map must be identical to each other and in the same order. The rows must not collide with each other.
string	$fname	Calling function name (use METHOD) for logs/profiling

Exceptions

DBError If an error occurs, {

See also: query}

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 508 of file DatabaseSqlite.php.

◆ serverIsReadOnly()

Wikimedia\Rdbms\DatabaseSqlite::serverIsReadOnly ( )

Returns: bool Whether this DB server is running in server-side read-only mode

Exceptions

DBError If an error occurs, {

See also: query}

Since: 1.28

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 539 of file DatabaseSqlite.php.

References $path.

◆ setTableAliases()

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

Make certain table names use their own database, schema, and table prefix when passed into SQL queries pre-escaped and without a qualified database name.

For example, "user" can be converted to "myschema.mydbname.user" for convenience. Appearances like user, somedb.user, somedb.someschema.user will used literally.

Calling this twice will completely clear any old table aliases. Also, note that callers are responsible for making sure the schemas and databases actually exist.

Parameters

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

Since: 1.28 in IDatabase, moved to ISQLPlatform in 1.39

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 844 of file DatabaseSqlite.php.

◆ strencode()

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

Parameters

string $s

Returns: string

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 605 of file DatabaseSqlite.php.

◆ tableExists()

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

Query whether a given table exists.

Parameters

string	$table	The unqualified name of a table
string	$fname

Returns: bool

Exceptions

DBError If an error occurs, {

See also: query}

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 471 of file DatabaseSqlite.php.

◆ truncateTable()

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

Delete all data in a table and reset any sequences owned by that table.

Parameters

string	$table	The unqualified name of a table
string	$fname

Exceptions

DBError If an error occurs

Since: 1.42

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 820 of file DatabaseSqlite.php.

Member Data Documentation

◆ $conn

PDO null 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 42 of file DatabaseSqlite.php.

◆ $dbPath

string null Wikimedia\Rdbms\DatabaseSqlite::$dbPath

protected

Explicit path for the SQLite database file.

Definition at line 44 of file DatabaseSqlite.php.

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

◆ $lockMgr

LockManager null Wikimedia\Rdbms\DatabaseSqlite::$lockMgr

protected

(hopefully on the same server as the DB)

Definition at line 52 of file DatabaseSqlite.php.

◆ $platform

SQLPlatform Wikimedia\Rdbms\DatabaseSqlite::$platform

protected

Initial value:

=[[,,,],[,],,,]
    private const VALID_PRAGMAS  
        
        'synchronous' =>  'EXTRA' 'FULL' 'NORMAL' 'OFF' 
        
        'temp_store' =>  'FILE' 'MEMORY' 
        
        'mmap_size' => 'integer'
        
        'cache_size' => 'integer'

Definition at line 76 of file DatabaseSqlite.php.

◆ $trxMode

string Wikimedia\Rdbms\DatabaseSqlite::$trxMode

protected

Transaction mode.

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

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addQuotes()

◆ attachDatabase()

◆ closeConnection()

◆ databasesAreIndependent()

◆ decodeBlob()

◆ doBegin()

◆ doFlushSession()

◆ doHandleSessionLossPreconnect()

◆ doLock()

◆ doLockIsFree()

◆ doSelectDomain()

◆ doSingleStatementQuery()

◆ doUnlock()

◆ duplicateTableStructure()

◆ encodeBlob()

◆ fieldInfo()

◆ generateFileName()

◆ getAttributes()

◆ getBindingHandle()

◆ getDbFilePath()

◆ getFulltextSearchModule()

◆ getInsertIdColumnForUpsert()

◆ getLockFileDirectory()

◆ getServerVersion()

◆ getSoftwareLink()

◆ getType()

◆ indexInfo()

◆ isConnectionError()

◆ isKnownStatementRollbackError()

◆ lastErrno()

◆ lastError()

◆ lastInsertId()

◆ listTables()

◆ newStandaloneInstance()

◆ open()

◆ replace()

◆ serverIsReadOnly()

◆ setTableAliases()

◆ strencode()

◆ tableExists()

◆ truncateTable()

Member Data Documentation

◆ $conn

◆ $dbDir

◆ $dbPath

◆ $lockMgr

◆ $platform

◆ $trxMode