MediaWiki  REL1_31
Wikimedia\Rdbms\DatabaseSqlite Class Reference
Inheritance diagram for Wikimedia\Rdbms\DatabaseSqlite:
Collaboration diagram for Wikimedia\Rdbms\DatabaseSqlite:

Public Member Functions

 __construct (array $p)
 Additional params include: More...
 
 __toString ()
 
 addQuotes ( $s)
 
 attachDatabase ( $name, $file=false, $fname=__METHOD__)
 Attaches external database to our connection, see https://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...
 
 buildStringCast ( $field)
 
 buildSubstring ( $input, $startPosition, $length=null)
 
 checkForEnabledSearch ()
 Check if the searchindext table is FTS enabled. More...
 
 databasesAreIndependent ()
 Returns true if DBs are assumed to be on potentially different servers. 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)
 Determine whether a query writes to the DB. More...
 
 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__)
 
 resetSequenceForTable ( $table, $fname=__METHOD__)
 
 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...
 
 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...
 
 wasConnectionError ( $errno)
 Do not use this method outside of Database/DBError classes. More...
 
 wasDeadlock ()
 
 wasReadOnlyError ()
 
- Public Member Functions inherited from Wikimedia\Rdbms\Database
 __clone ()
 Make sure that copies do not share the same client binding handle. More...
 
 __destruct ()
 Run a few simple sanity checks and close dangling connections. More...
 
 __sleep ()
 Called by serialize. More...
 
 addIdentifierQuotes ( $s)
 Quotes an identifier using backticks or "double quotes" depending on the database type. More...
 
 affectedRows ()
 Get the number of rows affected by the last write query. 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...
 
 buildIntegerCast ( $field)
 
 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...
 
 buildSelectSubquery ( $table, $vars, $conds='', $fname=__METHOD__, $options=[], $join_conds=[])
 Equivalent to IDatabase::selectSQLText() except wraps the result in Subqyery. More...
 
 cancelAtomic ( $fname=__METHOD__, AtomicSectionIdentifier $sectionId=null)
 Cancel an atomic section of SQL statements. More...
 
 clearFlag ( $flag, $remember=self::REMEMBER_NOTHING)
 Clear a flag for this connection. More...
 
 close ()
 Close the database connection. More...
 
 commit ( $fname=__METHOD__, $flush=self::FLUSHING_ONE)
 Commits a transaction previously started using begin(). More...
 
 conditional ( $cond, $trueVal, $falseVal)
 Returns an SQL expression for a simple conditional. More...
 
 connectionErrorLogger ( $errno, $errstr)
 Error handler for logging errors during database connection This method should not be used outside of Database classes. More...
 
 dbSchema ( $schema=null)
 Get/set the db schema. 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, $cancelable=self::ATOMIC_NOT_CANCELABLE)
 Perform an atomic section of reversable SQL statements from a callback. More...
 
 doneWrites ()
 Returns true if the connection may have been used for write queries. 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, $var=' *', $conds='', $fname=__METHOD__, $options=[], $join_conds=[])
 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...
 
 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 the amount of replication lag for this database server. 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...
 
 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...
 
 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...
 
 initConnection ()
 Initialize the connection to the database over the wire (or to local files) More...
 
 insertSelect ( $destTable, $srcTable, $varMap, $conds, $fname=__METHOD__, $insertOptions=[], $selectOptions=[], $selectJoinConds=[])
 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...
 
 listViews ( $prefix=null, $fname=__METHOD__)
 Lists all the VIEWs in the database. More...
 
 lockIsFree ( $lockName, $method)
 Check to see if a named lock is not locked by any thread (non-blocking) More...
 
 lockTables (array $read, array $write, $method)
 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)
 Deprecated method, calls should be removed. 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...
 
 pendingWriteRowsAffected ()
 Get the number of affected rows from pending write queries. 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...
 
 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=[], $join_conds=[])
 A SELECT wrapper which returns a single field from a single result row. More...
 
 selectFieldValues ( $table, $var, $cond='', $fname=__METHOD__, $options=[], $join_conds=[])
 A SELECT wrapper which returns a list of single field values from result rows. More...
 
 selectRow ( $table, $vars, $conds, $fname=__METHOD__, $options=[], $join_conds=[])
 Single row SELECT wrapper. More...
 
 selectRowCount ( $tables, $var=' *', $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...
 
 setIndexAliases (array $aliases)
 Convert certain index names to alternative names before querying the DB. 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)
 Set the PSR-3 logger interface to use for query logging. 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...
 
 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__, $cancelable=self::ATOMIC_NOT_CANCELABLE)
 Begin an atomic section of SQL statements. More...
 
 streamStatementEnd (&$sql, &$newLine)
 Called by sourceStream() to check if we've reached a statement end. More...
 
 strreplace ( $orig, $old, $new)
 Returns a command for str_replace function in SQL query. More...
 
 tableExists ( $table, $fname=__METHOD__)
 Query whether a given table exists. More...
 
 tableLocksHaveTransactionScope ()
 Checks if table locks acquired by lockTables() are transaction-bound in their scope. 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...
 
 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...
 
 trxStatus ()
 
 trxTimestamp ()
 Get the UNIX timestamp of the time that the transaction was established. More...
 
 unionConditionPermutations ( $table, $vars, array $permute_conds, $extra_conds='', $fname=__METHOD__, $options=[], $join_conds=[])
 Construct a UNION query for permutations of conditions. More...
 
 unlockTables ( $method)
 Unlock all tables locked via lockTables() 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...
 
 wasConnectionLoss ()
 Determines if the last query error was due to a dropped connection. More...
 
 wasErrorReissuable ()
 Determines if the last query error was due to something outside of the query itself. More...
 
 wasLockTimeout ()
 Determines if the last failure was due to a lock timeout. More...
 
 writesOrCallbacksPending ()
 Returns true if there is a transaction/round open with possible write queries or transaction pre-commit/idle callbacks waiting on it to finish. More...
 
 writesPending ()
 
