MediaWiki  1.28.1
DatabaseSqlite Class Reference
Inheritance diagram for DatabaseSqlite:
Collaboration diagram for DatabaseSqlite:

Public Member Functions

 __construct (array $p)
 Additional params include: More...
 
 __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. More...
 
 buildConcat ($stringList)
 Build a concatenation list to feed into a SQL query. More...
 
 buildGroupConcatField ($delim, $table, $field, $conds= '', $join_conds=[])
 Build a GROUP_CONCAT or equivalent statement for a query. More...
 
 buildLike ()
 
 buildStringCast ($field)
 
 checkForEnabledSearch ()
 Check if the searchindext table is FTS enabled. More...
 
 dataSeek ($res, $row)
 
 deadlockLoop ()
 No-op version of deadlockLoop. More...
 
 decodeBlob ($b)
 
 dropTable ($tableName, $fName=__METHOD__)
 Override due to no CASCADE support. More...
 
 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)
 
 getDbFilePath ()
 
 getServerVersion ()
 
 getSoftwareLink ()
 
 getType ()
 
 implicitGroupby ()
 
 indexInfo ($table, $index, $fname=__METHOD__)
 Returns information about an index Returns false if the index does not exist. More...
 
 indexUnique ($table, $index, $fname=__METHOD__)
 
 insert ($table, $a, $fname=__METHOD__, $options=[])
 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...
 
 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 Database
 __clone ()
 Make sure that copies do not share the same client binding handle. More...
 
 __construct (array $params)
 Constructor and database handle and attempt to connect to the DB server. More...
 
 __destruct ()
 Run a few simple sanity checks and close dangling connections. More...
 
 __sleep ()
 Called by serialize. More...
 
 __toString ()
 
 addIdentifierQuotes ($s)
 Quotes an identifier using backticks or "double quotes" depending on the database type. More...
 
 addQuotes ($s)
 Adds quotes and backslashes. 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__, $mode=self::TRANSACTION_EXPLICIT)
 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...
 
 buildConcat ($stringList)
 Build a concatenation list to feed into a SQL query. More...
 
 buildGroupConcatField ($delim, $table, $field, $conds= '', $join_conds=[])
 Build a GROUP_CONCAT or equivalent statement for a query. More...
 
 buildLike ()
 LIKE statement wrapper, receives a variable-length argument list with parts of pattern to match containing either string literals that will be escaped or tokens returned by anyChar() or anyString(). More...
 
 buildStringCast ($field)
 
 clearFlag ($flag, $remember=self::REMEMBER_NOTHING)
 Clear a flag for this connection. 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...
 
 connectionErrorLogger ($errno, $errstr)
 This method should not be used outside of Database classes. More...
 
 dbSchema ($schema=null)
 Get/set the db schema. More...
 
 deadlockLoop ()
 Perform a deadlock-prone transaction. More...
 
 decodeBlob ($b)
 Some DBMSs return a special placeholder object representing blob fields in result objects. 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...
 
 doAtomicSection ($fname, callable $callback)
 Run a callback to do an atomic set of updates for this database. More...
 
 doneWrites ()
 Returns true if the connection may have been used for write queries. More...
 
 dropTable ($tableName, $fName=__METHOD__)
 Delete a table. More...
 
 duplicateTableStructure ($oldName, $newName, $temporary=false, $fname=__METHOD__)
 Creates a new table with structure copied from existing table Note that unlike most database abstraction functions, this function does not automatically append database prefix, because it works at a lower abstraction level. More...
 
 encodeBlob ($b)
 Some DBMSs have a special format for inserting into blob fields, they don't allow simple quoted strings to be inserted. More...
 
 encodeExpiry ($expiry)
 Encode an expiry time into the DBMS dependent format. More...
 
 endAtomic ($fname=__METHOD__)
 Ends an atomic section of SQL statements. More...
 
 estimateRowCount ($table, $vars= '*', $conds= '', $fname=__METHOD__, $options=[])
 Estimate the number of rows in dataset. More...
 
 explicitTrxActive ()
 
 fieldExists ($table, $field, $fname=__METHOD__)
 Determines whether a field exists in a table. More...
 
 flushSnapshot ($fname=__METHOD__)
 Commit any transaction but error out if writes or callbacks are pending. More...
 
 freeResult ($res)
 Free a result object returned by query() or select(). More...
 
 getDBname ()
 Get the current DB name. More...
 
 getDomainID ()
 
 getFlag ($flag)
 Returns a boolean whether the flag $flag is set for this connection. More...
 
 getInfinity ()
 Find out when 'infinity' is. More...
 
 getLag ()
 Get replica DB 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)
 
 getReplicaPos ()
 Get the replication position of this replica DB. More...
 
 getScopedLockAndFlush ($lockKey, $fname, $timeout)
 Acquire a named lock, flush any transaction, and return an RAII style unlocker object. More...
 
 getSearchEngine ()
 
 getServer ()
 Get the server hostname or IP address. More...
 
 getServerInfo ()
 A string describing the current software version, and possibly other details in a user-friendly way. More...
 
 getServerUptime ()
 Determines how long the server has been up. More...
 
 getSessionLagStatus ()
 Get the replica DB lag when the current transaction started or a general lag estimate if not transaction is active. More...
 
 getWikiID ()
 Alias for getDomainID() More...
 
 ignoreIndexClause ($index)
 IGNORE INDEX clause. More...
 
 implicitGroupby ()
 Returns true if this database does an implicit sort when doing GROUP BY. 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...
 
 indexInfo ($table, $index, $fname=__METHOD__)
 Get information about an index into an object. More...
 
 indexUnique ($table, $index)
 Determines if a given index is unique. More...
 
 insert ($table, $a, $fname=__METHOD__, $options=[])
 INSERT wrapper, inserts an array into a table. More...
 
 insertSelect ($destTable, $srcTable, $varMap, $conds, $fname=__METHOD__, $insertOptions=[], $selectOptions=[])
 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...
 
 isReadOnly ()
 
 lastDoneWrites ()
 Returns the last time the connection may have been used for write queries. More...
 
 lastQuery ()
 Return the last query that went through IDatabase::query() More...
 
 limitResult ($sql, $limit, $offset=false)
 Construct a LIMIT query with optional offset. More...
 
 listTables ($prefix=null, $fname=__METHOD__)
 List all tables on the database. More...
 
 listViews ($prefix=null, $fname=__METHOD__)
 Lists all the VIEWs in the database. More...
 
 lock ($lockName, $method, $timeout=5)
 Acquire a named lock. More...
 
 lockIsFree ($lockName, $method)
 Check to see if a named lock is available (non-blocking) More...
 
 lockTables ($read, $write, $method, $lowPriority=true)
 Lock specific tables. More...
 
 makeList ($a, $mode=self::LIST_COMMA)
 Makes an encoded list of strings from an array. 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 replica DB 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...
 
 namedLocksEnqueue ()
 Check to see if a named lock used by lock() use blocking queues. More...
 
 nextSequenceValue ($seqName)
 Returns an appropriately quoted sequence value for inserting a new row. More...
 
 onTransactionIdle (callable $callback, $fname=__METHOD__)
 Run a callback as soon as there is no transaction pending. More...
 
 onTransactionPreCommitOrIdle (callable $callback, $fname=__METHOD__)
 Run a callback before the current transaction commits or now if there is none. More...
 
 onTransactionResolution (callable $callback, $fname=__METHOD__)
 Run a callback as soon as the current transaction commits or rolls back. More...
 
 pendingWriteCallers ()
 Get the list of method names that did write queries for this transaction. More...
 
 pendingWriteQueryDuration ($type=self::ESTIMATE_TOTAL)
 Get the time spend running write queries for this transaction. More...
 
 ping (&$rtt=null)
 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...
 
 replace ($table, $uniqueIndexes, $rows, $fname=__METHOD__)
 REPLACE query wrapper. More...
 
 reportConnectionError ($error= 'Unknown error')
 
 reportQueryError ($error, $errno, $sql, $fname, $tempIgnore=false)
 Report a query error. More...
 
 restoreFlags ($state=self::RESTORE_PRIOR)
 Restore the flags to their prior state before the last setFlag/clearFlag call. More...
 
 rollback ($fname=__METHOD__, $flush= '')
 Rollback a transaction previously started using begin(). More...
 
 runOnTransactionIdleCallbacks ($trigger)
 Actually run and consume any "on transaction idle/resolution" callbacks. More...
 
 runOnTransactionPreCommitCallbacks ()
 Actually run and consume any "on transaction pre-commit" callbacks. More...
 
 runTransactionListenerCallbacks ($trigger)
 Actually run any "transaction listener" callbacks. More...
 
 select ($table, $vars, $conds= '', $fname=__METHOD__, $options=[], $join_conds=[])
 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=[])
 A SELECT wrapper which returns a single field from a single result row. More...
 
 selectFieldValues ($table, $var, $cond= '', $fname=__METHOD__, $options=[], $join_conds=[])
 
 selectRow ($table, $vars, $conds, $fname=__METHOD__, $options=[], $join_conds=[])
 Single row SELECT wrapper. More...
 
 selectRowCount ($tables, $vars= '*', $conds= '', $fname=__METHOD__, $options=[], $join_conds=[])
 Get the number of rows in dataset. More...
 
 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. More...
 
 serverIsReadOnly ()
 
 setBigSelects ($value=true)
 Allow or deny "big selects" for this session only. More...
 
 setFlag ($flag, $remember=self::REMEMBER_NOTHING)
 Set a flag for this connection. More...
 
 setLazyMasterHandle (IDatabase $conn)
 Set a lazy-connecting DB handle to the master DB (for replication status purposes) More...
 
 setLBInfo ($name, $value=null)
 Set the LB info array, or a member of it. More...
 
 setLogger (LoggerInterface $logger)
 
 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...
 
 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. More...
 
 setTransactionListener ($name, callable $callback=null)
 Run a callback each time any transaction commits or rolls back. More...
 
 setTrxEndCallbackSuppression ($suppress)
 Whether to disable running of post-COMMIT/ROLLBACK callbacks. More...
 
 sourceFile ($filename, callable $lineCallback=null, callable $resultCallback=null, $fname=false, callable $inputCallback=null)
 Read and execute SQL commands from a file. More...
 
 sourceStream ($fp, callable $lineCallback=null, callable $resultCallback=null, $fname=__METHOD__, callable $inputCallback=null)
 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...
 
 strencode ($s)
 Wrapper for addslashes() 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...
 
 tableName ($name, $format= 'quoted')
 Format a table name ready for use in constructing an SQL query. 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...
 
 tablePrefix ($prefix=null)
 Get/set the table prefix. More...
 
 textFieldSize ($table, $field)
 Returns the size of a text field, or -1 for "unlimited". 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...
 
 trxTimestamp ()
 Get the UNIX timestamp of the time that the transaction was established. More...
 
 unionQueries ($sqls, $all)
 Construct a UNION query This is used for providing overload point for other DB abstractions not compatible with the MySQL syntax. More...
 
 unionSupportsOrderAndLimit ()
 Returns true if current database backend supports ORDER BY or LIMIT for separate subqueries within the UNION construct. More...
 
 unlock ($lockName, $method)
 Release a lock. More...
 
 unlockTables ($method)
 Unlock specific tables. More...
 
 update ($table, $values, $conds, $fname=__METHOD__, $options=[])
 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...
 
 wasConnectionError ($errno)
 Do not use this method outside of Database/DBError classes. More...
 
 wasDeadlock ()
 Determines if the last failure was due to a deadlock. More...
 
 wasErrorReissuable ()
 Determines if the last query error was due to a dropped connection and should be dealt with by pinging the connection and reissuing the query. More...
 
 wasLockTimeout ()
 Determines if the last failure was due to a lock timeout. More...
 
 wasReadOnlyError ()
 Determines if the last failure was due to the database being read-only. 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...
 
 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. 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 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. More...
 
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. More...
 

