MediaWiki
1.30.0
|
Public Member Functions | |
__construct (array $p) | |
Additional params include: More... | |
__toString () | |
addQuotes ( $s) | |
affectedRows () | |
attachDatabase ( $name, $file=false, $fname=__METHOD__) | |
Attaches external database to our connection, see 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) | |
checkForEnabledSearch () | |
Check if the searchindext table is FTS enabled. More... | |
dataSeek ( $res, $row) | |
deadlockLoop () | |
No-op version of deadlockLoop. More... | |
decodeBlob ( $b) | |
dropTable ( $tableName, $fName=__METHOD__) | |
Override due to no CASCADE support. More... | |
duplicateTableStructure ( $oldName, $newName, $temporary=false, $fname=__METHOD__) | |
encodeBlob ( $b) | |
fetchObject ( $res) | |
fetchRow ( $res) | |
fieldInfo ( $table, $field) | |
Get information about a given field Returns false if the field does not exist. More... | |
fieldName ( $res, $n) | |
freeResult ( $res) | |
getDbFilePath () | |
getServerVersion () | |
getSoftwareLink () | |
getType () | |
implicitGroupby () | |
indexInfo ( $table, $index, $fname=__METHOD__) | |
Returns information about an index Returns false if the index does not exist. More... | |
indexUnique ( $table, $index, $fname=__METHOD__) | |
insert ( $table, $a, $fname=__METHOD__, $options=[]) | |
Based on generic method (parent) with some prior SQLite-sepcific adjustments. More... | |
insertId () | |
This must be called after nextSequenceVal. More... | |
isWriteQuery ( $sql) | |
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__) | |
selectDB ( $db) | |
Change the current database. 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... | |
wasDeadlock () | |
wasErrorReissuable () | |
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... | |
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... | |
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... | |
clearFlag ( $flag, $remember=self::REMEMBER_NOTHING) | |
Clear a flag for this connection. More... | |
close () | |
Closes a database connection. More... | |
commit ( $fname=__METHOD__, $flush='') | |
Commits a transaction previously started using begin(). More... | |
conditional ( $cond, $trueVal, $falseVal) | |
Returns an SQL expression for a simple conditional. More... | |
connectionErrorLogger ( $errno, $errstr) | |
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... | |
decodeExpiry ( $expiry, $format=TS_MW) | |
Decode an expiry time into a DBMS independent format. More... | |
delete ( $table, $conds, $fname=__METHOD__) | |
DELETE query wrapper. More... | |
deleteJoin ( $delTable, $joinTable, $delVar, $joinVar, $conds, $fname=__METHOD__) | |
DELETE where the condition is a join. More... | |
doAtomicSection ( $fname, callable $callback) | |
Run a callback to do an atomic set of updates for this database. More... | |
doneWrites () | |
Returns true if the connection may have been used for write queries. More... | |
encodeExpiry ( $expiry) | |
Encode an expiry time into the DBMS dependent format. More... | |
endAtomic ( $fname=__METHOD__) | |
Ends an atomic section of SQL statements. More... | |
estimateRowCount ( $table, $vars=' *', $conds='', $fname=__METHOD__, $options=[]) | |
Estimate the number of rows in dataset. More... | |
explicitTrxActive () | |
fieldExists ( $table, $field, $fname=__METHOD__) | |
Determines whether a field exists in a table. More... | |
flushSnapshot ( $fname=__METHOD__) | |
Commit any transaction but error out if writes or callbacks are pending. More... | |
getDBname () | |
Get the current DB name. More... | |
getDomainID () | |
getFlag ( $flag) | |
Returns a boolean whether the flag $flag is set for this connection. More... | |
getInfinity () | |
Find out when 'infinity' is. More... | |
getLag () | |
Get replica DB lag. More... | |
getLBInfo ( $name=null) | |
Get properties passed down from the server info array of the load balancer. More... | |
getMasterPos () | |
Get the position of this master. More... | |
getProperty ( $name) | |
getReplicaPos () | |
Get the replication position of this replica DB. More... | |
getScopedLockAndFlush ( $lockKey, $fname, $timeout) | |
Acquire a named lock, flush any transaction, and return an RAII style unlocker object. More... | |
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... | |
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 available (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... | |
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, $vars=' *', $conds='', $fname=__METHOD__, $options=[], $join_conds=[]) | |
Get the number of rows in dataset. More... | |
selectSQLText ( $table, $vars, $conds='', $fname=__METHOD__, $options=[], $join_conds=[]) | |
The equivalent of IDatabase::select() except that the constructed SQL is returned, instead of being immediately executed. More... | |
serverIsReadOnly () | |
setBigSelects ( $value=true) | |
Allow or deny "big selects" for this session only. More... | |
setFlag ( $flag, $remember=self::REMEMBER_NOTHING) | |
Set a flag for this connection. More... | |
setLazyMasterHandle (IDatabase $conn) | |
Set a lazy-connecting DB handle to the master DB (for replication status purposes) More... | |
setLBInfo ( $name, $value=null) | |
Set the LB info array, or a member of it. More... | |
setLogger (LoggerInterface $logger) | |
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 each time any transaction commits or rolls back. More... | |
setTrxEndCallbackSuppression ( $suppress) | |
Whether to disable running of post-COMMIT/ROLLBACK callbacks. More... | |
sourceFile ( $filename, callable $lineCallback=null, callable $resultCallback=null, $fname=false, callable $inputCallback=null) | |
Read and execute SQL commands from a file. More... | |
sourceStream ( $fp, callable $lineCallback=null, callable $resultCallback=null, $fname=__METHOD__, callable $inputCallback=null) | |
Read and execute commands from an open file handle. More... | |
startAtomic ( $fname=__METHOD__) | |
Begin an atomic section of statements. More... | |
streamStatementEnd (&$sql, &$newLine) | |
Called by sourceStream() to check if we've reached a statement end. More... | |
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... | |
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... | |
wasConnectionError ( $errno) | |
Do not use this method outside of Database/DBError classes. More... | |
wasLockTimeout () | |
Determines if the last failure was due to a lock timeout. More... | |
writesOrCallbacksPending () | |
Returns true if there is a transaction open with possible write queries or transaction pre-commit/idle callbacks waiting on it to finish. More... | |
writesPending () | |
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 | factory ( $dbType, $p=[]) |
Construct a Database subclass instance given a database type and parameters. More... | |
static | getCacheSetOptions (IDatabase $db1) |
Merge the result of getSessionLagStatus() for several DBs using the most pessimistic values to estimate the lag of any data derived from them in combination. More... | |
Protected Member Functions | |
closeConnection () | |
Does not actually close the connection, just destroys the reference for GC to do its work. More... | |
doBegin ( $fname='') | |
Issues the BEGIN command to the database server. More... | |
doQuery ( $sql) | |
SQLite doesn't allow buffered results or data seeking etc, so we'll use fetchAll as the result. More... | |
makeUpdateOptionsArray ( $options) | |
openFile ( $fileName) | |
Opens a database file. More... | |
replaceVars ( $s) | |
requiresDatabaseUser () | |
Protected Member Functions inherited from Wikimedia\Rdbms\Database | |
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... | |
doRollback ( $fname) | |
Issues the ROLLBACK command to the database server. More... | |
doUnlockTables ( $method) | |
Helper function for unlockTables() that handles the actual table unlocking. More... | |
escapeLikeInternal ( $s, $escapeChar='`') | |
fieldNamesWithAlias ( $fields) | |
Gets an array of aliased field names. More... | |
fieldNameWithAlias ( $name, $alias=false) | |
Get an aliased field name e.g. More... | |
getApproximateLagStatus () | |
Get a replica DB lag estimate for this server. More... | |
getBindingHandle () | |
Get the underlying binding handle, mConn. More... | |
getDefaultSchemaVars () | |
Get schema variables to use if none have been set via setSchemaVars(). More... | |
getLastPHPError () | |
getLazyMasterHandle () | |
getLogContext (array $extras=[]) | |
Create a log context to pass to PSR-3 logger functions. More... | |
getQueryVerb ( $sql) | |
getReadOnlyReason () | |
getSchemaVars () | |
Get schema variables. More... | |
getTransactionLagStatus () | |
Get the replica DB lag when the current transaction started. More... | |
ignoreErrors ( $ignoreErrors=null) | |
Turns on (false) or off (true) the automatic generation and sending of a "we're sorry, but there has been a database error" page on database errors. More... | |
indexName ( $index) | |
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... | |
isTransactableQuery ( $sql) | |
Determine whether a SQL statement is sensitive to isolation level. More... | |
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... | |
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... | |
reconnect () | |
Close existing database connection and open a new connection. More... | |
registerTempTableOperation ( $sql) | |
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 ( $name, $alias=false) | |
Get an aliased table name e.g. More... | |
Protected Attributes | |
string | $dbDir |
Directory. More... | |
string | $dbPath |
File name for SQLite database file. More... | |
FSLockManager | $lockMgr |
(hopefully on the same server as the DB) More... | |
int | $mAffectedRows |
The number of rows affected as an integer. More... | |
PDO | $mConn |
resource | $mLastResult |
string | $trxMode |
Transaction mode. More... | |
Protected Attributes inherited from Wikimedia\Rdbms\Database | |
string | $agent |
Agent name for query profiling. More... | |
bool | $cliMode |
Whether this PHP instance is for a CLI script. More... | |
LoggerInterface | $connLogger |
DatabaseDomain | $currentDomain |
string | $delimiter = ';' |
callback | $errorLogger |
Error logging callback. More... | |
string bool null | $htmlErrors |
Stashed value of html_errors INI setting. More... | |
float | $lastPing = 0.0 |
UNIX timestamp. More... | |
resource null | $mConn = null |
Database connection. More... | |
string | $mDBname |
bool null | $mDefaultBigSelects = null |
int | $mFlags |
string | $mLastQuery = '' |
SQL query. More... | |
float bool | $mLastWriteTime = false |
UNIX timestamp of last write query. More... | |
array | $mLBInfo = [] |
bool | $mOpened = false |
string | $mPassword |
string bool | $mPHPError = false |
string | $mSchema = '' |
array bool | $mSchemaVars = false |
string | $mServer |
array | $mSessionTempTables = [] |
Map of (table name => 1) for TEMPORARY tables. More... | |
array | $mSessionVars = [] |
string | $mTablePrefix = '' |
array[] | $mTrxEndCallbacks = [] |
List of (callable, method name) More... | |
bool | $mTrxEndCallbacksSuppressed = false |
Whether to suppress triggering of transaction end callbacks. More... | |
array[] | $mTrxIdleCallbacks = [] |
List of (callable, method name) More... | |
int | $mTrxLevel = 0 |
Either 1 if a transaction is active or 0 otherwise. More... | |
array[] | $mTrxPreCommitCallbacks = [] |
List of (callable, method name) More... | |
callable[] | $mTrxRecurringCallbacks = [] |
Map of (name => callable) More... | |
string | $mTrxShortId = '' |
Either a short hexidecimal string if a transaction is active or "". More... | |
string | $mUser |
array null | $preparedArgs |
object string | $profiler |
Class name or object With profileIn/profileOut methods. More... | |
LoggerInterface | $queryLogger |
BagOStuff | $srvCache |
APC cache. More... | |
$tableAliases = [] | |
TransactionProfiler | $trxProfiler |
Static Private Attributes | |
static bool | $fulltextEnabled = null |
Whether full text is enabled. More... | |
Additional Inherited Members | |
Public Attributes inherited from 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 |
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... | |
Definition at line 37 of file DatabaseSqlite.php.
Wikimedia\Rdbms\DatabaseSqlite::__construct | ( | array | $p | ) |
Additional params include:
array | $p |
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 67 of file DatabaseSqlite.php.
References Wikimedia\Rdbms\Database\$mDBname, $params, as, Wikimedia\Rdbms\DatabaseSqlite\attachDatabase(), Wikimedia\Rdbms\Database\isOpen(), Wikimedia\Rdbms\DatabaseSqlite\open(), and Wikimedia\Rdbms\DatabaseSqlite\openFile().
Wikimedia\Rdbms\DatabaseSqlite::__toString | ( | ) |
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 1043 of file DatabaseSqlite.php.
References string.
Wikimedia\Rdbms\DatabaseSqlite::addQuotes | ( | $s | ) |
string | int | null | bool | Blob | $s |
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 788 of file DatabaseSqlite.php.
References $s.
Referenced by Wikimedia\Rdbms\DatabaseSqlite\attachDatabase(), Wikimedia\Rdbms\DatabaseSqlite\buildGroupConcatField(), Wikimedia\Rdbms\DatabaseSqlite\duplicateTableStructure(), Wikimedia\Rdbms\DatabaseSqlite\fieldInfo(), Wikimedia\Rdbms\DatabaseSqlite\indexInfo(), Wikimedia\Rdbms\DatabaseSqlite\strencode(), and DatabaseSqliteTest\testAddQuotes().
Wikimedia\Rdbms\DatabaseSqlite::affectedRows | ( | ) |
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 497 of file DatabaseSqlite.php.
References Wikimedia\Rdbms\DatabaseSqlite\$mAffectedRows.
Wikimedia\Rdbms\DatabaseSqlite::attachDatabase | ( | $name, | |
$file = false , |
|||
$fname = __METHOD__ |
|||
) |
Attaches external database to our connection, see https://sqlite.org/lang_attach.html for details.
string | $name | Database name to be used in queries like SELECT foo FROM dbname.table |
bool | string | $file | Database file name. If omitted, will be generated using $name and configured data directory |
string | $fname | Calling function name |
Definition at line 292 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\__construct().
Wikimedia\Rdbms\DatabaseSqlite::buildConcat | ( | $stringList | ) |
Build a concatenation list to feed into a SQL query.
string[] | $stringList |
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 913 of file DatabaseSqlite.php.
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.
string | $delim | Glue to bind the results together |
string | array | $table | Table name |
string | $field | Field name |
string | array | $conds | Conditions |
string | array | $join_conds | Join conditions |
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 917 of file DatabaseSqlite.php.
References Wikimedia\Rdbms\DatabaseSqlite\addQuotes(), and Wikimedia\Rdbms\Database\selectSQLText().
Wikimedia\Rdbms\DatabaseSqlite::buildStringCast | ( | $field | ) |
string | $field | Field or column to cast |
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 820 of file DatabaseSqlite.php.
Wikimedia\Rdbms\DatabaseSqlite::checkForEnabledSearch | ( | ) |
Check if the searchindext table is FTS enabled.
Definition at line 246 of file DatabaseSqlite.php.
References Wikimedia\Rdbms\DatabaseSqlite\$fulltextEnabled, $res, Wikimedia\Rdbms\Database\query(), and Wikimedia\Rdbms\DatabaseSqlite\tableName().
|
protected |
Does not actually close the connection, just destroys the reference for GC to do its work.
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 226 of file DatabaseSqlite.php.
Wikimedia\Rdbms\DatabaseSqlite::dataSeek | ( | $res, | |
$row | |||
) |
ResultWrapper | array | $res | |
int | $row |
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 455 of file DatabaseSqlite.php.
References $res.
Wikimedia\Rdbms\DatabaseSqlite::deadlockLoop | ( | ) |
No-op version of deadlockLoop.
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 829 of file DatabaseSqlite.php.
References $args.
Wikimedia\Rdbms\DatabaseSqlite::decodeBlob | ( | $b | ) |
Blob | string | $b |
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 776 of file DatabaseSqlite.php.
|
protected |
Issues the BEGIN command to the database server.
string | $fname |
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 747 of file DatabaseSqlite.php.
References $fname, and Wikimedia\Rdbms\Database\query().
|
protected |
SQLite doesn't allow buffered results or data seeking etc, so we'll use fetchAll as the result.
string | $sql |
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 311 of file DatabaseSqlite.php.
References $res.
Wikimedia\Rdbms\DatabaseSqlite::dropTable | ( | $tableName, | |
$fName = __METHOD__ |
|||
) |
Override due to no CASCADE support.
string | $tableName | |
string | $fName |
DBReadOnlyError |
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 1027 of file DatabaseSqlite.php.
References Wikimedia\Rdbms\Database\query(), Wikimedia\Rdbms\Database\tableExists(), and Wikimedia\Rdbms\DatabaseSqlite\tableName().
Wikimedia\Rdbms\DatabaseSqlite::duplicateTableStructure | ( | $oldName, | |
$newName, | |||
$temporary = false , |
|||
$fname = __METHOD__ |
|||
) |
string | $oldName | |
string | $newName | |
bool | $temporary | |
string | $fname |
RuntimeException |
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 933 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().
Wikimedia\Rdbms\DatabaseSqlite::encodeBlob | ( | $b | ) |
string | $b |
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 768 of file DatabaseSqlite.php.
Wikimedia\Rdbms\DatabaseSqlite::fetchObject | ( | $res | ) |
ResultWrapper | array | $res |
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 339 of file DatabaseSqlite.php.
Referenced by Wikimedia\Rdbms\DatabaseSqlite\duplicateTableStructure().
Wikimedia\Rdbms\DatabaseSqlite::fetchRow | ( | $res | ) |
ResultWrapper | mixed | $res |
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 366 of file DatabaseSqlite.php.
References $res.
Wikimedia\Rdbms\DatabaseSqlite::fieldInfo | ( | $table, | |
$field | |||
) |
Get information about a given field Returns false if the field does not exist.
string | $table | |
string | $field |
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 734 of file DatabaseSqlite.php.
References $res, Wikimedia\Rdbms\DatabaseSqlite\addQuotes(), as, Wikimedia\Rdbms\Database\query(), and Wikimedia\Rdbms\DatabaseSqlite\tableName().
Wikimedia\Rdbms\DatabaseSqlite::fieldName | ( | $res, | |
$n | |||
) |
ResultWrapper | $res | |
int | $n |
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 414 of file DatabaseSqlite.php.
|
static |
array | $options |
Definition at line 583 of file DatabaseSqlite.php.
Referenced by Wikimedia\Rdbms\DatabaseSqlite\makeInsertOptions(), and Wikimedia\Rdbms\DatabaseSqlite\makeUpdateOptionsArray().
Wikimedia\Rdbms\DatabaseSqlite::freeResult | ( | $res | ) |
ResultWrapper | mixed | $res |
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 327 of file DatabaseSqlite.php.
References $res.
|
static |
Generates a database file name.
Explicitly public for installer.
string | $dir | Directory where database resides |
string | $dbName | Database name |
Definition at line 238 of file DatabaseSqlite.php.
Referenced by Wikimedia\Rdbms\DatabaseSqlite\attachDatabase(), and Wikimedia\Rdbms\DatabaseSqlite\open().
Wikimedia\Rdbms\DatabaseSqlite::getDbFilePath | ( | ) |
Definition at line 218 of file DatabaseSqlite.php.
References Wikimedia\Rdbms\DatabaseSqlite\$dbPath.
|
static |
Returns version of currently supported SQLite fulltext search module or false if none present.
Definition at line 264 of file DatabaseSqlite.php.
References Wikimedia\Rdbms\DatabaseSqlite\newStandaloneInstance().
Referenced by DatabaseSqliteTest\testDuplicateTableStructureVirtual().
Wikimedia\Rdbms\DatabaseSqlite::getServerVersion | ( | ) |
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 720 of file DatabaseSqlite.php.
Referenced by SqliteInstaller\checkPrerequisites().
Wikimedia\Rdbms\DatabaseSqlite::getSoftwareLink | ( | ) |
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 713 of file DatabaseSqlite.php.
Wikimedia\Rdbms\DatabaseSqlite::getType | ( | ) |
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 134 of file DatabaseSqlite.php.
Wikimedia\Rdbms\DatabaseSqlite::implicitGroupby | ( | ) |
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 143 of file DatabaseSqlite.php.
Wikimedia\Rdbms\DatabaseSqlite::indexInfo | ( | $table, | |
$index, | |||
$fname = __METHOD__ |
|||
) |
Returns information about an index Returns false if the index does not exist.
string | $table | |
string | $index | |
string | $fname |
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 511 of file DatabaseSqlite.php.
References $fname, $res, Wikimedia\Rdbms\DatabaseSqlite\addQuotes(), as, Wikimedia\Rdbms\Database\indexName(), and Wikimedia\Rdbms\Database\query().
Wikimedia\Rdbms\DatabaseSqlite::indexUnique | ( | $table, | |
$index, | |||
$fname = __METHOD__ |
|||
) |
string | $table | |
string | $index | |
string | $fname |
Definition at line 531 of file DatabaseSqlite.php.
References $fname, $options, Wikimedia\Rdbms\Database\indexName(), and Wikimedia\Rdbms\Database\selectRow().
Wikimedia\Rdbms\DatabaseSqlite::insert | ( | $table, | |
$a, | |||
$fname = __METHOD__ , |
|||
$options = [] |
|||
) |
Based on generic method (parent) with some prior SQLite-sepcific adjustments.
string | $table | |
array | $a | |
string | $fname | |
array | $options |
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 612 of file DatabaseSqlite.php.
References $options, $ret, as, captcha-old\count, and insert.
Referenced by DatabaseSqliteTest\testDeleteJoin(), DatabaseSqliteTest\testInsertIdType(), and DatabaseSqliteTest\testNumFields().
Wikimedia\Rdbms\DatabaseSqlite::insertId | ( | ) |
This must be called after nextSequenceVal.
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 446 of file DatabaseSqlite.php.
Referenced by DatabaseSqliteTest\testInsertIdType().
Wikimedia\Rdbms\DatabaseSqlite::isWriteQuery | ( | $sql | ) |
Determine whether a query writes to the DB.
Should return true if unsure.
string | $sql |
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 301 of file DatabaseSqlite.php.
Wikimedia\Rdbms\DatabaseSqlite::lastErrno | ( | ) |
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 484 of file DatabaseSqlite.php.
Referenced by Wikimedia\Rdbms\DatabaseSqlite\wasDeadlock(), Wikimedia\Rdbms\DatabaseSqlite\wasErrorReissuable(), and Wikimedia\Rdbms\DatabaseSqlite\wasReadOnlyError().
Wikimedia\Rdbms\DatabaseSqlite::lastError | ( | ) |
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 472 of file DatabaseSqlite.php.
References $e.
Wikimedia\Rdbms\DatabaseSqlite::listTables | ( | $prefix = null , |
|
$fname = __METHOD__ |
|||
) |
List all tables on the database.
string | $prefix | Only show tables with this prefix, e.g. mw_ |
string | $fname | Calling function name |
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 996 of file DatabaseSqlite.php.
References $vars, as, and Wikimedia\Rdbms\Database\select().
Referenced by DatabaseSqliteTest\getTables().
Wikimedia\Rdbms\DatabaseSqlite::lock | ( | $lockName, | |
$method, | |||
$timeout = 5 |
|||
) |
Acquire a named lock.
Named locks are not related to transactions
string | $lockName | Name of lock to aquire |
string | $method | Name of the calling method |
int | $timeout | Acquisition timeout in seconds |
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 893 of file DatabaseSqlite.php.
References LockManager\LOCK_EX.
Wikimedia\Rdbms\DatabaseSqlite::makeInsertOptions | ( | $options | ) |
array | $options |
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 598 of file DatabaseSqlite.php.
References $options, and Wikimedia\Rdbms\DatabaseSqlite\fixIgnore().
Wikimedia\Rdbms\DatabaseSqlite::makeSelectOptions | ( | $options | ) |
Filter the options used in SELECT statements.
array | $options |
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 558 of file DatabaseSqlite.php.
|
protected |
array | $options |
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 572 of file DatabaseSqlite.php.
References $options, and Wikimedia\Rdbms\DatabaseSqlite\fixIgnore().
|
static |
string | $filename | |
array | $p | Options map; supports:
|
Definition at line 121 of file DatabaseSqlite.php.
References Wikimedia\Rdbms\Database\factory().
Referenced by Wikimedia\Rdbms\DatabaseSqlite\getFulltextSearchModule().
Wikimedia\Rdbms\DatabaseSqlite::numFields | ( | $res | ) |
ResultWrapper | $res |
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 398 of file DatabaseSqlite.php.
References $res, and captcha-old\count.
Referenced by DatabaseSqliteTest\testNumFields().
Wikimedia\Rdbms\DatabaseSqlite::numRows | ( | $res | ) |
The PDO::Statement class implements the array interface so count() will work.
ResultWrapper | array | $res |
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 388 of file DatabaseSqlite.php.
References $res, and captcha-old\count.
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.
string | $server | |
string | $user | |
string | $pass | |
string | $dbName |
DBConnectionError |
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 158 of file DatabaseSqlite.php.
References Wikimedia\Rdbms\DatabaseSqlite\$mConn, Wikimedia\Rdbms\Database\close(), Wikimedia\Rdbms\DatabaseSqlite\generateFileName(), and Wikimedia\Rdbms\DatabaseSqlite\openFile().
Referenced by Wikimedia\Rdbms\DatabaseSqlite\__construct().
|
protected |
Opens a database file.
string | $fileName |
DBConnectionError |
Definition at line 177 of file DatabaseSqlite.php.
References $e, Wikimedia\Rdbms\DatabaseSqlite\$mConn, DBO_PERSISTENT, and Wikimedia\Rdbms\Database\query().
Referenced by Wikimedia\Rdbms\DatabaseSqlite\__construct(), and Wikimedia\Rdbms\DatabaseSqlite\open().
Wikimedia\Rdbms\DatabaseSqlite::replace | ( | $table, | |
$uniqueIndexes, | |||
$rows, | |||
$fname = __METHOD__ |
|||
) |
string | $table | |
array | $uniqueIndexes | Unused |
string | array | $rows | |
string | $fname |
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 639 of file DatabaseSqlite.php.
References $ret, $rows, as, captcha-old\count, and Wikimedia\Rdbms\Database\nativeReplace().
|
protected |
string | $s |
Reimplemented from Wikimedia\Rdbms\Database.
Reimplemented in DatabaseSqliteMock.
Definition at line 840 of file DatabaseSqlite.php.
References $s.
|
protected |
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 1036 of file DatabaseSqlite.php.
Wikimedia\Rdbms\DatabaseSqlite::selectDB | ( | $db | ) |
Change the current database.
string | $db |
DBConnectionError | If databasesAreIndependent() is true and an error occurs |
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 210 of file DatabaseSqlite.php.
Wikimedia\Rdbms\DatabaseSqlite::strencode | ( | $s | ) |
string | $s |
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 760 of file DatabaseSqlite.php.
References $s, and Wikimedia\Rdbms\DatabaseSqlite\addQuotes().
Wikimedia\Rdbms\DatabaseSqlite::tableName | ( | $name, | |
$format = 'quoted' |
|||
) |
Use MySQL's naming (accounts for prefix etc) but remove surrounding backticks.
string | $name | |
string | $format |
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 432 of file DatabaseSqlite.php.
References $name, and tableName().
Referenced by Wikimedia\Rdbms\DatabaseSqlite\checkForEnabledSearch(), Wikimedia\Rdbms\DatabaseSqlite\dropTable(), Wikimedia\Rdbms\DatabaseSqlite\fieldInfo(), and DatabaseSqliteTest\testTableName().
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.
string | $table | |
string | $field |
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 667 of file DatabaseSqlite.php.
Wikimedia\Rdbms\DatabaseSqlite::unionQueries | ( | $sqls, | |
$all | |||
) |
string[] | $sqls | |
bool | $all | Whether to "UNION ALL" or not |
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 683 of file DatabaseSqlite.php.
Wikimedia\Rdbms\DatabaseSqlite::unionSupportsOrderAndLimit | ( | ) |
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 674 of file DatabaseSqlite.php.
Wikimedia\Rdbms\DatabaseSqlite::unlock | ( | $lockName, | |
$method | |||
) |
Release a lock.
Named locks are not related to transactions
string | $lockName | Name of lock to release |
string | $method | Name of the calling method |
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 903 of file DatabaseSqlite.php.
References LockManager\LOCK_EX.
Wikimedia\Rdbms\DatabaseSqlite::wasDeadlock | ( | ) |
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 692 of file DatabaseSqlite.php.
References Wikimedia\Rdbms\DatabaseSqlite\lastErrno().
Wikimedia\Rdbms\DatabaseSqlite::wasErrorReissuable | ( | ) |
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 699 of file DatabaseSqlite.php.
References Wikimedia\Rdbms\DatabaseSqlite\lastErrno().
Wikimedia\Rdbms\DatabaseSqlite::wasReadOnlyError | ( | ) |
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 706 of file DatabaseSqlite.php.
References Wikimedia\Rdbms\DatabaseSqlite\lastErrno().
|
protected |
Directory.
Definition at line 42 of file DatabaseSqlite.php.
|
protected |
File name for SQLite database file.
Definition at line 44 of file DatabaseSqlite.php.
Referenced by Wikimedia\Rdbms\DatabaseSqlite\getDbFilePath().
|
staticprivate |
Whether full text is enabled.
Definition at line 39 of file DatabaseSqlite.php.
Referenced by Wikimedia\Rdbms\DatabaseSqlite\checkForEnabledSearch().
|
protected |
(hopefully on the same server as the DB)
Definition at line 57 of file DatabaseSqlite.php.
|
protected |
The number of rows affected as an integer.
Definition at line 49 of file DatabaseSqlite.php.
Referenced by Wikimedia\Rdbms\DatabaseSqlite\affectedRows().
|
protected |
Definition at line 54 of file DatabaseSqlite.php.
Referenced by Wikimedia\Rdbms\DatabaseSqlite\open(), and Wikimedia\Rdbms\DatabaseSqlite\openFile().
|
protected |
Definition at line 51 of file DatabaseSqlite.php.
|
protected |
Transaction mode.
Definition at line 46 of file DatabaseSqlite.php.