- Public Member Functions inherited from Wikimedia\Rdbms\IDatabase
 buildSubString ( $input, $startPosition, $length=null)
 Build a SUBSTRING function. 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 Wikimedia\Rdbms\Database
static attributesFromType ( $dbType, $driver=null)
 
static factory ( $dbType, $p=[], $connect=self::NEW_CONNECTED)
 Construct a Database subclass instance given a database type and parameters. More...
 
static getCacheSetOptions (IDatabase $db1, IDatabase $db2=null)
 Merge the result of getSessionLagStatus() for several DBs using the most pessimistic values to estimate the lag of any data derived from them in combination. 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...
 
 doInitConnection ()
 Actually connect to the database over the wire (or to local files) More...
 
 doQuery ( $sql)
 SQLite doesn't allow buffered results or data seeking etc, so we'll use fetchAll as the result. More...
 
 fetchAffectedRowCount ()
 
 getBindingHandle ()
 
 isTransactableQuery ( $sql)
 Determine whether a SQL statement is sensitive to isolation level. More...
 
 makeUpdateOptionsArray ( $options)
 
 openFile ( $fileName, $dbName)
 Opens a database file. More...
 
 replaceVars ( $s)
 
 wasKnownStatementRollbackError ()
 
- Protected Member Functions inherited from Wikimedia\Rdbms\Database
 assertBuildSubstringParams ( $startPosition, $length)
 Check type and bounds for parameters to self::buildSubstring() More...
 
 assertOpen ()
 Make sure isOpen() returns true as a sanity check. More...
 
 doCommit ( $fname)
 Issues the COMMIT command to the database server. More...
 
 doLockTables (array $read, array $write, $method)
 Helper function for lockTables() that handles the actual table locking. More...
 
 doReleaseSavepoint ( $identifier, $fname)
 Release a savepoint. More...
 
 doRollback ( $fname)
 Issues the ROLLBACK command to the database server. More...
 
 doRollbackToSavepoint ( $identifier, $fname)
 Rollback to a savepoint. More...
 
 doSavepoint ( $identifier, $fname)
 Create a savepoint. More...
 
 doUnlockTables ( $method)
 Helper function for unlockTables() that handles the actual table unlocking. More...
 
 escapeLikeInternal ( $s, $escapeChar='`')
 
 extractSingleFieldFromList ( $var)
 
 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...
 
 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 ()
 
 getRecordedTransactionLagStatus ()
 Get the replica DB lag when the current transaction started. More...
 
 getSchemaVars ()
 Get schema variables. More...
 
 getTransactionRoundId ()
 
 indexName ( $index)
 Allows for index remapping in queries where this is not consistent across DBMS. More...
 
 installErrorHandler ()
 Set a custom error handler for logging errors during database connection. More...
 
 isInsertSelectSafe (array $insertOptions, array $selectOptions)
 
 makeGroupByWithHaving ( $options)
 Returns an optional GROUP BY with an optional HAVING. More...
 
 makeOrderBy ( $options)
 Returns an optional ORDER BY. More...
 
 makeUpdateOptions ( $options)
 Make UPDATE options for the Database::update function. More...
 
 nativeInsertSelect ( $destTable, $srcTable, $varMap, $conds, $fname=__METHOD__, $insertOptions=[], $selectOptions=[], $selectJoinConds=[])
 Native server-side implementation of insertSelect() for situations where we don't want to select everything into memory. More...
 
 nativeReplace ( $table, $rows, $fname)
 REPLACE query wrapper for MySQL and SQLite, which have a native REPLACE statement. More...
 
 nonNativeInsertSelect ( $destTable, $srcTable, $varMap, $conds, $fname=__METHOD__, $insertOptions=[], $selectOptions=[], $selectJoinConds=[])
 Implementation of insertSelect() based on select() and insert() More...
 
 normalizeConditions ( $conds, $fname)
 
 pendingWriteAndCallbackCallers ()
 Get the list of method names that have pending write queries or callbacks for this transaction. More...
 
 qualifiedTableComponents ( $name)
 Get the table components needed for a query given the currently selected database. More...
 
 registerTempTableOperation ( $sql)
 
 replaceLostConnection ( $fname)
 Close any existing (dead) database connection and open a new connection. More...
 
 restoreErrorHandler ()
 Restore the previous error handler and return the last PHP error for this DB. More...
 
 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 ( $table, $alias=false)
 Get an aliased table name. More...
 
 wasQueryTimeout ( $error, $errno)
 Checks whether the cause of the error is detected to be a timeout. More...
 