Protected Member Functions

 closeConnection ()
 Does not actually close the connection, just destroys the reference for GC to do its work. More...
 
 doBegin ($fname= '')
 
 doQuery ($sql)
 SQLite doesn't allow buffered results or data seeking etc, so we'll use fetchAll as the result. More...
 
 indexName ($index)
 Index names have DB scope. More...
 
 makeUpdateOptionsArray ($options)
 
 openFile ($fileName)
 Opens a database file. More...
 
 replaceVars ($s)
 
 requiresDatabaseUser ()
 
- Protected Member Functions inherited from Database
 assertOpen ()
 Make sure isOpen() returns true as a sanity check. More...
 
 closeConnection ()
 Closes underlying database connection. 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)
 The DBMS-dependent part of query() More...
 
 doRollback ($fname)
 Issues the ROLLBACK command to the database server. More...
 
 escapeLikeInternal ($s)
 
 fieldNamesWithAlias ($fields)
 Gets an array of aliased field names. More...
 
 fieldNameWithAlias ($name, $alias=false)
 Get an aliased field name e.g. More...
 
 getApproximateLagStatus ()
 Get a replica DB lag estimate for this server. More...
 
 getBindingHandle ()
 Get the underlying binding handle, mConn. More...
 
 getDefaultSchemaVars ()
 Get schema variables to use if none have been set via setSchemaVars(). More...
 
 getLastPHPError ()
 
 getLazyMasterHandle ()
 
 getLogContext (array $extras=[])
 Create a log context to pass to PSR-3 logger functions. More...
 
 getQueryVerb ($sql)
 
 getReadOnlyReason ()
 
 getSchemaVars ()
 Get schema variables. More...
 
 getTransactionLagStatus ()
 Get the replica DB lag when the current transaction started. More...
 
 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...
 
 indexName ($index)
 Get the name of an index in a given table. More...
 
 installErrorHandler ()
 
 isTransactableQuery ($sql)
 Determine whether a SQL statement is sensitive to isolation level. More...
 
 isWriteQuery ($sql)
 Determine whether a query writes to the DB. More...
 
 makeGroupByWithHaving ($options)
 Returns an optional GROUP BY with an optional HAVING. More...
 
 makeInsertOptions ($options)
 Helper for Database::insert(). More...
 
 makeOrderBy ($options)
 Returns an optional ORDER BY. More...
 
 makeSelectOptions ($options)
 Returns an optional USE INDEX clause to go after the table, and a string to go at the end of the query. More...
 
 makeUpdateOptions ($options)
 Make UPDATE options for the Database::update function. More...
 
 makeUpdateOptionsArray ($options)
 Make UPDATE options array for Database::makeUpdateOptions. More...
 
 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. More...
 
 pendingWriteAndCallbackCallers ()
 
 reconnect ()
 
 registerTempTableOperation ($sql)
 
 replaceVars ($ins)
 Database independent variable replacement. More...
 
 requiresDatabaseUser ()
 
 restoreErrorHandler ()
 
 resultObject ($result)
 Take the result from a query, and wrap it in a ResultWrapper if necessary. More...
 
 tableNamesWithAlias ($tables)
 Gets an array of aliased table names. More...
 
 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. More...
 
 tableNameWithAlias ($name, $alias=false)
 Get an aliased table name e.g. More...
 

