Wikimedia\Rdbms\DatabaseSqlite Class Reference

Inheritance diagram for Wikimedia\Rdbms\DatabaseSqlite:

Collaboration diagram for Wikimedia\Rdbms\DatabaseSqlite:

Public Member Functions
	__construct (array $p)
	Additional params include:
	addQuotes ( $s)
	attachDatabase ( $name, $file=false, $fname=__METHOD__)
	Attaches external database to the connection handle.
	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)
	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 ()
	getLockFileDirectory ()
	getServerVersion ()
	getSoftwareLink ()
	getType ()
	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)
	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__)
	serverIsReadOnly ()
	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.
	__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 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)
	Backwards-compatibility no-op method for disabling query buffering.
	buildIntegerCast ( $field)
	buildLike ( $param,... $params)
	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 ( $fname=__METHOD__, $owner=null)
	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.
	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__, $flush=self::FLUSHING_ONE)
	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.
	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 ()
	Get a human-readable string describing the current software version.
	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.
	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.
	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 ()
	isQuotedIdentifier ( $name)
	Returns if the given identifier looks quoted or not according to the database convention for quoting identifiers .
	isReadOnly ()
	lastDoneWrites ()
	Get the last time the connection may have been used for a write query.
	lastQuery ()
	Get the last query that sent on account of 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.
	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)
	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=[])
	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 ( $table, $vars, $conds='', $fname=__METHOD__, $options=[], $join_conds=[])
	Take the same arguments as IDatabase::select() and return the SQL it would use.
	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 ( $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 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 SQL expression for simple string replacement (e.g.
	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 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.
	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
	buildLike ( $param)
	LIKE statement wrapper.
	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 ( $type, $params=[], $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.
	doHandleSessionLossPreconnect ()
	Reset any additional subclass trx* and session* fields.
	doQuery ( $sql)
	SQLite doesn't allow buffered results or data seeking etc, so we'll use fetchAll as the result.
	doSelectDomain (DatabaseDomain $domain)
	fetchAffectedRowCount ()
	getBindingHandle ()
	isTransactableQuery ( $sql)
	Determine whether a SQL statement is sensitive to isolation level.
	isWriteQuery ( $sql)
	Determine whether a query writes to the DB.
	makeSelectOptions (array $options)
	Returns an optional USE INDEX clause to go after the table, and a string to go at the end of the query.
	makeUpdateOptionsArray ( $options)
	open ( $server, $user, $pass, $dbName, $schema, $tablePrefix)
	Open a new connection to the database (closing any existing one)
	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.
	doGetLag ()
	doInitConnection ()
	Actually connect to the database over the wire (or to local files)
	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.
	doUnlockTables ( $method)
	Helper function for unlockTables() that handles the actual table unlocking.
	escapeLikeInternal ( $s, $escapeChar='`')
	executeQuery ( $sql, $fname, $flags)
	Execute a query, retrying it if there is a recoverable connection loss.
	extractSingleFieldFromList ( $var)
	fieldHasBit ( $field, $flags)
	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.
	getTempWrites ( $sql, $pseudoPermanent)
	getTransactionRoundId ()
	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.
	newExceptionAfterConnectError ( $error)
	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.
	registerTempWrites ( $ret, $tmpType, $tmpNew, $tmpDel)
	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 a query result and wrap it in an iterable result wrapper 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 ()

Protected Attributes
PDO	$conn
string null	$dbDir
	Directory for SQLite database files listed under their DB name.
string null	$dbPath
	Explicit path for the 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
	Database connection.
array	$connectionParams
	Parameters used by initConnection() to establish a connection.
string[] int[] float[]	$connectionVariables
	SQL variables values to use for all new connections.
LoggerInterface	$connLogger
DatabaseDomain	$currentDomain
string	$delimiter = ';'
	Current SQL query delimiter.
callable	$deprecationLogger
	Deprecation logging callback.
callable	$errorLogger
	Error logging callback.
int	$flags
	Current bit field of class DBO_* constants.
string[]	$indexAliases = []
	Current map of (index alias => index)
array	$lbInfo = []
	Current LoadBalancer tracking information.
int	$nonNativeInsertSelectBatchSize
	Row batch size to use for emulated INSERT SELECT queries.
string	$password
	Password used to establish the current connection.
callable null	$profiler
LoggerInterface	$queryLogger
array null	$schemaVars
	Current variables use for schema element placeholders.
string	$server
	Server that this instance is currently connected to.
array	$sessionNamedLocks = []
	Map of (name => 1) for locks obtained via lock()
array	$sessionTempTables = []
	Map of (table name => 1) for TEMPORARY tables.
BagOStuff	$srvCache
	APC cache.
array[]	$tableAliases = []
	Current map of (table => (dbname, schema, prefix) map)
TransactionProfiler	$trxProfiler
string	$user
	User that this instance is currently connected under the name of.

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

Static Private Member Functions
static	generateDatabaseName ( $path)
static	isProcessMemoryPath ( $path)

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

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

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

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

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

Member Function Documentation

addQuotes()

Wikimedia\Rdbms\DatabaseSqlite::addQuotes

(

$s

)

Parameters

string | int | null | bool | Blob

$s

Returns

string|int

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 860 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(), and Wikimedia\Rdbms\DatabaseSqlite\tableExists().

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

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

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

attachDatabasesFromTableAliases()

Wikimedia\Rdbms\DatabaseSqlite::attachDatabasesFromTableAliases ( )

private

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

Definition at line 1131 of file DatabaseSqlite.php.

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

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

buildConcat()

Wikimedia\Rdbms\DatabaseSqlite::buildConcat

(

$stringList

)

Build a concatenation list to feed into a SQL query.

Parameters

string[]

$stringList

Returns

string

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 996 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 1000 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 901 of file DatabaseSqlite.php.

buildSubstring()

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

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 887 of file DatabaseSqlite.php.

References Wikimedia\Rdbms\Database\assertBuildSubstringParams().

closeConnection()

Wikimedia\Rdbms\DatabaseSqlite::closeConnection ( )

protected

Does not actually close the connection, just destroys the reference for GC to do its work.

Returns

bool

Reimplemented from Wikimedia\Rdbms\Database.

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

dataSeek()

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

Parameters

IResultWrapper | array	$res
int	$row

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 497 of file DatabaseSqlite.php.

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

deadlockLoop()

Wikimedia\Rdbms\DatabaseSqlite::deadlockLoop

(

)

No-op version of deadlockLoop.

Returns

mixed

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 910 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 848 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 820 of file DatabaseSqlite.php.

References Wikimedia\Rdbms\Database\query().

doHandleSessionLossPreconnect()

Wikimedia\Rdbms\DatabaseSqlite::doHandleSessionLossPreconnect ( )

protected

Reset any additional subclass trx* and session* fields.

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 1157 of file DatabaseSqlite.php.

doQuery()

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

protected

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

Parameters

string

$sql

Returns

bool|IResultWrapper

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 332 of file DatabaseSqlite.php.

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

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

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

dropTable()

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

Override due to no CASCADE support.

Parameters

string	$tableName
string	$fName

Returns

bool|IResultWrapper

Exceptions

DBReadOnlyError

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 1112 of file DatabaseSqlite.php.

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

duplicateTableStructure()

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

Parameters

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

Returns

bool|IResultWrapper

Exceptions

RuntimeException

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 1016 of file DatabaseSqlite.php.

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

encodeBlob()

Wikimedia\Rdbms\DatabaseSqlite::encodeBlob

(

$b

)

Parameters

string

$b

Returns

Blob

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 840 of file DatabaseSqlite.php.

fetchAffectedRowCount()

Wikimedia\Rdbms\DatabaseSqlite::fetchAffectedRowCount ( )

protected

Returns

int

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 535 of file DatabaseSqlite.php.

References Wikimedia\Rdbms\DatabaseSqlite\$lastAffectedRowCount.

fetchObject()

Wikimedia\Rdbms\DatabaseSqlite::fetchObject

(

$res

)

Parameters

IResultWrapper | array

$res

Returns

stdClass|bool

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 358 of file DatabaseSqlite.php.

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

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

fetchRow()

Wikimedia\Rdbms\DatabaseSqlite::fetchRow

(

$res

)

Parameters

IResultWrapper | mixed

$res

Returns

array|bool

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 381 of file DatabaseSqlite.php.

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

fieldInfo()

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

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

Parameters

string	$table
string	$field

Returns

SQLiteField|bool False on failure

Implements Wikimedia\Rdbms\IMaintainableDatabase.

Definition at line 807 of file DatabaseSqlite.php.

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

fieldName()

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

Parameters

IResultWrapper	$res
int	$n

Returns

bool

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 426 of file DatabaseSqlite.php.

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

fixIgnore()

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

static

Parameters

array

$options

Returns

array

Definition at line 632 of file DatabaseSqlite.php.

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

freeResult()

Wikimedia\Rdbms\DatabaseSqlite::freeResult

(

$res

)

Parameters

IResultWrapper | mixed

$res

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 348 of file DatabaseSqlite.php.

References $res.

generateDatabaseName()

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

staticprivate

Parameters

string

$path

Returns

string

Definition at line 249 of file DatabaseSqlite.php.

References $path.

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

generateFileName()

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

static

Generates a database file name.

Explicitly public for installer.

Parameters

string	$dir	Directory where database resides
string | bool	$dbName	Database name (or false from Database::factory, validated here)

Returns

string

Exceptions

DBUnexpectedError

Definition at line 230 of file DatabaseSqlite.php.

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

getAttributes()

static Wikimedia\Rdbms\DatabaseSqlite::getAttributes ( )

staticprotected

Returns

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

Since

1.31

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 95 of file DatabaseSqlite.php.

References true.

getBindingHandle()

Wikimedia\Rdbms\DatabaseSqlite::getBindingHandle ( )

protected

Returns

PDO

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 1164 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|null SQLite DB file path

Exceptions

DBUnexpectedError

Since

1.25

Definition at line 196 of file DatabaseSqlite.php.

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

Referenced by SqliteMaintenance\backup(), Wikimedia\Rdbms\DatabaseSqlite\serverIsReadOnly(), and SqliteMaintenance\vacuum().

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

References Wikimedia\Rdbms\DatabaseSqlite\newStandaloneInstance().

getLockFileDirectory()

Wikimedia\Rdbms\DatabaseSqlite::getLockFileDirectory

(

)

Returns

string|null Lock file directory

Definition at line 203 of file DatabaseSqlite.php.

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

getServerVersion()

Wikimedia\Rdbms\DatabaseSqlite::getServerVersion

(

)

Returns

string Version information from the database

Implements Wikimedia\Rdbms\IDatabase.

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

getType()

Wikimedia\Rdbms\DatabaseSqlite::getType

(

)

Returns

string

Implements Wikimedia\Rdbms\IDatabase.

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

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

indexUnique()

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

Parameters

string	$table
string	$index
string	$fname

Returns

bool|null

Definition at line 585 of file DatabaseSqlite.php.

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

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

insertId()

Wikimedia\Rdbms\DatabaseSqlite::insertId

(

)

This must be called after nextSequenceVal.

Returns

int

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 488 of file DatabaseSqlite.php.

References Wikimedia\Rdbms\DatabaseSqlite\getBindingHandle().

isProcessMemoryPath()

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

staticprivate

Parameters

string

$path

Returns

bool

Definition at line 266 of file DatabaseSqlite.php.

References $path.

isTransactableQuery()

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

protected

Determine whether a SQL statement is sensitive to isolation level.

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

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

Parameters

string

$sql

Returns

bool

Reimplemented from Wikimedia\Rdbms\Database.

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

lastErrno()

Wikimedia\Rdbms\DatabaseSqlite::lastErrno

(

)

Returns

string

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 522 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 510 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 1081 of file DatabaseSqlite.php.

References Wikimedia\Rdbms\Database\select().

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 (0 means non-blocking)

Returns

bool Success

Exceptions

DBError

If an error occurs, see IDatabase::query()

Reimplemented from Wikimedia\Rdbms\Database.

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

References Wikimedia\Rdbms\DatabaseSqlite\fixIgnore().

makeSelectOptions()

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

protected

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

See also

Database::select()

Parameters

array

$options

Associative array of options to be turned into an SQL query, valid keys are listed in the function.

Returns

array

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 606 of file DatabaseSqlite.php.

makeUpdateOptionsArray()

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

protected

Parameters

array

$options

Returns

array

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 621 of file DatabaseSqlite.php.

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

References Wikimedia\Rdbms\Database\factory().

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

numFields()

Wikimedia\Rdbms\DatabaseSqlite::numFields

(

$res

)

Parameters

IResultWrapper

$res

Returns

int

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 410 of file DatabaseSqlite.php.

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

numRows()

Wikimedia\Rdbms\DatabaseSqlite::numRows

(

$res

)

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

Parameters

IResultWrapper | array | false

$res

Returns

int

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 399 of file DatabaseSqlite.php.

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

open()

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

protected

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

Parameters

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

Exceptions

DBConnectionError

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 125 of file DatabaseSqlite.php.

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

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

References Wikimedia\Rdbms\Database\$affectedRowCount, Wikimedia\Rdbms\Database\affectedRows(), 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.

Definition at line 921 of file DatabaseSqlite.php.

References $s.

resetSequenceForTable()

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

Definition at line 1143 of file DatabaseSqlite.php.

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

serverIsReadOnly()

Wikimedia\Rdbms\DatabaseSqlite::serverIsReadOnly

(

)

Returns

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

Since

1.28

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 775 of file DatabaseSqlite.php.

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

setTableAliases()

Wikimedia\Rdbms\DatabaseSqlite::setTableAliases

(

array

$aliases

)

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

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

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

Parameters

array[]

$aliases

Map of (table => (dbname, schema, prefix) map)

Since

1.28

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 1121 of file DatabaseSqlite.php.

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

strencode()

Wikimedia\Rdbms\DatabaseSqlite::strencode

(

$s

)

Parameters

string

$s

Returns

string

Reimplemented from Wikimedia\Rdbms\Database.

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

If an error occurs, see IDatabase::query()

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 539 of file DatabaseSqlite.php.

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

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

tableName()

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

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

Parameters

string	$name
string	$format

Returns

string

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 474 of file DatabaseSqlite.php.

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

textFieldSize()

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

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

No way to query it though.

Parameters

string	$table
string	$field

Returns

int

Reimplemented from Wikimedia\Rdbms\Database.

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

unionSupportsOrderAndLimit()

Wikimedia\Rdbms\DatabaseSqlite::unionSupportsOrderAndLimit

(

)

Returns

bool

Reimplemented from Wikimedia\Rdbms\Database.

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

bool Success

Exceptions

DBError

If an error occurs, see IDatabase::query()

Reimplemented from Wikimedia\Rdbms\Database.

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

wasDeadlock()

Wikimedia\Rdbms\DatabaseSqlite::wasDeadlock

(

)

Returns

bool

Reimplemented from Wikimedia\Rdbms\Database.

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

wasReadOnlyError()

Wikimedia\Rdbms\DatabaseSqlite::wasReadOnlyError

(

)

Returns

bool

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 759 of file DatabaseSqlite.php.

References Wikimedia\Rdbms\DatabaseSqlite\lastErrno().

Member Data Documentation

$conn

PDO Wikimedia\Rdbms\DatabaseSqlite::$conn

protected

Definition at line 52 of file DatabaseSqlite.php.

$dbDir

string null Wikimedia\Rdbms\DatabaseSqlite::$dbDir

protected

Directory for SQLite database files listed under their DB name.

Definition at line 40 of file DatabaseSqlite.php.

$dbPath

string null Wikimedia\Rdbms\DatabaseSqlite::$dbPath

protected

Explicit path for the SQLite database file.

Definition at line 42 of file DatabaseSqlite.php.

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

$lastAffectedRowCount

int Wikimedia\Rdbms\DatabaseSqlite::$lastAffectedRowCount

protected

The number of rows affected as an integer.

Definition at line 47 of file DatabaseSqlite.php.

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

$lastResultHandle

resource Wikimedia\Rdbms\DatabaseSqlite::$lastResultHandle

protected

Definition at line 49 of file DatabaseSqlite.php.

$lockMgr

FSLockManager Wikimedia\Rdbms\DatabaseSqlite::$lockMgr

protected

(hopefully on the same server as the DB)

Definition at line 55 of file DatabaseSqlite.php.

$sessionAttachedDbs

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

private

List of shared database already attached to this connection.

Definition at line 58 of file DatabaseSqlite.php.

$trxMode

string Wikimedia\Rdbms\DatabaseSqlite::$trxMode

protected

Transaction mode.

Definition at line 44 of file DatabaseSqlite.php.

$VALID_TRX_MODES

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

staticprivate

See https://www.sqlite.org/lang_transaction.html.

Definition at line 61 of file DatabaseSqlite.php.

---

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

• includes/libs/rdbms/database/DatabaseSqlite.php