Static Protected Member Functions

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

Protected Attributes

PDO $conn
 
string $dbDir
 Directory. More...
 
string $dbPath
 File name for SQLite database file. More...
 
int $lastAffectedRowCount
 The number of rows affected as an integer. More...
 
resource $lastResultHandle
 
FSLockManager $lockMgr
 (hopefully on the same server as the DB) More...
 
string $trxMode
 Transaction mode. More...
 
- Protected Attributes inherited from Wikimedia\Rdbms\Database
integer null $affectedRowCount
 Rows affected by the last query to query() or its CRUD wrappers. More...
 
string $agent
 Agent name for query profiling. More...
 
bool $cliMode
 Whether this PHP instance is for a CLI script. More...
 
resource null $conn = null
 Database connection. More...
 
array $connectionParams = []
 Parameters used by initConnection() to establish a connection. More...
 
LoggerInterface $connLogger
 
DatabaseDomain $currentDomain
 
string $dbName
 Database that this instance is currently connected to. More...
 
string $delimiter = ';'
 
callback $deprecationLogger
 Deprecation logging callback. More...
 
callback $errorLogger
 Error logging callback. More...
 
int $flags
 
string bool null $htmlErrors
 Stashed value of html_errors INI setting. More...
 
string[] $indexAliases = []
 Map of (index alias => index) More...
 
float $lastPing = 0.0
 UNIX timestamp. More...
 
string $lastQuery = ''
 SQL query. More...
 
float bool $lastWriteTime = false
 UNIX timestamp of last write query. More...
 
array $lbInfo = []
 
int $nonNativeInsertSelectBatchSize = 10000
 
bool $opened = false
 
string $password
 Password used to establish the current connection. More...
 
string bool $phpError = false
 
