Inheritance diagram for DatabaseSqlite:

[legend]

Collaboration diagram for DatabaseSqlite:

[legend]

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

	__toString ()

	addQuotes ( $s)

	affectedRows ()

	attachDatabase ( $name, $file=false, $fname=__METHOD__)
	Attaches external database to our connection, see http://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.

	buildLike ()

	buildStringCast ( $field)

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

	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.

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

	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.

	open ( $server, $user, $pass, $dbName)
	Open an SQLite database and return a resource handle to it NOTE: only $dbName is used, the other parameters are irrelevant for SQLite databases.

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

	strencode ( $s)

	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.

	wasDeadlock ()

	wasErrorReissuable ()

	wasReadOnlyError ()

Public Member Functions inherited from 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 using `backticks` or "double quotes" depending on the database type.

	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.

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

	clearFlag ( $flag, $remember=self::REMEMBER_NOTHING)
	Clear a flag for this connection.

	close ()
	Closes a database connection.

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

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

	connectionErrorLogger ( $errno, $errstr)
	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)
	Run a callback to do an atomic set of updates for this database.

	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, $vars=' *', $conds='', $fname=__METHOD__, $options=[])
	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 ()

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

	getInfinity ()
	Find out when 'infinity' is.

	getLag ()
	Get replica DB lag.

	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.

	getSearchEngine ()

	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.

	insertSelect ( $destTable, $srcTable, $varMap, $conds, $fname=__METHOD__, $insertOptions=[], $selectOptions=[])
	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.

	lockIsFree ( $lockName, $method)
	Check to see if a named lock is available (non-blocking)

	lockTables ( $read, $write, $method, $lowPriority=true)
	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)
	Returns an appropriately quoted sequence value for inserting a new row.

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

	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.

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

	pendingWriteQueryDuration ( $type=self::ESTIMATE_TOTAL)
	Get the time spend running write queries for this transaction.

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

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

	reportConnectionError ( $error='Unknown error')

	reportQueryError ( $error, $errno, $sql, $fname, $tempIgnore=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 run and consume any "on transaction idle/resolution" callbacks.

	runOnTransactionPreCommitCallbacks ()
	Actually run and consume 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.

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

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

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

	selectRowCount ( $tables, $vars=' *', $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.

	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)

	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.

	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.

	setTransactionListener ( $name, callable $callback=null)
	Run a callback 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__)
	Begin an atomic section of statements.

	streamStatementEnd (&$sql, &$newLine)
	Called by sourceStream() to check if we've reached a statement end.

	strreplace ( $orig, $old, $new)
	Returns a comand for str_replace function in SQL query.

	tableExists ( $table, $fname=__METHOD__)
	Query whether a given table exists.

	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.

	trxTimestamp ()
	Get the UNIX timestamp of the time that the transaction was established.

	unlockTables ( $method)
	Unlock specific tables.

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

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

	useIndexClause ( $index)
	USE INDEX clause.

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

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

	writesOrCallbacksPending ()
	Returns true if there is a transaction open with possible write queries or transaction pre-commit/idle callbacks waiting on it to finish.

	writesPending ()

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

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 Database
static	factory ( $dbType, $p=[])
	Construct a Database subclass instance given a database type and parameters.

static	getCacheSetOptions (IDatabase $db1)
	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.

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

	indexName ( $index)
	Index names have DB scope.

	makeUpdateOptionsArray ( $options)

	openFile ( $fileName)
	Opens a database file.

	replaceVars ( $s)

	requiresDatabaseUser ()

Protected Member Functions inherited from Database
	assertOpen ()
	Make sure isOpen() returns true as a sanity check.

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

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

	escapeLikeInternal ( $s)

	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.

	getBindingHandle ()
	Get the underlying binding handle, mConn.

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

	getSchemaVars ()
	Get schema variables.

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

	ignoreErrors ( $ignoreErrors=null)
	Turns on (false) or off (true) the automatic generation and sending of a "we're sorry, but there has been a database error" page on database errors.

	installErrorHandler ()

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

	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=[])

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

	pendingWriteAndCallbackCallers ()

	reconnect ()

	registerTempTableOperation ( $sql)

	restoreErrorHandler ()

	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 ( $name, $alias=false)
	Get an aliased table name e.g.

