Inheritance diagram for Wikimedia\Rdbms\DatabaseSqlite:

[legend]

Collaboration diagram for Wikimedia\Rdbms\DatabaseSqlite:

[legend]

Public Member Functions
	__construct (array $p)
	Additional params include:

	__toString ()

	addQuotes ( $s)

	attachDatabase ( $name, $file=false, $fname=__METHOD__)
	Attaches external database to our connection, see https://sqlite.org/lang_attach.html for details.

	buildConcat ( $stringList)
	Build a concatenation list to feed into a SQL query.

	buildGroupConcatField ( $delim, $table, $field, $conds='', $join_conds=[])
	Build a GROUP_CONCAT or equivalent statement for a query.

	buildStringCast ( $field)

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

	checkForEnabledSearch ()
	Check if the searchindext table is FTS enabled.

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

	dataSeek ( $res, $row)

	deadlockLoop ()
	No-op version of deadlockLoop.

	decodeBlob ( $b)

	dropTable ( $tableName, $fName=__METHOD__)
	Override due to no CASCADE support.

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

	encodeBlob ( $b)

	fetchObject ( $res)

	fetchRow ( $res)

	fieldInfo ( $table, $field)
	Get information about a given field Returns false if the field does not exist.

	fieldName ( $res, $n)

	freeResult ( $res)

	getDbFilePath ()

	getServerVersion ()

	getSoftwareLink ()

	getType ()

	implicitGroupby ()

	indexInfo ( $table, $index, $fname=__METHOD__)
	Returns information about an index Returns false if the index does not exist.

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

	insert ( $table, $a, $fname=__METHOD__, $options=[])
	Based on generic method (parent) with some prior SQLite-sepcific adjustments.

	insertId ()
	This must be called after nextSequenceVal.

	lastErrno ()

	lastError ()

	listTables ( $prefix=null, $fname=__METHOD__)
	List all tables on the database.

	lock ( $lockName, $method, $timeout=5)
	Acquire a named lock.

	makeInsertOptions ( $options)

	makeSelectOptions ( $options)
	Filter the options used in SELECT statements.

	numFields ( $res)

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

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

	resetSequenceForTable ( $table, $fname=__METHOD__)

	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.

	tableName ( $name, $format='quoted')
	Use MySQL's naming (accounts for prefix etc) but remove surrounding backticks.

	textFieldSize ( $table, $field)
	Returns the size of a text field, or -1 for "unlimited" In SQLite this is SQLITE_MAX_LENGTH, by default 1GB.

	unionQueries ( $sqls, $all)

	unionSupportsOrderAndLimit ()

	unlock ( $lockName, $method)
	Release a lock.

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

	wasDeadlock ()

	wasReadOnlyError ()

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 sanity checks and close dangling connections.

	__sleep ()
	Called by serialize.

	addIdentifierQuotes ( $s)
	Quotes an identifier, in order to make user controlled input safe.

	affectedRows ()
	Get the number of rows affected by the last write query.

	aggregateValue ( $valuedata, $valuename='value')
	Return aggregated value alias.

	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.

	assertNoOpenTransactions ()
	Assert that all explicit transactions or atomic sections have been closed.

	begin ( $fname=__METHOD__, $mode=self::TRANSACTION_EXPLICIT)
	Begin a transaction.

	bitAnd ( $fieldLeft, $fieldRight)

	bitNot ( $field)

	bitOr ( $fieldLeft, $fieldRight)

	bufferResults ( $buffer=null)
	Turns buffering of SQL result sets on (true) or off (false).

	buildIntegerCast ( $field)

	buildLike ()
	LIKE statement wrapper, receives 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().

	buildSelectSubquery ( $table, $vars, $conds='', $fname=__METHOD__, $options=[], $join_conds=[])
	Equivalent to IDatabase::selectSQLText() except wraps the result in Subqyery.

	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 ()
	Close the database connection.

	commit ( $fname=__METHOD__, $flush=self::FLUSHING_ONE)
	Commits a transaction previously started using begin().

	conditional ( $cond, $trueVal, $falseVal)
	Returns an SQL expression for a simple conditional.

	connectionErrorLogger ( $errno, $errstr)
	Error handler for logging errors during database connection This method should not be used outside of Database classes.

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

	deleteJoin ( $delTable, $joinTable, $delVar, $joinVar, $conds, $fname=__METHOD__)
	DELETE where the condition is a join.

	doAtomicSection ( $fname, callable $callback, $cancelable=self::ATOMIC_NOT_CANCELABLE)
	Perform an atomic section of reversable SQL statements from a callback.

	doneWrites ()
	Returns true if the connection may have been used for write queries.

	encodeExpiry ( $expiry)
	Encode an expiry time into the DBMS dependent format.

	endAtomic ( $fname=__METHOD__)
	Ends an atomic section of SQL statements.

	estimateRowCount ( $table, $var=' *', $conds='', $fname=__METHOD__, $options=[], $join_conds=[])
	Estimate the number of rows in dataset.

	explicitTrxActive ()

	fieldExists ( $table, $field, $fname=__METHOD__)
	Determines whether a field exists in a table.

	flushSnapshot ( $fname=__METHOD__)
	Commit any transaction but error out if writes or callbacks are pending.

	getDBname ()
	Get the current DB name.

	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 amount of replication lag for this database server.

	getLBInfo ( $name=null)
	Get properties passed down from the server info array of the load balancer.

	getMasterPos ()
	Get the position of this master.

	getProperty ( $name)

	getReplicaPos ()
	Get the replication position of this replica DB.

	getScopedLockAndFlush ( $lockKey, $fname, $timeout)
	Acquire a named lock, flush any transaction, and return an RAII style unlocker object.

	getServer ()
	Get the server hostname or IP address.

	getServerInfo ()
	A string describing the current software version, and possibly other details in a user-friendly way.

	getServerUptime ()
	Determines how long the server has been up.

	getSessionLagStatus ()
	Get the replica DB lag when the current transaction started or a general lag estimate if not transaction is active.

	getWikiID ()
	Alias for getDomainID()

	ignoreIndexClause ( $index)
	IGNORE INDEX clause.

	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 Usually throws a DBQueryError on failure If errors are explicitly ignored, returns NULL on failure.

	indexUnique ( $table, $index)
	Determines if a given index is unique.

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

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

	isOpen ()
	Is a connection to the database open?

	isQuotedIdentifier ( $name)
	Returns if the given identifier looks quoted or not according to the database convention for quoting identifiers .

	isReadOnly ()

	lastDoneWrites ()
	Returns the last time the connection may have been used for write queries.

	lastQuery ()
	Return the last query that went through IDatabase::query()

	limitResult ( $sql, $limit, $offset=false)
	Construct a LIMIT query with optional offset.

	listViews ( $prefix=null, $fname=__METHOD__)
	Lists all the VIEWs in the database.

	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)

	lockTables (array $read, array $write, $method)
	Lock specific tables.

	makeList ( $a, $mode=self::LIST_COMMA)
	Makes an encoded list of strings from an array.

	makeWhereFrom2d ( $data, $baseKey, $subKey)
	Build a partial where clause from a 2-d array such as used for LinkBatch.

	masterPosWait (DBMasterPos $pos, $timeout)
	Wait for the replica DB to catch up to a given master position.

	maxListLen ()
	Return the maximum number of items allowed in a list, or 0 for unlimited.

	namedLocksEnqueue ()
	Check to see if a named lock used by lock() use blocking queues.

	nextSequenceValue ( $seqName)
	Deprecated method, calls should be removed.

	onAtomicSectionCancel (callable $callback, $fname=__METHOD__)
	Run a callback when the atomic section is cancelled.

	onTransactionCommitOrIdle (callable $callback, $fname=__METHOD__)
	Run a callback as soon as there is no transaction pending.

	onTransactionIdle (callable $callback, $fname=__METHOD__)
	Alias for onTransactionCommitOrIdle() for backwards-compatibility.

	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 as soon as the current transaction commits or rolls back.

	pendingWriteAndCallbackCallers ()
	List the methods that have write queries or callbacks for the current transaction.

	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.

	pendingWriteRowsAffected ()
	Get the number of affected rows from pending write queries.

	ping (&$rtt=null)
	Ping the server and try to reconnect if it there is no connection.

	preCommitCallbacksPending ()

	query ( $sql, $fname=__METHOD__, $flags=0)
	Run an SQL query and return the result.

	reportConnectionError ( $error='Unknown error')

	reportQueryError ( $error, $errno, $sql, $fname, $ignoreErrors=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='')
	Rollback a transaction previously started using begin().

	runOnTransactionIdleCallbacks ( $trigger)
	Actually consume and run any "on transaction idle/resolution" callbacks.

	runOnTransactionPreCommitCallbacks ()
	Actually consume and run any "on transaction pre-commit" callbacks.

	runTransactionListenerCallbacks ( $trigger)
	Actually run any "transaction listener" callbacks.

	select ( $table, $vars, $conds='', $fname=__METHOD__, $options=[], $join_conds=[])
	Execute a SELECT query constructed using the various parameters provided.

	selectDB ( $db)
	Change the current database.

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

	selectField ( $table, $var, $cond='', $fname=__METHOD__, $options=[], $join_conds=[])
	A SELECT wrapper which returns a single field from a single result row.

	selectFieldValues ( $table, $var, $cond='', $fname=__METHOD__, $options=[], $join_conds=[])
	A SELECT wrapper which returns a list of single field values from result rows.

	selectRow ( $table, $vars, $conds, $fname=__METHOD__, $options=[], $join_conds=[])
	Single row SELECT wrapper.

	selectRowCount ( $tables, $var=' *', $conds='', $fname=__METHOD__, $options=[], $join_conds=[])
	Get the number of rows in dataset.

	selectSQLText ( $table, $vars, $conds='', $fname=__METHOD__, $options=[], $join_conds=[])
	The equivalent of IDatabase::select() except that the constructed SQL is returned, instead of being immediately executed.

	serverIsReadOnly ()

	setBigSelects ( $value=true)
	Allow or deny "big selects" for this session only.

	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.

	setLazyMasterHandle (IDatabase $conn)
	Set a lazy-connecting DB handle to the master DB (for replication status purposes)

	setLBInfo ( $name, $value=null)
	Set the LB info array, or a member of it.

	setLogger (LoggerInterface $logger)
	Set the PSR-3 logger interface to use for query logging.

	setSchemaVars ( $vars)
	Set variables to be used in sourceFile/sourceStream, in preference to the ones in $GLOBALS.

	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.

	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 command for str_replace function in SQL query.

	tableLocksHaveTransactionScope ()
	Checks if table locks acquired by lockTables() are transaction-bound in their scope.

	tableNames ()
	Fetch a number of table names into an array This is handy when you need to construct SQL for joins.

	tableNamesN ()
	Fetch a number of table names into an zero-indexed numerical array This is handy when you need to construct SQL for joins.

	tablePrefix ( $prefix=null)
	Get/set the table prefix.

	timestamp ( $ts=0)
	Convert a timestamp in one of the formats accepted by wfTimestamp() 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 wfTimestamp() 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.

	unionConditionPermutations ( $table, $vars, array $permute_conds, $extra_conds='', $fname=__METHOD__, $options=[], $join_conds=[])
	Construct a UNION query for permutations of conditions.

	unlockTables ( $method)
	Unlock all tables locked via lockTables()

	update ( $table, $values, $conds, $fname=__METHOD__, $options=[])
	UPDATE wrapper.

	upsert ( $table, array $rows, $uniqueIndexes, array $set, $fname=__METHOD__)
	INSERT ON DUPLICATE KEY UPDATE wrapper, upserts an array into a table.

	useIndexClause ( $index)
	USE INDEX clause.

	wasConnectionLoss ()
	Determines if the last query error was due to a dropped connection.

	wasErrorReissuable ()
	Determines if the last query error was due to something outside of the query itself.

	wasLockTimeout ()
	Determines if the last failure was due to a lock timeout.

	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\IDatabase
	buildSubString ( $input, $startPosition, $length=null)
	Build a SUBSTRING function.