array null $preparedArgs
 
object string $profiler
 Class name or object With profileIn/profileOut methods. More...
 
LoggerInterface $queryLogger
 
string $schema = ''
 
array bool $schemaVars = false
 
string $server
 Server that this instance is currently connected to. More...
 
array $sessionTempTables = []
 Map of (table name => 1) for TEMPORARY tables. More...
 
array $sessionVars = []
 
BagOStuff $srvCache
 APC cache. More...
 
array[] $tableAliases = []
 Map of (table => (dbname, schema, prefix) map) More...
 
string $tablePrefix = ''
 
array[] $trxEndCallbacks = []
 List of (callable, method name, atomic section id) More...
 
bool $trxEndCallbacksSuppressed = false
 Whether to suppress triggering of transaction end callbacks. More...
 
array[] $trxIdleCallbacks = []
 List of (callable, method name, atomic section id) More...
 
int $trxLevel = 0
 Either 1 if a transaction is active or 0 otherwise. More...
 
array[] $trxPreCommitCallbacks = []
 List of (callable, method name, atomic section id) More...
 
TransactionProfiler $trxProfiler
 
callable[] $trxRecurringCallbacks = []
 Map of (name => callable) More...
 
string $trxShortId = ''
 Either a short hexidecimal string if a transaction is active or "". More...
 
int $trxStatus = self::STATUS_TRX_NONE
 Transaction status. More...
 
Exception null $trxStatusCause
 The last error that caused the status to become STATUS_TRX_ERROR. More...
 
array null $trxStatusIgnoredCause
 If wasKnownStatementRollbackError() prevented trxStatus from being set, the relevant details are stored here. More...
 
string $user
 User that this instance is currently connected under the name of. More...
 

Private Attributes

array $alreadyAttached = []
 List of shared database already attached to this connection. More...
 

Static Private Attributes

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

Additional Inherited Members

- Public Attributes inherited from Wikimedia\Rdbms\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 = 0.500
 
const SMALL_WRITE_ROWS = 100
 
const TINY_WRITE_SEC = 0.010
 

Detailed Description

Definition at line 37 of file DatabaseSqlite.php.

Constructor & Destructor Documentation

◆ __construct()

Wikimedia\Rdbms\DatabaseSqlite::__construct ( array  $p)

Additional params include:

  • dbDirectory : directory containing the DB and the lock file directory [defaults to $wgSQLiteDataDir]
  • dbFilePath : use this to force the path of the DB file
  • trxMode : one of (deferred, immediate, exclusive)
    Parameters
    array$p

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 70 of file DatabaseSqlite.php.

Member Function Documentation

◆ __toString()

Wikimedia\Rdbms\DatabaseSqlite::__toString ( )
Returns
string

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 1091 of file DatabaseSqlite.php.

References string.

◆ addQuotes()

◆ attachDatabase()

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

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

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

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

◆ buildConcat()

Wikimedia\Rdbms\DatabaseSqlite::buildConcat (   $stringList)

Build a concatenation list to feed into a SQL query.

Parameters
string[]$stringList
Returns
string

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 944 of file DatabaseSqlite.php.

◆ buildGroupConcatField()

Wikimedia\Rdbms\DatabaseSqlite::buildGroupConcatField (   $delim,
  $table,
  $field,
  $conds = '',
  $join_conds = [] 
)

Build a GROUP_CONCAT or equivalent statement for a query.

This is useful for combining a field for several rows into a single string. NULL values will not appear in the output, duplicated values will appear, and the resulting delimiter-separated values have no defined sort order. Code using the results may need to use the PHP unique() or sort() methods.

Parameters
string$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

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 948 of file DatabaseSqlite.php.

References Wikimedia\Rdbms\DatabaseSqlite\addQuotes(), and Wikimedia\Rdbms\Database\selectSQLText().

◆ buildStringCast()

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

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 851 of file DatabaseSqlite.php.

◆ buildSubstring()

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

◆ checkForEnabledSearch()

Wikimedia\Rdbms\DatabaseSqlite::checkForEnabledSearch ( )

Check if the searchindext table is FTS enabled.

