Inheritance diagram for DatabaseSqlite:

Collaboration diagram for DatabaseSqlite:

Public Member Functions
	__construct ($server=false, $user=false, $password=false, $dbName=false, $flags=0)
	Constructor.
	addQuotes ($s)
	affectedRows ()
	attachDatabase ($name, $file=false, $fname= 'DatabaseSqlite::attachDatabase')
	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.
	buildLike ()
	checkForEnabledSearch ()
	Check if the searchindext table is FTS enabled.
	dataSeek ($res, $row)
	deadlockLoop ()
	No-op version of deadlockLoop.
	decodeBlob ($b)
	duplicateTableStructure ($oldName, $newName, $temporary=false, $fname= 'DatabaseSqlite::duplicateTableStructure')
	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)
	getSearchEngine ()
	getServerInfo ()
	getServerVersion ()
	getType ()
	implicitGroupby ()
	indexInfo ($table, $index, $fname= 'DatabaseSqlite::indexExists')
	Returns information about an index Returns false if the index does not exist.
	indexName ($index)
	Index names have DB scope.
	indexUnique ($table, $index, $fname= 'DatabaseSqlite::indexUnique')
	insert ($table, $a, $fname= 'DatabaseSqlite::insert', $options=array())
	Based on generic method (parent) with some prior SQLite-sepcific adjustments.
	insertId ()
	This must be called after nextSequenceVal.
	isWriteQuery ($sql)
	lastErrno ()
	lastError ()
	listTables ($prefix=null, $fname= 'DatabaseSqlite::listTables')
	List all tables on the database.
	makeInsertOptions ($options)
	makeSelectOptions ($options)
	Filter the options used in SELECT statements.
	makeUpdateOptions ($options)
	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.
	openFile ($fileName)
	Opens a database file.
	replace ($table, $uniqueIndexes, $rows, $fname= 'DatabaseSqlite::replace')
	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 ()
	wasDeadlock ()
	wasErrorReissuable ()
	wasReadOnlyError ()
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	getSoftwareLink ()
Public Attributes
	$mAffectedRows
	$mDatabaseFile
	$mLastResult
	$mName
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.
	doCommit ($fname= '')
	Issues the COMMIT 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.
	doRollback ($fname= '')
	Issues the ROLLBACK command to the database server.
	replaceVars ($s)
Protected Attributes
PDO	$mConn
Static Private Attributes
static	$fulltextEnabled = null

Detailed Description

Definition at line 28 of file DatabaseSqlite.php.

Constructor & Destructor Documentation

DatabaseSqlite::__construct	(	$	server = `false`,
		$	user = `false`,
		$	password = `false`,
		$	dbName = `false`,
		$	flags = `0`
	)

Constructor.

Parameters $server, $user and $password are not used.

Parameters:

$server	string
$user	string
$password	string
$dbName	string
$flags	int

Definition at line 50 of file DatabaseSqlite.php.

Member Function Documentation

DatabaseSqlite::addQuotes ( $ s )

Parameters:

$s	Blob\|string

Returns:: string

Reimplemented from DatabaseBase.

Definition at line 706 of file DatabaseSqlite.php.

DatabaseSqlite::affectedRows ( )

Returns:: int

Implements DatabaseType.

Definition at line 411 of file DatabaseSqlite.php.

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

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
string	$file	database file name. If omitted, will be generated using $name and $wgSQLiteDataDir
string	$fname	calling function name

Returns:: ResultWrapper

Definition at line 202 of file DatabaseSqlite.php.

DatabaseSqlite::buildConcat ( $ stringList )

Build a concatenation list to feed into a SQL query.

Parameters:

$stringList array

Returns:: string

Reimplemented from DatabaseBase.

Definition at line 803 of file DatabaseSqlite.php.

DatabaseSqlite::buildLike ( )

Returns:: string

Reimplemented from DatabaseBase.

Definition at line 725 of file DatabaseSqlite.php.

DatabaseSqlite::checkForEnabledSearch ( )

Check if the searchindext table is FTS enabled.

Returns:: bool False if not enabled.

Definition at line 158 of file DatabaseSqlite.php.

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

DatabaseSqlite::dataSeek	(	$	res,
		$	row
	)

Parameters:

$res	ResultWrapper
$row

Implements DatabaseType.

Definition at line 371 of file DatabaseSqlite.php.

DatabaseSqlite::deadlockLoop ( )

No-op version of deadlockLoop.

Returns:: mixed

Reimplemented from DatabaseBase.

Definition at line 744 of file DatabaseSqlite.php.

DatabaseSqlite::decodeBlob ( $ b )

Parameters:

$b	Blob\|string

Returns:: string

Reimplemented from DatabaseBase.

Definition at line 695 of file DatabaseSqlite.php.

DatabaseSqlite::doBegin ( $ fname = '' ) [protected]