Protected Attributes
string	$dbDir
	Directory.

string	$dbPath
	File name for SQLite database file.

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

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

$mConn	$mConn
	PDO.

resource	$mLastResult

string	$trxMode
	Transaction mode.

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

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

LoggerInterface	$connLogger

DatabaseDomain	$currentDomain

string	$delimiter = ';'

callback	$errorLogger
	Error logging callback.

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

float	$lastPing = 0.0
	UNIX timestamp.

resource null	$mConn = null
	Database connection.

string	$mDBname

bool null	$mDefaultBigSelects = null

integer	$mFlags

string	$mLastQuery = ''
	SQL query.

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

array	$mLBInfo = []

bool	$mOpened = false

string	$mPassword

string bool	$mPHPError = false

string	$mSchema = ''

array bool	$mSchemaVars = false

string	$mServer

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

array	$mSessionVars = []

string	$mTablePrefix = ''

array[]	$mTrxEndCallbacks = []
	List of (callable, method name)

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

array[]	$mTrxIdleCallbacks = []
	List of (callable, method name)

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

array[]	$mTrxPreCommitCallbacks = []
	List of (callable, method name)

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

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

string	$mUser

array null	$preparedArgs

object string	$profiler
	Class name or object With profileIn/profileOut methods.

LoggerInterface	$queryLogger

BagOStuff	$srvCache
	APC cache.

	$tableAliases = []

TransactionProfiler	$trxProfiler

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

Additional Inherited Members
Public Attributes inherited from 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 = .500

const	SMALL_WRITE_ROWS = 100

const	TINY_WRITE_SEC = .010

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

Detailed Description

Definition at line 28 of file DatabaseSqlite.php.

Constructor & Destructor Documentation

◆ __construct()

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

Definition at line 61 of file DatabaseSqlite.php.

References Database\$mDBname, $params, as, attachDatabase(), Database\isOpen(), open(), and openFile().

Member Function Documentation

◆ __toString()

DatabaseSqlite::__toString ( )

Returns: string

Reimplemented from Database.

Definition at line 1056 of file DatabaseSqlite.php.

References string.

◆ addQuotes()

DatabaseSqlite::addQuotes ( $s )

Parameters

string | int | null | bool | Blob $s

Returns: string|int

Reimplemented from Database.

Definition at line 789 of file DatabaseSqlite.php.

References $s.

Referenced by attachDatabase(), buildGroupConcatField(), duplicateTableStructure(), fieldInfo(), indexInfo(), strencode(), and DatabaseSqliteTest\testAddQuotes().

◆ affectedRows()

DatabaseSqlite::affectedRows ( )

Returns: int

Implements IDatabase.

Definition at line 495 of file DatabaseSqlite.php.

References $mAffectedRows.

◆ attachDatabase()

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

Attaches external database to our connection, see http://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 280 of file DatabaseSqlite.php.

References $fname, $name, addQuotes(), generateFileName(), and Database\query().

Referenced by __construct().

◆ buildConcat()

DatabaseSqlite::buildConcat ( $stringList )

Build a concatenation list to feed into a SQL query.

Parameters

string[] $stringList

Returns: string

Reimplemented from Database.

Definition at line 926 of file DatabaseSqlite.php.

◆ buildGroupConcatField()

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

Definition at line 930 of file DatabaseSqlite.php.

References addQuotes(), and Database\selectSQLText().

◆ buildLike()

DatabaseSqlite::buildLike ( )

Returns: string

Reimplemented from Database.

Definition at line 819 of file DatabaseSqlite.php.

References $params.

◆ buildStringCast()