Returns
bool False if not enabled.

Definition at line 255 of file DatabaseSqlite.php.

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

◆ closeConnection()

Wikimedia\Rdbms\DatabaseSqlite::closeConnection ( )
protected

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

Returns
bool

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 235 of file DatabaseSqlite.php.

◆ databasesAreIndependent()

Wikimedia\Rdbms\DatabaseSqlite::databasesAreIndependent ( )

Returns true if DBs are assumed to be on potentially different servers.

In systems like mysql/mariadb, different databases can easily be referenced on a single connection merely by name, even in a single query via JOIN. On the other hand, Postgres treats databases as fully separate, only allowing mechanisms like postgres_fdw to effectively "mount" foreign DBs. This is true even among DBs on the same server.

Returns
bool
Since
1.29

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 1084 of file DatabaseSqlite.php.

◆ dataSeek()

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

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 472 of file DatabaseSqlite.php.

References $res.

◆ deadlockLoop()

Wikimedia\Rdbms\DatabaseSqlite::deadlockLoop ( )

No-op version of deadlockLoop.

Returns
mixed

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 860 of file DatabaseSqlite.php.

References $args.

◆ decodeBlob()

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

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 798 of file DatabaseSqlite.php.

◆ doBegin()

Wikimedia\Rdbms\DatabaseSqlite::doBegin (   $fname = '')
protected

Issues the BEGIN command to the database server.

See also
Database::begin()
Parameters
string$fname

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 769 of file DatabaseSqlite.php.

References $fname, Wikimedia\Rdbms\Database\query(), and Wikimedia\Rdbms\Database\trxLevel().

◆ doInitConnection()

Wikimedia\Rdbms\DatabaseSqlite::doInitConnection ( )
protected

Actually connect to the database over the wire (or to local files)

Exceptions
InvalidArgumentException
DBConnectionError
Since
1.31

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 120 of file DatabaseSqlite.php.

References Wikimedia\Rdbms\DatabaseSqlite\open(), and Wikimedia\Rdbms\DatabaseSqlite\openFile().

◆ doQuery()

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

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

Parameters
string$sql
Returns
bool|ResultWrapper

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 328 of file DatabaseSqlite.php.

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

◆ dropTable()

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

Override due to no CASCADE support.

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

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 1058 of file DatabaseSqlite.php.

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

◆ duplicateTableStructure()

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

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 964 of file DatabaseSqlite.php.

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

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

◆ encodeBlob()

Wikimedia\Rdbms\DatabaseSqlite::encodeBlob (   $b)
Parameters
string$b
Returns
Blob

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 790 of file DatabaseSqlite.php.

◆ fetchAffectedRowCount()

Wikimedia\Rdbms\DatabaseSqlite::fetchAffectedRowCount ( )
protected
Returns
int

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 514 of file DatabaseSqlite.php.

References Wikimedia\Rdbms\DatabaseSqlite\$lastAffectedRowCount.

◆ fetchObject()

Wikimedia\Rdbms\DatabaseSqlite::fetchObject (   $res)
Parameters
ResultWrapper | array$res
Returns
stdClass|bool

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 356 of file DatabaseSqlite.php.

References $res, and as.

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

◆ fetchRow()

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

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 383 of file DatabaseSqlite.php.

References $res.

◆ fieldInfo()

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

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

Parameters
string$table
string$field
Returns
SQLiteField|bool False on failure

Implements Wikimedia\Rdbms\IMaintainableDatabase.

Definition at line 756 of file DatabaseSqlite.php.

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

◆ fieldName()

Wikimedia\Rdbms\DatabaseSqlite::fieldName (   $res,
  $n 
)
Parameters
ResultWrapper$res
int$n
Returns
bool

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 431 of file DatabaseSqlite.php.

References $keys, and $res.

◆ fixIgnore()

static Wikimedia\Rdbms\DatabaseSqlite::fixIgnore (   $options)
static
Parameters
array$options
Returns
array

Definition at line 600 of file DatabaseSqlite.php.

References $options, and as.

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

◆ freeResult()

