MediaWiki  master
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...
 
 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...
 
 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...
 
 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)
 
 tableExists ( $table, $fname=__METHOD__)
 Query whether a given table exists. More...
 
 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)
 
 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...
 
 __toString ()
 Get a debugging string that mentions the database type, the ID of this instance, and the ID of any underlying connection resource or driver object if one is present. More...
 
 addIdentifierQuotes ( $s)
 Quotes an identifier, in order to make user controlled input safe. More...
 
 addQuotes ( $s)
 Adds quotes and backslashes. 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...
 
 assertNoOpenTransactions ()
 Assert that all explicit transactions or atomic sections have been closed. 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...
 
 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...
 
 buildStringCast ( $field)
 
 buildSubstring ( $input, $startPosition, $length=null)
 
 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...
 
 databasesAreIndependent ()
 Returns true if DBs are assumed to be on potentially different servers. 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, $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...
 
 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. 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, $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...
 
 freeResult ( $res)
 Free a result object returned by query() or select(). More...
 
 getDBname ()
 Get the current DB name. More...
 
 getDomainID ()
 Return the currently selected domain ID. More...
 
 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...
 
 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...
 
 initConnection ()
 Initialize the connection to the database over the wire (or to local files) 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=[], $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 sent on account of 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...
 
 lockForUpdate ( $table, $conds='', $fname=__METHOD__, $options=[], $join_conds=[])
 Lock all rows meeting the given conditions/options FOR UPDATE. 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...
 
 onTransactionCommitOrIdle (callable $callback, $fname=__METHOD__)
 Run a callback as soon as there is no transaction pending. More...
 
 onTransactionIdle (callable $callback, $fname=__METHOD__)
 Alias for onTransactionCommitOrIdle() for backwards-compatibility. 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...
 
 pendingWriteAndCallbackCallers ()
 List the methods that have write queries or callbacks for the current transaction. 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...
 
 preCommitCallbacksPending ()
 
 query ( $sql, $fname=__METHOD__, $flags=0)
 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, $ignore=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=self::FLUSHING_ONE)
 Rollback a transaction previously started using begin(). More...
 
 runOnTransactionIdleCallbacks ( $trigger)
 Actually consume and run any "on transaction idle/resolution" callbacks. More...
 
 runOnTransactionPreCommitCallbacks ()
 Actually consume and run 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...
 
 selectDomain ( $domain)
 Set the current domain (database, schema, and table prefix) 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...
 
 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 after 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...
 
 strencode ( $s)
 Wrapper for addslashes() 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...
 
 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...
 
 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...
 
 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 all tables locked via lockTables() More...
 
 update ( $table, $values, $conds, $fname=__METHOD__, $options=[])
 UPDATE wrapper. More...
 
 upsert ( $table, array $rows, $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...
 
 wasConnectionLoss ()
 Determines if the last query error was due to a dropped connection. More...
 
 wasDeadlock ()
 Determines if the last failure was due to a deadlock. 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...
 
 wasReadOnlyError ()
 Determines if the last failure was due to the database being read-only. More...
 
 writesOrCallbacksPending ()
 Whether there is a transaction open with either possible write queries or unresolved pre-commit/commit/resolution callbacks pending. 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='')
 
 doInitConnection ()
 
 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)
 
 isWriteQuery ( $sql)
 
 makeUpdateOptionsArray ( $options)
 
 open ( $server, $user, $pass, $dbName, $schema, $tablePrefix)
 
 openFile ( $fileName, $dbName, $tablePrefix)
 Opens a database file. More...
 
 replaceVars ( $s)
 
 wasKnownStatementRollbackError ()
 
- Protected Member Functions inherited from Wikimedia\Rdbms\Database
 __construct (array $params)
 
 assertBuildSubstringParams ( $startPosition, $length)
 Check type and bounds for parameters to self::buildSubstring() More...
 
 assertHasConnectionHandle ()
 Make sure there is an open connection handle (alive or not) as a sanity check. More...
 
 assertIsWritableMaster ()
 Make sure that this server is not marked as a replica nor read-only 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...
 
 doInitConnection ()
 Actually connect to the database over the wire (or to local files) More...
 
 doLockTables (array $read, array $write, $method)
 Helper function for lockTables() that handles the actual table locking. More...
 
 doQuery ( $sql)
 Run a query and return a DBMS-dependent wrapper or boolean. 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...
 
 doSelectDomain (DatabaseDomain $domain)
 
 doUnlockTables ( $method)
 Helper function for unlockTables() that handles the actual table unlocking. More...
 
 escapeLikeInternal ( $s, $escapeChar='`')
 
 executeQuery ( $sql, $fname, $flags)
 Execute a query, retrying it if there is a recoverable connection loss. More...
 
 extractSingleFieldFromList ( $var)
 
 fetchAffectedRowCount ()
 
 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 connection handle. 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 ()
 
 hasFlags ( $field, $flags)
 
 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)
 
 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=[], $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)
 
 open ( $server, $user, $password, $dbName, $schema, $tablePrefix)
 Open a new connection to the database (closing any existing one) More...
 
 qualifiedTableComponents ( $name)
 Get the table components needed for a query given the currently selected database. More...
 
 registerTempTableWrite ( $sql, $pseudoPermanent)
 
 relationSchemaQualifier ()
 
 replaceLostConnection ( $fname)
 Close any existing (dead) database connection and open a new connection. More...
 
 replaceVars ( $ins)
 Database independent variable replacement. 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...
 
 wasKnownStatementRollbackError ()
 
 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 getAttributes ()
 

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...
 
