Inheritance diagram for DatabaseSqlite:

[legend]

Collaboration diagram for DatabaseSqlite:

[legend]

Public Member Functions
	__construct ( $p=null)
	Constructor. More...

	addQuotes ( $s)

	affectedRows ()

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

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

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

	buildLike ()

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

	dataSeek ( $res, $row)

	deadlockLoop ()
	No-op version of deadlockLoop. More...

	decodeBlob ( $b)

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

	fieldName ( $res, $n)

	freeResult ( $res)

	getSearchEngine ()

	getServerInfo ()

	getServerVersion ()

	getSoftwareLink ()

	getType ()

	implicitGroupby ()

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

	indexName ( $index)
	Index names have DB scope. More...

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

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

	insertId ()
	This must be called after nextSequenceVal. More...

	isWriteQuery ( $sql)

	lastErrno ()

	lastError ()

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

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

	makeInsertOptions ( $options)

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

	numFields ( $res)

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

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

	openFile ( $fileName)
	Opens a database file. More...

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

	strencode ( $s)

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

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

	unionQueries ( $sqls, $all)

	unionSupportsOrderAndLimit ()

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

	wasDeadlock ()

	wasErrorReissuable ()

	wasReadOnlyError ()

Public Member Functions inherited from DatabaseBase
	__destruct ()
	Run a few simple sanity checks. More...

	__sleep ()
	Called by serialize. More...

	__toString ()

	addIdentifierQuotes ( $s)
	Quotes an identifier using `backticks` or "double quotes" depending on the database type. More...

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

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

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

	begin ( $fname=__METHOD__)
	Begin a transaction. More...

	bitAnd ( $fieldLeft, $fieldRight)

	bitNot ( $field)

	bitOr ( $fieldLeft, $fieldRight)

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

	cascadingDeletes ()
	Returns true if this database supports (and uses) cascading deletes. More...

	cleanupTriggers ()
	Returns true if this database supports (and uses) triggers (e.g. More...

	clearFlag ( $flag)
	Clear a flag for this connection. More...

	clearViewsCache ()
	Reset the views process cache set by listViews() More...

	close ()
	Closes a database connection. More...

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

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

	connectionErrorHandler ( $errno, $errstr)

	dbSchema ( $schema=null)
	Get/set the db schema. More...

	debug ( $debug=null)
	Boolean, controls output of large amounts of debug information. More...

	decodeExpiry ( $expiry, $format=TS_MW)
	Decode an expiry time into a DBMS independent format. More...

	delete ( $table, $conds, $fname=__METHOD__)
	DELETE query wrapper. More...

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

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

	dropTable ( $tableName, $fName=__METHOD__)
	Delete a table. More...

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

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

	errorCount ( $count=null)
	Get/set the number of errors logged. More...

	estimateRowCount ( $table, $vars=' *', $conds='', $fname=__METHOD__, $options=array())
	Estimate rows in dataset. More...

	execute ( $prepared, $args=null)
	Execute a prepared query with the various arguments. More...

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

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

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

	fillPrepared ( $preparedQuery, $args)
	For faking prepared SQL statements on DBs that don't support it directly. More...

	functionalIndexes ()
	Returns true if this database can use functional indexes. More...

	getDBname ()
	Get the current DB name. More...

	getDelimiter ()

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

	getInfinity ()
	Find out when 'infinity' is. More...

	getLag ()
	Get slave lag. More...

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

	getMasterPos ()
	Get the position of this master. More...

	getProperty ( $name)
	General read-only accessor. More...

	getSchemaPath ()
	Return a path to the DBMS-specific schema file, otherwise default to tables.sql. More...

	getServer ()
	Get the server hostname or IP address. More...

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

	getSlavePos ()
	Get the replication position of this slave. More...

	getWikiID ()

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

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

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

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

	insertSelect ( $destTable, $srcTable, $varMap, $conds, $fname=__METHOD__, $insertOptions=array(), $selectOptions=array())
	INSERT SELECT wrapper. More...

	isOpen ()
	Is a connection to the database open? More...

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

	isView ( $name)
	Differentiates between a TABLE and a VIEW. More...

	lastQuery ()
	Return the last query that went through DatabaseBase::query() More...

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

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

	lockIsFree ( $lockName, $method)
	Check to see if a named lock is available. More...

	lockTables ( $read, $write, $method, $lowPriority=true)
	Lock specific tables. More...

	lowPriorityOption ()
	A string to insert into queries to show that they're low-priority, like MySQL's LOW_PRIORITY. More...

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

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

	makeOrderBy ( $options)
	Returns an optional ORDER BY. More...

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

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

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

	nextSequenceValue ( $seqName)
	Returns an appropriately quoted sequence value for inserting a new row. More...

	onTransactionIdle ( $callback)
	Run an anonymous function as soon as there is no transaction pending. More...

	onTransactionPreCommitOrIdle ( $callback)
	Run an anonymous function before the current transaction commits or now if there is none. More...

	patchPath ( $patch)
	Get the full path of a patch file. More...

	ping ()
	Ping the server and try to reconnect if it there is no connection. More...

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

	realTimestamps ()
	Returns true if this database uses timestamps rather than integers. More...

	reportConnectionError ( $error='Unknown error')

	reportQueryError ( $error, $errno, $sql, $fname, $tempIgnore=false)
	Report a query error. More...

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

	rollback ( $fname=__METHOD__, $flush='')
	Rollback a transaction previously started using begin(). More...

	searchableIPs ()
	Returns true if this database can do a native search on IP columns e.g. More...

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

	selectDB ( $db)
	Change the current database. More...

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

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

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

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

	setFakeMaster ( $enabled=true)
	Make this connection a fake master. More...

	setFakeSlaveLag ( $lag)
	Set lag time in seconds for a fake slave. More...

	setFileHandle ( $fh)
	Set the filehandle to copy write statements to. More...

	setFlag ( $flag)
	Set a flag for this connection. More...

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

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

	setSessionOptions (array $options)
	Override database's default behavior. More...

	sourceFile ( $filename, $lineCallback=false, $resultCallback=false, $fname=false, $inputCallback=false)
	Read and execute SQL commands from a file. More...

	sourceStream ( $fp, $lineCallback=false, $resultCallback=false, $fname=__METHOD__, $inputCallback=false)
	Read and execute commands from an open file handle. More...

	startAtomic ( $fname=__METHOD__)
	Begin an atomic section of statements. More...

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

	strictIPs ()
	Returns true if this database is strict about what can be put into an IP field. More...

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

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

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

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

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

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

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

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

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

	trxLevel ()
	Gets the current transaction level. More...

	unlockTables ( $method)
	Unlock specific tables. More...

	update ( $table, $values, $conds, $fname=__METHOD__, $options=array())
	UPDATE wrapper. More...

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

	useIndexClause ( $index)
	USE INDEX clause. More...

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

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

Static Public Member Functions
static	fixIgnore ( $options)

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

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

Static Public Member Functions inherited from DatabaseBase
static	factory ( $dbType, $p=array())
	Given a DB type, construct the name of the appropriate child class of DatabaseBase. More...

static	generalizeSQL ( $sql)
	Removes most variables from an SQL query and replaces them with X or N for numbers. More...

Public Attributes
string	$mDatabaseFile
	File name for SQLite database file *. More...

Public Attributes inherited from DatabaseBase
	$mDBname

	$mPassword

	$mUser

const	DEADLOCK_DELAY_MAX = 1500000
	Maximum time to wait before retry. More...

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

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

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

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

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

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

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

	makeUpdateOptionsArray ( $options)

	replaceVars ( $s)

Protected Member Functions inherited from DatabaseBase
	escapeLikeInternal ( $s)

	fillPreparedArg ( $matches)
	preg_callback func for fillPrepared() The arguments should be in $this->preparedArgs and must not be touched while we're doing this. More...

	freePrepared ( $prepared)
	Free a prepared query, generated by prepare(). More...

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

	getSchemaVars ()
	Get schema variables. More...

	indexNameCallback ( $matches)
	Index name callback. More...

	installErrorHandler ()

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

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

	prepare ( $sql, $func='DatabaseBase::prepare')
	Intended to be compatible with the PEAR::DB wrapper functions. More...

	replaceSchemaVars ( $ins)
	Database independent variable replacement. More...

	restoreErrorHandler ()

	runOnTransactionIdleCallbacks ()
	Actually any "on transaction idle" callbacks. More...

	runOnTransactionPreCommitCallbacks ()
	Actually any "on transaction pre-commit" callbacks. More...

	tableNameCallback ( $matches)
	Table name callback. More...

	tableNamesWithUseIndexOrJOIN ( $tables, $use_index=array(), $join_conds=array())
	Get the aliased table name clause for a FROM clause which might have a JOIN and/or USE INDEX clause. More...

Protected Attributes
FSLockManager	$lockMgr
	(hopefully on the same server as the DB) * More...

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

PDO	$mConn

resource	$mLastResult

Protected Attributes inherited from DatabaseBase
string[]	$allViews = null

	$delimiter = ';'

resource	$fileHandle = null

	$htmlErrors

resource	$mConn = null
	Database connection *. More...

	$mDefaultBigSelects = null

	$mDoneWrites = false

	$mErrorCount = 0

	$mFlags

	$mForeign

	$mLastQuery = ''

	$mLBInfo = array()

	$mOpened = false

	$mPHPError = false

	$mSchema

	$mSchemaVars = false

	$mServer

	$mTablePrefix

callable[]	$mTrxIdleCallbacks = array()

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

callable[]	$mTrxPreCommitCallbacks = array()

	$preparedArgs

Static Private Attributes
static	$fulltextEnabled = null

Detailed Description

Definition at line 28 of file DatabaseSqlite.php.

Constructor & Destructor Documentation

◆ __construct()

DatabaseSqlite::__construct ( $params = null )

Constructor.

FIXME: It is possible to construct a Database object with no associated connection object, by specifying no parameters to __construct(). This feature is deprecated and should be removed.

DatabaseBase subclasses should not be constructed directly in external code. DatabaseBase::factory() should be used instead.

Parameters

array $params Parameters passed from DatabaseBase::factory()

Reimplemented from DatabaseBase.

Definition at line 42 of file DatabaseSqlite.php.

References $args, array(), attachDatabase(), global, DatabaseBase\isOpen(), open(), and wfDeprecated().

Member Function Documentation

◆ addQuotes()

DatabaseSqlite::addQuotes ( $s )

Parameters

Blob | string $s

Returns: string

Reimplemented from DatabaseBase.

Definition at line 768 of file DatabaseSqlite.php.

References $s.

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

◆ affectedRows()

DatabaseSqlite::affectedRows ( )

Returns: int

Implements DatabaseType.

Definition at line 442 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 $wgSQLiteDataDir
string	$fname	Calling function name

Returns: ResultWrapper

Definition at line 225 of file DatabaseSqlite.php.

References $file, $fname, $name, addQuotes(), generateFileName(), global, and DatabaseBase\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 DatabaseBase.

Definition at line 893 of file DatabaseSqlite.php.

◆ buildGroupConcatField()

DatabaseSqlite::buildGroupConcatField	(	$delim,
		$table,
		$field,
		$conds = `''`,
		$join_conds = `array()`
	)

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

Definition at line 897 of file DatabaseSqlite.php.

References addQuotes(), array(), and DatabaseBase\selectSQLText().

◆ buildLike()

DatabaseSqlite::buildLike ( )

Returns: string

Reimplemented from DatabaseBase.

Definition at line 789 of file DatabaseSqlite.php.

References $params.

◆ checkForEnabledSearch()

DatabaseSqlite::checkForEnabledSearch ( )

Check if the searchindext table is FTS enabled.

Returns: bool False if not enabled.

Definition at line 178 of file DatabaseSqlite.php.

References $fulltextEnabled, $res, DatabaseBase\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 DatabaseBase.

Definition at line 158 of file DatabaseSqlite.php.

◆ dataSeek()

DatabaseSqlite::dataSeek	(	$res,
		$row
	)

Parameters

ResultWrapper \| array	$res
int	$row

Implements DatabaseType.

Definition at line 400 of file DatabaseSqlite.php.

References $res.

◆ deadlockLoop()

DatabaseSqlite::deadlockLoop ( )

No-op version of deadlockLoop.

Returns: mixed

Reimplemented from DatabaseBase.

Definition at line 810 of file DatabaseSqlite.php.

References $args.

◆ decodeBlob()

DatabaseSqlite::decodeBlob ( $b )

Parameters

$b	Blob\|string

Returns: string

Reimplemented from DatabaseBase.

Definition at line 756 of file DatabaseSqlite.php.

◆ doBegin()

DatabaseSqlite::doBegin ( $fname = '' )

protected

Issues the BEGIN command to the database server.

See also: DatabaseBase::begin()

Parameters

string $fname

Reimplemented from DatabaseBase.

Definition at line 704 of file DatabaseSqlite.php.

References $e, and DatabaseBase\commit().

◆ doCommit()

DatabaseSqlite::doCommit ( $fname = '' )

protected

Issues the COMMIT command to the database server.

See also: DatabaseBase::commit()

Parameters

string $fname

Reimplemented from DatabaseBase.

Definition at line 716 of file DatabaseSqlite.php.

References $e.

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

Definition at line 251 of file DatabaseSqlite.php.

References $res.

◆ doRollback()

DatabaseSqlite::doRollback ( $fname = '' )

protected

Issues the ROLLBACK command to the database server.

See also: DatabaseBase::rollback()

Parameters

string $fname

Reimplemented from DatabaseBase.

Definition at line 728 of file DatabaseSqlite.php.

◆ duplicateTableStructure()

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

Exceptions

MWException

Parameters

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

Returns: bool|ResultWrapper

Reimplemented from DatabaseBase.

Definition at line 913 of file DatabaseSqlite.php.

References $fname, $res, DatabaseBase\addIdentifierQuotes(), addQuotes(), fetchObject(), DatabaseBase\query(), and wfDebug().

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

◆ encodeBlob()

DatabaseSqlite::encodeBlob ( $b )

Parameters

$b

Returns: Blob

Reimplemented from DatabaseBase.

Definition at line 748 of file DatabaseSqlite.php.

◆ fetchObject()

DatabaseSqlite::fetchObject ( $res )

Parameters

ResultWrapper | array $res

Returns: stdClass|bool

Implements DatabaseType.

Definition at line 279 of file DatabaseSqlite.php.

References $res, and as.

Referenced by duplicateTableStructure().

◆ fetchRow()

DatabaseSqlite::fetchRow ( $res )

Parameters

ResultWrapper | mixed $res

Returns: array|bool

Implements DatabaseType.

Definition at line 306 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 DatabaseType.

Definition at line 691 of file DatabaseSqlite.php.

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

◆ fieldName()

DatabaseSqlite::fieldName	(	$res,
		$n
	)

Parameters

ResultWrapper	$res
	$n

Returns: bool

Implements DatabaseType.

Definition at line 349 of file DatabaseSqlite.php.

References $keys, $n, and $res.

◆ fixIgnore()

static DatabaseSqlite::fixIgnore ( $options )

static

Parameters

array $options

Returns: array

Definition at line 531 of file DatabaseSqlite.php.

References $options, and as.

Referenced by makeInsertOptions(), and makeUpdateOptionsArray().

◆ freeResult()

DatabaseSqlite::freeResult ( $res )

Parameters

ResultWrapper | mixed $res

Reimplemented from DatabaseBase.

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

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

◆ getFulltextSearchModule()

static DatabaseSqlite::getFulltextSearchModule ( )

static

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

Returns: string

Definition at line 196 of file DatabaseSqlite.php.

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

◆ getSearchEngine()

DatabaseSqlite::getSearchEngine ( )

Returns: string

Reimplemented from DatabaseBase.

Definition at line 801 of file DatabaseSqlite.php.

◆ getServerInfo()

DatabaseSqlite::getServerInfo ( )

Returns: string User-friendly database information

Reimplemented from DatabaseBase.

Definition at line 677 of file DatabaseSqlite.php.

References getServerVersion(), and wfMessage().

◆ getServerVersion()

DatabaseSqlite::getServerVersion ( )

Returns: string Version information from the database

Implements DatabaseType.

Definition at line 668 of file DatabaseSqlite.php.

Referenced by SqliteInstaller\checkPrerequisites(), and getServerInfo().

◆ getSoftwareLink()

DatabaseSqlite::getSoftwareLink ( )

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

Implements DatabaseType.

Definition at line 661 of file DatabaseSqlite.php.

◆ getType()

DatabaseSqlite::getType ( )

Returns: string

Implements DatabaseType.

Definition at line 76 of file DatabaseSqlite.php.

◆ implicitGroupby()

DatabaseSqlite::implicitGroupby ( )

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

Returns: bool

Reimplemented from DatabaseBase.

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

Implements DatabaseType.

Definition at line 456 of file DatabaseSqlite.php.

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

◆ indexName()

DatabaseSqlite::indexName ( $index )

Index names have DB scope.

Parameters

string $index

Returns: string

Reimplemented from DatabaseBase.

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

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

◆ insert()

DatabaseSqlite::insert	(	$table,
		$a,
		$fname = `__METHOD__`,
		$options = `array()`
	)

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

Parameters

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

Returns: bool

Reimplemented from DatabaseBase.

Definition at line 560 of file DatabaseSqlite.php.

References $options, $ret, as, and insert.

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

◆ insertId()

DatabaseSqlite::insertId ( )

This must be called after nextSequenceVal.

Returns: int

Implements DatabaseType.

Definition at line 391 of file DatabaseSqlite.php.

Referenced by DatabaseSqliteTest\testInsertIdType().

◆ isWriteQuery()

DatabaseSqlite::isWriteQuery ( $sql )

See also: DatabaseBase::isWriteQuery()

Parameters

$sql string

Returns: bool

Reimplemented from DatabaseBase.

Definition at line 241 of file DatabaseSqlite.php.

◆ lastErrno()

DatabaseSqlite::lastErrno ( )

Returns: string

Implements DatabaseType.

Definition at line 429 of file DatabaseSqlite.php.

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

◆ lastError()

DatabaseSqlite::lastError ( )

Returns: string

Implements DatabaseType.

Definition at line 417 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 DatabaseBase.

Definition at line 946 of file DatabaseSqlite.php.

References $vars, array(), as, and DatabaseBase\select().

Referenced by DatabaseSqliteTest\getTables().

◆ lock()

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

Acquire a named lock.

Abstracted from Filestore::lock() so child classes can implement for their own needs.

Parameters

string	$lockName	Name of lock to aquire
string	$method	Name of method calling us
int	$timeout

Returns: bool

Reimplemented from DatabaseBase.

Definition at line 871 of file DatabaseSqlite.php.

References array(), global, and LockManager\LOCK_EX.

◆ makeInsertOptions()

DatabaseSqlite::makeInsertOptions ( $options )

Parameters

array $options

Returns: string

Reimplemented from DatabaseBase.

Definition at line 546 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 DatabaseBase.

Definition at line 506 of file DatabaseSqlite.php.

References $options, and as.

◆ makeUpdateOptionsArray()

DatabaseSqlite::makeUpdateOptionsArray ( $options )

protected

Parameters

array $options

Returns: string

Reimplemented from DatabaseBase.

Definition at line 520 of file DatabaseSqlite.php.

References $options, and fixIgnore().

◆ numFields()

DatabaseSqlite::numFields ( $res )

Parameters

ResultWrapper $res

Returns: int

Implements DatabaseType.

Definition at line 338 of file DatabaseSqlite.php.

References $res.

◆ numRows()

DatabaseSqlite::numRows ( $res )

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

Parameters

ResultWrapper | array $res

Returns: int

Implements DatabaseType.

Definition at line 328 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 DatabaseType.

Definition at line 100 of file DatabaseSqlite.php.

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

Referenced by __construct().

◆ openFile()

DatabaseSqlite::openFile ( $fileName )

Opens a database file.

Parameters

string $fileName

Exceptions

DBConnectionError

Returns: PDO|bool SQL connection or false if failed

Definition at line 121 of file DatabaseSqlite.php.

References $e, $mConn, array(), DBO_PERSISTENT, DatabaseBase\query(), and wfDebug().

Referenced by DatabaseSqliteStandalone\__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 DatabaseBase.

Definition at line 587 of file DatabaseSqlite.php.

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

◆ replaceVars()

DatabaseSqlite::replaceVars ( $s )

protected

Parameters

string $s

Returns: string

Reimplemented from DatabaseBase.

Reimplemented in MockDatabaseSqlite.

Definition at line 821 of file DatabaseSqlite.php.

References $s.

◆ strencode()

DatabaseSqlite::strencode ( $s )

Parameters

string $s

Returns: string

Implements DatabaseType.

Definition at line 740 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 DatabaseBase.

Definition at line 367 of file DatabaseSqlite.php.

References $name, and tableName().

Referenced by checkForEnabledSearch(), fieldInfo(), and 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 DatabaseBase.

Definition at line 615 of file DatabaseSqlite.php.

◆ unionQueries()

DatabaseSqlite::unionQueries	(	$sqls,
		$all
	)

Parameters

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

Returns: string

Reimplemented from DatabaseBase.

Definition at line 631 of file DatabaseSqlite.php.

◆ unionSupportsOrderAndLimit()

DatabaseSqlite::unionSupportsOrderAndLimit ( )

Returns: bool

Reimplemented from DatabaseBase.

Definition at line 622 of file DatabaseSqlite.php.

◆ unlock()

DatabaseSqlite::unlock	(	$lockName,
		$method
	)

Release a lock.

Parameters

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

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

Definition at line 883 of file DatabaseSqlite.php.

References array(), and LockManager\LOCK_EX.

◆ wasDeadlock()

DatabaseSqlite::wasDeadlock ( )

Returns: bool

Reimplemented from DatabaseBase.

Definition at line 640 of file DatabaseSqlite.php.

References lastErrno().

◆ wasErrorReissuable()

DatabaseSqlite::wasErrorReissuable ( )

Returns: bool

Reimplemented from DatabaseBase.

Definition at line 647 of file DatabaseSqlite.php.

References lastErrno().

◆ wasReadOnlyError()

DatabaseSqlite::wasReadOnlyError ( )

Returns: bool

Reimplemented from DatabaseBase.

Definition at line 654 of file DatabaseSqlite.php.

References lastErrno().

Member Data Documentation

◆ $fulltextEnabled

DatabaseSqlite::$fulltextEnabled = null

staticprivate

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

◆ $mAffectedRows

int DatabaseSqlite::$mAffectedRows

protected

The number of rows affected as an integer *.

Definition at line 34 of file DatabaseSqlite.php.

Referenced by affectedRows().

◆ $mConn

PDO DatabaseSqlite::$mConn

protected

Definition at line 38 of file DatabaseSqlite.php.

Referenced by open(), and openFile().

◆ $mDatabaseFile

string DatabaseSqlite::$mDatabaseFile

File name for SQLite database file *.

Definition at line 32 of file DatabaseSqlite.php.

◆ $mLastResult

resource DatabaseSqlite::$mLastResult

protected

Definition at line 36 of file DatabaseSqlite.php.

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

includes/db/DatabaseSqlite.php

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addQuotes()

◆ affectedRows()

◆ attachDatabase()

◆ buildConcat()

◆ buildGroupConcatField()

◆ buildLike()

◆ checkForEnabledSearch()

◆ closeConnection()

◆ dataSeek()

◆ deadlockLoop()

◆ decodeBlob()

◆ doBegin()

◆ doCommit()

◆ doQuery()

◆ doRollback()

◆ duplicateTableStructure()

◆ encodeBlob()

◆ fetchObject()

◆ fetchRow()

◆ fieldInfo()

◆ fieldName()

◆ fixIgnore()

◆ freeResult()

◆ generateFileName()

◆ getFulltextSearchModule()

◆ getSearchEngine()

◆ getServerInfo()

◆ getServerVersion()

◆ getSoftwareLink()

◆ getType()

◆ implicitGroupby()

◆ indexInfo()

◆ indexName()

◆ indexUnique()

◆ insert()

◆ insertId()

◆ isWriteQuery()

◆ lastErrno()

◆ lastError()

◆ listTables()

◆ lock()

◆ makeInsertOptions()

◆ makeSelectOptions()

◆ makeUpdateOptionsArray()

◆ numFields()

◆ numRows()

◆ open()

◆ openFile()

◆ replace()

◆ replaceVars()

◆ strencode()

◆ tableName()

◆ textFieldSize()

◆ unionQueries()

◆ unionSupportsOrderAndLimit()

◆ unlock()

◆ wasDeadlock()

◆ wasErrorReissuable()

◆ wasReadOnlyError()

Member Data Documentation

◆ $fulltextEnabled

◆ $lockMgr

◆ $mAffectedRows

◆ $mConn

◆ $mDatabaseFile

◆ $mLastResult