Protected Attributes

string $dbDir
 Directory. More...
 
string $dbPath
 File name for SQLite database file. More...
 
FSLockManager $lockMgr
 (hopefully on the same server as the DB) More...
 
int $mAffectedRows
 The number of rows affected as an integer. More...
 
$mConn $mConn
 PDO. More...
 
resource $mLastResult
 
string $trxMode
 Transaction mode. More...
 
- Protected Attributes inherited from Database
string $agent
 Agent name for query profiling. More...
 
bool $cliMode
 Whether this PHP instance is for a CLI script. More...
 
LoggerInterface $connLogger
 
DatabaseDomain $currentDomain
 
string $delimiter = ';'
 
callback $errorLogger
 Error logging callback. More...
 
string bool null $htmlErrors
 Stashed value of html_errors INI setting. More...
 
float $lastPing = 0.0
 UNIX timestamp. More...
 
resource null $mConn = null
 Database connection. More...
 
string $mDBname
 
bool null $mDefaultBigSelects = null
 
integer $mFlags
 
string $mLastQuery = ''
 SQL query. More...
 
float bool $mLastWriteTime = false
 UNIX timestamp of last write query. More...
 
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. More...
 
array $mSessionVars = []
 
string $mTablePrefix = ''
 
array[] $mTrxEndCallbacks = []
 List of (callable, method name) More...
 