object resource null $conn = null
 Database connection. More...
 
array $connectionParams = []
 Parameters used by initConnection() to establish a connection. More...
 
array $connectionVariables = []
 SQL variables values to use for all new connections. More...
 
LoggerInterface $connLogger
 
DatabaseDomain $currentDomain
 
string $delimiter = ';'
 Current SQL query delimiter. More...
 
callable $deprecationLogger
 Deprecation logging callback. More...
 
callable $errorLogger
 Error logging callback. More...
 
int $flags
 Bitfield of class DBO_* constants. More...
 
string bool null $htmlErrors
 Stashed value of html_errors INI setting. More...
 
string [] $indexAliases = []
 Map of (index alias => index) More...
 
array $lbInfo = []
 LoadBalancer tracking information. More...
 
int $nonNativeInsertSelectBatchSize = 10000
 
bool $opened = false
 Whether a connection handle is open (connection itself might be dead) More...
 
string $password
 Password used to establish the current connection. More...
 
callable null $profiler
 
LoggerInterface $queryLogger
 
array bool $schemaVars = false
 Variables use for schema element placeholders. More...
 
string $server
 Server that this instance is currently connected to. More...
 
array $sessionNamedLocks = []
 Map of (name => 1) for locks obtained via lock() More...
 
array $sessionTempTables = []
 Map of (table name => 1) for TEMPORARY tables. More...
 
BagOStuff $srvCache
 APC cache. More...
 
array [] $tableAliases = []
 Map of (table => (dbname, schema, prefix) map) More...
 
int $trxLevel = 0
 Whether there is an active transaction (1 or 0) More...
 
TransactionProfiler $trxProfiler
 
string $trxShortId = ''
 Hexidecimal string if a transaction is active or empty string otherwise. 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...
 
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...
 

Detailed Description

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

Definition at line 71 of file DatabaseSqlite.php.

References null.

Member Function Documentation

◆ 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
IResultWrapper

Definition at line 308 of file DatabaseSqlite.php.

References $file, $fname, $name, Wikimedia\Rdbms\DatabaseSqlite\addQuotes(), 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

Implements Wikimedia\Rdbms\IDatabase.

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

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 980 of file DatabaseSqlite.php.

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

◆ buildStringCast()

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

Implements Wikimedia\Rdbms\IDatabase.

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

References $res, null, 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

Definition at line 242 of file DatabaseSqlite.php.

References null.

◆ 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

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 1118 of file DatabaseSqlite.php.

◆ dataSeek()

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

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 480 of file DatabaseSqlite.php.

References $res.

◆ deadlockLoop()

Wikimedia\Rdbms\DatabaseSqlite::deadlockLoop ( )

No-op version of deadlockLoop.

Returns
mixed

Implements Wikimedia\Rdbms\IMaintainableDatabase.

Definition at line 892 of file DatabaseSqlite.php.

References $args.

◆ decodeBlob()

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

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 830 of file DatabaseSqlite.php.

◆ doBegin()

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

◆ doInitConnection()

Wikimedia\Rdbms\DatabaseSqlite::doInitConnection ( )
protected

◆ 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|IResultWrapper

Definition at line 335 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|IResultWrapper
Exceptions
DBReadOnlyError

Implements Wikimedia\Rdbms\IMaintainableDatabase.

Definition at line 1092 of file DatabaseSqlite.php.

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

◆ duplicateTableStructure()

Wikimedia\Rdbms\DatabaseSqlite::duplicateTableStructure (   $oldName,
  $newName,
  $temporary = false,
  $fname = __METHOD__ 
)

◆ encodeBlob()

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

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 822 of file DatabaseSqlite.php.

◆ fetchAffectedRowCount()

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

Definition at line 522 of file DatabaseSqlite.php.

References Wikimedia\Rdbms\DatabaseSqlite\$lastAffectedRowCount.

◆ fetchObject()

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

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 363 of file DatabaseSqlite.php.

References $res, and as.

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

◆ fetchRow()

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

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 390 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 788 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
IResultWrapper$res
int$n
Returns
bool

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 439 of file DatabaseSqlite.php.

References $keys, and $res.

◆ fixIgnore()

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

Definition at line 621 of file DatabaseSqlite.php.

References $options, and as.

◆ freeResult()

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

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 351 of file DatabaseSqlite.php.

References $res, and null.

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

◆ getAttributes()

static Wikimedia\Rdbms\DatabaseSqlite::getAttributes ( )
staticprotected

Definition at line 102 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 234 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 280 of file DatabaseSqlite.php.

References null.

Referenced by DatabaseSqliteTest\testDuplicateTableStructureVirtual().