DatabaseSqlite::buildStringCast ( $field )

Parameters

string $field Field or column to cast

Returns: string

Since: 1.28

Reimplemented from Database.

Definition at line 833 of file DatabaseSqlite.php.

◆ checkForEnabledSearch()

DatabaseSqlite::checkForEnabledSearch ( )

Check if the searchindext table is FTS enabled.

Returns: bool False if not enabled.

Definition at line 234 of file DatabaseSqlite.php.

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

◆ closeConnection()

DatabaseSqlite::closeConnection ( )

protected

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

Returns: bool

Reimplemented from Database.

Definition at line 214 of file DatabaseSqlite.php.

◆ dataSeek()

DatabaseSqlite::dataSeek	(	$res,
		$row
	)

Parameters

ResultWrapper \| array	$res
int	$row

Implements IDatabase.

Definition at line 453 of file DatabaseSqlite.php.

References $res.

◆ deadlockLoop()

DatabaseSqlite::deadlockLoop ( )

No-op version of deadlockLoop.

Returns: mixed

Reimplemented from Database.

Definition at line 842 of file DatabaseSqlite.php.

References $args.

◆ decodeBlob()

DatabaseSqlite::decodeBlob ( $b )

Parameters

Blob | string $b

Returns: string

Reimplemented from Database.

Definition at line 777 of file DatabaseSqlite.php.

◆ doBegin()

DatabaseSqlite::doBegin ( $fname = '' )

protected

Issues the BEGIN command to the database server.

See also: Database::begin()

Parameters

string $fname

Reimplemented from Database.

Definition at line 748 of file DatabaseSqlite.php.

References $fname, and Database\query().

◆ doQuery()

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

Definition at line 299 of file DatabaseSqlite.php.

References $res.

◆ dropTable()

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

Override due to no CASCADE support.

Parameters

string	$tableName
string	$fName

Returns: bool|ResultWrapper

Exceptions

DBReadOnlyError

Reimplemented from Database.

Definition at line 1040 of file DatabaseSqlite.php.

References Database\query(), Database\tableExists(), and tableName().

◆ duplicateTableStructure()

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

Parameters

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

Returns: bool|ResultWrapper

Exceptions

RuntimeException

Reimplemented from Database.

Definition at line 946 of file DatabaseSqlite.php.

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

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

◆ encodeBlob()

DatabaseSqlite::encodeBlob ( $b )

Parameters

string $b

Returns: Blob

Reimplemented from Database.

Definition at line 769 of file DatabaseSqlite.php.

◆ fetchObject()

DatabaseSqlite::fetchObject ( $res )

Parameters

ResultWrapper | array $res

Returns: stdClass|bool

Implements IDatabase.

Definition at line 327 of file DatabaseSqlite.php.

References $res, and as.

Referenced by duplicateTableStructure().

◆ fetchRow()

DatabaseSqlite::fetchRow ( $res )

Parameters

ResultWrapper | mixed $res

Returns: array|bool

Implements IDatabase.

Definition at line 354 of file DatabaseSqlite.php.

References $res.

◆ fieldInfo()

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

Definition at line 735 of file DatabaseSqlite.php.

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

◆ fieldName()

DatabaseSqlite::fieldName	(	$res,
		$n
	)

Parameters

ResultWrapper	$res
int	$n

Returns: bool

Implements IDatabase.

Definition at line 402 of file DatabaseSqlite.php.

References $keys, and $res.

◆ fixIgnore()

static DatabaseSqlite::fixIgnore ( $options )

static

Parameters

array $options

Returns: array

Definition at line 584 of file DatabaseSqlite.php.

References $options, and as.

Referenced by makeInsertOptions(), and makeUpdateOptionsArray().

◆ freeResult()

DatabaseSqlite::freeResult ( $res )

Parameters

ResultWrapper | mixed $res

Reimplemented from Database.

Definition at line 315 of file DatabaseSqlite.php.

References $res.