bool $mTrxEndCallbacksSuppressed = false
 Whether to suppress triggering of transaction end callbacks. More...
 
array[] $mTrxIdleCallbacks = []
 List of (callable, method name) More...
 
int $mTrxLevel = 0
 Either 1 if a transaction is active or 0 otherwise. More...
 
array[] $mTrxPreCommitCallbacks = []
 List of (callable, method name) More...
 
callable[] $mTrxRecurringCallbacks = []
 Map of (name => callable) More...
 
string $mTrxShortId = ''
 Either a short hexidecimal string if a transaction is active or "". More...
 
string $mUser
 
array null $preparedArgs
 
object string $profiler
 Class name or object With profileIn/profileOut methods. More...
 
LoggerInterface $queryLogger
 
BagOStuff $srvCache
 APC cache. More...
 
 $tableAliases = []
 
TransactionProfiler $trxProfiler
 

Static Private Attributes

static bool $fulltextEnabled = null
 Whether full text is enabled. More...
 

Additional Inherited Members

- Public Attributes inherited from Database
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...
 
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. More...
 
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. More...
 

Detailed Description

Definition at line 28 of file DatabaseSqlite.php.

Constructor & Destructor Documentation

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

Definition at line 61 of file DatabaseSqlite.php.

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

Member Function Documentation