Issues the BEGIN command to the database server.

See also:: DatabaseBase::begin()

Parameters:

type $fname

Reimplemented from DatabaseBase.

Definition at line 651 of file DatabaseSqlite.php.

References DatabaseBase\commit().

DatabaseSqlite::doCommit ( $ fname = '' ) [protected]

Issues the COMMIT command to the database server.

See also:: DatabaseBase::commit()

Parameters:

type $fname

Reimplemented from DatabaseBase.

Definition at line 659 of file DatabaseSqlite.php.

DatabaseSqlite::doQuery ( $ sql ) [protected]

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

Parameters:

$sql string

Returns:: ResultWrapper

Reimplemented from DatabaseBase.

Definition at line 229 of file DatabaseSqlite.php.

DatabaseSqlite::doRollback ( $ fname = '' ) [protected]

Issues the ROLLBACK command to the database server.

See also:: DatabaseBase::rollback()

Parameters:

type $fname

Reimplemented from DatabaseBase.

Definition at line 667 of file DatabaseSqlite.php.

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

Exceptions:

MWException

Parameters:

$oldName
$newName
$temporary	bool
$fname	string

Returns:: bool|ResultWrapper

Reimplemented from DatabaseBase.

Definition at line 815 of file DatabaseSqlite.php.

DatabaseSqlite::encodeBlob ( $ b )

Parameters:

$b

Returns:: Blob

Reimplemented from DatabaseBase.

Definition at line 687 of file DatabaseSqlite.php.

DatabaseSqlite::fetchObject ( $ res )

Parameters:

$res	ResultWrapper

Returns:: object|bool

Implements DatabaseType.

Definition at line 256 of file DatabaseSqlite.php.

DatabaseSqlite::fetchRow ( $ res )

Parameters:

$res	ResultWrapper

Returns:: array|bool

Implements DatabaseType.

Definition at line 282 of file DatabaseSqlite.php.

DatabaseSqlite::fieldInfo	(	$	table,
		$	field
	)

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

Parameters:

$table	string
$field	string

Returns:: SQLiteField|bool False on failure

Implements DatabaseType.

Definition at line 639 of file DatabaseSqlite.php.

DatabaseSqlite::fieldName	(	$	res,
		$	n
	)

Parameters:

$res	ResultWrapper
$n

Returns:: bool

Implements DatabaseType.

Definition at line 322 of file DatabaseSqlite.php.

static DatabaseSqlite::fixIgnore ( $ options ) [static]

Parameters:

$options array

Returns:: array

Definition at line 493 of file DatabaseSqlite.php.

DatabaseSqlite::freeResult ( $ res )

Parameters:

$res	ResultWrapper

Reimplemented from DatabaseBase.

Definition at line 244 of file DatabaseSqlite.php.

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

static DatabaseSqlite::getFulltextSearchModule ( ) [static]

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

Returns:: String

Definition at line 175 of file DatabaseSqlite.php.

Referenced by RebuildTextIndex\execute(), and SqliteUpdater\sqliteSetupSearchindex().

DatabaseSqlite::getSearchEngine ( )

Returns:: string

Reimplemented from DatabaseBase.

Definition at line 736 of file DatabaseSqlite.php.

DatabaseSqlite::getServerInfo ( )

Returns:: string User-friendly database information

Reimplemented from DatabaseBase.

Definition at line 627 of file DatabaseSqlite.php.

DatabaseSqlite::getServerVersion ( )

Returns:: string Version information from the database

Implements DatabaseType.

Definition at line 619 of file DatabaseSqlite.php.

static DatabaseSqlite::getSoftwareLink ( ) [static]

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

Implements DatabaseType.

Definition at line 612 of file DatabaseSqlite.php.

DatabaseSqlite::getType ( )

Returns:: string

Implements DatabaseType.

Definition at line 65 of file DatabaseSqlite.php.

DatabaseSqlite::implicitGroupby ( )

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

Returns:: bool

Reimplemented from DatabaseBase.

Definition at line 74 of file DatabaseSqlite.php.

DatabaseSqlite::indexInfo	(	$	table,
		$	index,
		$	fname = `'DatabaseSqlite::indexExists'`
	)

Returns information about an index Returns false if the index does not exist.

if errors are explicitly ignored, returns NULL on failure

Returns:: array

Implements DatabaseType.

Definition at line 422 of file DatabaseSqlite.php.

DatabaseSqlite::indexName ( $ index )

Index names have DB scope.

Parameters:

$index string

Returns:: string

Reimplemented from DatabaseBase.

Definition at line 353 of file DatabaseSqlite.php.

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

Parameters:

$table
$index
$fname	string

Returns:: bool|null

Definition at line 444 of file DatabaseSqlite.php.

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

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

Returns:: bool