◆ generateFileName()

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

Referenced by attachDatabase(), SqliteInstaller\makeStubDBFile(), SqliteInstaller\needsUpgrade(), and open().

◆ getDbFilePath()

DatabaseSqlite::getDbFilePath ( )

Returns: string SQLite DB file path

Since: 1.25

Definition at line 206 of file DatabaseSqlite.php.

References $dbPath.

◆ getFulltextSearchModule()

static DatabaseSqlite::getFulltextSearchModule ( )

static

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

Returns: string

Definition at line 252 of file DatabaseSqlite.php.

References newStandaloneInstance().

Referenced by SqliteInstaller\checkPrerequisites(), RebuildTextIndex\execute(), SqliteInstaller\setupSearchIndex(), SqliteUpdater\sqliteSetupSearchindex(), and DatabaseSqliteTest\testDuplicateTableStructureVirtual().

◆ getServerVersion()

DatabaseSqlite::getServerVersion ( )

Returns: string Version information from the database

Implements IDatabase.

Definition at line 721 of file DatabaseSqlite.php.

Referenced by SqliteInstaller\checkPrerequisites().

◆ getSoftwareLink()

DatabaseSqlite::getSoftwareLink ( )

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

Implements IDatabase.

Definition at line 714 of file DatabaseSqlite.php.

◆ getType()

DatabaseSqlite::getType ( )

Returns: string

Implements IDatabase.

Definition at line 126 of file DatabaseSqlite.php.

◆ implicitGroupby()

DatabaseSqlite::implicitGroupby ( )

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

Returns: bool

Reimplemented from Database.

Definition at line 135 of file DatabaseSqlite.php.

◆ indexInfo()

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

Reimplemented from Database.

Definition at line 509 of file DatabaseSqlite.php.

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

◆ indexName()

DatabaseSqlite::indexName ( $index )

protected

Index names have DB scope.

Parameters

string $index

Returns: string

Reimplemented from Database.

Definition at line 435 of file DatabaseSqlite.php.

Referenced by indexInfo(), and indexUnique().

◆ indexUnique()

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

Parameters

string	$table
string	$index
string	$fname

Returns: bool|null

Definition at line 532 of file DatabaseSqlite.php.

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

◆ insert()

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

Definition at line 613 of file DatabaseSqlite.php.

References $options, $ret, and as.

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

◆ insertId()

DatabaseSqlite::insertId ( )

This must be called after nextSequenceVal.

Returns: int

Implements IDatabase.

Definition at line 444 of file DatabaseSqlite.php.

Referenced by DatabaseSqliteTest\testInsertIdType().

◆ isWriteQuery()

DatabaseSqlite::isWriteQuery ( $sql )

Determine whether a query writes to the DB.

Should return true if unsure.

Parameters

string $sql

Returns: bool

Reimplemented from Database.

Definition at line 289 of file DatabaseSqlite.php.

◆ lastErrno()

DatabaseSqlite::lastErrno ( )

Returns: string

Implements IDatabase.

Definition at line 482 of file DatabaseSqlite.php.

Referenced by wasDeadlock(), wasErrorReissuable(), and wasReadOnlyError().

◆ lastError()

DatabaseSqlite::lastError ( )

Returns: string

Implements IDatabase.

Definition at line 470 of file DatabaseSqlite.php.

References $e.

◆ listTables()

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

List all tables on the database.

Parameters

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

Returns: array

Reimplemented from Database.

Definition at line 1009 of file DatabaseSqlite.php.

References $vars, as, and select().

Referenced by DatabaseSqliteTest\getTables().

◆ lock()

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

Reimplemented from Database.

Definition at line 906 of file DatabaseSqlite.php.

References LockManager\LOCK_EX.

◆ makeInsertOptions()

DatabaseSqlite::makeInsertOptions ( $options )

Parameters

array $options

Returns: string

Reimplemented from Database.

Definition at line 599 of file DatabaseSqlite.php.