◆ getServerVersion()

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

Implements Wikimedia\Rdbms\IDatabase.

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

◆ getType()

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

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 156 of file DatabaseSqlite.php.

◆ implicitGroupby()

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

Implements Wikimedia\Rdbms\IDatabase.

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

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

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

◆ insert()

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

◆ insertId()

Wikimedia\Rdbms\DatabaseSqlite::insertId ( )

This must be called after nextSequenceVal.

Returns
int

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 471 of file DatabaseSqlite.php.

References Wikimedia\Rdbms\DatabaseSqlite\getBindingHandle().

Referenced by DatabaseSqliteTest\testInsertIdType().

◆ isTransactableQuery()

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

Definition at line 321 of file DatabaseSqlite.php.

References Wikimedia\Rdbms\Database\getQueryVerb().

◆ isWriteQuery()

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

Definition at line 317 of file DatabaseSqlite.php.

◆ lastErrno()

Wikimedia\Rdbms\DatabaseSqlite::lastErrno ( )

◆ lastError()

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

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 497 of file DatabaseSqlite.php.

References $e.

◆ listTables()

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

List all tables on the database.

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

Implements Wikimedia\Rdbms\IMaintainableDatabase.

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

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 956 of file DatabaseSqlite.php.

References LockManager\LOCK_EX.

◆ makeInsertOptions()

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

Definition at line 636 of file DatabaseSqlite.php.

References $options.

◆ makeSelectOptions()

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

Filter the options used in SELECT statements.

Parameters
array$options
Returns
array

Definition at line 596 of file DatabaseSqlite.php.

References $options, and as.

◆ makeUpdateOptionsArray()

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

Definition at line 610 of file DatabaseSqlite.php.

References $options.

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

References Wikimedia\Rdbms\Database\factory(), and null.

◆ numFields()

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

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 423 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
IResultWrapper | array | false$res
Returns
int

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 412 of file DatabaseSqlite.php.

References $res.

◆ open()

Wikimedia\Rdbms\DatabaseSqlite::open (   $server,
  $user,
  $pass,
  $dbName,
  $schema,
  $tablePrefix 
)
protected

◆ openFile()

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

Opens a database file.

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

Definition at line 191 of file DatabaseSqlite.php.

References Wikimedia\Rdbms\DatabaseSqlite\$conn, $e, DBO_PERSISTENT, null, 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__ 
)

◆ replaceVars()

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

Definition at line 903 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[]$aliases Map of (table => (dbname, schema, prefix) map)
Since
1.28

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 1101 of file DatabaseSqlite.php.

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

◆ strencode()

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

Definition at line 814 of file DatabaseSqlite.php.

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

◆ tableExists()

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

Query whether a given table exists.

Parameters
string$table
string$fname
Returns
bool
Exceptions
DBError

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 526 of file DatabaseSqlite.php.

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

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

◆ tableName()

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

◆ 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

Implements Wikimedia\Rdbms\IMaintainableDatabase.

Definition at line 716 of file DatabaseSqlite.php.

◆ unionQueries()

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

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 732 of file DatabaseSqlite.php.

◆ unionSupportsOrderAndLimit()

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

Implements Wikimedia\Rdbms\IDatabase.

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

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 966 of file DatabaseSqlite.php.

References LockManager\LOCK_EX.

◆ wasConnectionError()

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

Definition at line 752 of file DatabaseSqlite.php.

◆ wasDeadlock()

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

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 741 of file DatabaseSqlite.php.

References Wikimedia\Rdbms\DatabaseSqlite\lastErrno().

◆ wasKnownStatementRollbackError()

Wikimedia\Rdbms\DatabaseSqlite::wasKnownStatementRollbackError ( )
protected

Definition at line 756 of file DatabaseSqlite.php.

◆ wasReadOnlyError()

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

Implements Wikimedia\Rdbms\IDatabase.

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

◆ $conn

PDO Wikimedia\Rdbms\DatabaseSqlite::$conn
protected

◆ $dbDir

string Wikimedia\Rdbms\DatabaseSqlite::$dbDir
protected

Directory.

Definition at line 43 of file DatabaseSqlite.php.

◆ $dbPath

string Wikimedia\Rdbms\DatabaseSqlite::$dbPath
protected

File name for SQLite database file.

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

◆ $lastAffectedRowCount

int Wikimedia\Rdbms\DatabaseSqlite::$lastAffectedRowCount
protected

The number of rows affected as an integer.

Definition at line 50 of file DatabaseSqlite.php.

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

◆ $lastResultHandle

resource Wikimedia\Rdbms\DatabaseSqlite::$lastResultHandle
protected

Definition at line 52 of file DatabaseSqlite.php.

◆ $lockMgr

FSLockManager Wikimedia\Rdbms\DatabaseSqlite::$lockMgr
protected

(hopefully on the same server as the DB)

Definition at line 58 of file DatabaseSqlite.php.

◆ $trxMode

string Wikimedia\Rdbms\DatabaseSqlite::$trxMode
protected

Transaction mode.

Definition at line 47 of file DatabaseSqlite.php.


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