MediaWiki REL1_35
|
Public Member Functions | |||||||||||||||||||||
__construct (array $params) | |||||||||||||||||||||
Additional params include: | |||||||||||||||||||||
addQuotes ( $s) | |||||||||||||||||||||
attachDatabase ( $name, $file=false, $fname=__METHOD__) | |||||||||||||||||||||
Attaches external database to the connection handle. | |||||||||||||||||||||
buildConcat ( $stringList) | |||||||||||||||||||||
Build a concatenation list to feed into a SQL query. | |||||||||||||||||||||
buildGreatest ( $fields, $values) | |||||||||||||||||||||
Build a GREATEST function statement comparing columns/values.Integer and float values in $values will not be quotedIf $fields is an array, then each value with a string key is treated as an expression (which must be manually quoted); such string keys do not appear in the SQL and are only descriptive aliases.
| |||||||||||||||||||||
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.
| |||||||||||||||||||||
buildLeast ( $fields, $values) | |||||||||||||||||||||
Build a LEAST function statement comparing columns/values.Integer and float values in $values will not be quotedIf $fields is an array, then each value with a string key is treated as an expression (which must be manually quoted); such string keys do not appear in the SQL and are only descriptive aliases.
| |||||||||||||||||||||
buildStringCast ( $field) | |||||||||||||||||||||
buildSubstring ( $input, $startPosition, $length=null) | |||||||||||||||||||||
Stable to override Stable to override | |||||||||||||||||||||
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 logically separate, with different database users, requiring special mechanisms like postgres_fdw to "mount" foreign DBs. This is true even among DBs on the same server. Changing the selected database via selectDomain() requires a new connection.
| |||||||||||||||||||||
dataSeek ( $res, $row) | |||||||||||||||||||||
deadlockLoop (... $args) | |||||||||||||||||||||
No-op version of deadlockLoop. | |||||||||||||||||||||
decodeBlob ( $b) | |||||||||||||||||||||
dropTable ( $table, $fname=__METHOD__) | |||||||||||||||||||||
Delete a table. | |||||||||||||||||||||
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. | |||||||||||||||||||||
fieldName ( $res, $n) | |||||||||||||||||||||
freeResult ( $res) | |||||||||||||||||||||
getDbFilePath () | |||||||||||||||||||||
getLockFileDirectory () | |||||||||||||||||||||
getServerVersion () | |||||||||||||||||||||
getSoftwareLink () | |||||||||||||||||||||
getType () | |||||||||||||||||||||
indexInfo ( $table, $index, $fname=__METHOD__) | |||||||||||||||||||||
Returns information about an index Returns false if the index does not exist. | |||||||||||||||||||||
indexUnique ( $table, $index, $fname=__METHOD__) | |||||||||||||||||||||
insertId () | |||||||||||||||||||||
This must be called after nextSequenceVal. | |||||||||||||||||||||
lastErrno () | |||||||||||||||||||||
lastError () | |||||||||||||||||||||
listTables ( $prefix=null, $fname=__METHOD__) | |||||||||||||||||||||
List all tables on the database. | |||||||||||||||||||||
lock ( $lockName, $method, $timeout=5) | |||||||||||||||||||||
Acquire a named lock.Named locks are not related to transactions
| |||||||||||||||||||||
numFields ( $res) | |||||||||||||||||||||
numRows ( $res) | |||||||||||||||||||||
The PDO::Statement class implements the array interface so count() will work. | |||||||||||||||||||||
serverIsReadOnly () | |||||||||||||||||||||
| |||||||||||||||||||||
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.
| |||||||||||||||||||||
strencode ( $s) | |||||||||||||||||||||
tableExists ( $table, $fname=__METHOD__) | |||||||||||||||||||||
Query whether a given table exists. | |||||||||||||||||||||
tableName ( $name, $format='quoted') | |||||||||||||||||||||
Use MySQL's naming (accounts for prefix etc) but remove surrounding backticks. | |||||||||||||||||||||
textFieldSize ( $table, $field) | |||||||||||||||||||||
Returns the size of a text field, or -1 for "unlimited" In SQLite this is SQLITE_MAX_LENGTH, by default 1GB. | |||||||||||||||||||||
unionQueries ( $sqls, $all) | |||||||||||||||||||||
unionSupportsOrderAndLimit () | |||||||||||||||||||||
unlock ( $lockName, $method) | |||||||||||||||||||||
Release a lock.Named locks are not related to transactions
| |||||||||||||||||||||
wasConnectionError ( $errno) | |||||||||||||||||||||
Do not use this method outside of Database/DBError classes. | |||||||||||||||||||||
wasDeadlock () | |||||||||||||||||||||
wasReadOnlyError () | |||||||||||||||||||||
Public Member Functions inherited from Wikimedia\Rdbms\Database | |||||||||||||||||||||
__clone () | |||||||||||||||||||||
Make sure that copies do not share the same client binding handle. | |||||||||||||||||||||
__destruct () | |||||||||||||||||||||
Run a few simple sanity checks and close dangling connections. | |||||||||||||||||||||
__sleep () | |||||||||||||||||||||
Called by serialize. | |||||||||||||||||||||
__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. | |||||||||||||||||||||
addIdentifierQuotes ( $s) | |||||||||||||||||||||
Escape a SQL identifier (e.g.table, column, database) for use in a SQL queryDepending on the database this will either be backticks or "double quotes"
| |||||||||||||||||||||
affectedRows () | |||||||||||||||||||||
Get the number of rows affected by the last write query. | |||||||||||||||||||||
aggregateValue ( $valuedata, $valuename='value') | |||||||||||||||||||||
Return aggregated value alias.
| |||||||||||||||||||||
anyChar () | |||||||||||||||||||||
Returns a token for buildLike() that denotes a '_' to be used in a LIKE query. | |||||||||||||||||||||
anyString () | |||||||||||||||||||||
Returns a token for buildLike() that denotes a '' to be used in a LIKE query. | |||||||||||||||||||||
assertNoOpenTransactions () | |||||||||||||||||||||
Assert that all explicit transactions or atomic sections have been closed. | |||||||||||||||||||||
begin ( $fname=__METHOD__, $mode=self::TRANSACTION_EXPLICIT) | |||||||||||||||||||||
Begin a transaction. | |||||||||||||||||||||
bitAnd ( $fieldLeft, $fieldRight) | |||||||||||||||||||||
| |||||||||||||||||||||
bitNot ( $field) | |||||||||||||||||||||
| |||||||||||||||||||||
bitOr ( $fieldLeft, $fieldRight) | |||||||||||||||||||||
| |||||||||||||||||||||
buildIntegerCast ( $field) | |||||||||||||||||||||
| |||||||||||||||||||||
buildLike ( $param,... $params) | |||||||||||||||||||||
LIKE statement wrapper.This takes 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(). Alternatively, the function could be provided with an array of aforementioned parameters.Example: $dbr->buildLike( 'My_page_title/', $dbr->anyString() ) returns a LIKE clause that searches for subpages of 'My page title'. Alternatively: $pattern = [ 'My_page_title/', $dbr->anyString() ]; $query .= $dbr->buildLike( $pattern );
| |||||||||||||||||||||
buildSelectSubquery ( $table, $vars, $conds='', $fname=__METHOD__, $options=[], $join_conds=[]) | |||||||||||||||||||||
Equivalent to IDatabase::selectSQLText() except wraps the result in Subquery. | |||||||||||||||||||||
cancelAtomic ( $fname=__METHOD__, AtomicSectionIdentifier $sectionId=null) | |||||||||||||||||||||
Cancel an atomic section of SQL statements. | |||||||||||||||||||||
clearFlag ( $flag, $remember=self::REMEMBER_NOTHING) | |||||||||||||||||||||
Clear a flag for this connection. | |||||||||||||||||||||
close ( $fname=__METHOD__, $owner=null) | |||||||||||||||||||||
Close the database connection. | |||||||||||||||||||||
commit ( $fname=__METHOD__, $flush=self::FLUSHING_ONE) | |||||||||||||||||||||
Commits a transaction previously started using begin() | |||||||||||||||||||||
conditional ( $cond, $trueVal, $falseVal) | |||||||||||||||||||||
Returns an SQL expression for a simple conditional.This doesn't need to be overridden unless CASE isn't supported in the RDBMS.
| |||||||||||||||||||||
connectionErrorLogger ( $errno, $errstr) | |||||||||||||||||||||
Error handler for logging errors during database connection This method should not be used outside of Database classes. | |||||||||||||||||||||
dbSchema ( $schema=null) | |||||||||||||||||||||
Get/set the db schema. | |||||||||||||||||||||
decodeExpiry ( $expiry, $format=TS_MW) | |||||||||||||||||||||
Decode an expiry time into a DBMS independent format. | |||||||||||||||||||||
delete ( $table, $conds, $fname=__METHOD__) | |||||||||||||||||||||
Delete all rows in a table that match a condition. | |||||||||||||||||||||
deleteJoin ( $delTable, $joinTable, $delVar, $joinVar, $conds, $fname=__METHOD__) | |||||||||||||||||||||
DELETE where the condition is a join.MySQL overrides this to use a multi-table DELETE syntax, in other databases we use sub-selectsFor safety, an empty $conds will not delete everything. If you want to delete all rows where the join condition matches, set $conds=IDatabase::ALL_ROWS.DO NOT put the join condition in $conds.
| |||||||||||||||||||||
doAtomicSection ( $fname, callable $callback, $cancelable=self::ATOMIC_NOT_CANCELABLE) | |||||||||||||||||||||
Perform an atomic section of reversable SQL statements from a callback. | |||||||||||||||||||||
encodeExpiry ( $expiry) | |||||||||||||||||||||
Encode an expiry time into the DBMS dependent format. | |||||||||||||||||||||
endAtomic ( $fname=__METHOD__) | |||||||||||||||||||||
Ends an atomic section of SQL statements. | |||||||||||||||||||||
estimateRowCount ( $tables, $var=' *', $conds='', $fname=__METHOD__, $options=[], $join_conds=[]) | |||||||||||||||||||||
Estimate the number of rows in dataset.MySQL allows you to estimate the number of rows that would be returned by a SELECT query, using EXPLAIN SELECT. The estimate is provided using index cardinality statistics, and is notoriously inaccurate, especially when large numbers of rows have recently been added or deleted.For DBMSs that don't support fast result size estimation, this function will actually perform the SELECT COUNT(*).Takes the same arguments as IDatabase::select().
| |||||||||||||||||||||
explicitTrxActive () | |||||||||||||||||||||
fieldExists ( $table, $field, $fname=__METHOD__) | |||||||||||||||||||||
Determines whether a field exists in a table. | |||||||||||||||||||||
flushSnapshot ( $fname=__METHOD__, $flush=self::FLUSHING_ONE) | |||||||||||||||||||||
Commit any transaction but error out if writes or callbacks are pending. | |||||||||||||||||||||
getDBname () | |||||||||||||||||||||
Get the current DB name. | |||||||||||||||||||||
getDomainID () | |||||||||||||||||||||
Return the currently selected domain ID. | |||||||||||||||||||||
getFlag ( $flag) | |||||||||||||||||||||
Returns a boolean whether the flag $flag is set for this connection. | |||||||||||||||||||||
getInfinity () | |||||||||||||||||||||
Find out when 'infinity' is.Most DBMSes support this. This is a special keyword for timestamps in PostgreSQL, and works with CHAR(14) as well because "i" sorts after all numbers.
| |||||||||||||||||||||
getLag () | |||||||||||||||||||||
Get the amount of replication lag for this database server. | |||||||||||||||||||||
getLBInfo ( $name=null) | |||||||||||||||||||||
Get properties passed down from the server info array of the load balancer. | |||||||||||||||||||||
getMasterPos () | |||||||||||||||||||||
Get the position of this master.
| |||||||||||||||||||||
getReplicaPos () | |||||||||||||||||||||
Get the replication position of this replica DB.
| |||||||||||||||||||||
getScopedLockAndFlush ( $lockKey, $fname, $timeout) | |||||||||||||||||||||
Acquire a named lock, flush any transaction, and return an RAII style unlocker object. | |||||||||||||||||||||
getServer () | |||||||||||||||||||||
Get the server hostname or IP address. | |||||||||||||||||||||
getServerInfo () | |||||||||||||||||||||
Get a human-readable string describing the current software version. | |||||||||||||||||||||
getServerUptime () | |||||||||||||||||||||
Determines how long the server has been up.
| |||||||||||||||||||||
getSessionLagStatus () | |||||||||||||||||||||
Get the replica DB lag when the current transaction started or a general lag estimate if not transaction is active. | |||||||||||||||||||||
getTopologyRole () | |||||||||||||||||||||
Get the replication topology role of this server. | |||||||||||||||||||||
getTopologyRootMaster () | |||||||||||||||||||||
Get the host (or address) of the root master server for the replication topology. | |||||||||||||||||||||
ignoreIndexClause ( $index) | |||||||||||||||||||||
IGNORE INDEX clause. | |||||||||||||||||||||
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.
| |||||||||||||||||||||
indexExists ( $table, $index, $fname=__METHOD__) | |||||||||||||||||||||
Determines whether an index exists. | |||||||||||||||||||||
initConnection () | |||||||||||||||||||||
Initialize the connection to the database over the wire (or to local files) | |||||||||||||||||||||
insert ( $table, $rows, $fname=__METHOD__, $options=[]) | |||||||||||||||||||||
Insert the given row(s) into a table. | |||||||||||||||||||||
insertSelect ( $destTable, $srcTable, $varMap, $conds, $fname=__METHOD__, $insertOptions=[], $selectOptions=[], $selectJoinConds=[]) | |||||||||||||||||||||
INSERT SELECT wrapper. | |||||||||||||||||||||
isOpen () | |||||||||||||||||||||
isQuotedIdentifier ( $name) | |||||||||||||||||||||
Returns if the given identifier looks quoted or not according to the database convention for quoting identifiers. | |||||||||||||||||||||
isReadOnly () | |||||||||||||||||||||
lastDoneWrites () | |||||||||||||||||||||
Get the last time the connection may have been used for a write query. | |||||||||||||||||||||
lastQuery () | |||||||||||||||||||||
Get the last query that sent on account of IDatabase::query() | |||||||||||||||||||||
limitResult ( $sql, $limit, $offset=false) | |||||||||||||||||||||
Construct a LIMIT query with optional offset.The SQL should be adjusted so that only the first $limit rows are returned. If $offset is provided as well, then the first $offset rows should be discarded, and the next $limit rows should be returned. If the result of the query is not ordered, then the rows to be returned are theoretically arbitrary.$sql is expected to be a SELECT, if that makes a difference.
| |||||||||||||||||||||
listViews ( $prefix=null, $fname=__METHOD__) | |||||||||||||||||||||
Lists all the VIEWs in the database.
| |||||||||||||||||||||
lockForUpdate ( $table, $conds='', $fname=__METHOD__, $options=[], $join_conds=[]) | |||||||||||||||||||||
Lock all rows meeting the given conditions/options FOR UPDATE. | |||||||||||||||||||||
lockIsFree ( $lockName, $method) | |||||||||||||||||||||
Check to see if a named lock is not locked by any thread (non-blocking)
| |||||||||||||||||||||
lockTables (array $read, array $write, $method) | |||||||||||||||||||||
Lock specific tables. | |||||||||||||||||||||
makeList (array $a, $mode=self::LIST_COMMA) | |||||||||||||||||||||
Makes an encoded list of strings from an array. | |||||||||||||||||||||
makeWhereFrom2d ( $data, $baseKey, $subKey) | |||||||||||||||||||||
Build a partial where clause from a 2-d array such as used for LinkBatch. | |||||||||||||||||||||
masterPosWait (DBMasterPos $pos, $timeout) | |||||||||||||||||||||
Wait for the replica DB to catch up to a given master position.Note that this does not start any new transactions. If any existing transaction is flushed, and this is called, then queries will reflect the point the DB was synced up to (on success) without interference from REPEATABLE-READ snapshots.
| |||||||||||||||||||||
maxListLen () | |||||||||||||||||||||
Return the maximum number of items allowed in a list, or 0 for unlimited.
| |||||||||||||||||||||
namedLocksEnqueue () | |||||||||||||||||||||
Check to see if a named lock used by lock() use blocking queues.
| |||||||||||||||||||||
newSelectQueryBuilder () | |||||||||||||||||||||
Create an empty SelectQueryBuilder which can be used to run queries against this connection.
| |||||||||||||||||||||
nextSequenceValue ( $seqName) | |||||||||||||||||||||
Deprecated method, calls should be removed. | |||||||||||||||||||||
onAtomicSectionCancel (callable $callback, $fname=__METHOD__) | |||||||||||||||||||||
Run a callback when the atomic section is cancelled. | |||||||||||||||||||||
onTransactionCommitOrIdle (callable $callback, $fname=__METHOD__) | |||||||||||||||||||||
Run a callback as soon as there is no transaction pending. | |||||||||||||||||||||
onTransactionIdle (callable $callback, $fname=__METHOD__) | |||||||||||||||||||||
Alias for onTransactionCommitOrIdle() for backwards-compatibility. | |||||||||||||||||||||
onTransactionPreCommitOrIdle (callable $callback, $fname=__METHOD__) | |||||||||||||||||||||
Run a callback before the current transaction commits or now if there is none. | |||||||||||||||||||||
onTransactionResolution (callable $callback, $fname=__METHOD__) | |||||||||||||||||||||
Run a callback as soon as the current transaction commits or rolls back. | |||||||||||||||||||||
pendingWriteAndCallbackCallers () | |||||||||||||||||||||
List the methods that have write queries or callbacks for the current transaction. | |||||||||||||||||||||
pendingWriteCallers () | |||||||||||||||||||||
Get the list of method names that did write queries for this transaction. | |||||||||||||||||||||
pendingWriteQueryDuration ( $type=self::ESTIMATE_TOTAL) | |||||||||||||||||||||
Get the time spend running write queries for this transaction. | |||||||||||||||||||||
pendingWriteRowsAffected () | |||||||||||||||||||||
Get the number of affected rows from pending write queries. | |||||||||||||||||||||
ping (&$rtt=null) | |||||||||||||||||||||
Ping the server and try to reconnect if it there is no connection. | |||||||||||||||||||||
preCommitCallbacksPending () | |||||||||||||||||||||
query ( $sql, $fname=__METHOD__, $flags=self::QUERY_NORMAL) | |||||||||||||||||||||
Run an SQL query and return the result. | |||||||||||||||||||||
replace ( $table, $uniqueKeys, $rows, $fname=__METHOD__) | |||||||||||||||||||||
Insert row(s) into a table, deleting all conflicting rows beforehand. | |||||||||||||||||||||
reportQueryError ( $error, $errno, $sql, $fname, $ignore=false) | |||||||||||||||||||||
Report a query error. | |||||||||||||||||||||
restoreFlags ( $state=self::RESTORE_PRIOR) | |||||||||||||||||||||
Restore the flags to their prior state before the last setFlag/clearFlag call. | |||||||||||||||||||||
rollback ( $fname=__METHOD__, $flush=self::FLUSHING_ONE) | |||||||||||||||||||||
Rollback a transaction previously started using begin() | |||||||||||||||||||||
runOnTransactionIdleCallbacks ( $trigger) | |||||||||||||||||||||
Actually consume and run any "on transaction idle/resolution" callbacks. | |||||||||||||||||||||
runOnTransactionPreCommitCallbacks () | |||||||||||||||||||||
Actually consume and run any "on transaction pre-commit" callbacks. | |||||||||||||||||||||
runTransactionListenerCallbacks ( $trigger) | |||||||||||||||||||||
Actually run any "transaction listener" callbacks. | |||||||||||||||||||||
select ( $table, $vars, $conds='', $fname=__METHOD__, $options=[], $join_conds=[]) | |||||||||||||||||||||
Execute a SELECT query constructed using the various parameters provided. | |||||||||||||||||||||
selectDB ( $db) | |||||||||||||||||||||
Change the current database. | |||||||||||||||||||||
selectDomain ( $domain) | |||||||||||||||||||||
Set the current domain (database, schema, and table prefix) | |||||||||||||||||||||
selectField ( $table, $var, $cond='', $fname=__METHOD__, $options=[], $join_conds=[]) | |||||||||||||||||||||
A SELECT wrapper which returns a single field from a single result row. | |||||||||||||||||||||
selectFieldValues ( $table, $var, $cond='', $fname=__METHOD__, $options=[], $join_conds=[]) | |||||||||||||||||||||
A SELECT wrapper which returns a list of single field values from result rows. | |||||||||||||||||||||
selectRow ( $table, $vars, $conds, $fname=__METHOD__, $options=[], $join_conds=[]) | |||||||||||||||||||||
Wrapper to IDatabase::select() that only fetches one row (via LIMIT) | |||||||||||||||||||||
selectRowCount ( $tables, $var=' *', $conds='', $fname=__METHOD__, $options=[], $join_conds=[]) | |||||||||||||||||||||
Get the number of rows in dataset. | |||||||||||||||||||||
selectSQLText ( $table, $vars, $conds='', $fname=__METHOD__, $options=[], $join_conds=[]) | |||||||||||||||||||||
Take the same arguments as IDatabase::select() and return the SQL it would use.This can be useful for making UNION queries, where the SQL text of each query is needed. In general, however, callers outside of Database classes should just use select().
| |||||||||||||||||||||
setBigSelects ( $value=true) | |||||||||||||||||||||
Allow or deny "big selects" for this session only.This is done by setting the sql_big_selects session variable.This is a MySQL-specific feature.
| |||||||||||||||||||||
setFlag ( $flag, $remember=self::REMEMBER_NOTHING) | |||||||||||||||||||||
Set a flag for this connection. | |||||||||||||||||||||
setIndexAliases (array $aliases) | |||||||||||||||||||||
Convert certain index names to alternative names before querying the DB.Note that this applies to indexes regardless of the table they belong to.This can be employed when an index was renamed X => Y in code, but the new Y-named indexes were not yet built on all DBs. After all the Y-named ones are added by the DBA, the aliases can be removed, and then the old X-named indexes dropped.
| |||||||||||||||||||||
setLBInfo ( $nameOrArray, $value=null) | |||||||||||||||||||||
Set the entire array or a particular key of the managing load balancer info array. | |||||||||||||||||||||
setLogger (LoggerInterface $logger) | |||||||||||||||||||||
Set the PSR-3 logger interface to use for query logging. | |||||||||||||||||||||
setSchemaVars ( $vars) | |||||||||||||||||||||
Set schema variables to be used when streaming commands from SQL files or stdin. | |||||||||||||||||||||
setSessionOptions (array $options) | |||||||||||||||||||||
Override database's default behavior.$options include: 'connTimeout' : Set the connection timeout value in seconds. May be useful for very long batch queries such as full-wiki dumps, where a single query reads out over hours or days.
| |||||||||||||||||||||
setTransactionListener ( $name, callable $callback=null) | |||||||||||||||||||||
Run a callback after each time any transaction commits or rolls back. | |||||||||||||||||||||
setTrxEndCallbackSuppression ( $suppress) | |||||||||||||||||||||
Whether to disable running of post-COMMIT/ROLLBACK callbacks. | |||||||||||||||||||||
sourceFile ( $filename, callable $lineCallback=null, callable $resultCallback=null, $fname=false, callable $inputCallback=null) | |||||||||||||||||||||
Read and execute SQL commands from a file. | |||||||||||||||||||||
sourceStream ( $fp, callable $lineCallback=null, callable $resultCallback=null, $fname=__METHOD__, callable $inputCallback=null) | |||||||||||||||||||||
Read and execute commands from an open file handle. | |||||||||||||||||||||
startAtomic ( $fname=__METHOD__, $cancelable=self::ATOMIC_NOT_CANCELABLE) | |||||||||||||||||||||
Begin an atomic section of SQL statements. | |||||||||||||||||||||
streamStatementEnd (&$sql, &$newLine) | |||||||||||||||||||||
Called by sourceStream() to check if we've reached a statement end. | |||||||||||||||||||||
strreplace ( $orig, $old, $new) | |||||||||||||||||||||
Returns a SQL expression for simple string replacement (e.g.REPLACE() in mysql)
| |||||||||||||||||||||
tableLocksHaveTransactionScope () | |||||||||||||||||||||
Checks if table locks acquired by lockTables() are transaction-bound in their scope. | |||||||||||||||||||||
tableNames (... $tables) | |||||||||||||||||||||
Fetch a number of table names into an array This is handy when you need to construct SQL for joins. | |||||||||||||||||||||
tableNamesN (... $tables) | |||||||||||||||||||||
Fetch a number of table names into an zero-indexed numerical array This is handy when you need to construct SQL for joins. | |||||||||||||||||||||
tablePrefix ( $prefix=null) | |||||||||||||||||||||
Get/set the table prefix. | |||||||||||||||||||||
timestamp ( $ts=0) | |||||||||||||||||||||
Convert a timestamp in one of the formats accepted by ConvertibleTimestamp to the format used for inserting into timestamp fields in this DBMS.The result is unquoted, and needs to be passed through addQuotes() before it can be included in raw SQL.
| |||||||||||||||||||||
timestampOrNull ( $ts=null) | |||||||||||||||||||||
Convert a timestamp in one of the formats accepted by ConvertibleTimestamp to the format used for inserting into timestamp fields in this DBMS. | |||||||||||||||||||||
truncate ( $tables, $fname=__METHOD__) | |||||||||||||||||||||
Delete all data in a table(s) and reset any sequences owned by that table(s) | |||||||||||||||||||||
trxLevel () | |||||||||||||||||||||
Gets the current transaction level. | |||||||||||||||||||||
trxStatus () | |||||||||||||||||||||
trxTimestamp () | |||||||||||||||||||||
Get the UNIX timestamp of the time that the transaction was established. | |||||||||||||||||||||
unionConditionPermutations ( $table, $vars, array $permute_conds, $extra_conds='', $fname=__METHOD__, $options=[], $join_conds=[]) | |||||||||||||||||||||
Construct a UNION query for permutations of conditions. | |||||||||||||||||||||
unlockTables ( $method) | |||||||||||||||||||||
Unlock all tables locked via lockTables() | |||||||||||||||||||||
update ( $table, $set, $conds, $fname=__METHOD__, $options=[]) | |||||||||||||||||||||
Update all rows in a table that match a given condition. | |||||||||||||||||||||
upsert ( $table, array $rows, $uniqueKeys, array $set, $fname=__METHOD__) | |||||||||||||||||||||
Upsert the given row(s) into a table. | |||||||||||||||||||||
useIndexClause ( $index) | |||||||||||||||||||||
USE INDEX clause. | |||||||||||||||||||||
wasConnectionLoss () | |||||||||||||||||||||
Determines if the last query error was due to a dropped connection.Note that during a connection loss, the prior transaction will have been lost
| |||||||||||||||||||||
wasErrorReissuable () | |||||||||||||||||||||
Determines if the last query error was due to something outside of the query itself. | |||||||||||||||||||||
wasLockTimeout () | |||||||||||||||||||||
Determines if the last failure was due to a lock timeout.Note that during a lock wait timeout, the prior transaction will have been lost
| |||||||||||||||||||||
writesOrCallbacksPending () | |||||||||||||||||||||
Whether there is a transaction open with either possible write queries or unresolved pre-commit/commit/resolution callbacks pending. | |||||||||||||||||||||
writesPending () | |||||||||||||||||||||
Public Member Functions inherited from Wikimedia\Rdbms\IDatabase | |||||||||||||||||||||
buildSubString ( $input, $startPosition, $length=null) | |||||||||||||||||||||
Build a SUBSTRING function. | |||||||||||||||||||||
Static Public Member Functions | |
static | generateFileName ( $dir, $dbName) |
Generates a database file name. | |
static | getFulltextSearchModule () |
Returns version of currently supported SQLite fulltext search module or false if none present. | |
static | newStandaloneInstance ( $filename, array $p=[]) |
Static Public Member Functions inherited from Wikimedia\Rdbms\Database | |
static | attributesFromType ( $dbType, $driver=null) |
static | factory ( $type, $params=[], $connect=self::NEW_CONNECTED) |
Construct a Database subclass instance given a database type and parameters. | |
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. | |
Protected Member Functions | |
closeConnection () | |
Does not actually close the connection, just destroys the reference for GC to do its work. | |
doBegin ( $fname='') | |
Issues the BEGIN command to the database server. | |
doHandleSessionLossPreconnect () | |
Reset any additional subclass trx* and session* fields Stable to override. | |
doQuery ( $sql) | |
SQLite doesn't allow buffered results or data seeking etc, so we'll use fetchAll as the result. | |
doReplace ( $table, array $uniqueKeys, array $rows, $fname) | |
doSelectDomain (DatabaseDomain $domain) | |
Stable to override. | |
doTruncate (array $tables, $fname) | |
fetchAffectedRowCount () | |
getBindingHandle () | |
isTransactableQuery ( $sql) | |
Determine whether a SQL statement is sensitive to isolation level. | |
isWriteQuery ( $sql, $flags) | |
Determine whether a query writes to the DB. | |
makeInsertNonConflictingVerbAndOptions () | |
Stable to override. | |
makeSelectOptions (array $options) | |
Returns an optional USE INDEX clause to go after the table, and a string to go at the end of the query. | |
makeUpdateOptionsArray ( $options) | |
open ( $server, $user, $pass, $dbName, $schema, $tablePrefix) | |
Open a new connection to the database (closing any existing one) | |
replaceVars ( $s) | |
wasKnownStatementRollbackError () | |
Stable to override. | |
Protected Member Functions inherited from Wikimedia\Rdbms\Database | |
assertBuildSubstringParams ( $startPosition, $length) | |
Check type and bounds for parameters to self::buildSubstring() | |
assertConditionIsNotEmpty ( $conds, string $fname, bool $deprecate) | |
Check type and bounds conditions parameters for update. | |
assertHasConnectionHandle () | |
Make sure there is an open connection handle (alive or not) as a sanity check. | |
assertIsWritableMaster () | |
Make sure that this server is not marked as a replica nor read-only as a sanity check. | |
buildSuperlative ( $sqlfunc, $fields, $values) | |
Build a superlative function statement comparing columns/values. | |
doCommit ( $fname) | |
Issues the COMMIT command to the database server. | |
doDropTable ( $table, $fname) | |
doGetLag () | |
Stable to override | |
doInitConnection () | |
Actually connect to the database over the wire (or to local files) | |
doInsert ( $table, array $rows, $fname) | |
doInsertNonConflicting ( $table, array $rows, $fname) | |
doInsertSelectGeneric ( $destTable, $srcTable, array $varMap, $conds, $fname, array $insertOptions, array $selectOptions, $selectJoinConds) | |
Implementation of insertSelect() based on select() and insert() | |
doInsertSelectNative ( $destTable, $srcTable, array $varMap, $conds, $fname, array $insertOptions, array $selectOptions, $selectJoinConds) | |
Native server-side implementation of insertSelect() for situations where we don't want to select everything into memory. | |
doLockTables (array $read, array $write, $method) | |
Helper function for lockTables() that handles the actual table locking. | |
doReleaseSavepoint ( $identifier, $fname) | |
Release a savepoint. | |
doRollback ( $fname) | |
Issues the ROLLBACK command to the database server. | |
doRollbackToSavepoint ( $identifier, $fname) | |
Rollback to a savepoint. | |
doSavepoint ( $identifier, $fname) | |
Create a savepoint. | |
doUnlockTables ( $method) | |
Helper function for unlockTables() that handles the actual table unlocking. | |
doUpsert ( $table, array $rows, array $uniqueKeys, array $set, $fname) | |
escapeLikeInternal ( $s, $escapeChar='`') | |
Stable to override. | |
executeQuery ( $sql, $fname, $flags) | |
Execute a query, retrying it if there is a recoverable connection loss. | |
extractSingleFieldFromList ( $var) | |
fieldHasBit ( $field, $flags) | |
fieldNamesWithAlias ( $fields) | |
Gets an array of aliased field names. | |
fieldNameWithAlias ( $name, $alias=false) | |
Get an aliased field name e.g. | |
getApproximateLagStatus () | |
Get a replica DB lag estimate for this server at the start of a transaction. | |
getDefaultSchemaVars () | |
Get schema variables to use if none have been set via setSchemaVars(). | |
getLastPHPError () | |
getLazyMasterHandle () | |
Get a handle to the master server of the cluster to which this server belongs. | |
getLogContext (array $extras=[]) | |
Create a log context to pass to PSR-3 logger functions. | |
getQueryVerb ( $sql) | |
getReadOnlyReason () | |
getRecordedTransactionLagStatus () | |
Get the replica DB lag when the current transaction started. | |
getSchemaVars () | |
Get schema variables. | |
getTempTableWrites ( $sql, $pseudoPermanent) | |
getTransactionRoundId () | |
indexName ( $index) | |
Allows for index remapping in queries where this is not consistent across DBMS. | |
installErrorHandler () | |
Set a custom error handler for logging errors during database connection. | |
isFlagInOptions ( $option, array $options) | |
isInsertSelectSafe (array $insertOptions, array $selectOptions) | |
Stable to override. | |
isPristineTemporaryTable ( $table) | |
Check if the table is both a TEMPORARY table and has not yet received CRUD operations. | |
makeConditionCollidesUponKeys (array $rows, array $uniqueKeys) | |
makeGroupByWithHaving ( $options) | |
Returns an optional GROUP BY with an optional HAVING. | |
makeInsertLists (array $rows) | |
Make SQL lists of columns, row tuples for INSERT/VALUES expressions. | |
makeOrderBy ( $options) | |
Returns an optional ORDER BY. | |
makeUpdateOptions ( $options) | |
Make UPDATE options for the Database::update function. | |
newExceptionAfterConnectError ( $error) | |
normalizeConditions ( $conds, $fname) | |
normalizeOptions ( $options) | |
normalizeRowArray (array $rowOrRows) | |
normalizeUpsertKeys ( $uniqueKeys) | |
qualifiedTableComponents ( $name) | |
Get the table components needed for a query given the currently selected database. | |
registerTempWrites ( $ret, array $changes) | |
relationSchemaQualifier () | |
Stable to override. | |
replaceLostConnection ( $fname) | |
Close any existing (dead) database connection and open a new connection. | |
restoreErrorHandler () | |
Restore the previous error handler and return the last PHP error for this DB. | |
resultObject ( $result) | |
Take a query result and wrap it in an iterable result wrapper if necessary. | |
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. | |
tableNameWithAlias ( $table, $alias=false) | |
Get an aliased table name. | |
wasQueryTimeout ( $error, $errno) | |
Checks whether the cause of the error is detected to be a timeout. | |
Static Protected Member Functions | |
static | getAttributes () |
Stable to override. | |
Protected Attributes | |
PDO | $conn |
string null | $dbDir |
Directory for SQLite database files listed under their DB name. | |
string null | $dbPath |
Explicit path for the SQLite database file. | |
int | $lastAffectedRowCount |
The number of rows affected as an integer. | |
FSLockManager | $lockMgr |
(hopefully on the same server as the DB) | |
string | $trxMode |
Transaction mode. | |
Protected Attributes inherited from Wikimedia\Rdbms\Database | |
integer null | $affectedRowCount |
Rows affected by the last query to query() or its CRUD wrappers. | |
string | $agent |
Agent name for query profiling. | |
bool | $cliMode |
Whether this PHP instance is for a CLI script. | |
object resource null | $conn |
Database connection. | |
array | $connectionParams |
Parameters used by initConnection() to establish a connection. | |
string[] int[] float[] | $connectionVariables |
SQL variables values to use for all new connections. | |
LoggerInterface | $connLogger |
DatabaseDomain | $currentDomain |
string | $delimiter = ';' |
Current SQL query delimiter. | |
callable | $deprecationLogger |
Deprecation logging callback. | |
callable | $errorLogger |
Error logging callback. | |
int | $flags |
Current bit field of class DBO_* constants. | |
string[] | $indexAliases = [] |
Current map of (index alias => index) | |
array | $lbInfo = [] |
Current LoadBalancer tracking information. | |
int | $nonNativeInsertSelectBatchSize |
Row batch size to use for emulated INSERT SELECT queries. | |
string | $password |
Password used to establish the current connection. | |
callable null | $profiler |
LoggerInterface | $queryLogger |
LoggerInterface | $replLogger |
array null | $schemaVars |
Current variables use for schema element placeholders. | |
string | $server |
Server that this instance is currently connected to. | |
array | $sessionDirtyTempTables = [] |
Map of (table name => 1) for current TEMPORARY tables. | |
array | $sessionNamedLocks = [] |
Map of (name => 1) for locks obtained via lock() | |
array | $sessionTempTables = [] |
Map of (table name => 1) for current TEMPORARY tables. | |
BagOStuff | $srvCache |
APC cache. | |
array[] | $tableAliases = [] |
Current map of (table => (dbname, schema, prefix) map) | |
string | $topologyRole |
Replication topology role of the server; one of the class ROLE_* constants. | |
string null | $topologyRootMaster |
Host (or address) of the root master server for the replication topology. | |
TransactionProfiler | $trxProfiler |
string | $user |
User that this instance is currently connected under the name of. | |
Private Member Functions | |
attachDatabasesFromTableAliases () | |
Issue ATTATCH statements for all unattached foreign DBs in table aliases. | |
getDefaultPragmas () | |
rewriteIgnoreKeyword ( $options) | |
Static Private Member Functions | |
static | generateDatabaseName ( $path) |
static | isProcessMemoryPath ( $path) |
Private Attributes | |
array | $sessionAttachedDbs = [] |
List of shared database already attached to this connection. | |
string null | $version |
Static Private Attributes | |
static string[][] | $VALID_PRAGMAS |
static string[] | $VALID_TRX_MODES = [ '', 'DEFERRED', 'IMMEDIATE', 'EXCLUSIVE' ] |
See https://www.sqlite.org/lang_transaction.html. | |
Additional Inherited Members | |
Static Protected Attributes inherited from Wikimedia\Rdbms\Database | |
static int | $DBO_MUTABLE |
Bit field of all DBO_* flags that can be changed after connection. | |
static string[] | $MUTABLE_FLAGS |
List of DBO_* flags that can be changed after connection. | |
Definition at line 37 of file DatabaseSqlite.php.
Wikimedia\Rdbms\DatabaseSqlite::__construct | ( | array | $params | ) |
Additional params include:
array | $params |
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 78 of file DatabaseSqlite.php.
References Wikimedia\Rdbms\DatabaseSqlite\generateDatabaseName(), Wikimedia\Rdbms\Database\getDomainID(), and Wikimedia\Rdbms\DatabaseSqlite\getLockFileDirectory().
Wikimedia\Rdbms\DatabaseSqlite::addQuotes | ( | $s | ) |
string | int | float | null | bool | Blob | $s |
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 831 of file DatabaseSqlite.php.
References $s, and Wikimedia\Rdbms\DatabaseSqlite\getBindingHandle().
Referenced by Wikimedia\Rdbms\DatabaseSqlite\attachDatabase(), Wikimedia\Rdbms\DatabaseSqlite\buildGroupConcatField(), Wikimedia\Rdbms\DatabaseSqlite\doTruncate(), Wikimedia\Rdbms\DatabaseSqlite\duplicateTableStructure(), Wikimedia\Rdbms\DatabaseSqlite\fieldInfo(), Wikimedia\Rdbms\DatabaseSqlite\indexInfo(), Wikimedia\Rdbms\DatabaseSqlite\strencode(), and Wikimedia\Rdbms\DatabaseSqlite\tableExists().
Wikimedia\Rdbms\DatabaseSqlite::attachDatabase | ( | $name, | |
$file = false , |
|||
$fname = __METHOD__ |
|||
) |
Attaches external database to the connection handle.
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 337 of file DatabaseSqlite.php.
References $file, Wikimedia\Rdbms\DatabaseSqlite\addQuotes(), Wikimedia\Rdbms\DatabaseSqlite\generateFileName(), and Wikimedia\Rdbms\Database\query().
Referenced by Wikimedia\Rdbms\DatabaseSqlite\attachDatabasesFromTableAliases().
|
private |
Issue ATTATCH statements for all unattached foreign DBs in table aliases.
Definition at line 1145 of file DatabaseSqlite.php.
References Wikimedia\Rdbms\DatabaseSqlite\attachDatabase(), and Wikimedia\Rdbms\Database\getDBname().
Referenced by Wikimedia\Rdbms\DatabaseSqlite\open(), and Wikimedia\Rdbms\DatabaseSqlite\setTableAliases().
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 969 of file DatabaseSqlite.php.
Wikimedia\Rdbms\DatabaseSqlite::buildGreatest | ( | $fields, | |
$values | |||
) |
Build a GREATEST function statement comparing columns/values.Integer and float values in $values will not be quotedIf $fields is an array, then each value with a string key is treated as an expression (which must be manually quoted); such string keys do not appear in the SQL and are only descriptive aliases.
string | string[] | $fields | Name(s) of column(s) with values to compare |
string | int | float | string[] | int[] | float[] | $values | Values to compare |
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 981 of file DatabaseSqlite.php.
References Wikimedia\Rdbms\Database\buildSuperlative().
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 973 of file DatabaseSqlite.php.
References Wikimedia\Rdbms\DatabaseSqlite\addQuotes(), and Wikimedia\Rdbms\Database\selectSQLText().
Wikimedia\Rdbms\DatabaseSqlite::buildLeast | ( | $fields, | |
$values | |||
) |
Build a LEAST function statement comparing columns/values.Integer and float values in $values will not be quotedIf $fields is an array, then each value with a string key is treated as an expression (which must be manually quoted); such string keys do not appear in the SQL and are only descriptive aliases.
string | string[] | $fields | Name(s) of column(s) with values to compare |
string | int | float | string[] | int[] | float[] | $values | Values to compare |
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 985 of file DatabaseSqlite.php.
References Wikimedia\Rdbms\Database\buildSuperlative().
Wikimedia\Rdbms\DatabaseSqlite::buildStringCast | ( | $field | ) |
string | $field | Field or column to cast |
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 874 of file DatabaseSqlite.php.
Wikimedia\Rdbms\DatabaseSqlite::buildSubstring | ( | $input, | |
$startPosition, | |||
$length = null |
|||
) |
Stable to override Stable to override
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 860 of file DatabaseSqlite.php.
References Wikimedia\Rdbms\Database\assertBuildSubstringParams().
|
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 247 of file DatabaseSqlite.php.
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 logically separate, with different database users, requiring special mechanisms like postgres_fdw to "mount" foreign DBs. This is true even among DBs on the same server. Changing the selected database via selectDomain() requires a new connection.
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 1157 of file DatabaseSqlite.php.
Wikimedia\Rdbms\DatabaseSqlite::dataSeek | ( | $res, | |
$row | |||
) |
IResultWrapper | array | $res | |
int | $row |
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 531 of file DatabaseSqlite.php.
References $res, and Wikimedia\Rdbms\ResultWrapper\unwrap().
Wikimedia\Rdbms\DatabaseSqlite::deadlockLoop | ( | $args | ) |
No-op version of deadlockLoop.
mixed | ...$args |
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 884 of file DatabaseSqlite.php.
References $args.
Wikimedia\Rdbms\DatabaseSqlite::decodeBlob | ( | $b | ) |
Blob | string | $b |
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 819 of file DatabaseSqlite.php.
|
protected |
Issues the BEGIN command to the database server.
string | $fname |
DBError |
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 791 of file DatabaseSqlite.php.
References Wikimedia\Rdbms\Database\query().
|
protected |
Reset any additional subclass trx* and session* fields Stable to override.
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 1161 of file DatabaseSqlite.php.
|
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 366 of file DatabaseSqlite.php.
References $res, Wikimedia\Rdbms\DatabaseSqlite\getBindingHandle(), and Wikimedia\Rdbms\ResultWrapper\unwrap().
|
protected |
string | $table | |
string[][] | $uniqueKeys | Non-empty list of unique keys |
array | $rows | Non-empty list of rows |
string | $fname |
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 681 of file DatabaseSqlite.php.
References Wikimedia\Rdbms\Database\makeInsertLists(), Wikimedia\Rdbms\Database\query(), and Wikimedia\Rdbms\DatabaseSqlite\tableName().
|
protected |
Stable to override.
DatabaseDomain | $domain |
DBConnectionError | |
DBError |
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 471 of file DatabaseSqlite.php.
References Wikimedia\Rdbms\DatabaseDomain\getDatabase(), Wikimedia\Rdbms\Database\getDBname(), Wikimedia\Rdbms\DatabaseDomain\getSchema(), and Wikimedia\Rdbms\DatabaseDomain\getTablePrefix().
|
protected |
string[] | $tables | |
string | $fname |
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 1113 of file DatabaseSqlite.php.
References Wikimedia\Rdbms\Database\addIdentifierQuotes(), Wikimedia\Rdbms\DatabaseSqlite\addQuotes(), Wikimedia\Rdbms\Database\endAtomic(), Wikimedia\Rdbms\Database\query(), Wikimedia\Rdbms\Database\startAtomic(), and Wikimedia\Rdbms\DatabaseSqlite\tableName().
Wikimedia\Rdbms\DatabaseSqlite::dropTable | ( | $table, | |
$fname = __METHOD__ |
|||
) |
Delete a table.
string | $table | |
string | $fname |
DBError | If an error occurs |
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 1101 of file DatabaseSqlite.php.
References Wikimedia\Rdbms\Database\query(), Wikimedia\Rdbms\DatabaseSqlite\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 997 of file DatabaseSqlite.php.
References $res, Wikimedia\Rdbms\Database\addIdentifierQuotes(), Wikimedia\Rdbms\DatabaseSqlite\addQuotes(), Wikimedia\Rdbms\DatabaseSqlite\fetchObject(), and Wikimedia\Rdbms\Database\query().
Wikimedia\Rdbms\DatabaseSqlite::encodeBlob | ( | $b | ) |
string | $b |
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 811 of file DatabaseSqlite.php.
|
protected |
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 569 of file DatabaseSqlite.php.
References Wikimedia\Rdbms\DatabaseSqlite\$lastAffectedRowCount.
Wikimedia\Rdbms\DatabaseSqlite::fetchObject | ( | $res | ) |
IResultWrapper | array | $res |
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 392 of file DatabaseSqlite.php.
References $res, and Wikimedia\Rdbms\ResultWrapper\unwrap().
Referenced by Wikimedia\Rdbms\DatabaseSqlite\duplicateTableStructure().
Wikimedia\Rdbms\DatabaseSqlite::fetchRow | ( | $res | ) |
IResultWrapper | mixed | $res |
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 415 of file DatabaseSqlite.php.
References $res, and Wikimedia\Rdbms\ResultWrapper\unwrap().
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\IMaintainableDatabase.
Definition at line 778 of file DatabaseSqlite.php.
References $res, Wikimedia\Rdbms\DatabaseSqlite\addQuotes(), Wikimedia\Rdbms\Database\query(), and Wikimedia\Rdbms\DatabaseSqlite\tableName().
Wikimedia\Rdbms\DatabaseSqlite::fieldName | ( | $res, | |
$n | |||
) |
IResultWrapper | $res | |
int | $n |
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 460 of file DatabaseSqlite.php.
References $keys, $res, and Wikimedia\Rdbms\ResultWrapper\unwrap().
Wikimedia\Rdbms\DatabaseSqlite::freeResult | ( | $res | ) |
IResultWrapper | mixed | $res |
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 382 of file DatabaseSqlite.php.
References $res.
|
staticprivate |
string | $path |
Definition at line 279 of file DatabaseSqlite.php.
References $path.
Referenced by Wikimedia\Rdbms\DatabaseSqlite\__construct().
|
static |
Generates a database file name.
Explicitly public for installer.
string | $dir | Directory where database resides |
string | bool | $dbName | Database name (or false from Database::factory, validated here) |
DBUnexpectedError |
Definition at line 260 of file DatabaseSqlite.php.
Referenced by Wikimedia\Rdbms\DatabaseSqlite\attachDatabase(), Wikimedia\Rdbms\DatabaseSqlite\getDbFilePath(), and Wikimedia\Rdbms\DatabaseSqlite\open().
|
staticprotected |
Stable to override.
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 103 of file DatabaseSqlite.php.
References true.
|
protected |
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 1168 of file DatabaseSqlite.php.
Referenced by Wikimedia\Rdbms\DatabaseSqlite\addQuotes(), Wikimedia\Rdbms\DatabaseSqlite\doQuery(), Wikimedia\Rdbms\DatabaseSqlite\getServerVersion(), and Wikimedia\Rdbms\DatabaseSqlite\insertId().
Wikimedia\Rdbms\DatabaseSqlite::getDbFilePath | ( | ) |
DBUnexpectedError |
Definition at line 226 of file DatabaseSqlite.php.
References Wikimedia\Rdbms\DatabaseSqlite\generateFileName(), and Wikimedia\Rdbms\Database\getDBname().
Referenced by SqliteMaintenance\backup(), Wikimedia\Rdbms\DatabaseSqlite\serverIsReadOnly(), and SqliteMaintenance\vacuum().
|
private |
Definition at line 211 of file DatabaseSqlite.php.
Referenced by Wikimedia\Rdbms\DatabaseSqlite\open().
|
static |
Returns version of currently supported SQLite fulltext search module or false if none present.
Definition at line 304 of file DatabaseSqlite.php.
References Wikimedia\Rdbms\DatabaseSqlite\newStandaloneInstance().
Wikimedia\Rdbms\DatabaseSqlite::getLockFileDirectory | ( | ) |
Definition at line 233 of file DatabaseSqlite.php.
Referenced by Wikimedia\Rdbms\DatabaseSqlite\__construct().
Wikimedia\Rdbms\DatabaseSqlite::getServerVersion | ( | ) |
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 762 of file DatabaseSqlite.php.
References Wikimedia\Rdbms\DatabaseSqlite\$version, and Wikimedia\Rdbms\DatabaseSqlite\getBindingHandle().
Referenced by SqliteInstaller\checkPrerequisites().
Wikimedia\Rdbms\DatabaseSqlite::getSoftwareLink | ( | ) |
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 755 of file DatabaseSqlite.php.
Wikimedia\Rdbms\DatabaseSqlite::getType | ( | ) |
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 132 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 599 of file DatabaseSqlite.php.
References $res, Wikimedia\Rdbms\DatabaseSqlite\addQuotes(), Wikimedia\Rdbms\Database\indexName(), and Wikimedia\Rdbms\Database\query().
Wikimedia\Rdbms\DatabaseSqlite::indexUnique | ( | $table, | |
$index, | |||
$fname = __METHOD__ |
|||
) |
string | $table | |
string | $index | |
string | $fname |
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 619 of file DatabaseSqlite.php.
References Wikimedia\Rdbms\Database\indexName(), and Wikimedia\Rdbms\Database\selectRow().
Wikimedia\Rdbms\DatabaseSqlite::insertId | ( | ) |
This must be called after nextSequenceVal.
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 522 of file DatabaseSqlite.php.
References Wikimedia\Rdbms\DatabaseSqlite\getBindingHandle().
|
staticprivate |
string | $path |
Definition at line 296 of file DatabaseSqlite.php.
References $path.
|
protected |
Determine whether a SQL statement is sensitive to isolation level.
A SQL statement is considered transactable if its result could vary depending on the transaction isolation level. Operational commands such as 'SET' and 'SHOW' are not considered to be transactable.
Main purpose: Used by query() to decide whether to begin a transaction before the current query (in DBO_TRX mode, on by default).
Stable to override
string | $sql |
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 352 of file DatabaseSqlite.php.
References Wikimedia\Rdbms\Database\getQueryVerb().
|
protected |
Determine whether a query writes to the DB.
When in doubt, this returns true.
Main use cases:
string | $sql | |
int | $flags | Query flags to query() |
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 348 of file DatabaseSqlite.php.
References Wikimedia\Rdbms\Database\$flags.
Wikimedia\Rdbms\DatabaseSqlite::lastErrno | ( | ) |
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 556 of file DatabaseSqlite.php.
Referenced by Wikimedia\Rdbms\DatabaseSqlite\wasDeadlock(), and Wikimedia\Rdbms\DatabaseSqlite\wasReadOnlyError().
Wikimedia\Rdbms\DatabaseSqlite::lastError | ( | ) |
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 544 of file DatabaseSqlite.php.
Wikimedia\Rdbms\DatabaseSqlite::listTables | ( | $prefix = null , |
|
$fname = __METHOD__ |
|||
) |
List all tables on the database.
string | null | $prefix | Only show tables with this prefix, e.g. mw_ |
string | $fname | Calling function name |
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 1078 of file DatabaseSqlite.php.
References Wikimedia\Rdbms\Database\query().
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 (0 means non-blocking) |
DBError | If an error occurs, see IDatabase::query() |
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 947 of file DatabaseSqlite.php.
References LockManager\LOCK_EX.
|
protected |
Stable to override.
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 677 of file DatabaseSqlite.php.
|
protected |
Returns an optional USE INDEX clause to go after the table, and a string to go at the end of the query.
Stable to override
array | $options | Associative array of options to be turned into an SQL query, valid keys are listed in the function. |
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 640 of file DatabaseSqlite.php.
|
protected |
array | $options |
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 655 of file DatabaseSqlite.php.
References Wikimedia\Rdbms\DatabaseSqlite\rewriteIgnoreKeyword().
|
static |
string | $filename | |
array | $p | Options map; supports:
|
Definition at line 119 of file DatabaseSqlite.php.
References Wikimedia\Rdbms\Database\factory().
Referenced by Wikimedia\Rdbms\DatabaseSqlite\getFulltextSearchModule().
Wikimedia\Rdbms\DatabaseSqlite::numFields | ( | $res | ) |
IResultWrapper | $res |
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 444 of file DatabaseSqlite.php.
References $res, and Wikimedia\Rdbms\ResultWrapper\unwrap().
Wikimedia\Rdbms\DatabaseSqlite::numRows | ( | $res | ) |
The PDO::Statement class implements the array interface so count() will work.
IResultWrapper | array | false | $res |
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 433 of file DatabaseSqlite.php.
References $res, and Wikimedia\Rdbms\ResultWrapper\unwrap().
|
protected |
Open a new connection to the database (closing any existing one)
string | null | $server | Database server host |
string | null | $user | Database user name |
string | null | $password | Database user password |
string | null | $dbName | Database name |
string | null | $schema | Database schema name |
string | $tablePrefix | Table prefix |
DBConnectionError |
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 136 of file DatabaseSqlite.php.
References Wikimedia\Rdbms\DatabaseSqlite\$dbPath, Wikimedia\Rdbms\Database\$flags, $path, Wikimedia\Rdbms\DatabaseSqlite\attachDatabasesFromTableAliases(), Wikimedia\Rdbms\Database\close(), Wikimedia\Rdbms\DatabaseSqlite\generateFileName(), Wikimedia\Rdbms\DatabaseSqlite\getDefaultPragmas(), Wikimedia\Rdbms\Database\getFlag(), Wikimedia\Rdbms\Database\getLogContext(), Wikimedia\Rdbms\Database\newExceptionAfterConnectError(), and Wikimedia\Rdbms\Database\query().
|
protected |
string | $s |
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 894 of file DatabaseSqlite.php.
References $s.
|
private |
array | $options |
Definition at line 666 of file DatabaseSqlite.php.
Referenced by Wikimedia\Rdbms\DatabaseSqlite\makeUpdateOptionsArray().
Wikimedia\Rdbms\DatabaseSqlite::serverIsReadOnly | ( | ) |
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 744 of file DatabaseSqlite.php.
References $path, Wikimedia\Rdbms\Database\assertHasConnectionHandle(), and Wikimedia\Rdbms\DatabaseSqlite\getDbFilePath().
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.
array[] | $aliases | Map of (table => (dbname, schema, prefix) map) |
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 1135 of file DatabaseSqlite.php.
References Wikimedia\Rdbms\DatabaseSqlite\attachDatabasesFromTableAliases(), and Wikimedia\Rdbms\Database\isOpen().
Wikimedia\Rdbms\DatabaseSqlite::strencode | ( | $s | ) |
string | $s |
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 803 of file DatabaseSqlite.php.
References $s, and Wikimedia\Rdbms\DatabaseSqlite\addQuotes().
Wikimedia\Rdbms\DatabaseSqlite::tableExists | ( | $table, | |
$fname = __METHOD__ |
|||
) |
Query whether a given table exists.
string | $table | |
string | $fname |
DBError | If an error occurs, see IDatabase::query() |
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 573 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().
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 508 of file DatabaseSqlite.php.
Referenced by Wikimedia\Rdbms\DatabaseSqlite\doReplace(), Wikimedia\Rdbms\DatabaseSqlite\doTruncate(), Wikimedia\Rdbms\DatabaseSqlite\dropTable(), Wikimedia\Rdbms\DatabaseSqlite\fieldInfo(), and Wikimedia\Rdbms\DatabaseSqlite\tableExists().
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 696 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 712 of file DatabaseSqlite.php.
Wikimedia\Rdbms\DatabaseSqlite::unionSupportsOrderAndLimit | ( | ) |
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 703 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 |
DBError | If an error occurs, see IDatabase::query() |
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 959 of file DatabaseSqlite.php.
References LockManager\LOCK_EX.
Wikimedia\Rdbms\DatabaseSqlite::wasConnectionError | ( | $errno | ) |
Do not use this method outside of Database/DBError classes.
Stable to override
int | string | $errno |
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 732 of file DatabaseSqlite.php.
Wikimedia\Rdbms\DatabaseSqlite::wasDeadlock | ( | ) |
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 721 of file DatabaseSqlite.php.
References Wikimedia\Rdbms\DatabaseSqlite\lastErrno().
|
protected |
Stable to override.
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 736 of file DatabaseSqlite.php.
Wikimedia\Rdbms\DatabaseSqlite::wasReadOnlyError | ( | ) |
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 728 of file DatabaseSqlite.php.
References Wikimedia\Rdbms\DatabaseSqlite\lastErrno().
|
protected |
Definition at line 49 of file DatabaseSqlite.php.
|
protected |
Directory for SQLite database files listed under their DB name.
Definition at line 39 of file DatabaseSqlite.php.
|
protected |
Explicit path for the SQLite database file.
Definition at line 41 of file DatabaseSqlite.php.
Referenced by Wikimedia\Rdbms\DatabaseSqlite\open().
|
protected |
The number of rows affected as an integer.
Definition at line 46 of file DatabaseSqlite.php.
Referenced by Wikimedia\Rdbms\DatabaseSqlite\fetchAffectedRowCount().
|
protected |
(hopefully on the same server as the DB)
Definition at line 52 of file DatabaseSqlite.php.
|
private |
List of shared database already attached to this connection.
Definition at line 58 of file DatabaseSqlite.php.
|
protected |
Transaction mode.
Definition at line 43 of file DatabaseSqlite.php.
|
staticprivate |
Definition at line 64 of file DatabaseSqlite.php.
|
staticprivate |
See https://www.sqlite.org/lang_transaction.html.
Definition at line 61 of file DatabaseSqlite.php.
|
private |
Definition at line 55 of file DatabaseSqlite.php.
Referenced by Wikimedia\Rdbms\DatabaseSqlite\getServerVersion().