References $options, and fixIgnore().

◆ makeSelectOptions()

DatabaseSqlite::makeSelectOptions ( $options )

Filter the options used in SELECT statements.

Parameters

array $options

Returns: array

Reimplemented from Database.

Definition at line 559 of file DatabaseSqlite.php.

References $options, and as.

◆ makeUpdateOptionsArray()

DatabaseSqlite::makeUpdateOptionsArray ( $options )

protected

Parameters

array $options

Returns: string

Reimplemented from Database.

Definition at line 573 of file DatabaseSqlite.php.

References $options, and fixIgnore().

◆ newStandaloneInstance()

static 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 Database\factory().

◆ numFields()

DatabaseSqlite::numFields ( $res )

Parameters

ResultWrapper $res

Returns: int

Implements IDatabase.

Definition at line 386 of file DatabaseSqlite.php.

References $res.

Referenced by DatabaseSqliteTest\testNumFields().

◆ numRows()

DatabaseSqlite::numRows ( $res )

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

Parameters

ResultWrapper | array $res

Returns: int

Implements IDatabase.

Definition at line 376 of file DatabaseSqlite.php.

References $res.

◆ open()

DatabaseSqlite::open	(	$server,
		$user,
		$pass,
		$dbName
	)

Open an SQLite database and return a resource handle to it NOTE: only $dbName is used, the other parameters are irrelevant for SQLite databases.

Parameters

string	$server
string	$user
string	$pass
string	$dbName

Exceptions

DBConnectionError

Returns: PDO

Implements IDatabase.

Definition at line 150 of file DatabaseSqlite.php.

References $mConn, Database\close(), generateFileName(), and openFile().

Referenced by __construct().

◆ openFile()

DatabaseSqlite::openFile ( $fileName )

protected

Opens a database file.

Parameters

string $fileName

Exceptions

DBConnectionError

Returns: PDO|bool SQL connection or false if failed

Definition at line 169 of file DatabaseSqlite.php.

References $e, $mConn, and Database\query().

Referenced by __construct(), and open().

◆ replace()

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

Parameters

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

Returns: bool|ResultWrapper

Reimplemented from Database.

Definition at line 640 of file DatabaseSqlite.php.

References $ret, as, and Database\nativeReplace().

◆ replaceVars()

DatabaseSqlite::replaceVars ( $s )

protected

Parameters

string $s

Returns: string

Reimplemented from Database.

Reimplemented in DatabaseSqliteMock.

Definition at line 853 of file DatabaseSqlite.php.

References $s.

◆ requiresDatabaseUser()

DatabaseSqlite::requiresDatabaseUser ( )

protected

Returns: bool Whether a DB user is required to access the DB

Since: 1.28

Reimplemented from Database.

Definition at line 1049 of file DatabaseSqlite.php.

◆ strencode()

DatabaseSqlite::strencode ( $s )

Parameters

string $s

Returns: string

Reimplemented from Database.

Definition at line 761 of file DatabaseSqlite.php.

References $s, and addQuotes().

◆ tableName()

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

Definition at line 420 of file DatabaseSqlite.php.

References $name.

Referenced by DatabaseSqliteTest\testTableName().

◆ textFieldSize()

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

Definition at line 668 of file DatabaseSqlite.php.

◆ unionQueries()

DatabaseSqlite::unionQueries	(	$sqls,
		$all
	)

Parameters

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

Returns: string

Reimplemented from Database.

Definition at line 684 of file DatabaseSqlite.php.

◆ unionSupportsOrderAndLimit()

DatabaseSqlite::unionSupportsOrderAndLimit ( )

Returns: bool

Reimplemented from Database.

Definition at line 675 of file DatabaseSqlite.php.

◆ unlock()

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

Reimplemented from Database.

Definition at line 916 of file DatabaseSqlite.php.

References LockManager\LOCK_EX.

◆ wasDeadlock()

DatabaseSqlite::wasDeadlock ( )

Returns: bool

