MediaWiki
1.33.0
|
Public Member Functions | |
__construct (array $params) | |
addQuotes ( $s) | |
Adds quotes and backslashes. More... | |
aggregateValue ( $valuedata, $valuename='value') | |
Return aggregated value alias. More... | |
buildConcat ( $stringList) | |
Build a concatenation list to feed into a SQL query. More... | |
buildGroupConcatField ( $delimiter, $table, $field, $conds='', $options=[], $join_conds=[]) | |
buildStringCast ( $field) | |
constraintExists ( $table, $constraint) | |
currentSequenceValue ( $seqName) | |
Return the current value of a sequence. More... | |
databasesAreIndependent () | |
Returns true if DBs are assumed to be on potentially different servers. More... | |
dataSeek ( $res, $row) | |
Change the position of the cursor in a result object. More... | |
decodeBlob ( $b) | |
Some DBMSs return a special placeholder object representing blob fields in result objects. More... | |
determineCoreSchema ( $desiredSchema) | |
Determine default schema for the current application Adjust this session schema search path if desired schema exists and is not alread there. More... | |
doLockTables (array $read, array $write, $method) | |
Helper function for lockTables() that handles the actual table locking. More... | |
doQuery ( $sql) | |
doSelectDomain (DatabaseDomain $domain) | |
duplicateTableStructure ( $oldName, $newName, $temporary=false, $fname=__METHOD__) | |
Creates a new table with structure copied from existing table. More... | |
encodeBlob ( $b) | |
Some DBMSs have a special format for inserting into blob fields, they don't allow simple quoted strings to be inserted. More... | |
estimateRowCount ( $table, $var=' *', $conds='', $fname=__METHOD__, $options=[], $join_conds=[]) | |
Estimate rows in dataset Returns estimated count, based on EXPLAIN output This is not necessarily an accurate estimate, so use sparingly Returns -1 if count cannot be found Takes same arguments as Database::select() More... | |
fetchObject ( $res) | |
Fetch the next row from the given result object, in object form. More... | |
fetchRow ( $res) | |
Fetch the next row from the given result object, in associative array form. More... | |
fieldInfo ( $table, $field) | |
fieldName ( $res, $n) | |
Get a field name in a result object. More... | |
fieldType ( $res, $index) | |
pg_field_type() wrapper More... | |
freeResult ( $res) | |
Free a result object returned by query() or select(). More... | |
getCoreSchema () | |
Return schema name for core application tables. More... | |
getCoreSchemas () | |
Return schema names for temporary tables and core application tables. More... | |
getCurrentSchema () | |
Return current schema (executes SELECT current_schema()) Needs transaction. More... | |
getSchemas () | |
Return list of schemas which are accessible without schema name This is list does not contain magic keywords like "$user" Needs transaction. More... | |
getSearchPath () | |
Return search patch for schemas This is different from getSchemas() since it contain magic keywords (like "$user"). More... | |
getServerVersion () | |
A string describing the current software version, like from mysql_get_server_info(). More... | |
getSoftwareLink () | |
Returns a wikitext link to the DB's website, e.g., return "[https://www.mysql.com/ MySQL]"; Should at least contain plain text, if for some reason your database has no website. More... | |
getType () | |
Get the type of the DBMS, as it appears in $wgDBtype. More... | |
hasConstraint ( $name) | |
implicitGroupby () | |
Returns true if this database does an implicit sort when doing GROUP BY. More... | |
implicitOrderby () | |
Returns true if this database does an implicit order by when the column has an index For example: SELECT page_title FROM page LIMIT 1. More... | |
indexAttributes ( $index, $schema=false) | |
indexInfo ( $table, $index, $fname=__METHOD__) | |
Get information about an index into an object. More... | |
indexUnique ( $table, $index, $fname=__METHOD__) | |
insert ( $table, $args, $fname=__METHOD__, $options=[]) | |
@inheritDoc More... | |
insertId () | |
Get the inserted value of an auto-increment row. More... | |
lastErrno () | |
Get the last error number. More... | |
lastError () | |
Get a description of the last error. More... | |
limitResult ( $sql, $limit, $offset=false) | |
Construct a LIMIT query with optional offset. More... | |
listTables ( $prefix=null, $fname=__METHOD__) | |
@suppress SecurityCheck-SQLInjection array_map not recognized T204911 More... | |
lock ( $lockName, $method, $timeout=5) | |
Acquire a named lock. More... | |
lockIsFree ( $lockName, $method) | |
Check to see if a named lock is not locked by any thread (non-blocking) More... | |
makeSelectOptions ( $options) | |
Returns an optional USE INDEX clause to go after the table, and a string to go at the end of the query. More... | |
nextSequenceValue ( $seqName) | |
Deprecated method, calls should be removed. More... | |
numFields ( $res) | |
Get the number of fields in a result object. More... | |
numRows ( $res) | |
Get the number of rows in a query result. More... | |
realTableName ( $name, $format='quoted') | |
remappedTableName ( $name) | |
resetSequenceForTable ( $table, $fname=__METHOD__) | |
roleExists ( $roleName) | |
Returns true if a given role (i.e. More... | |
ruleExists ( $table, $rule) | |
schemaExists ( $schema) | |
Query whether a given schema exists. 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... | |
sequenceExists ( $sequence, $schema=false) | |
serverIsReadOnly () | |
streamStatementEnd (&$sql, &$newLine) | |
Called by sourceStream() to check if we've reached a statement end. More... | |
strencode ( $s) | |
Wrapper for addslashes() More... | |
tableExists ( $table, $fname=__METHOD__, $schema=false) | |
For backward compatibility, this function checks both tables and views. More... | |
tableName ( $name, $format='quoted') | |
Format a table name ready for use in constructing an SQL query. More... | |
textFieldSize ( $table, $field) | |
Returns the size of a text field, or -1 for "unlimited". More... | |
timestamp ( $ts=0) | |
Convert a timestamp in one of the formats accepted by wfTimestamp() to the format used for inserting into timestamp fields in this DBMS. More... | |
triggerExists ( $table, $trigger) | |
unlock ( $lockName, $method) | |
Release a lock. More... | |
wasConnectionError ( $errno) | |
Do not use this method outside of Database/DBError classes. More... | |
wasDeadlock () | |
Determines if the last failure was due to a deadlock. More... | |
wasLockTimeout () | |
Determines if the last failure was due to a lock timeout. More... | |
Public Member Functions inherited from Wikimedia\Rdbms\Database | |
__clone () | |
Make sure that copies do not share the same client binding handle. More... | |
__destruct () | |
Run a few simple sanity checks and close dangling connections. More... | |
__sleep () | |
Called by serialize. More... | |
__toString () | |
addIdentifierQuotes ( $s) | |
Quotes an identifier, in order to make user controlled input safe. More... | |
affectedRows () | |
Get the number of rows affected by the last write query. More... | |
anyChar () | |
Returns a token for buildLike() that denotes a '_' to be used in a LIKE query. More... | |
anyString () | |
Returns a token for buildLike() that denotes a '' to be used in a LIKE query. More... | |
assertNoOpenTransactions () | |
Assert that all explicit transactions or atomic sections have been closed. More... | |
begin ( $fname=__METHOD__, $mode=self::TRANSACTION_EXPLICIT) | |
Begin a transaction. More... | |
bitAnd ( $fieldLeft, $fieldRight) | |
bitNot ( $field) | |
bitOr ( $fieldLeft, $fieldRight) | |
bufferResults ( $buffer=null) | |
Turns buffering of SQL result sets on (true) or off (false). More... | |
buildGroupConcatField ( $delim, $table, $field, $conds='', $join_conds=[]) | |
Build a GROUP_CONCAT or equivalent statement for a query. More... | |
buildIntegerCast ( $field) | |
buildLike () | |
LIKE statement wrapper, receives a variable-length argument list with parts of pattern to match containing either string literals that will be escaped or tokens returned by anyChar() or anyString(). More... | |
buildSelectSubquery ( $table, $vars, $conds='', $fname=__METHOD__, $options=[], $join_conds=[]) | |
Equivalent to IDatabase::selectSQLText() except wraps the result in Subqyery. More... | |
buildSubstring ( $input, $startPosition, $length=null) | |
cancelAtomic ( $fname=__METHOD__, AtomicSectionIdentifier $sectionId=null) | |
Cancel an atomic section of SQL statements. More... | |
clearFlag ( $flag, $remember=self::REMEMBER_NOTHING) | |
Clear a flag for this connection. More... | |
close () | |
Close the database connection. More... | |
commit ( $fname=__METHOD__, $flush=self::FLUSHING_ONE) | |
Commits a transaction previously started using begin(). More... | |
conditional ( $cond, $trueVal, $falseVal) | |
Returns an SQL expression for a simple conditional. More... | |
connectionErrorLogger ( $errno, $errstr) | |
Error handler for logging errors during database connection This method should not be used outside of Database classes. More... | |
dbSchema ( $schema=null) | |
Get/set the db schema. More... | |
deadlockLoop () | |
Perform a deadlock-prone transaction. More... | |
decodeExpiry ( $expiry, $format=TS_MW) | |
Decode an expiry time into a DBMS independent format. More... | |
delete ( $table, $conds, $fname=__METHOD__) | |
DELETE query wrapper. More... | |
deleteJoin ( $delTable, $joinTable, $delVar, $joinVar, $conds, $fname=__METHOD__) | |
DELETE where the condition is a join. More... | |
doAtomicSection ( $fname, callable $callback, $cancelable=self::ATOMIC_NOT_CANCELABLE) | |
Perform an atomic section of reversable SQL statements from a callback. More... | |
doneWrites () | |
Returns true if the connection may have been used for write queries. More... | |
dropTable ( $tableName, $fName=__METHOD__) | |
Delete a table. More... | |
encodeExpiry ( $expiry) | |
Encode an expiry time into the DBMS dependent format. More... | |
endAtomic ( $fname=__METHOD__) | |
Ends an atomic section of SQL statements. 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 () | |
Return the currently selected domain ID. More... | |
getFlag ( $flag) | |
Returns a boolean whether the flag $flag is set for this connection. More... | |
getInfinity () | |
Find out when 'infinity' is. More... | |
getLag () | |
Get the amount of replication lag for this database server. More... | |
getLBInfo ( $name=null) | |
Get properties passed down from the server info array of the load balancer. More... | |
getMasterPos () | |
Get the position of this master. More... | |
getProperty ( $name) | |
getReplicaPos () | |
Get the replication position of this replica DB. More... | |
getScopedLockAndFlush ( $lockKey, $fname, $timeout) | |
Acquire a named lock, flush any transaction, and return an RAII style unlocker object. More... | |
getServer () | |
Get the server hostname or IP address. More... | |
getServerInfo () | |
A string describing the current software version, and possibly other details in a user-friendly way. More... | |
getServerUptime () | |
Determines how long the server has been up. More... | |
getSessionLagStatus () | |
Get the replica DB lag when the current transaction started or a general lag estimate if not transaction is active. More... | |
getWikiID () | |
Alias for getDomainID() More... | |
ignoreIndexClause ( $index) | |
IGNORE INDEX clause. More... | |
indexExists ( $table, $index, $fname=__METHOD__) | |
Determines whether an index exists Usually throws a DBQueryError on failure If errors are explicitly ignored, returns NULL on failure. More... | |
indexUnique ( $table, $index) | |
Determines if a given index is unique. More... | |
initConnection () | |
Initialize the connection to the database over the wire (or to local files) More... | |
insertSelect ( $destTable, $srcTable, $varMap, $conds, $fname=__METHOD__, $insertOptions=[], $selectOptions=[], $selectJoinConds=[]) | |
INSERT SELECT wrapper. More... | |
isOpen () | |
Is a connection to the database open? More... | |
isQuotedIdentifier ( $name) | |
Returns if the given identifier looks quoted or not according to the database convention for quoting identifiers . More... | |
isReadOnly () | |
lastDoneWrites () | |
Returns the last time the connection may have been used for write queries. More... | |
lastQuery () | |
Return the last query that went through IDatabase::query() More... | |
listViews ( $prefix=null, $fname=__METHOD__) | |
Lists all the VIEWs in the database. More... | |
lockForUpdate ( $table, $conds='', $fname=__METHOD__, $options=[], $join_conds=[]) | |
Lock all rows meeting the given conditions/options FOR UPDATE. 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... | |
onTransactionCommitOrIdle (callable $callback, $fname=__METHOD__) | |
Run a callback as soon as there is no transaction pending. More... | |
onTransactionIdle (callable $callback, $fname=__METHOD__) | |
Alias for onTransactionCommitOrIdle() for backwards-compatibility. More... | |
onTransactionPreCommitOrIdle (callable $callback, $fname=__METHOD__) | |
Run a callback before the current transaction commits or now if there is none. More... | |
onTransactionResolution (callable $callback, $fname=__METHOD__) | |
Run a callback as soon as the current transaction commits or rolls back. More... | |
pendingWriteAndCallbackCallers () | |
List the methods that have write queries or callbacks for the current transaction. More... | |
pendingWriteCallers () | |
Get the list of method names that did write queries for this transaction. More... | |
pendingWriteQueryDuration ( $type=self::ESTIMATE_TOTAL) | |
Get the time spend running write queries for this transaction. More... | |
pendingWriteRowsAffected () | |
Get the number of affected rows from pending write queries. More... | |
ping (&$rtt=null) | |
Ping the server and try to reconnect if it there is no connection. More... | |
preCommitCallbacksPending () | |
query ( $sql, $fname=__METHOD__, $flags=0) | |
Run an SQL query and return the result. More... | |
replace ( $table, $uniqueIndexes, $rows, $fname=__METHOD__) | |
REPLACE query wrapper. More... | |
reportConnectionError ( $error='Unknown error') | |
reportQueryError ( $error, $errno, $sql, $fname, $ignoreErrors=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 consume and run any "on transaction idle/resolution" callbacks. More... | |
runOnTransactionPreCommitCallbacks () | |
Actually consume and run any "on transaction pre-commit" callbacks. More... | |
runTransactionListenerCallbacks ( $trigger) | |
Actually run any "transaction listener" callbacks. More... | |
select ( $table, $vars, $conds='', $fname=__METHOD__, $options=[], $join_conds=[]) | |
Execute a SELECT query constructed using the various parameters provided. More... | |
selectDB ( $db) | |
Change the current database. More... | |
selectDomain ( $domain) | |
Set the current domain (database, schema, and table prefix) More... | |
selectField ( $table, $var, $cond='', $fname=__METHOD__, $options=[], $join_conds=[]) | |
A SELECT wrapper which returns a single field from a single result row. More... | |
selectFieldValues ( $table, $var, $cond='', $fname=__METHOD__, $options=[], $join_conds=[]) | |
A SELECT wrapper which returns a list of single field values from result rows. More... | |
selectRow ( $table, $vars, $conds, $fname=__METHOD__, $options=[], $join_conds=[]) | |
Single row SELECT wrapper. More... | |
selectRowCount ( $tables, $var=' *', $conds='', $fname=__METHOD__, $options=[], $join_conds=[]) | |
Get the number of rows in dataset. More... | |
setBigSelects ( $value=true) | |
Allow or deny "big selects" for this session only. More... | |
setFlag ( $flag, $remember=self::REMEMBER_NOTHING) | |
Set a flag for this connection. More... | |
setIndexAliases (array $aliases) | |
Convert certain index names to alternative names before querying the DB. More... | |
setLazyMasterHandle (IDatabase $conn) | |
Set a lazy-connecting DB handle to the master DB (for replication status purposes) More... | |
setLBInfo ( $name, $value=null) | |
Set the LB info array, or a member of it. More... | |
setLogger (LoggerInterface $logger) | |
Set the PSR-3 logger interface to use for query logging. More... | |
setSchemaVars ( $vars) | |
Set variables to be used in sourceFile/sourceStream, in preference to the ones in $GLOBALS. More... | |
setSessionOptions (array $options) | |
Override database's default behavior. More... | |
setTableAliases (array $aliases) | |
Make certain table names use their own database, schema, and table prefix when passed into SQL queries pre-escaped and without a qualified database name. More... | |
setTransactionListener ( $name, callable $callback=null) | |
Run a callback after each time any transaction commits or rolls back. More... | |
setTrxEndCallbackSuppression ( $suppress) | |
Whether to disable running of post-COMMIT/ROLLBACK callbacks. More... | |
sourceFile ( $filename, callable $lineCallback=null, callable $resultCallback=null, $fname=false, callable $inputCallback=null) | |
Read and execute SQL commands from a file. More... | |
sourceStream ( $fp, callable $lineCallback=null, callable $resultCallback=null, $fname=__METHOD__, callable $inputCallback=null) | |
Read and execute commands from an open file handle. More... | |
startAtomic ( $fname=__METHOD__, $cancelable=self::ATOMIC_NOT_CANCELABLE) | |
Begin an atomic section of SQL statements. More... | |
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... | |
timestampOrNull ( $ts=null) | |
Convert a timestamp in one of the formats accepted by wfTimestamp() to the format used for inserting into timestamp fields in this DBMS. More... | |
trxLevel () | |
Gets the current transaction level. More... | |
trxStatus () | |
trxTimestamp () | |
Get the UNIX timestamp of the time that the transaction was established. More... | |
unionConditionPermutations ( $table, $vars, array $permute_conds, $extra_conds='', $fname=__METHOD__, $options=[], $join_conds=[]) | |
Construct a UNION query for permutations of conditions. More... | |
unionQueries ( $sqls, $all) | |
Construct a UNION query This is used for providing overload point for other DB abstractions not compatible with the MySQL syntax. More... | |
unionSupportsOrderAndLimit () | |
Returns true if current database backend supports ORDER BY or LIMIT for separate subqueries within the UNION construct. More... | |
unlockTables ( $method) | |
Unlock all tables locked via lockTables() More... | |
update ( $table, $values, $conds, $fname=__METHOD__, $options=[]) | |
UPDATE wrapper. More... | |
upsert ( $table, array $rows, $uniqueIndexes, array $set, $fname=__METHOD__) | |
INSERT ON DUPLICATE KEY UPDATE wrapper, upserts an array into a table. More... | |
useIndexClause ( $index) | |
USE INDEX clause. More... | |
wasConnectionLoss () | |
Determines if the last query error was due to a dropped connection. More... | |
wasErrorReissuable () | |
Determines if the last query error was due to something outside of the query itself. More... | |
wasReadOnlyError () | |
Determines if the last failure was due to the database being read-only. More... | |
writesOrCallbacksPending () | |
Whether there is a transaction open with either possible write queries or unresolved pre-commit/commit/resolution callbacks pending. More... | |
writesPending () | |
Public Member Functions inherited from Wikimedia\Rdbms\IDatabase | |
buildSubString ( $input, $startPosition, $length=null) | |
Build a SUBSTRING function. More... | |
Static Public Member Functions | |
static | getAttributes () |
Static Public Member Functions inherited from Wikimedia\Rdbms\Database | |
static | attributesFromType ( $dbType, $driver=null) |
static | factory ( $dbType, $p=[], $connect=self::NEW_CONNECTED) |
Construct a Database subclass instance given a database type and parameters. More... | |
static | getCacheSetOptions (IDatabase $db1, IDatabase $db2=null) |
Merge the result of getSessionLagStatus() for several DBs using the most pessimistic values to estimate the lag of any data derived from them in combination. More... | |
Protected Member Functions | |
closeConnection () | |
Closes underlying database connection. More... | |
dumpError () | |
fetchAffectedRowCount () | |
isTransactableQuery ( $sql) | |
Determine whether a SQL statement is sensitive to isolation level. More... | |
makeUpdateOptionsArray ( $options) | |
Make UPDATE options array for Database::makeUpdateOptions. More... | |
nativeInsertSelect ( $destTable, $srcTable, $varMap, $conds, $fname=__METHOD__, $insertOptions=[], $selectOptions=[], $selectJoinConds=[]) | |
INSERT SELECT wrapper $varMap must be an associative array of the form [ 'dest1' => 'source1', ... More... | |
open ( $server, $user, $password, $dbName, $schema, $tablePrefix) | |
Open a new connection to the database (closing any existing one) More... | |
relationSchemaQualifier () | |
wasKnownStatementRollbackError () | |
Protected Member Functions inherited from Wikimedia\Rdbms\Database | |
assertBuildSubstringParams ( $startPosition, $length) | |
Check type and bounds for parameters to self::buildSubstring() More... | |
assertHasConnectionHandle () | |
Make sure there is an open connection handle (alive or not) as a sanity check. More... | |
assertIsWritableMaster () | |
Make sure that this server is not marked as a replica nor read-only as a sanity check. More... | |
doBegin ( $fname) | |
Issues the BEGIN command to the database server. More... | |
doCommit ( $fname) | |
Issues the COMMIT command to the database server. More... | |
doInitConnection () | |
Actually connect to the database over the wire (or to local files) More... | |
doReleaseSavepoint ( $identifier, $fname) | |
Release a savepoint. More... | |
doRollback ( $fname) | |
Issues the ROLLBACK command to the database server. More... | |
doRollbackToSavepoint ( $identifier, $fname) | |
Rollback to a savepoint. More... | |
doSavepoint ( $identifier, $fname) | |
Create a savepoint. More... | |
doUnlockTables ( $method) | |
Helper function for unlockTables() that handles the actual table unlocking. More... | |
escapeLikeInternal ( $s, $escapeChar='`') | |
extractSingleFieldFromList ( $var) | |
fieldNamesWithAlias ( $fields) | |
Gets an array of aliased field names. More... | |
fieldNameWithAlias ( $name, $alias=false) | |
Get an aliased field name e.g. More... | |
getApproximateLagStatus () | |
Get a replica DB lag estimate for this server. More... | |
getBindingHandle () | |
Get the underlying binding connection handle. More... | |
getDefaultSchemaVars () | |
Get schema variables to use if none have been set via setSchemaVars(). More... | |
getLastPHPError () | |
getLazyMasterHandle () | |
getLogContext (array $extras=[]) | |
Create a log context to pass to PSR-3 logger functions. More... | |
getQueryVerb ( $sql) | |
getReadOnlyReason () | |
getRecordedTransactionLagStatus () | |
Get the replica DB lag when the current transaction started. More... | |
getSchemaVars () | |
Get schema variables. More... | |
getTransactionRoundId () | |
hasFlags ( $field, $flags) | |
indexName ( $index) | |
Allows for index remapping in queries where this is not consistent across DBMS. More... | |
installErrorHandler () | |
Set a custom error handler for logging errors during database connection. More... | |
isInsertSelectSafe (array $insertOptions, array $selectOptions) | |
isWriteQuery ( $sql) | |
Determine whether a query writes to the DB. More... | |
makeGroupByWithHaving ( $options) | |
Returns an optional GROUP BY with an optional HAVING. More... | |
makeInsertOptions ( $options) | |
Helper for Database::insert(). More... | |
makeOrderBy ( $options) | |
Returns an optional ORDER BY. More... | |
makeUpdateOptions ( $options) | |
Make UPDATE options for the Database::update function. More... | |
nativeReplace ( $table, $rows, $fname) | |
REPLACE query wrapper for MySQL and SQLite, which have a native REPLACE statement. More... | |
nonNativeInsertSelect ( $destTable, $srcTable, $varMap, $conds, $fname=__METHOD__, $insertOptions=[], $selectOptions=[], $selectJoinConds=[]) | |
Implementation of insertSelect() based on select() and insert() More... | |
normalizeConditions ( $conds, $fname) | |
qualifiedTableComponents ( $name) | |
Get the table components needed for a query given the currently selected database. More... | |
registerTempTableWrite ( $sql, $pseudoPermanent) | |
replaceLostConnection ( $fname) | |
Close any existing (dead) database connection and open a new connection. More... | |
replaceVars ( $ins) | |
Database independent variable replacement. More... | |
restoreErrorHandler () | |
Restore the previous error handler and return the last PHP error for this DB. More... | |
resultObject ( $result) | |
Take the result from a query, and wrap it in a ResultWrapper if necessary. More... | |
tableNamesWithAlias ( $tables) | |
Gets an array of aliased table names. More... | |
tableNamesWithIndexClauseOrJOIN ( $tables, $use_index=[], $ignore_index=[], $join_conds=[]) | |
Get the aliased table name clause for a FROM clause which might have a JOIN and/or USE INDEX or IGNORE INDEX clause. More... | |
tableNameWithAlias ( $table, $alias=false) | |
Get an aliased table name. More... | |
wasQueryTimeout ( $error, $errno) | |
Checks whether the cause of the error is detected to be a timeout. More... | |
Protected Attributes | |
resource | $lastResultHandle = null |
int bool | $port |
Protected Attributes inherited from Wikimedia\Rdbms\Database | |
integer null | $affectedRowCount |
Rows affected by the last query to query() or its CRUD wrappers. More... | |
string | $agent |
Agent name for query profiling. More... | |
bool | $cliMode |
Whether this PHP instance is for a CLI script. More... | |
object resource null | $conn = null |
Database connection. More... | |
array | $connectionParams = [] |
Parameters used by initConnection() to establish a connection. More... | |
LoggerInterface | $connLogger |
DatabaseDomain | $currentDomain |
string | $delimiter = ';' |
callable | $deprecationLogger |
Deprecation logging callback. More... | |
callable | $errorLogger |
Error logging callback. More... | |
int | $flags |
string bool null | $htmlErrors |
Stashed value of html_errors INI setting. More... | |
string[] | $indexAliases = [] |
Map of (index alias => index) More... | |
float | $lastPing = 0.0 |
UNIX timestamp. More... | |
string | $lastQuery = '' |
SQL query. More... | |
float bool | $lastWriteTime = false |
UNIX timestamp of last write query. More... | |
array | $lbInfo = [] |
int | $nonNativeInsertSelectBatchSize = 10000 |
bool | $opened = false |
string | $password |
Password used to establish the current connection. More... | |
string bool | $phpError = false |
array null | $preparedArgs |
callable null | $profiler |
LoggerInterface | $queryLogger |
array bool | $schemaVars = false |
string | $server |
Server that this instance is currently connected to. More... | |
array | $sessionTempTables = [] |
Map of (table name => 1) for TEMPORARY tables. More... | |
array | $sessionVars = [] |
BagOStuff | $srvCache |
APC cache. More... | |
array[] | $tableAliases = [] |
Map of (table => (dbname, schema, prefix) map) More... | |
array[] | $trxEndCallbacks = [] |
List of (callable, method name, atomic section id) More... | |
bool | $trxEndCallbacksSuppressed = false |
Whether to suppress triggering of transaction end callbacks. More... | |
array[] | $trxIdleCallbacks = [] |
List of (callable, method name, atomic section id) More... | |
int | $trxLevel = 0 |
Either 1 if a transaction is active or 0 otherwise. More... | |
array[] | $trxPreCommitCallbacks = [] |
List of (callable, method name, atomic section id) More... | |
TransactionProfiler | $trxProfiler |
callable[] | $trxRecurringCallbacks = [] |
Map of (name => callable) More... | |
string | $trxShortId = '' |
Either a short hexidecimal string if a transaction is active or "". More... | |
int | $trxStatus = self::STATUS_TRX_NONE |
Transaction status. More... | |
Exception null | $trxStatusCause |
The last error that caused the status to become STATUS_TRX_ERROR. More... | |
array null | $trxStatusIgnoredCause |
If wasKnownStatementRollbackError() prevented trxStatus from being set, the relevant details are stored here. More... | |
string | $user |
User that this instance is currently connected under the name of. More... | |
Private Member Functions | |
bigintFromLockName ( $lockName) | |
makeConnectionString ( $vars) | |
pg_array_parse ( $text, &$output, $limit=false, $offset=1) | |
Posted by cc[plus]php[at]c2se[dot]com on 25-Mar-2009 09:12 to https://secure.php.net/manual/en/ref.pgsql.php. More... | |
relationExists ( $table, $types, $schema=false) | |
Query whether a given relation exists (in the given schema, or the default mw one if not given) More... | |
setSearchPath ( $search_path) | |
Update search_path, values should already be sanitized Values may contain magic keywords like "$user". More... | |
Private Attributes | |
string | $connectString |
Connect string to open a PostgreSQL connection. More... | |
string | $coreSchema |
string[] | $keywordTableMap = [] |
Map of (reserved table name => alternate table name) More... | |
float string | $numericVersion = null |
string | $tempSchema |
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 33 of file DatabasePostgres.php.
Wikimedia\Rdbms\DatabasePostgres::__construct | ( | array | $params | ) |
array | $params | Additional parameters include:
|
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 56 of file DatabasePostgres.php.
Wikimedia\Rdbms\DatabasePostgres::addQuotes | ( | $s | ) |
Adds quotes and backslashes.
string | int | null | bool | Blob | $s |
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 1306 of file DatabasePostgres.php.
References Wikimedia\Rdbms\Database\$conn, $s, and Wikimedia\Rdbms\Database\getBindingHandle().
Referenced by Wikimedia\Rdbms\DatabasePostgres\buildGroupConcatField(), Wikimedia\Rdbms\DatabasePostgres\constraintExists(), Wikimedia\Rdbms\DatabasePostgres\duplicateTableStructure(), Wikimedia\Rdbms\PostgresField\fromText(), Wikimedia\Rdbms\DatabasePostgres\hasConstraint(), Wikimedia\Rdbms\DatabasePostgres\indexAttributes(), Wikimedia\Rdbms\DatabasePostgres\lock(), Wikimedia\Rdbms\DatabasePostgres\lockIsFree(), Wikimedia\Rdbms\DatabasePostgres\relationExists(), Wikimedia\Rdbms\DatabasePostgres\resetSequenceForTable(), Wikimedia\Rdbms\DatabasePostgres\triggerExists(), and Wikimedia\Rdbms\DatabasePostgres\unlock().
Wikimedia\Rdbms\DatabasePostgres::aggregateValue | ( | $valuedata, | |
$valuename = 'value' |
|||
) |
Return aggregated value alias.
array | $valuedata | |
string | $valuename |
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 968 of file DatabasePostgres.php.
|
private |
string | $lockName |
Definition at line 1476 of file DatabasePostgres.php.
Referenced by Wikimedia\Rdbms\DatabasePostgres\lock(), Wikimedia\Rdbms\DatabasePostgres\lockIsFree(), and Wikimedia\Rdbms\DatabasePostgres\unlock().
Wikimedia\Rdbms\DatabasePostgres::buildConcat | ( | $stringList | ) |
Build a concatenation list to feed into a SQL query.
array | $stringList | List of raw SQL expressions; caller is responsible for any quoting |
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 1356 of file DatabasePostgres.php.
Wikimedia\Rdbms\DatabasePostgres::buildGroupConcatField | ( | $delimiter, | |
$table, | |||
$field, | |||
$conds = '' , |
|||
$options = [] , |
|||
$join_conds = [] |
|||
) |
Definition at line 1360 of file DatabasePostgres.php.
References Wikimedia\Rdbms\Database\$delimiter, Wikimedia\Rdbms\DatabasePostgres\addQuotes(), and Wikimedia\Rdbms\DatabasePostgres\selectSQLText().
Wikimedia\Rdbms\DatabasePostgres::buildStringCast | ( | $field | ) |
string | $field | Field or column to cast |
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 1368 of file DatabasePostgres.php.
|
protected |
Closes underlying database connection.
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 210 of file DatabasePostgres.php.
Wikimedia\Rdbms\DatabasePostgres::constraintExists | ( | $table, | |
$constraint | |||
) |
Definition at line 1220 of file DatabasePostgres.php.
References $res, Wikimedia\Rdbms\DatabasePostgres\addQuotes(), as, Wikimedia\Rdbms\DatabasePostgres\getCoreSchemas(), and Wikimedia\Rdbms\Database\query().
Wikimedia\Rdbms\DatabasePostgres::currentSequenceValue | ( | $seqName | ) |
Return the current value of a sequence.
Assumes it has been nextval'ed in this session.
string | $seqName |
Definition at line 763 of file DatabasePostgres.php.
References $res, Wikimedia\Rdbms\DatabasePostgres\fetchRow(), and Wikimedia\Rdbms\Database\query().
Wikimedia\Rdbms\DatabasePostgres::databasesAreIndependent | ( | ) |
Returns true if DBs are assumed to be on potentially different servers.
In systems like mysql/mariadb, different databases can easily be referenced on a single connection merely by name, even in a single query via JOIN. On the other hand, Postgres treats databases as fully separate, only allowing mechanisms like postgres_fdw to effectively "mount" foreign DBs. This is true even among DBs on the same server.
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 174 of file DatabasePostgres.php.
Wikimedia\Rdbms\DatabasePostgres::dataSeek | ( | $res, | |
$row | |||
) |
Change the position of the cursor in a result object.
mixed | $res | A SQL result |
int | $row |
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 361 of file DatabasePostgres.php.
References $res.
Wikimedia\Rdbms\DatabasePostgres::decodeBlob | ( | $b | ) |
Some DBMSs return a special placeholder object representing blob fields in result objects.
Pass the object through this function to return the original string.
string | Blob | $b |
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 1291 of file DatabasePostgres.php.
Wikimedia\Rdbms\DatabasePostgres::determineCoreSchema | ( | $desiredSchema | ) |
Determine default schema for the current application Adjust this session schema search path if desired schema exists and is not alread there.
We need to have name of the core schema stored to be able to query database metadata.
This will be also called by the installer after the schema is created
string | $desiredSchema |
Definition at line 1053 of file DatabasePostgres.php.
References Wikimedia\Rdbms\Database\addIdentifierQuotes(), Wikimedia\Rdbms\Database\begin(), Wikimedia\Rdbms\Database\commit(), Wikimedia\Rdbms\DatabasePostgres\getCurrentSchema(), Wikimedia\Rdbms\DatabasePostgres\getSchemas(), Wikimedia\Rdbms\DatabasePostgres\getSearchPath(), Wikimedia\Rdbms\DatabasePostgres\schemaExists(), and Wikimedia\Rdbms\DatabasePostgres\setSearchPath().
Referenced by Wikimedia\Rdbms\DatabasePostgres\open().
Helper function for lockTables() that handles the actual table locking.
array | $read | Array of tables to lock for read access |
array | $write | Array of tables to lock for write access |
string | $method | Name of caller |
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 1385 of file DatabasePostgres.php.
References as, Wikimedia\Rdbms\Database\query(), and Wikimedia\Rdbms\DatabasePostgres\tableName().
Wikimedia\Rdbms\DatabasePostgres::doQuery | ( | $sql | ) |
string | $sql |
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 223 of file DatabasePostgres.php.
References Wikimedia\Rdbms\Database\$conn, Wikimedia\Rdbms\DatabasePostgres\$lastResultHandle, $res, and Wikimedia\Rdbms\Database\getBindingHandle().
Referenced by Wikimedia\Rdbms\DatabasePostgres\hasConstraint(), and Wikimedia\Rdbms\DatabasePostgres\open().
Wikimedia\Rdbms\DatabasePostgres::doSelectDomain | ( | DatabaseDomain | $domain | ) |
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 178 of file DatabasePostgres.php.
References Wikimedia\Rdbms\DatabaseDomain\getDatabase(), Wikimedia\Rdbms\Database\getDBname(), Wikimedia\Rdbms\DatabaseDomain\getSchema(), Wikimedia\Rdbms\DatabaseDomain\getTablePrefix(), Wikimedia\Rdbms\DatabasePostgres\open(), server, and user.
|
protected |
Definition at line 242 of file DatabasePostgres.php.
References as.
Wikimedia\Rdbms\DatabasePostgres::duplicateTableStructure | ( | $oldName, | |
$newName, | |||
$temporary = false , |
|||
$fname = __METHOD__ |
|||
) |
Creates a new table with structure copied from existing table.
Note that unlike most database abstraction functions, this function does not automatically append database prefix, because it works at a lower abstraction level. The table names passed to this function shall not be quoted (this function calls addIdentifierQuotes() when needed).
string | $oldName | Name of table whose structure should be copied |
string | $newName | Name of table to be created |
bool | $temporary | Whether the new table should be temporary |
string | $fname | Calling function name |
RuntimeException |
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 814 of file DatabasePostgres.php.
References $fname, $res, $ret, Wikimedia\Rdbms\Database\addIdentifierQuotes(), Wikimedia\Rdbms\DatabasePostgres\addQuotes(), Wikimedia\Rdbms\DatabasePostgres\fetchObject(), Wikimedia\Rdbms\DatabasePostgres\getCoreSchema(), and Wikimedia\Rdbms\Database\query().
Wikimedia\Rdbms\DatabasePostgres::encodeBlob | ( | $b | ) |
Some DBMSs have a special format for inserting into blob fields, they don't allow simple quoted strings to be inserted.
To insert into such a field, pass the data through this function before passing it to IDatabase::insert().
string | $b |
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 1287 of file DatabasePostgres.php.
Wikimedia\Rdbms\DatabasePostgres::estimateRowCount | ( | $table, | |
$var = '*' , |
|||
$conds = '' , |
|||
$fname = __METHOD__ , |
|||
$options = [] , |
|||
$join_conds = [] |
|||
) |
Estimate rows in dataset Returns estimated count, based on EXPLAIN output This is not necessarily an accurate estimate, so use sparingly Returns -1 if count cannot be found Takes same arguments as Database::select()
string | $table | |
string | $var | |
string | $conds | |
string | $fname | |
array | $options | |
array | $join_conds |
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 412 of file DatabasePostgres.php.
References $fname, $options, $res, $rows, Wikimedia\Rdbms\Database\extractSingleFieldFromList(), Wikimedia\Rdbms\DatabasePostgres\fetchRow(), Wikimedia\Rdbms\Database\normalizeConditions(), and Wikimedia\Rdbms\Database\select().
|
protected |
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 389 of file DatabasePostgres.php.
Wikimedia\Rdbms\DatabasePostgres::fetchObject | ( | $res | ) |
Fetch the next row from the given result object, in object form.
Fields can be retrieved with $row->fieldname, with fields acting like member variables. If no more rows are available, false is returned.
IResultWrapper | stdClass | $res | Object as returned from IDatabase::query(), etc. |
DBUnexpectedError | Thrown if the database returns an error |
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 275 of file DatabasePostgres.php.
References Wikimedia\Rdbms\Database\$conn, $res, and Wikimedia\Rdbms\Database\getBindingHandle().
Referenced by Wikimedia\Rdbms\DatabasePostgres\duplicateTableStructure(), Wikimedia\Rdbms\PostgresField\fromText(), Wikimedia\Rdbms\DatabasePostgres\getCoreSchemas(), Wikimedia\Rdbms\DatabasePostgres\lock(), Wikimedia\Rdbms\DatabasePostgres\lockIsFree(), Wikimedia\Rdbms\DatabasePostgres\resetSequenceForTable(), Wikimedia\Rdbms\DatabasePostgres\serverIsReadOnly(), Wikimedia\Rdbms\DatabasePostgres\textFieldSize(), and Wikimedia\Rdbms\DatabasePostgres\unlock().
Wikimedia\Rdbms\DatabasePostgres::fetchRow | ( | $res | ) |
Fetch the next row from the given result object, in associative array form.
Fields are retrieved with $row['fieldname']. If no more rows are available, false is returned.
IResultWrapper | $res | Result object as returned from IDatabase::query(), etc. |
DBUnexpectedError | Thrown if the database returns an error |
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 297 of file DatabasePostgres.php.
References Wikimedia\Rdbms\Database\$conn, $res, and Wikimedia\Rdbms\Database\getBindingHandle().
Referenced by Wikimedia\Rdbms\DatabasePostgres\currentSequenceValue(), Wikimedia\Rdbms\DatabasePostgres\estimateRowCount(), Wikimedia\Rdbms\DatabasePostgres\getCurrentSchema(), Wikimedia\Rdbms\DatabasePostgres\getSchemas(), Wikimedia\Rdbms\DatabasePostgres\getSearchPath(), and Wikimedia\Rdbms\DatabasePostgres\insertId().
Wikimedia\Rdbms\DatabasePostgres::fieldInfo | ( | $table, | |
$field | |||
) |
string | $table | |
string | $field |
Implements Wikimedia\Rdbms\IMaintainableDatabase.
Definition at line 1269 of file DatabasePostgres.php.
References Wikimedia\Rdbms\PostgresField\fromText().
Wikimedia\Rdbms\DatabasePostgres::fieldName | ( | $res, | |
$n | |||
) |
Get a field name in a result object.
mixed | $res | A SQL result |
int | $n |
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 347 of file DatabasePostgres.php.
References $res.
Wikimedia\Rdbms\DatabasePostgres::fieldType | ( | $res, | |
$index | |||
) |
pg_field_type() wrapper
ResultWrapper | resource | $res | ResultWrapper or PostgreSQL query result resource |
int | $index | Field number, starting from 0 |
Definition at line 1279 of file DatabasePostgres.php.
References $res.
Wikimedia\Rdbms\DatabasePostgres::freeResult | ( | $res | ) |
Free a result object returned by query() or select().
It's usually not necessary to call this, just use unset() or let the variable holding the result object go out of scope.
mixed | $res | A SQL result |
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 263 of file DatabasePostgres.php.
References $res.
|
static |
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 1468 of file DatabasePostgres.php.
References true.
Wikimedia\Rdbms\DatabasePostgres::getCoreSchema | ( | ) |
Return schema name for core application tables.
Definition at line 1090 of file DatabasePostgres.php.
References Wikimedia\Rdbms\DatabasePostgres\$coreSchema.
Referenced by Wikimedia\Rdbms\DatabasePostgres\duplicateTableStructure(), and Wikimedia\Rdbms\DatabasePostgres\getCoreSchemas().
Wikimedia\Rdbms\DatabasePostgres::getCoreSchemas | ( | ) |
Return schema names for temporary tables and core application tables.
Definition at line 1100 of file DatabasePostgres.php.
References $res, Wikimedia\Rdbms\DatabasePostgres\$tempSchema, Wikimedia\Rdbms\DatabasePostgres\fetchObject(), Wikimedia\Rdbms\DatabasePostgres\getCoreSchema(), and Wikimedia\Rdbms\Database\query().
Referenced by Wikimedia\Rdbms\DatabasePostgres\constraintExists(), Wikimedia\Rdbms\PostgresField\fromText(), Wikimedia\Rdbms\DatabasePostgres\hasConstraint(), Wikimedia\Rdbms\DatabasePostgres\indexAttributes(), Wikimedia\Rdbms\DatabasePostgres\listTables(), Wikimedia\Rdbms\DatabasePostgres\relationExists(), Wikimedia\Rdbms\DatabasePostgres\resetSequenceForTable(), Wikimedia\Rdbms\DatabasePostgres\ruleExists(), and Wikimedia\Rdbms\DatabasePostgres\triggerExists().
Wikimedia\Rdbms\DatabasePostgres::getCurrentSchema | ( | ) |
Return current schema (executes SELECT current_schema()) Needs transaction.
Definition at line 983 of file DatabasePostgres.php.
References $res, Wikimedia\Rdbms\DatabasePostgres\fetchRow(), and Wikimedia\Rdbms\Database\query().
Referenced by Wikimedia\Rdbms\DatabasePostgres\determineCoreSchema().
Wikimedia\Rdbms\DatabasePostgres::getSchemas | ( | ) |
Return list of schemas which are accessible without schema name This is list does not contain magic keywords like "$user" Needs transaction.
Definition at line 1000 of file DatabasePostgres.php.
References $res, Wikimedia\Rdbms\DatabasePostgres\fetchRow(), Wikimedia\Rdbms\DatabasePostgres\pg_array_parse(), and Wikimedia\Rdbms\Database\query().
Referenced by Wikimedia\Rdbms\DatabasePostgres\determineCoreSchema().
Wikimedia\Rdbms\DatabasePostgres::getSearchPath | ( | ) |
Return search patch for schemas This is different from getSchemas() since it contain magic keywords (like "$user").
Needs transaction
Definition at line 1019 of file DatabasePostgres.php.
References $res, Wikimedia\Rdbms\DatabasePostgres\fetchRow(), and Wikimedia\Rdbms\Database\query().
Referenced by Wikimedia\Rdbms\DatabasePostgres\determineCoreSchema().
Wikimedia\Rdbms\DatabasePostgres::getServerVersion | ( | ) |
A string describing the current software version, like from mysql_get_server_info().
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 1117 of file DatabasePostgres.php.
References Wikimedia\Rdbms\Database\$conn, Wikimedia\Rdbms\DatabasePostgres\$numericVersion, and Wikimedia\Rdbms\Database\getBindingHandle().
Referenced by Wikimedia\Rdbms\DatabasePostgres\insert(), and Wikimedia\Rdbms\DatabasePostgres\nativeInsertSelect().
Wikimedia\Rdbms\DatabasePostgres::getSoftwareLink | ( | ) |
Returns a wikitext link to the DB's website, e.g., return "[https://www.mysql.com/ MySQL]"; Should at least contain plain text, if for some reason your database has no website.
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 972 of file DatabasePostgres.php.
Wikimedia\Rdbms\DatabasePostgres::getType | ( | ) |
Get the type of the DBMS, as it appears in $wgDBtype.
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 63 of file DatabasePostgres.php.
Wikimedia\Rdbms\DatabasePostgres::hasConstraint | ( | $name | ) |
Definition at line 75 of file DatabasePostgres.php.
References $name, $res, Wikimedia\Rdbms\DatabasePostgres\addQuotes(), as, Wikimedia\Rdbms\DatabasePostgres\doQuery(), Wikimedia\Rdbms\DatabasePostgres\getCoreSchemas(), and Wikimedia\Rdbms\DatabasePostgres\numRows().
Wikimedia\Rdbms\DatabasePostgres::implicitGroupby | ( | ) |
Returns true if this database does an implicit sort when doing GROUP BY.
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 67 of file DatabasePostgres.php.
Wikimedia\Rdbms\DatabasePostgres::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.
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 71 of file DatabasePostgres.php.
Wikimedia\Rdbms\DatabasePostgres::indexAttributes | ( | $index, | |
$schema = false |
|||
) |
Definition at line 450 of file DatabasePostgres.php.
References $res, Wikimedia\Rdbms\DatabasePostgres\addQuotes(), as, FROM, Wikimedia\Rdbms\DatabasePostgres\getCoreSchemas(), n, and Wikimedia\Rdbms\Database\query().
Wikimedia\Rdbms\DatabasePostgres::indexInfo | ( | $table, | |
$index, | |||
$fname = __METHOD__ |
|||
) |
Get information about an index into an object.
string | $table | Table name |
string | $index | Index name |
string | $fname | Calling function name |
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 435 of file DatabasePostgres.php.
References $fname, $res, as, and Wikimedia\Rdbms\Database\query().
Wikimedia\Rdbms\DatabasePostgres::indexUnique | ( | $table, | |
$index, | |||
$fname = __METHOD__ |
|||
) |
Definition at line 513 of file DatabasePostgres.php.
References $fname, $res, Wikimedia\Rdbms\Database\indexName(), Wikimedia\Rdbms\Database\query(), and Wikimedia\Rdbms\DatabasePostgres\strencode().
Wikimedia\Rdbms\DatabasePostgres::insert | ( | $table, | |
$args, | |||
$fname = __METHOD__ , |
|||
$options = [] |
|||
) |
@inheritDoc
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 581 of file DatabasePostgres.php.
References $args, $e, $fname, $keys, $options, $rows, as, Wikimedia\Rdbms\Database\cancelAtomic(), captcha-old\count, Wikimedia\Rdbms\Database\endAtomic(), Wikimedia\Rdbms\DatabasePostgres\getServerVersion(), Wikimedia\Rdbms\Database\makeList(), Wikimedia\Rdbms\Database\query(), Wikimedia\Rdbms\Database\startAtomic(), and Wikimedia\Rdbms\DatabasePostgres\tableName().
Wikimedia\Rdbms\DatabasePostgres::insertId | ( | ) |
Get the inserted value of an auto-increment row.
This should only be called after an insert that used an auto-incremented value. If no such insert was previously done in the current database session, the return value is undefined.
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 355 of file DatabasePostgres.php.
References $res, Wikimedia\Rdbms\DatabasePostgres\fetchRow(), null, and Wikimedia\Rdbms\Database\query().
|
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).
string | $sql |
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 214 of file DatabasePostgres.php.
Wikimedia\Rdbms\DatabasePostgres::lastErrno | ( | ) |
Get the last error number.
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 381 of file DatabasePostgres.php.
Referenced by Wikimedia\Rdbms\DatabasePostgres\wasDeadlock(), and Wikimedia\Rdbms\DatabasePostgres\wasLockTimeout().
Wikimedia\Rdbms\DatabasePostgres::lastError | ( | ) |
Get a description of the last error.
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 369 of file DatabasePostgres.php.
References Wikimedia\Rdbms\Database\getLastPHPError().
Referenced by Wikimedia\Rdbms\DatabasePostgres\open().
Wikimedia\Rdbms\DatabasePostgres::limitResult | ( | $sql, | |
$limit, | |||
$offset = false |
|||
) |
Construct a LIMIT query with optional offset.
This is used for query pages. 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.
The version provided by default works in MySQL and SQLite. It will very likely need to be overridden for most other DBMSes.
string | $sql | SQL query we will append the limit too |
int | $limit | The SQL limit |
int | bool | $offset | The SQL offset (default false) |
DBUnexpectedError |
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 789 of file DatabasePostgres.php.
Wikimedia\Rdbms\DatabasePostgres::listTables | ( | $prefix = null , |
|
$fname = __METHOD__ |
|||
) |
@suppress SecurityCheck-SQLInjection array_map not recognized T204911
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 900 of file DatabasePostgres.php.
References $fname, $vars, as, Wikimedia\Rdbms\DatabasePostgres\getCoreSchemas(), and Wikimedia\Rdbms\Database\query().
Wikimedia\Rdbms\DatabasePostgres::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 |
DBError |
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 1425 of file DatabasePostgres.php.
References $res, Wikimedia\Rdbms\DatabasePostgres\addQuotes(), Wikimedia\Rdbms\DatabasePostgres\bigintFromLockName(), Wikimedia\Rdbms\DatabasePostgres\fetchObject(), Wikimedia\Rdbms\Database\query(), and use.
Wikimedia\Rdbms\DatabasePostgres::lockIsFree | ( | $lockName, | |
$method | |||
) |
Check to see if a named lock is not locked by any thread (non-blocking)
string | $lockName | Name of lock to poll |
string | $method | Name of method calling us |
DBError |
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 1412 of file DatabasePostgres.php.
References Wikimedia\Rdbms\DatabasePostgres\addQuotes(), Wikimedia\Rdbms\DatabasePostgres\bigintFromLockName(), Wikimedia\Rdbms\DatabasePostgres\fetchObject(), and Wikimedia\Rdbms\Database\query().
|
private |
string[] | $vars |
Definition at line 201 of file DatabasePostgres.php.
References $name, $s, $value, $vars, and as.
Referenced by Wikimedia\Rdbms\DatabasePostgres\open().
Wikimedia\Rdbms\DatabasePostgres::makeSelectOptions | ( | $options | ) |
Returns an optional USE INDEX clause to go after the table, and a string to go at the end of the query.
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 1327 of file DatabasePostgres.php.
References $options, as, Wikimedia\Rdbms\Database\makeGroupByWithHaving(), and Wikimedia\Rdbms\Database\makeOrderBy().
|
protected |
Make UPDATE options array for Database::makeUpdateOptions.
array | $options |
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 660 of file DatabasePostgres.php.
References $options.
|
protected |
INSERT SELECT wrapper $varMap must be an associative array of the form [ 'dest1' => 'source1', ...
] Source items may be literals rather then field names, but strings should be quoted with Database::addQuotes() $conds may be "*" to copy the whole table srcTable may be an array of tables.
string | $destTable | |
array | string | $srcTable | |
array | $varMap | |
array | $conds | |
string | $fname | |
array | $insertOptions | |
array | $selectOptions | |
array | $selectJoinConds |
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 690 of file DatabasePostgres.php.
References $fname, Wikimedia\Rdbms\DatabasePostgres\getServerVersion(), Wikimedia\Rdbms\Database\nonNativeInsertSelect(), Wikimedia\Rdbms\Database\query(), Wikimedia\Rdbms\DatabasePostgres\selectSQLText(), and Wikimedia\Rdbms\DatabasePostgres\tableName().
Wikimedia\Rdbms\DatabasePostgres::nextSequenceValue | ( | $seqName | ) |
Deprecated method, calls should be removed.
This was formerly used for PostgreSQL and Oracle to handle self::insertId() auto-incrementing fields. It is no longer necessary since DatabasePostgres::insertId() has been reimplemented using lastval()
and Oracle has been reimplemented using triggers.
Implementations should return null if inserting NULL
into an auto-incrementing field works, otherwise it should return an instance of NextSequenceValue and filter it on calls to relevant methods.
string | $seqName |
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 753 of file DatabasePostgres.php.
Wikimedia\Rdbms\DatabasePostgres::numFields | ( | $res | ) |
Get the number of fields in a result object.
mixed | $res | A SQL result |
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 339 of file DatabasePostgres.php.
References $res.
Wikimedia\Rdbms\DatabasePostgres::numRows | ( | $res | ) |
Get the number of rows in a query result.
If the query did not return any rows (for example, if it was a write query), this returns zero.
mixed | $res | A SQL result |
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 316 of file DatabasePostgres.php.
References Wikimedia\Rdbms\Database\$conn, $res, and Wikimedia\Rdbms\Database\getBindingHandle().
Referenced by Wikimedia\Rdbms\DatabasePostgres\hasConstraint(), and Wikimedia\Rdbms\DatabasePostgres\resetSequenceForTable().
|
protected |
Open a new connection to the database (closing any existing one)
string | $server | Database server host |
string | $user | Database user name |
string | $password | Database user password |
string | $dbName | Database name |
string | null | $schema | Database schema name |
string | $tablePrefix | Table prefix |
DBConnectionError |
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 89 of file DatabasePostgres.php.
References Wikimedia\Rdbms\Database\$conn, Wikimedia\Rdbms\Database\$password, Wikimedia\Rdbms\Database\$phpError, Wikimedia\Rdbms\Database\$server, Wikimedia\Rdbms\Database\$user, Wikimedia\Rdbms\Database\close(), DBO_SSL, Wikimedia\Rdbms\DatabasePostgres\determineCoreSchema(), Wikimedia\Rdbms\DatabasePostgres\doQuery(), Wikimedia\Rdbms\Database\installErrorHandler(), Wikimedia\Rdbms\DatabasePostgres\lastError(), Wikimedia\Rdbms\DatabasePostgres\makeConnectionString(), port(), Wikimedia\Rdbms\Database\query(), Wikimedia\Rdbms\Database\restoreErrorHandler(), server, and user.
Referenced by Wikimedia\Rdbms\DatabasePostgres\doSelectDomain().
|
private |
Posted by cc[plus]php[at]c2se[dot]com on 25-Mar-2009 09:12 to https://secure.php.net/manual/en/ref.pgsql.php.
Parsing a postgres array can be a tricky problem, he's my take on this, it handles multi-dimensional arrays plus escaping using a nasty regexp to determine the limits of each data-item.
This should really be handled by PHP PostgreSQL module
string | $text | Postgreql array returned in a text form like {a,b} |
string[] | $output | |
int | bool | $limit | |
int | $offset |
Definition at line 941 of file DatabasePostgres.php.
References $output.
Referenced by Wikimedia\Rdbms\DatabasePostgres\getSchemas().
Wikimedia\Rdbms\DatabasePostgres::realTableName | ( | $name, | |
$format = 'quoted' |
|||
) |
string | $name | |
string | $format |
Definition at line 749 of file DatabasePostgres.php.
References $name, and tableName().
Referenced by Wikimedia\Rdbms\DatabasePostgres\relationExists().
|
private |
Query whether a given relation exists (in the given schema, or the default mw one if not given)
string | $table | |
array | string | $types | |
bool | string | $schema |
Definition at line 1144 of file DatabasePostgres.php.
References $res, Wikimedia\Rdbms\DatabasePostgres\addQuotes(), as, Wikimedia\Rdbms\DatabasePostgres\getCoreSchemas(), Wikimedia\Rdbms\Database\query(), and Wikimedia\Rdbms\DatabasePostgres\realTableName().
Referenced by Wikimedia\Rdbms\DatabasePostgres\sequenceExists(), and Wikimedia\Rdbms\DatabasePostgres\tableExists().
|
protected |
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 165 of file DatabasePostgres.php.
Wikimedia\Rdbms\DatabasePostgres::remappedTableName | ( | $name | ) |
string | $name |
Definition at line 740 of file DatabasePostgres.php.
References $name.
Referenced by Wikimedia\Rdbms\PostgresField\fromText(), and Wikimedia\Rdbms\DatabasePostgres\tableName().
Wikimedia\Rdbms\DatabasePostgres::resetSequenceForTable | ( | $table, | |
$fname = __METHOD__ |
|||
) |
Definition at line 862 of file DatabasePostgres.php.
References $fname, $res, Wikimedia\Rdbms\DatabasePostgres\addQuotes(), as, Wikimedia\Rdbms\DatabasePostgres\fetchObject(), Wikimedia\Rdbms\DatabasePostgres\getCoreSchemas(), Wikimedia\Rdbms\DatabasePostgres\numRows(), Wikimedia\Rdbms\Database\query(), and Wikimedia\Rdbms\DatabasePostgres\tableName().
Wikimedia\Rdbms\DatabasePostgres::roleExists | ( | $roleName | ) |
Returns true if a given role (i.e.
user) exists, false otherwise.
string | $roleName |
Definition at line 1257 of file DatabasePostgres.php.
References Wikimedia\Rdbms\Database\selectField().
Wikimedia\Rdbms\DatabasePostgres::ruleExists | ( | $table, | |
$rule | |||
) |
Definition at line 1208 of file DatabasePostgres.php.
References Wikimedia\Rdbms\DatabasePostgres\getCoreSchemas(), and Wikimedia\Rdbms\Database\selectField().
Wikimedia\Rdbms\DatabasePostgres::schemaExists | ( | $schema | ) |
Query whether a given schema exists.
Returns true if it does, false if it doesn't.
string | $schema |
Definition at line 1241 of file DatabasePostgres.php.
References Wikimedia\Rdbms\Database\selectField().
Referenced by Wikimedia\Rdbms\DatabasePostgres\determineCoreSchema().
Wikimedia\Rdbms\DatabasePostgres::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.
This can be useful for doing UNION queries, where the SQL text of each query is needed. In general, however, callers outside of Database classes should just use select().
string | array | $table | Table name |
string | array | $vars | Field names |
string | array | $conds | Conditions |
string | $fname | Caller function name |
string | array | $options | Query options |
string | array | $join_conds | Join conditions |
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 526 of file DatabasePostgres.php.
References $fname, $name, $options, $vars, Wikimedia\Rdbms\Database\addIdentifierQuotes(), and key.
Referenced by Wikimedia\Rdbms\DatabasePostgres\buildGroupConcatField(), and Wikimedia\Rdbms\DatabasePostgres\nativeInsertSelect().
Wikimedia\Rdbms\DatabasePostgres::sequenceExists | ( | $sequence, | |
$schema = false |
|||
) |
Definition at line 1180 of file DatabasePostgres.php.
References Wikimedia\Rdbms\DatabasePostgres\relationExists().
Wikimedia\Rdbms\DatabasePostgres::serverIsReadOnly | ( | ) |
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 1461 of file DatabasePostgres.php.
References $res, Wikimedia\Rdbms\DatabasePostgres\fetchObject(), and Wikimedia\Rdbms\Database\query().
|
private |
Update search_path, values should already be sanitized Values may contain magic keywords like "$user".
array | $search_path | List of schemas to be searched by default |
Definition at line 1035 of file DatabasePostgres.php.
References Wikimedia\Rdbms\Database\query().
Referenced by Wikimedia\Rdbms\DatabasePostgres\determineCoreSchema().
Wikimedia\Rdbms\DatabasePostgres::streamStatementEnd | ( | & | $sql, |
& | $newLine | ||
) |
Called by sourceStream() to check if we've reached a statement end.
string | &$sql | SQL assembled so far |
string | &$newLine | New line about to be added to $sql |
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 1372 of file DatabasePostgres.php.
Wikimedia\Rdbms\DatabasePostgres::strencode | ( | $s | ) |
Wrapper for addslashes()
string | $s | String to be slashed. |
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 1301 of file DatabasePostgres.php.
References $s, and Wikimedia\Rdbms\Database\getBindingHandle().
Referenced by Wikimedia\Rdbms\DatabasePostgres\indexUnique().
Wikimedia\Rdbms\DatabasePostgres::tableExists | ( | $table, | |
$fname = __METHOD__ , |
|||
$schema = false |
|||
) |
For backward compatibility, this function checks both tables and views.
string | $table | |
string | $fname | |
bool | string | $schema |
Definition at line 1176 of file DatabasePostgres.php.
References Wikimedia\Rdbms\DatabasePostgres\relationExists().
Wikimedia\Rdbms\DatabasePostgres::tableName | ( | $name, | |
$format = 'quoted' |
|||
) |
Format a table name ready for use in constructing an SQL query.
This does two important things: it quotes the table names to clean them up, and it adds a table prefix if only given a table name with no quotes.
All functions of this object which require a table name call this function themselves. Pass the canonical name to such functions. This is only needed when calling query() directly.
string | $name | Database table name |
string | $format | One of: quoted - Automatically pass the table name through addIdentifierQuotes() so that it can be used in a query. raw - Do not add identifier quotes to the table name |
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 729 of file DatabasePostgres.php.
References $name, Wikimedia\Rdbms\DatabasePostgres\remappedTableName(), and tableName().
Referenced by Wikimedia\Rdbms\DatabasePostgres\doLockTables(), Wikimedia\Rdbms\DatabasePostgres\insert(), Wikimedia\Rdbms\DatabasePostgres\nativeInsertSelect(), Wikimedia\Rdbms\DatabasePostgres\resetSequenceForTable(), and Wikimedia\Rdbms\DatabasePostgres\textFieldSize().
Wikimedia\Rdbms\DatabasePostgres::textFieldSize | ( | $table, | |
$field | |||
) |
Returns the size of a text field, or -1 for "unlimited".
string | $table | |
string | $field |
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 772 of file DatabasePostgres.php.
References $res, Wikimedia\Rdbms\DatabasePostgres\fetchObject(), Wikimedia\Rdbms\Database\query(), and Wikimedia\Rdbms\DatabasePostgres\tableName().
Wikimedia\Rdbms\DatabasePostgres::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.
The result is unquoted, and needs to be passed through addQuotes() before it can be included in raw SQL.
string | int | $ts |
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 917 of file DatabasePostgres.php.
Wikimedia\Rdbms\DatabasePostgres::triggerExists | ( | $table, | |
$trigger | |||
) |
Definition at line 1184 of file DatabasePostgres.php.
References $res, Wikimedia\Rdbms\DatabasePostgres\addQuotes(), as, FROM, Wikimedia\Rdbms\DatabasePostgres\getCoreSchemas(), and Wikimedia\Rdbms\Database\query().
Wikimedia\Rdbms\DatabasePostgres::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 |
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 1445 of file DatabasePostgres.php.
References Wikimedia\Rdbms\DatabasePostgres\addQuotes(), Wikimedia\Rdbms\DatabasePostgres\bigintFromLockName(), Wikimedia\Rdbms\DatabasePostgres\fetchObject(), and Wikimedia\Rdbms\Database\query().
Wikimedia\Rdbms\DatabasePostgres::wasConnectionError | ( | $errno | ) |
Do not use this method outside of Database/DBError classes.
int | string | $errno |
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 803 of file DatabasePostgres.php.
Wikimedia\Rdbms\DatabasePostgres::wasDeadlock | ( | ) |
Determines if the last failure was due to a deadlock.
Note that during a deadlock, the prior transaction will have been lost
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 793 of file DatabasePostgres.php.
References Wikimedia\Rdbms\DatabasePostgres\lastErrno().
|
protected |
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 810 of file DatabasePostgres.php.
Wikimedia\Rdbms\DatabasePostgres::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
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 798 of file DatabasePostgres.php.
References Wikimedia\Rdbms\DatabasePostgres\lastErrno().
|
private |
Connect string to open a PostgreSQL connection.
Definition at line 43 of file DatabasePostgres.php.
|
private |
Definition at line 45 of file DatabasePostgres.php.
Referenced by Wikimedia\Rdbms\DatabasePostgres\getCoreSchema().
|
private |
Map of (reserved table name => alternate table name)
Definition at line 49 of file DatabasePostgres.php.
|
protected |
Definition at line 38 of file DatabasePostgres.php.
Referenced by Wikimedia\Rdbms\DatabasePostgres\doQuery().
Definition at line 41 of file DatabasePostgres.php.
Referenced by Wikimedia\Rdbms\DatabasePostgres\getServerVersion().
|
protected |
Definition at line 35 of file DatabasePostgres.php.
|
private |
Definition at line 47 of file DatabasePostgres.php.
Referenced by Wikimedia\Rdbms\DatabasePostgres\getCoreSchemas().