Reimplemented from DatabaseBase.

Definition at line 516 of file DatabaseSqlite.php.

DatabaseSqlite::insertId ( )

This must be called after nextSequenceVal.

Returns:: int

Implements DatabaseType.

Definition at line 362 of file DatabaseSqlite.php.

DatabaseSqlite::isWriteQuery ( $ sql )

See also:: DatabaseBase::isWriteQuery()

Parameters:

$sql string

Returns:: bool

Reimplemented from DatabaseBase.

Definition at line 218 of file DatabaseSqlite.php.

DatabaseSqlite::lastErrno ( )

Returns:: string

Implements DatabaseType.

Definition at line 399 of file DatabaseSqlite.php.

DatabaseSqlite::lastError ( )

Returns:: string

Implements DatabaseType.

Definition at line 388 of file DatabaseSqlite.php.

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

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

DatabaseSqlite::makeInsertOptions ( $ options )

Parameters:

$options array

Returns:: string

Reimplemented from DatabaseBase.

Definition at line 507 of file DatabaseSqlite.php.

DatabaseSqlite::makeSelectOptions ( $ options )

Filter the options used in SELECT statements.

Parameters:

$options array

Returns:: array

Reimplemented from DatabaseBase.

Definition at line 471 of file DatabaseSqlite.php.

DatabaseSqlite::makeUpdateOptions ( $ options )

Parameters:

$options array

Returns:: string

Reimplemented from DatabaseBase.

Definition at line 484 of file DatabaseSqlite.php.

DatabaseSqlite::numFields ( $ res )

Parameters:

$res	ResultWrapper

Returns:: int

Implements DatabaseType.

Definition at line 312 of file DatabaseSqlite.php.

DatabaseSqlite::numRows ( $ res )

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

Parameters:

$res	ResultWrapper

Returns:: int

Implements DatabaseType.

Definition at line 303 of file DatabaseSqlite.php.

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

DatabaseSqlite::openFile ( $ fileName )

Opens a database file.

Parameters:

$fileName string

Exceptions:

DBConnectionError

Returns:: PDO|bool SQL connection or false if failed

Definition at line 109 of file DatabaseSqlite.php.

Referenced by DatabaseSqliteStandalone\__construct().

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

Parameters:

$table
$uniqueIndexes
$rows
$fname	string

Returns:: bool|ResultWrapper

Reimplemented from DatabaseBase.

Definition at line 543 of file DatabaseSqlite.php.

DatabaseSqlite::replaceVars ( $ s ) [protected]

Parameters:

$s string

Returns:: string

Reimplemented from DatabaseBase.

Reimplemented in MockDatabaseSqlite.

Definition at line 754 of file DatabaseSqlite.php.

DatabaseSqlite::strencode ( $ s )

Parameters:

$s string

Returns:: string

Implements DatabaseType.

Definition at line 679 of file DatabaseSqlite.php.

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

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

Parameters:

$name
$format	String

Returns:: string

Reimplemented from DatabaseBase.

Definition at line 338 of file DatabaseSqlite.php.

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.

Returns:: int

Reimplemented from DatabaseBase.

Definition at line 567 of file DatabaseSqlite.php.

DatabaseSqlite::unionQueries	(	$	sqls,
		$	all
	)

Parameters:

$sqls
$all

Returns:: string

Reimplemented from DatabaseBase.

Definition at line 583 of file DatabaseSqlite.php.

DatabaseSqlite::unionSupportsOrderAndLimit ( )

Returns:: bool

Reimplemented from DatabaseBase.

Definition at line 574 of file DatabaseSqlite.php.

DatabaseSqlite::wasDeadlock ( )

Returns:: bool

Reimplemented from DatabaseBase.

Definition at line 591 of file DatabaseSqlite.php.

DatabaseSqlite::wasErrorReissuable ( )

Returns:: bool

Reimplemented from DatabaseBase.

Definition at line 598 of file DatabaseSqlite.php.

DatabaseSqlite::wasReadOnlyError ( )

Returns:: bool

Reimplemented from DatabaseBase.

Definition at line 605 of file DatabaseSqlite.php.

Member Data Documentation

DatabaseSqlite::$fulltextEnabled = null [static, private]

Definition at line 30 of file DatabaseSqlite.php.

DatabaseSqlite::$mAffectedRows

Definition at line 32 of file DatabaseSqlite.php.

PDO DatabaseSqlite::$mConn [protected]

Reimplemented from DatabaseBase.

Definition at line 39 of file DatabaseSqlite.php.

DatabaseSqlite::$mDatabaseFile

Definition at line 34 of file DatabaseSqlite.php.

DatabaseSqlite::$mLastResult

Definition at line 33 of file DatabaseSqlite.php.

DatabaseSqlite::$mName

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

Member Function Documentation

Member Data Documentation