DatabaseSqlite::__toString ( )
Returns
string

Definition at line 1056 of file DatabaseSqlite.php.

References string.

DatabaseSqlite::addQuotes (   $s)
Parameters
string | int | null | bool | Blob$s
Returns
string|int

Implements IDatabase.

Definition at line 789 of file DatabaseSqlite.php.

References $s.

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

DatabaseSqlite::affectedRows ( )
Returns
int

Implements IDatabase.

Definition at line 495 of file DatabaseSqlite.php.

References $mAffectedRows.

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

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

Parameters
string$nameDatabase name to be used in queries like SELECT foo FROM dbname.table
bool | string$fileDatabase file name. If omitted, will be generated using $name and configured data directory
string$fnameCalling function name
Returns
ResultWrapper

Definition at line 280 of file DatabaseSqlite.php.

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

Referenced by __construct().

DatabaseSqlite::buildConcat (   $stringList)

Build a concatenation list to feed into a SQL query.

Parameters
string[]$stringList
Returns
string

Implements IDatabase.

Definition at line 926 of file DatabaseSqlite.php.

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$delimGlue to bind the results together
string | array$tableTable name
string$fieldField name
string | array$condsConditions
string | array$join_condsJoin conditions
Returns
string SQL text
Since
1.23

Implements IDatabase.

Definition at line 930 of file DatabaseSqlite.php.

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

DatabaseSqlite::buildLike ( )
Returns
string

Implements IDatabase.

Definition at line 819 of file DatabaseSqlite.php.

References $params.

DatabaseSqlite::buildStringCast (   $field)
Parameters
string$fieldField or column to cast
Returns
string
Since
1.28

Implements IDatabase.

Definition at line 833 of file DatabaseSqlite.php.

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 $res, Database\query(), and tableName().

DatabaseSqlite::closeConnection ( )
protected

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

Returns
bool

Definition at line 214 of file DatabaseSqlite.php.

DatabaseSqlite::dataSeek (   $res,
  $row 
)
Parameters
ResultWrapper | array$res
int$row

Implements IDatabase.

Definition at line 453 of file DatabaseSqlite.php.

References $res.

DatabaseSqlite::deadlockLoop ( )

No-op version of deadlockLoop.

Returns
mixed

Implements IMaintainableDatabase.

Definition at line 842 of file DatabaseSqlite.php.

References $args.

DatabaseSqlite::decodeBlob (   $b)
Parameters
Blob | string$b
Returns
string

Implements IDatabase.

Definition at line 777 of file DatabaseSqlite.php.

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

Definition at line 748 of file DatabaseSqlite.php.

References $fname, and Database\query().

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

Definition at line 299 of file DatabaseSqlite.php.

References $res.

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

Override due to no CASCADE support.

Parameters
string$tableName
string$fName
Returns
bool|ResultWrapper
Exceptions
DBReadOnlyError

Implements IMaintainableDatabase.

Definition at line 1040 of file DatabaseSqlite.php.

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