Reimplemented from Database.

Definition at line 693 of file DatabaseSqlite.php.

References lastErrno().

◆ wasErrorReissuable()

DatabaseSqlite::wasErrorReissuable ( )

Returns: bool

Reimplemented from Database.

Definition at line 700 of file DatabaseSqlite.php.

References lastErrno().

◆ wasReadOnlyError()

DatabaseSqlite::wasReadOnlyError ( )

Returns: bool

Reimplemented from Database.

Definition at line 707 of file DatabaseSqlite.php.

References lastErrno().

Member Data Documentation

◆ $dbDir

string DatabaseSqlite::$dbDir

protected

Directory.

Definition at line 33 of file DatabaseSqlite.php.

◆ $dbPath

string DatabaseSqlite::$dbPath

protected

File name for SQLite database file.

Definition at line 36 of file DatabaseSqlite.php.

Referenced by getDbFilePath().

◆ $fulltextEnabled

bool DatabaseSqlite::$fulltextEnabled = null

staticprivate

Whether full text is enabled.

Definition at line 30 of file DatabaseSqlite.php.

Referenced by checkForEnabledSearch().

◆ $lockMgr

FSLockManager DatabaseSqlite::$lockMgr

protected

(hopefully on the same server as the DB)

Definition at line 51 of file DatabaseSqlite.php.

◆ $mAffectedRows

int DatabaseSqlite::$mAffectedRows

protected

The number of rows affected as an integer.

Definition at line 42 of file DatabaseSqlite.php.

Referenced by affectedRows().

◆ $mConn

$mConn DatabaseSqlite::$mConn

protected

PDO.

Definition at line 48 of file DatabaseSqlite.php.

Referenced by open(), and openFile().

◆ $mLastResult

resource DatabaseSqlite::$mLastResult

protected

Definition at line 45 of file DatabaseSqlite.php.

◆ $trxMode

string DatabaseSqlite::$trxMode

protected

Transaction mode.

Definition at line 39 of file DatabaseSqlite.php.

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

includes/libs/rdbms/database/DatabaseSqlite.php

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Static Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ __toString()

◆ addQuotes()

◆ affectedRows()

◆ attachDatabase()

◆ buildConcat()

◆ buildGroupConcatField()

◆ buildLike()

◆ buildStringCast()

◆ checkForEnabledSearch()

◆ closeConnection()

◆ dataSeek()

◆ deadlockLoop()

◆ decodeBlob()

◆ doBegin()

◆ doQuery()

◆ dropTable()

◆ duplicateTableStructure()

◆ encodeBlob()

◆ fetchObject()

◆ fetchRow()

◆ fieldInfo()

◆ fieldName()

◆ fixIgnore()

◆ freeResult()

◆ generateFileName()

◆ getDbFilePath()

◆ getFulltextSearchModule()

◆ getServerVersion()

◆ getSoftwareLink()

◆ getType()

◆ implicitGroupby()

◆ indexInfo()

◆ indexName()

◆ indexUnique()

◆ insert()

◆ insertId()

◆ isWriteQuery()

◆ lastErrno()

◆ lastError()

◆ listTables()

◆ lock()

◆ makeInsertOptions()

◆ makeSelectOptions()

◆ makeUpdateOptionsArray()

◆ newStandaloneInstance()

◆ numFields()

◆ numRows()

◆ open()

◆ openFile()

◆ replace()

◆ replaceVars()

◆ requiresDatabaseUser()

◆ strencode()

◆ tableName()

◆ textFieldSize()

◆ unionQueries()

◆ unionSupportsOrderAndLimit()

◆ unlock()

◆ wasDeadlock()

◆ wasErrorReissuable()

◆ wasReadOnlyError()

Member Data Documentation

◆ $dbDir

◆ $dbPath

◆ $fulltextEnabled

◆ $lockMgr

◆ $mAffectedRows

◆ $mConn

◆ $mLastResult

◆ $trxMode