Static Public Member Functions
static	fixIgnore ( $options)

static	generateFileName ( $dir, $dbName)
	Generates a database file name.

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	attributesFromType ( $dbType, $driver=null)

static	factory ( $dbType, $p=[], $connect=self::NEW_CONNECTED)
	Construct a Database subclass instance given a database type and parameters.

static	getCacheSetOptions (IDatabase $db1, IDatabase $db2=null)
	Merge the result of getSessionLagStatus() for several DBs using the most pessimistic values to estimate the lag of any data derived from them in combination.

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.

	doInitConnection ()
	Actually connect to the database over the wire (or to local files)

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

	fetchAffectedRowCount ()

	getBindingHandle ()

	isTransactableQuery ( $sql)
	Determine whether a SQL statement is sensitive to isolation level.

	isWriteQuery ( $sql)
	Determine whether a query writes to the DB.

	makeUpdateOptionsArray ( $options)

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

	openFile ( $fileName, $dbName, $tablePrefix)
	Opens a database file.

	replaceVars ( $s)

	wasKnownStatementRollbackError ()

Protected Member Functions inherited from Wikimedia\Rdbms\Database
	assertBuildSubstringParams ( $startPosition, $length)
	Check type and bounds for parameters to self::buildSubstring()

	assertHasConnectionHandle ()
	Make sure there is an open connection handle (alive or not) as a sanity check.

	assertIsWritableMaster ()
	Make sure that this server is not marked as a replica nor read-only as a sanity check.

	doCommit ( $fname)
	Issues the COMMIT command to the database server.

	doLockTables (array $read, array $write, $method)
	Helper function for lockTables() that handles the actual table locking.

	doReleaseSavepoint ( $identifier, $fname)
	Release a savepoint.

	doRollback ( $fname)
	Issues the ROLLBACK command to the database server.

	doRollbackToSavepoint ( $identifier, $fname)
	Rollback to a savepoint.

	doSavepoint ( $identifier, $fname)
	Create a savepoint.

	doSelectDomain (DatabaseDomain $domain)

	doUnlockTables ( $method)
	Helper function for unlockTables() that handles the actual table unlocking.

	escapeLikeInternal ( $s, $escapeChar='`')

	extractSingleFieldFromList ( $var)

	fieldNamesWithAlias ( $fields)
	Gets an array of aliased field names.

	fieldNameWithAlias ( $name, $alias=false)
	Get an aliased field name e.g.

	getApproximateLagStatus ()
	Get a replica DB lag estimate for this server.

	getDefaultSchemaVars ()
	Get schema variables to use if none have been set via setSchemaVars().

	getLastPHPError ()

	getLazyMasterHandle ()

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

	getQueryVerb ( $sql)

	getReadOnlyReason ()

	getRecordedTransactionLagStatus ()
	Get the replica DB lag when the current transaction started.

	getSchemaVars ()
	Get schema variables.

	getTransactionRoundId ()

	hasFlags ( $field, $flags)

	indexName ( $index)
	Allows for index remapping in queries where this is not consistent across DBMS.

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

	isInsertSelectSafe (array $insertOptions, array $selectOptions)

	makeGroupByWithHaving ( $options)
	Returns an optional GROUP BY with an optional HAVING.

	makeOrderBy ( $options)
	Returns an optional ORDER BY.

	makeUpdateOptions ( $options)
	Make UPDATE options for the Database::update function.

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

	nativeReplace ( $table, $rows, $fname)
	REPLACE query wrapper for MySQL and SQLite, which have a native REPLACE statement.

	nonNativeInsertSelect ( $destTable, $srcTable, $varMap, $conds, $fname=__METHOD__, $insertOptions=[], $selectOptions=[], $selectJoinConds=[])
	Implementation of insertSelect() based on select() and insert()

	normalizeConditions ( $conds, $fname)

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

	registerTempTableWrite ( $sql, $pseudoPermanent)

	relationSchemaQualifier ()

	replaceLostConnection ( $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.

	resultObject ( $result)
	Take the result from a query, and wrap it in a ResultWrapper if necessary.

	tableNamesWithAlias ( $tables)
	Gets an array of aliased table names.

	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.

	tableNameWithAlias ( $table, $alias=false)
	Get an aliased table name.

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

Static Protected Member Functions
static	getAttributes ()

Static Protected Member Functions inherited from Wikimedia\Rdbms\Database
static	generalizeSQL ( $sql)
	Removes most variables from an SQL query and replaces them with X or N for numbers.

Protected Attributes
PDO	$conn

string	$dbDir
	Directory.

string	$dbPath
	File name for SQLite database file.

int	$lastAffectedRowCount
	The number of rows affected as an integer.

resource	$lastResultHandle

FSLockManager	$lockMgr
	(hopefully on the same server as the DB)

string	$trxMode
	Transaction mode.

Protected Attributes inherited from Wikimedia\Rdbms\Database
integer null	$affectedRowCount
	Rows affected by the last query to query() or its CRUD wrappers.

string	$agent
	Agent name for query profiling.

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

object resource null	$conn = null
	Database connection.

array	$connectionParams = []
	Parameters used by initConnection() to establish a connection.

LoggerInterface	$connLogger

DatabaseDomain	$currentDomain

string	$delimiter = ';'

callable	$deprecationLogger
	Deprecation logging callback.

callable	$errorLogger
	Error logging callback.

int	$flags

string bool null	$htmlErrors
	Stashed value of html_errors INI setting.

string[]	$indexAliases = []
	Map of (index alias => index)

float	$lastPing = 0.0
	UNIX timestamp.

string	$lastQuery = ''
	SQL query.

float bool	$lastWriteTime = false
	UNIX timestamp of last write query.

array	$lbInfo = []

int	$nonNativeInsertSelectBatchSize = 10000

bool	$opened = false

string	$password
	Password used to establish the current connection.

string bool	$phpError = false

array null	$preparedArgs

callable null	$profiler

LoggerInterface	$queryLogger

array bool	$schemaVars = false

string	$server
	Server that this instance is currently connected to.

array	$sessionTempTables = []
	Map of (table name => 1) for TEMPORARY tables.

array	$sessionVars = []

BagOStuff	$srvCache
	APC cache.

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

array[]	$trxEndCallbacks = []
	List of (callable, method name, atomic section id)

bool	$trxEndCallbacksSuppressed = false
	Whether to suppress triggering of transaction end callbacks.

array[]	$trxIdleCallbacks = []
	List of (callable, method name, atomic section id)

int	$trxLevel = 0
	Either 1 if a transaction is active or 0 otherwise.

array[]	$trxPreCommitCallbacks = []
	List of (callable, method name, atomic section id)

TransactionProfiler	$trxProfiler

callable[]	$trxRecurringCallbacks = []
	Map of (name => callable)

string	$trxShortId = ''
	Either a short hexidecimal string if a transaction is active or "".

int	$trxStatus = self::STATUS_TRX_NONE
	Transaction status.

Exception null	$trxStatusCause
	The last error that caused the status to become STATUS_TRX_ERROR.

array null	$trxStatusIgnoredCause
	If wasKnownStatementRollbackError() prevented trxStatus from being set, the relevant details are stored here.

string	$user
	User that this instance is currently connected under the name of.

Private Attributes
array	$alreadyAttached = []
	List of shared database already attached to this connection.

Static Private Attributes
static bool	$fulltextEnabled = null
	Whether full text is enabled.

Additional Inherited Members
Public Attributes inherited from Wikimedia\Rdbms\Database
const	DEADLOCK_DELAY_MAX = 1500000
	Maximum time to wait before retry.

const	DEADLOCK_DELAY_MIN = 500000
	Minimum time to wait before retry, in microseconds.

const	DEADLOCK_TRIES = 4
	Number of times to re-try an operation in case of deadlock.

const	PING_QUERY = 'SELECT 1 AS ping'

const	PING_TTL = 1.0
	How long before it is worth doing a dummy query to test the connection.

const	SLOW_WRITE_SEC = 0.500

const	SMALL_WRITE_ROWS = 100

const	TINY_WRITE_SEC = 0.010

Detailed Description

Definition at line 38 of file DatabaseSqlite.php.

Constructor & Destructor Documentation

◆ __construct()

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

Additional params include:

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

array $p

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 71 of file DatabaseSqlite.php.

Member Function Documentation

◆ __toString()

Wikimedia\Rdbms\DatabaseSqlite::__toString ( )

Returns: string

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 1125 of file DatabaseSqlite.php.

References string.

◆ addQuotes()

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

Parameters

string | int | null | bool | Blob $s

Returns: string|int

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 842 of file DatabaseSqlite.php.

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

Referenced by Wikimedia\Rdbms\DatabaseSqlite\attachDatabase(), Wikimedia\Rdbms\DatabaseSqlite\buildGroupConcatField(), Wikimedia\Rdbms\DatabaseSqlite\duplicateTableStructure(), Wikimedia\Rdbms\DatabaseSqlite\fieldInfo(), Wikimedia\Rdbms\DatabaseSqlite\indexInfo(), Wikimedia\Rdbms\DatabaseSqlite\resetSequenceForTable(), Wikimedia\Rdbms\DatabaseSqlite\strencode(), Wikimedia\Rdbms\DatabaseSqlite\tableExists(), and DatabaseSqliteTest\testAddQuotes().

◆ attachDatabase()

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

Attaches external database to our connection, see https://sqlite.org/lang_attach.html for details.

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

Definition at line 308 of file DatabaseSqlite.php.

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

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

◆ buildConcat()

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

Build a concatenation list to feed into a SQL query.

Parameters

string[] $stringList

Returns: string

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 976 of file DatabaseSqlite.php.

◆ 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

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 980 of file DatabaseSqlite.php.

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

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

◆ buildSubstring()

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

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 869 of file DatabaseSqlite.php.

References $input, $params, and Wikimedia\Rdbms\Database\assertBuildSubstringParams().

◆ checkForEnabledSearch()

Wikimedia\Rdbms\DatabaseSqlite::checkForEnabledSearch ( )

Check if the searchindext table is FTS enabled.

Returns: bool False if not enabled.

Definition at line 262 of file DatabaseSqlite.php.

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

◆ 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 242 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 fully separate, only allowing mechanisms like postgres_fdw to effectively "mount" foreign DBs. This is true even among DBs on the same server.

Returns: bool

Since: 1.29

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 1118 of file DatabaseSqlite.php.

◆ dataSeek()

Wikimedia\Rdbms\DatabaseSqlite::dataSeek	(	$res,
		$row
	)

Parameters

ResultWrapper \| array	$res
int	$row

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 480 of file DatabaseSqlite.php.

References $res.

◆ deadlockLoop()

Wikimedia\Rdbms\DatabaseSqlite::deadlockLoop ( )

No-op version of deadlockLoop.

Returns: mixed

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 892 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 830 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

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 801 of file DatabaseSqlite.php.

References $fname, Wikimedia\Rdbms\Database\query(), and Wikimedia\Rdbms\Database\trxLevel().

◆ doInitConnection()

Wikimedia\Rdbms\DatabaseSqlite::doInitConnection ( )

protected

Actually connect to the database over the wire (or to local files)

Exceptions

InvalidArgumentException
DBConnectionError

Since: 1.31

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 125 of file DatabaseSqlite.php.

References Wikimedia\Rdbms\DatabaseSqlite\open(), and Wikimedia\Rdbms\DatabaseSqlite\openFile().

◆ doQuery()

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

protected

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

Parameters

string $sql

Returns: bool|ResultWrapper

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 335 of file DatabaseSqlite.php.

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

◆ dropTable()

Wikimedia\Rdbms\DatabaseSqlite::dropTable	(	$tableName,
		$fName = `__METHOD__`
	)

Override due to no CASCADE support.

Parameters

string	$tableName
string	$fName

Returns: bool|ResultWrapper

Exceptions

DBReadOnlyError

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 1092 of file DatabaseSqlite.php.

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

◆ duplicateTableStructure()

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

Parameters

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

Returns: bool|ResultWrapper

Exceptions

RuntimeException

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 996 of file DatabaseSqlite.php.

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

Referenced by DatabaseSqliteTest\testDuplicateTableStructure(), and DatabaseSqliteTest\testDuplicateTableStructureVirtual().

◆ encodeBlob()

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

Parameters

string $b

Returns: Blob

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 822 of file DatabaseSqlite.php.

◆ fetchAffectedRowCount()

Wikimedia\Rdbms\DatabaseSqlite::fetchAffectedRowCount ( )

protected

Returns: int

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 522 of file DatabaseSqlite.php.

References Wikimedia\Rdbms\DatabaseSqlite\$lastAffectedRowCount.

◆ fetchObject()

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

Parameters

ResultWrapper | array $res

Returns: stdClass|bool

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 363 of file DatabaseSqlite.php.

References $res, and as.

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

◆ fetchRow()

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

Parameters

ResultWrapper | mixed $res

Returns: array|bool

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 390 of file DatabaseSqlite.php.

References $res.

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

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

◆ fieldName()

Wikimedia\Rdbms\DatabaseSqlite::fieldName	(	$res,
		$n
	)

Parameters

ResultWrapper	$res
int	$n

Returns: bool

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 439 of file DatabaseSqlite.php.

References $keys, and $res.

◆ fixIgnore()

static Wikimedia\Rdbms\DatabaseSqlite::fixIgnore ( $options )

static

Parameters

array $options

Returns: array

Definition at line 621 of file DatabaseSqlite.php.

References $options, and as.

Referenced by Wikimedia\Rdbms\DatabaseSqlite\makeInsertOptions(), and Wikimedia\Rdbms\DatabaseSqlite\makeUpdateOptionsArray().

◆ freeResult()

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

Parameters

ResultWrapper | mixed $res

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 351 of file DatabaseSqlite.php.

References $res.

◆ generateFileName()

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

static

Generates a database file name.

Explicitly public for installer.

Parameters

string	$dir	Directory where database resides
string	$dbName	Database name

Returns: string

Definition at line 254 of file DatabaseSqlite.php.

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

◆ getAttributes()

static Wikimedia\Rdbms\DatabaseSqlite::getAttributes ( )

staticprotected

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

Since: 1.31

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 102 of file DatabaseSqlite.php.

References true.

◆ getBindingHandle()

Wikimedia\Rdbms\DatabaseSqlite::getBindingHandle ( )

protected

Returns: PDO

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 1134 of file DatabaseSqlite.php.

Referenced by Wikimedia\Rdbms\DatabaseSqlite\addQuotes(), Wikimedia\Rdbms\DatabaseSqlite\doQuery(), Wikimedia\Rdbms\DatabaseSqlite\getServerVersion(), and Wikimedia\Rdbms\DatabaseSqlite\insertId().

◆ getDbFilePath()

Wikimedia\Rdbms\DatabaseSqlite::getDbFilePath ( )

Returns: string SQLite DB file path

Since: 1.25

Definition at line 234 of file DatabaseSqlite.php.

References Wikimedia\Rdbms\DatabaseSqlite\$dbPath.

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

References Wikimedia\Rdbms\DatabaseSqlite\newStandaloneInstance().

Referenced by DatabaseSqliteTest\testDuplicateTableStructureVirtual().

◆ getServerVersion()

Wikimedia\Rdbms\DatabaseSqlite::getServerVersion ( )

Returns: string Version information from the database

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 774 of file DatabaseSqlite.php.

References Wikimedia\Rdbms\DatabaseSqlite\getBindingHandle().

Referenced by SqliteInstaller\checkPrerequisites().

◆ getSoftwareLink()

Wikimedia\Rdbms\DatabaseSqlite::getSoftwareLink ( )

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

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 767 of file DatabaseSqlite.php.

◆ getType()

Wikimedia\Rdbms\DatabaseSqlite::getType ( )

Returns: string

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 156 of file DatabaseSqlite.php.

◆ implicitGroupby()

Wikimedia\Rdbms\DatabaseSqlite::implicitGroupby ( )

Todo:: Check if it should be true like parent class

Returns: bool

Reimplemented from Wikimedia\Rdbms\Database.

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

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

◆ indexUnique()

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

Parameters

string	$table
string	$index
string	$fname

Returns: bool|null

Definition at line 569 of file DatabaseSqlite.php.

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

◆ insert()

Wikimedia\Rdbms\DatabaseSqlite::insert	(	$table,
		$a,
		$fname = `__METHOD__`,
		$options = `[]`
	)

Based on generic method (parent) with some prior SQLite-sepcific adjustments.

Parameters

string	$table
array	$a
string	$fname
array	$options

Returns: bool

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 650 of file DatabaseSqlite.php.

References Wikimedia\Rdbms\Database\$affectedRowCount, $e, $fname, $options, Wikimedia\Rdbms\Database\affectedRows(), as, Wikimedia\Rdbms\Database\cancelAtomic(), Wikimedia\Rdbms\Database\endAtomic(), and Wikimedia\Rdbms\Database\startAtomic().

Referenced by DatabaseSqliteTest\testDeleteJoin(), DatabaseSqliteTest\testInsertAffectedRows(), DatabaseSqliteTest\testInsertIdType(), and DatabaseSqliteTest\testNumFields().

◆ insertId()

Wikimedia\Rdbms\DatabaseSqlite::insertId ( )

This must be called after nextSequenceVal.

Returns: int

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 471 of file DatabaseSqlite.php.

References Wikimedia\Rdbms\DatabaseSqlite\getBindingHandle().

Referenced by DatabaseSqliteTest\testInsertIdType().

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

Parameters

string $sql

Returns: bool

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 321 of file DatabaseSqlite.php.

References Wikimedia\Rdbms\Database\getQueryVerb().

◆ isWriteQuery()

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

protected

Determine whether a query writes to the DB.

When in doubt, this returns true.

Main use cases:

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

Parameters

string $sql

Returns: bool

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 317 of file DatabaseSqlite.php.

◆ lastErrno()

Wikimedia\Rdbms\DatabaseSqlite::lastErrno ( )

Returns: string

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 509 of file DatabaseSqlite.php.

Referenced by Wikimedia\Rdbms\DatabaseSqlite\wasDeadlock(), and Wikimedia\Rdbms\DatabaseSqlite\wasReadOnlyError().

◆ lastError()

Wikimedia\Rdbms\DatabaseSqlite::lastError ( )

Returns: string

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 497 of file DatabaseSqlite.php.

References $e.

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

References $vars, as, and select().

Referenced by DatabaseSqliteTest\getTables().

◆ lock()

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

Acquire a named lock.

Named locks are not related to transactions

Parameters

string	$lockName	Name of lock to aquire
string	$method	Name of the calling method
int	$timeout	Acquisition timeout in seconds

Returns: bool

Exceptions

DBError

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 956 of file DatabaseSqlite.php.

References LockManager\LOCK_EX.

◆ makeInsertOptions()

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

Parameters

array $options

Returns: string

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 636 of file DatabaseSqlite.php.

References $options, and Wikimedia\Rdbms\DatabaseSqlite\fixIgnore().

◆ makeSelectOptions()

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

Filter the options used in SELECT statements.

Parameters

array $options

Returns: array

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 596 of file DatabaseSqlite.php.

References $options, and as.

◆ makeUpdateOptionsArray()

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

protected

Parameters

array $options

Returns: array

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 610 of file DatabaseSqlite.php.

References $options, and Wikimedia\Rdbms\DatabaseSqlite\fixIgnore().

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

References Wikimedia\Rdbms\Database\factory().

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

◆ numFields()

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

Parameters

ResultWrapper $res

Returns: int

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 423 of file DatabaseSqlite.php.

References $res.

Referenced by DatabaseSqliteTest\testNumFields().

◆ numRows()

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

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

Parameters

ResultWrapper | array | false $res

Returns: int

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 412 of file DatabaseSqlite.php.

References $res.

◆ open()

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

protected

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

Parameters

string	$server	Database server host
string	$user	Database user name
string	$password	Database user password
string	$dbName	Database name
string \| null	$schema	Database schema name
string	$tablePrefix	Table prefix

Returns: bool

Exceptions

DBConnectionError

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 169 of file DatabaseSqlite.php.

References Wikimedia\Rdbms\DatabaseSqlite\$conn, Wikimedia\Rdbms\Database\close(), Wikimedia\Rdbms\DatabaseSqlite\generateFileName(), and Wikimedia\Rdbms\DatabaseSqlite\openFile().

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

◆ openFile()

Wikimedia\Rdbms\DatabaseSqlite::openFile	(	$fileName,
		$dbName,
		$tablePrefix
	)

protected

Opens a database file.

Parameters

string	$fileName
string	$dbName
string	$tablePrefix

Exceptions

DBConnectionError

Returns: PDO|bool SQL connection or false if failed

Definition at line 191 of file DatabaseSqlite.php.

References Wikimedia\Rdbms\DatabaseSqlite\$conn, $e, and Wikimedia\Rdbms\Database\query().

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

◆ replace()

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

Parameters

string	$table
array	$uniqueIndexes	Unused
string \| array	$rows
string	$fname

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 683 of file DatabaseSqlite.php.

References Wikimedia\Rdbms\Database\$affectedRowCount, $e, $fname, $rows, Wikimedia\Rdbms\Database\affectedRows(), as, Wikimedia\Rdbms\Database\cancelAtomic(), Wikimedia\Rdbms\Database\endAtomic(), Wikimedia\Rdbms\Database\nativeReplace(), and Wikimedia\Rdbms\Database\startAtomic().

◆ replaceVars()

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

protected

Parameters

string $s

Returns: string

Reimplemented from Wikimedia\Rdbms\Database.

Reimplemented in DatabaseSqliteMock.

Definition at line 903 of file DatabaseSqlite.php.

References $s.

◆ resetSequenceForTable()

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

Definition at line 1112 of file DatabaseSqlite.php.

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

◆ 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

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 1101 of file DatabaseSqlite.php.

References $params, as, and Wikimedia\Rdbms\DatabaseSqlite\attachDatabase().

◆ strencode()

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

Parameters

string $s

Returns: string

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 814 of file DatabaseSqlite.php.

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

◆ tableExists()

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

Query whether a given table exists.

Parameters

string	$table
string	$fname

Returns: bool

Exceptions

DBError

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 526 of file DatabaseSqlite.php.

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

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

◆ tableName()

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

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

Parameters

string	$name
string	$format

Returns: string

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 457 of file DatabaseSqlite.php.

References $name.

Referenced by DatabaseSqliteTest\testTableName().

◆ textFieldSize()

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

Returns the size of a text field, or -1 for "unlimited" In SQLite this is SQLITE_MAX_LENGTH, by default 1GB.

No way to query it though.

Parameters

string	$table
string	$field

Returns: int

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 716 of file DatabaseSqlite.php.

◆ unionQueries()

Wikimedia\Rdbms\DatabaseSqlite::unionQueries	(	$sqls,
		$all
	)

Parameters

string[]	$sqls
bool	$all	Whether to "UNION ALL" or not

Returns: string

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 732 of file DatabaseSqlite.php.

◆ unionSupportsOrderAndLimit()

Wikimedia\Rdbms\DatabaseSqlite::unionSupportsOrderAndLimit ( )

Returns: bool

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 723 of file DatabaseSqlite.php.

◆ unlock()

Wikimedia\Rdbms\DatabaseSqlite::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: int Returns 1 if the lock was released, 0 if the lock was not established by this thread (in which case the lock is not released), and NULL if the named lock did not exist

Exceptions

DBError

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 966 of file DatabaseSqlite.php.

References LockManager\LOCK_EX.

◆ wasConnectionError()

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

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

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 752 of file DatabaseSqlite.php.

◆ wasDeadlock()

Wikimedia\Rdbms\DatabaseSqlite::wasDeadlock ( )

Returns: bool

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 741 of file DatabaseSqlite.php.

References Wikimedia\Rdbms\DatabaseSqlite\lastErrno().

◆ wasKnownStatementRollbackError()

Wikimedia\Rdbms\DatabaseSqlite::wasKnownStatementRollbackError ( )

protected

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

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

Since: 1.31

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 756 of file DatabaseSqlite.php.

◆ wasReadOnlyError()

Wikimedia\Rdbms\DatabaseSqlite::wasReadOnlyError ( )

Returns: bool

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 748 of file DatabaseSqlite.php.

References Wikimedia\Rdbms\DatabaseSqlite\lastErrno().

Member Data Documentation

◆ $alreadyAttached

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

private

List of shared database already attached to this connection.

Definition at line 61 of file DatabaseSqlite.php.

◆ $conn

PDO Wikimedia\Rdbms\DatabaseSqlite::$conn

protected

Definition at line 55 of file DatabaseSqlite.php.

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

◆ $dbDir

string Wikimedia\Rdbms\DatabaseSqlite::$dbDir

protected

Directory.

Definition at line 43 of file DatabaseSqlite.php.

◆ $dbPath

string Wikimedia\Rdbms\DatabaseSqlite::$dbPath

protected

File name for SQLite database file.

Definition at line 45 of file DatabaseSqlite.php.

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

◆ $fulltextEnabled

bool Wikimedia\Rdbms\DatabaseSqlite::$fulltextEnabled = null

staticprivate

Whether full text is enabled.

Definition at line 40 of file DatabaseSqlite.php.

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

◆ $lastAffectedRowCount

int Wikimedia\Rdbms\DatabaseSqlite::$lastAffectedRowCount

protected

The number of rows affected as an integer.

Definition at line 50 of file DatabaseSqlite.php.

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

◆ $lastResultHandle

resource Wikimedia\Rdbms\DatabaseSqlite::$lastResultHandle

protected

Definition at line 52 of file DatabaseSqlite.php.

◆ $lockMgr

FSLockManager Wikimedia\Rdbms\DatabaseSqlite::$lockMgr

protected

(hopefully on the same server as the DB)

Definition at line 58 of file DatabaseSqlite.php.

◆ $trxMode

string Wikimedia\Rdbms\DatabaseSqlite::$trxMode

protected

Transaction mode.

Definition at line 47 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 Attributes

Static Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ __toString()

◆ addQuotes()

◆ attachDatabase()

◆ buildConcat()

◆ buildGroupConcatField()

◆ buildStringCast()

◆ buildSubstring()

◆ checkForEnabledSearch()

◆ closeConnection()

◆ databasesAreIndependent()

◆ dataSeek()

◆ deadlockLoop()

◆ decodeBlob()

◆ doBegin()

◆ doInitConnection()

◆ doQuery()

◆ dropTable()

◆ duplicateTableStructure()

◆ encodeBlob()

◆ fetchAffectedRowCount()

◆ fetchObject()

◆ fetchRow()

◆ fieldInfo()

◆ fieldName()

◆ fixIgnore()

◆ freeResult()

◆ generateFileName()

◆ getAttributes()

◆ getBindingHandle()

◆ getDbFilePath()

◆ getFulltextSearchModule()

◆ getServerVersion()

◆ getSoftwareLink()

◆ getType()

◆ implicitGroupby()

◆ indexInfo()

◆ indexUnique()

◆ insert()

◆ insertId()

◆ isTransactableQuery()

◆ isWriteQuery()

◆ lastErrno()

◆ lastError()

◆ listTables()

◆ lock()

◆ makeInsertOptions()

◆ makeSelectOptions()

◆ makeUpdateOptionsArray()

◆ newStandaloneInstance()

◆ numFields()

◆ numRows()

◆ open()

◆ openFile()

◆ replace()

◆ replaceVars()

◆ resetSequenceForTable()

◆ setTableAliases()

◆ strencode()

◆ tableExists()

◆ tableName()

◆ textFieldSize()

◆ unionQueries()

◆ unionSupportsOrderAndLimit()

◆ unlock()

◆ wasConnectionError()

◆ wasDeadlock()

◆ wasKnownStatementRollbackError()

◆ wasReadOnlyError()