DatabaseSqlite::duplicateTableStructure (   $oldName,
  $newName,
  $temporary = false,
  $fname = __METHOD__ 
)
Parameters
string$oldName
string$newName
bool$temporary
string$fname
Returns
bool|ResultWrapper
Exceptions
RuntimeException

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

DatabaseSqlite::encodeBlob (   $b)
Parameters
string$b
Returns
Blob

Implements IDatabase.

Definition at line 769 of file DatabaseSqlite.php.

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

DatabaseSqlite::fetchRow (   $res)
Parameters
ResultWrapper | mixed$res
Returns
array|bool

Implements IDatabase.

Definition at line 354 of file DatabaseSqlite.php.

References $res.

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

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.

static DatabaseSqlite::fixIgnore (   $options)
static
Parameters
array$options
Returns
array

Definition at line 584 of file DatabaseSqlite.php.

References $options, and as.

DatabaseSqlite::freeResult (   $res)
Parameters
ResultWrapper | mixed$res

Implements IDatabase.

Definition at line 315 of file DatabaseSqlite.php.

References $res.

static DatabaseSqlite::generateFileName (   $dir,
  $dbName 
)
static

Generates a database file name.

Explicitly public for installer.

Parameters
string$dirDirectory where database resides
string$dbNameDatabase name
Returns
string

Definition at line 226 of file DatabaseSqlite.php.

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

DatabaseSqlite::getDbFilePath ( )
Returns
string SQLite DB file path
Since
1.25

Definition at line 206 of file DatabaseSqlite.php.

References $dbPath.

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.

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

DatabaseSqlite::getServerVersion ( )
Returns
string Version information from the database

Implements IDatabase.

Definition at line 721 of file DatabaseSqlite.php.

Referenced by SqliteInstaller\checkPrerequisites().

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.

DatabaseSqlite::getType ( )
Returns
string

Implements IDatabase.

Definition at line 126 of file DatabaseSqlite.php.

DatabaseSqlite::implicitGroupby ( )
Todo:
Check if it should be true like parent class
Returns
bool

Implements IDatabase.

Definition at line 135 of file DatabaseSqlite.php.

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

Definition at line 509 of file DatabaseSqlite.php.

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

DatabaseSqlite::indexName (   $index)
protected

Index names have DB scope.

Parameters
string$index
Returns
string

Definition at line 435 of file DatabaseSqlite.php.

Referenced by indexInfo(), and 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().

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

Implements IDatabase.

Definition at line 613 of file DatabaseSqlite.php.

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

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

DatabaseSqlite::insertId ( )

This must be called after nextSequenceVal.

Returns
int

Implements IDatabase.

Definition at line 444 of file DatabaseSqlite.php.

Referenced by DatabaseSqliteTest\testInsertIdType().

DatabaseSqlite::isWriteQuery (   $sql)

Definition at line 289 of file DatabaseSqlite.php.

DatabaseSqlite::lastErrno ( )
Returns
string

Implements IDatabase.

Definition at line 482 of file DatabaseSqlite.php.

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

DatabaseSqlite::lastError ( )
Returns
string

Implements IDatabase.

Definition at line 470 of file DatabaseSqlite.php.

References $e.

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

List all tables on the database.

Parameters
string$prefixOnly show tables with this prefix, e.g. mw_
string$fnameCalling function name
Returns
array

Implements IDatabase.

Definition at line 1009 of file DatabaseSqlite.php.

References $vars, as, and Database\select().

Referenced by DatabaseSqliteTest\getTables().

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

Acquire a named lock.

Named locks are not related to transactions

Parameters
string$lockNameName of lock to aquire
string$methodName of the calling method
int$timeoutAcquisition timeout in seconds
Returns
bool

Implements IDatabase.

Definition at line 906 of file DatabaseSqlite.php.

References LockManager\LOCK_EX.

DatabaseSqlite::makeInsertOptions (   $options)
Parameters
array$options
Returns
string

Definition at line 599 of file DatabaseSqlite.php.

References $options.

DatabaseSqlite::makeSelectOptions (   $options)

Filter the options used in SELECT statements.

Parameters
array$options
Returns
array

Definition at line 559 of file DatabaseSqlite.php.

References $options, and as.