Wikimedia\Rdbms\DatabaseSqlite::freeResult (   $res)
Parameters
ResultWrapper | mixed$res

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 344 of file DatabaseSqlite.php.

References $res.

◆ generateFileName()

static Wikimedia\Rdbms\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 247 of file DatabaseSqlite.php.

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

◆ getAttributes()

static Wikimedia\Rdbms\DatabaseSqlite::getAttributes ( )
staticprotected
Returns
array Map of (Database::ATTRIBUTE_* constant => value
Since
1.31

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 97 of file DatabaseSqlite.php.

References true.

◆ getBindingHandle()

Wikimedia\Rdbms\DatabaseSqlite::getBindingHandle ( )
protected

◆ getDbFilePath()

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

Definition at line 227 of file DatabaseSqlite.php.

References Wikimedia\Rdbms\DatabaseSqlite\$dbPath.

◆ getFulltextSearchModule()

static Wikimedia\Rdbms\DatabaseSqlite::getFulltextSearchModule ( )
static

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

Returns
string

Definition at line 273 of file DatabaseSqlite.php.

References Wikimedia\Rdbms\DatabaseSqlite\newStandaloneInstance().

Referenced by DatabaseSqliteTest\testDuplicateTableStructureVirtual().

◆ getServerVersion()

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

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 742 of file DatabaseSqlite.php.

References Wikimedia\Rdbms\DatabaseSqlite\getBindingHandle().

Referenced by SqliteInstaller\checkPrerequisites().

◆ getSoftwareLink()

Wikimedia\Rdbms\DatabaseSqlite::getSoftwareLink ( )
Returns
string Wikitext of a link to the server software's web site

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 735 of file DatabaseSqlite.php.

◆ getType()

Wikimedia\Rdbms\DatabaseSqlite::getType ( )
Returns
string

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 145 of file DatabaseSqlite.php.

◆ implicitGroupby()

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

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 154 of file DatabaseSqlite.php.

◆ indexInfo()

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

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

  • if errors are explicitly ignored, returns NULL on failure
Parameters
string$table
string$index
string$fname
Returns
array|false

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 528 of file DatabaseSqlite.php.

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

◆ indexUnique()

Wikimedia\Rdbms\DatabaseSqlite::indexUnique (   $table,
  $index,
  $fname = __METHOD__ 
)
Parameters
string$table
string$index
string$fname
Returns
bool|null

Definition at line 548 of file DatabaseSqlite.php.

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

◆ insert()

Wikimedia\Rdbms\DatabaseSqlite::insert (   $table,
  $a,
  $fname = __METHOD__,
  $options = [] 
)

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

Parameters
string$table
array$a
string$fname
array$options
Returns
bool

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 629 of file DatabaseSqlite.php.

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

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

◆ insertId()

Wikimedia\Rdbms\DatabaseSqlite::insertId ( )

This must be called after nextSequenceVal.

Returns
int

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 463 of file DatabaseSqlite.php.

References Wikimedia\Rdbms\DatabaseSqlite\getBindingHandle().

Referenced by DatabaseSqliteTest\testInsertIdType().

◆ isTransactableQuery()

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

Determine whether a SQL statement is sensitive to isolation level.

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

Parameters
string$sql
Returns
bool

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 314 of file DatabaseSqlite.php.

References Wikimedia\Rdbms\Database\getQueryVerb().

◆ isWriteQuery()

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

Determine whether a query writes to the DB.

Should return true if unsure.

Parameters
string$sql
Returns
bool

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 310 of file DatabaseSqlite.php.

◆ lastErrno()

Wikimedia\Rdbms\DatabaseSqlite::lastErrno ( )

◆ lastError()

Wikimedia\Rdbms\DatabaseSqlite::lastError ( )
Returns
string

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 489 of file DatabaseSqlite.php.

References $e.

◆ listTables()

Wikimedia\Rdbms\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

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 1027 of file DatabaseSqlite.php.

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

Referenced by DatabaseSqliteTest\getTables().

◆ lock()

Wikimedia\Rdbms\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
Exceptions
DBError

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 924 of file DatabaseSqlite.php.

References LockManager\LOCK_EX.

◆ makeInsertOptions()

Wikimedia\Rdbms\DatabaseSqlite::makeInsertOptions (   $options)
Parameters
array$options
Returns
string

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 615 of file DatabaseSqlite.php.

References $options, and Wikimedia\Rdbms\DatabaseSqlite\fixIgnore().

◆ makeSelectOptions()

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

Filter the options used in SELECT statements.

Parameters
array$options
Returns
array

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 575 of file DatabaseSqlite.php.

References $options, and as.

◆ makeUpdateOptionsArray()

Wikimedia\Rdbms\DatabaseSqlite::makeUpdateOptionsArray (   $options)
protected
Parameters
array$options
Returns
array

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 589 of file DatabaseSqlite.php.

References $options, and Wikimedia\Rdbms\DatabaseSqlite\fixIgnore().

◆ newStandaloneInstance()

static Wikimedia\Rdbms\DatabaseSqlite::newStandaloneInstance (   $filename,
array  $p = [] 
)
static
Parameters
string$filename
array$pOptions map; supports:
  • flags : (same as __construct counterpart)
  • trxMode : (same as __construct counterpart)
  • dbDirectory : (same as __construct counterpart)
Returns
DatabaseSqlite
Since
1.25

Definition at line 110 of file DatabaseSqlite.php.

References Wikimedia\Rdbms\Database\factory().

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

◆ numFields()

Wikimedia\Rdbms\DatabaseSqlite::numFields (   $res)
Parameters
ResultWrapper$res
Returns
int

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 415 of file DatabaseSqlite.php.

References $res.

Referenced by DatabaseSqliteTest\testNumFields().

◆ numRows()

Wikimedia\Rdbms\DatabaseSqlite::numRows (   $res)

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

Parameters
ResultWrapper | array$res
Returns
int

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 405 of file DatabaseSqlite.php.

References $res.

◆ open()

Wikimedia\Rdbms\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$userUnused
string$pass
string$dbName
Exceptions
DBConnectionError
Returns
bool

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 169 of file DatabaseSqlite.php.

References Wikimedia\Rdbms\DatabaseSqlite\$conn, Wikimedia\Rdbms\Database\$dbName, Wikimedia\Rdbms\Database\close(), Wikimedia\Rdbms\DatabaseSqlite\generateFileName(), and Wikimedia\Rdbms\DatabaseSqlite\openFile().

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

◆ openFile()

Wikimedia\Rdbms\DatabaseSqlite::openFile (   $fileName,
  $dbName 
)
protected

Opens a database file.

Parameters
string$fileName
string$dbName
Exceptions
DBConnectionError
Returns
PDO|bool SQL connection or false if failed

Definition at line 189 of file DatabaseSqlite.php.

References Wikimedia\Rdbms\DatabaseSqlite\$conn, Wikimedia\Rdbms\Database\$dbName, $e, DBO_PERSISTENT, flags, and Wikimedia\Rdbms\Database\query().

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

◆ replace()

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

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 656 of file DatabaseSqlite.php.

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

◆ replaceVars()

Wikimedia\Rdbms\DatabaseSqlite::replaceVars (   $s)
protected
Parameters
string$s
Returns
string

Reimplemented from Wikimedia\Rdbms\Database.

Reimplemented in DatabaseSqliteMock.

Definition at line 871 of file DatabaseSqlite.php.

References $s.

◆ resetSequenceForTable()

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

◆ setTableAliases()

Wikimedia\Rdbms\DatabaseSqlite::setTableAliases ( array  $aliases)

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

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

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

Parameters
array[]$aliasesMap of (table => (dbname, schema, prefix) map)
Since
1.28

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 1067 of file DatabaseSqlite.php.

References $params, as, and Wikimedia\Rdbms\DatabaseSqlite\attachDatabase().

◆ strencode()

Wikimedia\Rdbms\DatabaseSqlite::strencode (   $s)
Parameters
string$s
Returns
string

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 782 of file DatabaseSqlite.php.

References $s, and Wikimedia\Rdbms\DatabaseSqlite\addQuotes().

◆ tableName()

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

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

Parameters
string$name
string$format
Returns
string

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 449 of file DatabaseSqlite.php.

References $name, and tableName().

Referenced by Wikimedia\Rdbms\DatabaseSqlite\checkForEnabledSearch(), Wikimedia\Rdbms\DatabaseSqlite\dropTable(), Wikimedia\Rdbms\DatabaseSqlite\fieldInfo(), Wikimedia\Rdbms\DatabaseSqlite\resetSequenceForTable(), and DatabaseSqliteTest\testTableName().

◆ textFieldSize()

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

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

No way to query it though.

Parameters
string$table
string$field
Returns
int

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 684 of file DatabaseSqlite.php.

◆ unionQueries()

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

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 700 of file DatabaseSqlite.php.

◆ unionSupportsOrderAndLimit()

Wikimedia\Rdbms\DatabaseSqlite::unionSupportsOrderAndLimit ( )
Returns
bool

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 691 of file DatabaseSqlite.php.

◆ unlock()

Wikimedia\Rdbms\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
Exceptions
DBError

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 934 of file DatabaseSqlite.php.

References LockManager\LOCK_EX.

◆ wasConnectionError()

Wikimedia\Rdbms\DatabaseSqlite::wasConnectionError (   $errno)

Do not use this method outside of Database/DBError classes.

Parameters
int | string$errno
Returns
bool Whether the given query error was a connection drop

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 720 of file DatabaseSqlite.php.

◆ wasDeadlock()

Wikimedia\Rdbms\DatabaseSqlite::wasDeadlock ( )
Returns
bool

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 709 of file DatabaseSqlite.php.

References Wikimedia\Rdbms\DatabaseSqlite\lastErrno().

◆ wasKnownStatementRollbackError()

Wikimedia\Rdbms\DatabaseSqlite::wasKnownStatementRollbackError ( )
protected
Returns
bool Whether it is safe to assume the given error only caused statement rollback
Note
This is for backwards compatibility for callers catching DBError exceptions in order to ignore problems like duplicate key errors or foriegn key violations
Since
1.31

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 724 of file DatabaseSqlite.php.

◆ wasReadOnlyError()

Wikimedia\Rdbms\DatabaseSqlite::wasReadOnlyError ( )
Returns
bool

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 716 of file DatabaseSqlite.php.

References Wikimedia\Rdbms\DatabaseSqlite\lastErrno().

Member Data Documentation

◆ $alreadyAttached

array Wikimedia\Rdbms\DatabaseSqlite::$alreadyAttached = []
private

List of shared database already attached to this connection.

Definition at line 60 of file DatabaseSqlite.php.

◆ $conn

PDO Wikimedia\Rdbms\DatabaseSqlite::$conn
protected

◆ $dbDir

string Wikimedia\Rdbms\DatabaseSqlite::$dbDir
protected

Directory.

Definition at line 42 of file DatabaseSqlite.php.

◆ $dbPath

string Wikimedia\Rdbms\DatabaseSqlite::$dbPath
protected

File name for SQLite database file.

Definition at line 44 of file DatabaseSqlite.php.

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

◆ $fulltextEnabled

bool Wikimedia\Rdbms\DatabaseSqlite::$fulltextEnabled = null
staticprivate

Whether full text is enabled.

Definition at line 39 of file DatabaseSqlite.php.

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

◆ $lastAffectedRowCount

int Wikimedia\Rdbms\DatabaseSqlite::$lastAffectedRowCount
protected

The number of rows affected as an integer.

Definition at line 49 of file DatabaseSqlite.php.

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

◆ $lastResultHandle

resource Wikimedia\Rdbms\DatabaseSqlite::$lastResultHandle
protected

Definition at line 51 of file DatabaseSqlite.php.

◆ $lockMgr

FSLockManager Wikimedia\Rdbms\DatabaseSqlite::$lockMgr
protected

(hopefully on the same server as the DB)

Definition at line 57 of file DatabaseSqlite.php.

◆ $trxMode

string Wikimedia\Rdbms\DatabaseSqlite::$trxMode
protected

Transaction mode.

Definition at line 46 of file DatabaseSqlite.php.


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