DatabaseSqlite::makeUpdateOptionsArray (   $options)
protected
Parameters
array$options
Returns
string

Definition at line 573 of file DatabaseSqlite.php.

References $options.

static DatabaseSqlite::newStandaloneInstance (   $filename,
array  $p = [] 
)
static
DatabaseSqlite::numFields (   $res)
Parameters
ResultWrapper$res
Returns
int

Implements IDatabase.

Definition at line 386 of file DatabaseSqlite.php.

References $res.

Referenced by DatabaseSqliteTest\testNumFields().

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.

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(), and openFile().

Referenced by __construct().

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, DBO_PERSISTENT, and Database\query().

Referenced by __construct(), and open().

DatabaseSqlite::replace (   $table,
  $uniqueIndexes,
  $rows,
  $fname = __METHOD__ 
)
Parameters
string$table
array$uniqueIndexesUnused
string | array$rows
string$fname
Returns
bool|ResultWrapper

Implements IDatabase.

Definition at line 640 of file DatabaseSqlite.php.

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

DatabaseSqlite::replaceVars (   $s)
protected
Parameters
string$s
Returns
string

Definition at line 853 of file DatabaseSqlite.php.

References $s.

DatabaseSqlite::requiresDatabaseUser ( )
protected

Definition at line 1049 of file DatabaseSqlite.php.

DatabaseSqlite::strencode (   $s)
Parameters
string$s
Returns
string

Definition at line 761 of file DatabaseSqlite.php.

References $s, and addQuotes().

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

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

Parameters
string$name
string$format
Returns
string

Implements IMaintainableDatabase.

Definition at line 420 of file DatabaseSqlite.php.

References $name, and tableName().

Referenced by checkForEnabledSearch(), dropTable(), fieldInfo(), and DatabaseSqliteTest\testTableName().

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

Implements IMaintainableDatabase.

Definition at line 668 of file DatabaseSqlite.php.

DatabaseSqlite::unionQueries (   $sqls,
  $all 
)
Parameters
string$sqls
bool$allWhether to "UNION ALL" or not
Returns
string

Implements IDatabase.

Definition at line 684 of file DatabaseSqlite.php.

DatabaseSqlite::unionSupportsOrderAndLimit ( )
Returns
bool

Implements IDatabase.

Definition at line 675 of file DatabaseSqlite.php.

DatabaseSqlite::unlock (   $lockName,
  $method 
)

Release a lock.

Named locks are not related to transactions

Parameters
string$lockNameName of lock to release
string$methodName 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

Implements IDatabase.

Definition at line 916 of file DatabaseSqlite.php.

References LockManager\LOCK_EX.

DatabaseSqlite::wasDeadlock ( )
Returns
bool

Implements IDatabase.

Definition at line 693 of file DatabaseSqlite.php.

References lastErrno().

DatabaseSqlite::wasErrorReissuable ( )
Returns
bool

Implements IDatabase.

Definition at line 700 of file DatabaseSqlite.php.

References lastErrno().

DatabaseSqlite::wasReadOnlyError ( )
Returns
bool

Implements IDatabase.

Definition at line 707 of file DatabaseSqlite.php.

References lastErrno().

Member Data Documentation

string DatabaseSqlite::$dbDir
protected

Directory.

Definition at line 33 of file DatabaseSqlite.php.

string DatabaseSqlite::$dbPath
protected

File name for SQLite database file.

Definition at line 36 of file DatabaseSqlite.php.

Referenced by getDbFilePath().

bool DatabaseSqlite::$fulltextEnabled = null
staticprivate

Whether full text is enabled.

Definition at line 30 of file DatabaseSqlite.php.

FSLockManager DatabaseSqlite::$lockMgr
protected

(hopefully on the same server as the DB)

Definition at line 51 of file DatabaseSqlite.php.

int DatabaseSqlite::$mAffectedRows
protected

The number of rows affected as an integer.

Definition at line 42 of file DatabaseSqlite.php.

Referenced by affectedRows().

$mConn DatabaseSqlite::$mConn
protected

PDO.

Definition at line 48 of file DatabaseSqlite.php.

Referenced by open(), and openFile().

resource DatabaseSqlite::$mLastResult
protected

Definition at line 45 of file DatabaseSqlite.php.

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: