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

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)
 Run a query and return a DBMS-dependent wrapper (that has all IResultWrapper methods) More...
 
 duplicateTableStructure ( $oldName, $newName, $temporary=false, $fname=__METHOD__)
 Creates a new table with structure copied from existing table. More...
 
 encodeBlob ( $b)
 Some DBMSs have a special format for inserting into blob fields, they don't allow simple quoted strings to be inserted. More...
 
 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...
 
 getDBname ()
 Get the current DB name. 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...
 
 getServer ()
 Get the server hostname or IP address. 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__)
 List all tables on the database. 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...
 
 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...
 
 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 result object. More...
 
 open ( $server, $user, $password, $dbName)
 Open a new connection to the database (closing any existing one) 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...
 
 selectDB ( $db)
 Postgres doesn't support selectDB in the same way MySQL does. 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 using backticks or "double quotes" depending on the database type. 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...
 
 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...
 
 getDomainID ()
 
 getFlag ( $flag)
 Returns a boolean whether the flag $flag is set for this connection. More...
 
 getInfinity ()
 Find out when 'infinity' is. More...
 
 getLag ()
 Get the amount of replication lag for this database server. More...
 
 getLBInfo ( $name=null)
 Get properties passed down from the server info array of the load balancer. More...
 
 getMasterPos ()
 Get the position of this master. More...
 
 getProperty ( $name)
 
 getReplicaPos ()
 Get the replication position of this replica DB. More...
 
 getScopedLockAndFlush ( $lockKey, $fname, $timeout)
 Acquire a named lock, flush any transaction, and return an RAII style unlocker object. More...
 
 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...
 
 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...
 
 onTransactionIdle (callable $callback, $fname=__METHOD__)
 Run a callback as soon as there is no transaction pending. More...
 
 onTransactionPreCommitOrIdle (callable $callback, $fname=__METHOD__)
 Run a callback before the current transaction commits or now if there is none. More...
 
 onTransactionResolution (callable $callback, $fname=__METHOD__)
 Run a callback as soon as the current transaction commits or rolls back. More...
 
 pendingWriteCallers ()
 Get the list of method names that did write queries for this transaction. More...
 
 pendingWriteQueryDuration ( $type=self::ESTIMATE_TOTAL)
 Get the time spend running write queries for this transaction. More...
 
 pendingWriteRowsAffected ()
 Get the number of affected rows from pending write queries. More...
 
 ping (&$rtt=null)
 Ping the server and try to reconnect if it there is no connection. More...
 
 query ( $sql, $fname=__METHOD__, $tempIgnore=false)
 Run an SQL query and return the result. More...
 
 replace ( $table, $uniqueIndexes, $rows, $fname=__METHOD__)
 REPLACE query wrapper. More...
 
 reportConnectionError ( $error='Unknown error')
 
 reportQueryError ( $error, $errno, $sql, $fname, $tempIgnore=false)
 Report a query error. More...
 
 restoreFlags ( $state=self::RESTORE_PRIOR)
 Restore the flags to their prior state before the last setFlag/clearFlag call. More...
 
 rollback ( $fname=__METHOD__, $flush='')
 Rollback a transaction previously started using begin(). More...
 
 runOnTransactionIdleCallbacks ( $trigger)
 Actually run and consume any "on transaction idle/resolution" callbacks. More...
 
 runOnTransactionPreCommitCallbacks ()
 Actually run and consume any "on transaction pre-commit" callbacks. More...
 
 runTransactionListenerCallbacks ( $trigger)
 Actually run any "transaction listener" callbacks. More...
 
 select ( $table, $vars, $conds='', $fname=__METHOD__, $options=[], $join_conds=[])
 Execute a SELECT query constructed using the various parameters provided. More...
 
 selectField ( $table, $var, $cond='', $fname=__METHOD__, $options=[], $join_conds=[])
 A SELECT wrapper which returns a single field from a single result row. More...
 
 selectFieldValues ( $table, $var, $cond='', $fname=__METHOD__, $options=[], $join_conds=[])
 A SELECT wrapper which returns a list of single field values from result rows. More...
 
 selectRow ( $table, $vars, $conds, $fname=__METHOD__, $options=[], $join_conds=[])
 Single row SELECT wrapper. More...
 
 selectRowCount ( $tables, $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 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, array $uniqueIndexes, array $set, $fname=__METHOD__)
 INSERT ON DUPLICATE KEY UPDATE wrapper, upserts an array into a table. More...
 
 useIndexClause ( $index)
 USE INDEX clause. More...
 
 wasConnectionLoss ()
 Determines if the last query error was due to a dropped connection. More...
 
 wasErrorReissuable ()
 Determines if the last query error was due to something outside of the query itself. More...
 
 wasReadOnlyError ()
 Determines if the last failure was due to the database being read-only. More...
 
 writesOrCallbacksPending ()
 Returns true if there is a transaction/round open with possible write queries or transaction pre-commit/idle callbacks waiting on it to finish. More...
 
 writesPending ()
 
- Public Member Functions inherited from Wikimedia\Rdbms\IDatabase
 buildSubString ( $input, $startPosition, $length=null)
 Build a SUBSTRING function. More...
 

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...
 
 wasKnownStatementRollbackError ()
 
- Protected Member Functions inherited from Wikimedia\Rdbms\Database
 assertBuildSubstringParams ( $startPosition, $length)
 Check type and bounds for parameters to self::buildSubstring() More...
 
 assertOpen ()
 Make sure isOpen() returns true as a sanity check. More...
 
 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 ()
 
 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)
 
 pendingWriteAndCallbackCallers ()
 Get the list of method names that have pending write queries or callbacks for this transaction. More...
 
 qualifiedTableComponents ( $name)
 Get the table components needed for a query given the currently selected database. More...
 
 registerTempTableOperation ( $sql)
 
 replaceLostConnection ( $fname)
 Close any existing (dead) database connection and open a new connection. More...
 
 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...
 
resource null $conn = null
 Database connection. More...
 
array $connectionParams = []
 Parameters used by initConnection() to establish a connection. More...
 
LoggerInterface $connLogger
 
DatabaseDomain $currentDomain
 
string $dbName
 Database that this instance is currently connected to. More...
 
string $delimiter = ';'
 
callback $deprecationLogger
 Deprecation logging callback. More...
 
callback $errorLogger
 Error logging callback. More...
 
int $flags
 
string bool null $htmlErrors
 Stashed value of html_errors INI setting. More...
 
string[] $indexAliases = []
 Map of (index alias => index) More...
 
float $lastPing = 0.0
 UNIX timestamp. More...
 
string $lastQuery = ''
 SQL query. More...
 
float bool $lastWriteTime = false
 UNIX timestamp of last write query. More...
 
array $lbInfo = []
 
int $nonNativeInsertSelectBatchSize = 10000
 
bool $opened = false
 
string $password
 Password used to establish the current connection. More...
 
string bool $phpError = false
 
array null $preparedArgs
 
object string $profiler
 Class name or object With profileIn/profileOut methods. More...
 
LoggerInterface $queryLogger
 
string $schema = ''
 
array bool $schemaVars = false
 
string $server
 Server that this instance is currently connected to. More...
 
array $sessionTempTables = []
 Map of (table name => 1) for TEMPORARY tables. More...
 
array $sessionVars = []
 
BagOStuff $srvCache
 APC cache. More...
 
array[] $tableAliases = []
 Map of (table => (dbname, schema, prefix) map) More...
 
string $tablePrefix = ''
 
array[] $trxEndCallbacks = []
 List of (callable, method name, atomic section id) More...
 
bool $trxEndCallbacksSuppressed = false
 Whether to suppress triggering of transaction end callbacks. More...
 
array[] $trxIdleCallbacks = []
 List of (callable, method name, atomic section id) More...
 
int $trxLevel = 0
 Either 1 if a transaction is active or 0 otherwise. More...
 
array[] $trxPreCommitCallbacks = []
 List of (callable, method name, atomic section id) More...
 
TransactionProfiler $trxProfiler
 
callable[] $trxRecurringCallbacks = []
 Map of (name => callable) More...
 
string $trxShortId = ''
 Either a short hexidecimal string if a transaction is active or "". More...
 
int $trxStatus = self::STATUS_TRX_NONE
 Transaction status. More...
 
Exception null $trxStatusCause
 The last error that caused the status to become STATUS_TRX_ERROR. More...
 
array null $trxStatusIgnoredCause
 If wasKnownStatementRollbackError() prevented trxStatus from being set, the relevant details are stored here. More...
 
string $user
 User that this instance is currently connected under the name of. More...
 

Private 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

- 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...
 
- 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...
 
static getAttributes ()
 

Detailed Description

Definition at line 33 of file DatabasePostgres.php.

Constructor & Destructor Documentation

◆ __construct()

Wikimedia\Rdbms\DatabasePostgres::__construct ( array  $params)
See also
Database::__construct()
Parameters
array$paramsAdditional parameters include:
  • keywordTableMap : Map of reserved table names to alternative table names to use

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 56 of file DatabasePostgres.php.

References $params, and port().

Member Function Documentation

◆ addQuotes()

◆ aggregateValue()

Wikimedia\Rdbms\DatabasePostgres::aggregateValue (   $valuedata,
  $valuename = 'value' 
)

Return aggregated value alias.

Parameters
array$valuedata
string$valuename
Returns
string

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 942 of file DatabasePostgres.php.

◆ bigintFromLockName()

Wikimedia\Rdbms\DatabasePostgres::bigintFromLockName (   $lockName)
private
Parameters
string$lockName
Returns
string Integer

Definition at line 1454 of file DatabasePostgres.php.

Referenced by Wikimedia\Rdbms\DatabasePostgres\lock(), Wikimedia\Rdbms\DatabasePostgres\lockIsFree(), and Wikimedia\Rdbms\DatabasePostgres\unlock().

◆ buildConcat()

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

Build a concatenation list to feed into a SQL query.

Parameters
array$stringListList of raw SQL expressions; caller is responsible for any quoting
Returns
string

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 1338 of file DatabasePostgres.php.

◆ buildGroupConcatField()

Wikimedia\Rdbms\DatabasePostgres::buildGroupConcatField (   $delimiter,
  $table,
  $field,
  $conds = '',
  $options = [],
  $join_conds = [] 
)

◆ buildStringCast()

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

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 1350 of file DatabasePostgres.php.

◆ closeConnection()

Wikimedia\Rdbms\DatabasePostgres::closeConnection ( )
protected

Closes underlying database connection.

Since
1.20
Returns
bool Whether connection was closed successfully

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 201 of file DatabasePostgres.php.

◆ constraintExists()

Wikimedia\Rdbms\DatabasePostgres::constraintExists (   $table,
  $constraint 
)

◆ currentSequenceValue()

Wikimedia\Rdbms\DatabasePostgres::currentSequenceValue (   $seqName)

Return the current value of a sequence.

Assumes it has been nextval'ed in this session.

Parameters
string$seqName
Returns
int

Definition at line 747 of file DatabasePostgres.php.

References $res, Wikimedia\Rdbms\DatabasePostgres\fetchRow(), and Wikimedia\Rdbms\Database\query().

◆ databasesAreIndependent()

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.

Returns
bool
Since
1.29

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 169 of file DatabasePostgres.php.

◆ dataSeek()

Wikimedia\Rdbms\DatabasePostgres::dataSeek (   $res,
  $row 
)

Change the position of the cursor in a result object.

See also
https://secure.php.net/mysql_data_seek
Parameters
mixed$resA SQL result
int$row

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 344 of file DatabasePostgres.php.

References $res.

◆ decodeBlob()

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.

Parameters
string | Blob$b
Returns
string

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 1265 of file DatabasePostgres.php.

◆ determineCoreSchema()

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

Since
1.19
Parameters
string$desiredSchema

Definition at line 1027 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().

◆ doLockTables()

Wikimedia\Rdbms\DatabasePostgres::doLockTables ( array  $read,
array  $write,
  $method 
)

Helper function for lockTables() that handles the actual table locking.

Parameters
array$readArray of tables to lock for read access
array$writeArray of tables to lock for write access
string$methodName of caller
Returns
true

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 1367 of file DatabasePostgres.php.

References as, Wikimedia\Rdbms\Database\query(), and Wikimedia\Rdbms\DatabasePostgres\tableName().

◆ doQuery()

Wikimedia\Rdbms\DatabasePostgres::doQuery (   $sql)

Run a query and return a DBMS-dependent wrapper (that has all IResultWrapper methods)

This might return things, such as mysqli_result, that do not formally implement IResultWrapper, but nonetheless implement all of its methods correctly

Parameters
string$sqlSQL query.
Returns
IResultWrapper|bool Iterator to feed to fetchObject/fetchRow; false on failure

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 210 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().

◆ dumpError()

Wikimedia\Rdbms\DatabasePostgres::dumpError ( )
protected

Definition at line 229 of file DatabasePostgres.php.

References as.

◆ duplicateTableStructure()

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).

Parameters
string$oldNameName of table whose structure should be copied
string$newNameName of table to be created
bool$temporaryWhether the new table should be temporary
string$fnameCalling function name
Returns
bool True if operation was successful
Exceptions
RuntimeException

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 798 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().

◆ encodeBlob()

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().

Parameters
string$b
Returns
string|Blob

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 1261 of file DatabasePostgres.php.

◆ estimateRowCount()

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()

Parameters
string$table
string$var
string$conds
string$fname
array$options
array$join_conds
Returns
int

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 395 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().

◆ fetchAffectedRowCount()

Wikimedia\Rdbms\DatabasePostgres::fetchAffectedRowCount ( )
protected
Returns
int Number of retrieved rows according to the driver

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 372 of file DatabasePostgres.php.

◆ fetchObject()

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.

Parameters
IResultWrapper | stdClass$resObject as returned from IDatabase::query(), etc.
Returns
stdClass|bool
Exceptions
DBUnexpectedErrorThrown if the database returns an error

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 262 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().

◆ fetchRow()

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.

Parameters
IResultWrapper$resResult object as returned from IDatabase::query(), etc.
Returns
array|bool
Exceptions
DBUnexpectedErrorThrown if the database returns an error

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 284 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().

◆ fieldInfo()

Wikimedia\Rdbms\DatabasePostgres::fieldInfo (   $table,
  $field 
)
Parameters
string$table
string$field
Returns
PostgresField|null

Implements Wikimedia\Rdbms\IMaintainableDatabase.

Definition at line 1243 of file DatabasePostgres.php.

References Wikimedia\Rdbms\PostgresField\fromText().

◆ fieldName()

Wikimedia\Rdbms\DatabasePostgres::fieldName (   $res,
  $n 
)

Get a field name in a result object.

See also
https://secure.php.net/mysql_field_name
Parameters
mixed$resA SQL result
int$n
Returns
string

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 330 of file DatabasePostgres.php.

References $res.

◆ fieldType()

Wikimedia\Rdbms\DatabasePostgres::fieldType (   $res,
  $index 
)

pg_field_type() wrapper

Parameters
ResultWrapper | resource$resResultWrapper or PostgreSQL query result resource
int$indexField number, starting from 0
Returns
string

Definition at line 1253 of file DatabasePostgres.php.

References $res.

◆ freeResult()

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.

Parameters
mixed$resA SQL result

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 250 of file DatabasePostgres.php.

References $res.

◆ getCoreSchema()

Wikimedia\Rdbms\DatabasePostgres::getCoreSchema ( )

Return schema name for core application tables.

Since
1.19
Returns
string Core schema name

Definition at line 1064 of file DatabasePostgres.php.

References Wikimedia\Rdbms\DatabasePostgres\$coreSchema.

Referenced by Wikimedia\Rdbms\DatabasePostgres\duplicateTableStructure(), and Wikimedia\Rdbms\DatabasePostgres\getCoreSchemas().

◆ getCoreSchemas()

◆ getCurrentSchema()

Wikimedia\Rdbms\DatabasePostgres::getCurrentSchema ( )

Return current schema (executes SELECT current_schema()) Needs transaction.

Since
1.19
Returns
string Default schema for the current session

Definition at line 957 of file DatabasePostgres.php.

References $res, Wikimedia\Rdbms\DatabasePostgres\fetchRow(), and Wikimedia\Rdbms\Database\query().

Referenced by Wikimedia\Rdbms\DatabasePostgres\determineCoreSchema().

◆ getDBname()

Wikimedia\Rdbms\DatabasePostgres::getDBname ( )

Get the current DB name.

Returns
string

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 1330 of file DatabasePostgres.php.

References Wikimedia\Rdbms\Database\$dbName.

◆ getSchemas()

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.

See also
getSearchPath()
setSearchPath()
Since
1.19
Returns
array List of actual schemas for the current sesson

Definition at line 974 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().

◆ getSearchPath()

Wikimedia\Rdbms\DatabasePostgres::getSearchPath ( )

Return search patch for schemas This is different from getSchemas() since it contain magic keywords (like "$user").

Needs transaction

Since
1.19
Returns
array How to search for table names schemas for the current user

Definition at line 993 of file DatabasePostgres.php.

References $res, Wikimedia\Rdbms\DatabasePostgres\fetchRow(), and Wikimedia\Rdbms\Database\query().

Referenced by Wikimedia\Rdbms\DatabasePostgres\determineCoreSchema().

◆ getServer()

Wikimedia\Rdbms\DatabasePostgres::getServer ( )

Get the server hostname or IP address.

Returns
string

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 1334 of file DatabasePostgres.php.

References Wikimedia\Rdbms\Database\$server.

◆ getServerVersion()

Wikimedia\Rdbms\DatabasePostgres::getServerVersion ( )

A string describing the current software version, like from mysql_get_server_info().

Returns
string Version information from the database server.

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 1091 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().

◆ getSoftwareLink()

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.

Returns
string Wikitext of a link to the server software's web site

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 946 of file DatabasePostgres.php.

◆ getType()

Wikimedia\Rdbms\DatabasePostgres::getType ( )

Get the type of the DBMS, as it appears in $wgDBtype.

Returns
string

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 65 of file DatabasePostgres.php.

◆ hasConstraint()

◆ implicitGroupby()

Wikimedia\Rdbms\DatabasePostgres::implicitGroupby ( )

Returns true if this database does an implicit sort when doing GROUP BY.

Returns
bool
Deprecated:
Since 1.30; only use grouped or aggregated fields in the SELECT

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 69 of file DatabasePostgres.php.

◆ implicitOrderby()

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.

Returns
bool

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 73 of file DatabasePostgres.php.

◆ indexAttributes()

Wikimedia\Rdbms\DatabasePostgres::indexAttributes (   $index,
  $schema = false 
)

◆ indexInfo()

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

Get information about an index into an object.

Parameters
string$tableTable name
string$indexIndex name
string$fnameCalling function name
Returns
mixed Database-specific index description class or false if the index does not exist

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 418 of file DatabasePostgres.php.

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

◆ indexUnique()

Wikimedia\Rdbms\DatabasePostgres::indexUnique (   $table,
  $index,
  $fname = __METHOD__ 
)

◆ insert()

◆ insertId()

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.

Returns
int

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 338 of file DatabasePostgres.php.

References $res, Wikimedia\Rdbms\DatabasePostgres\fetchRow(), and Wikimedia\Rdbms\Database\query().

◆ isTransactableQuery()

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

Determine whether a SQL statement is sensitive to isolation level.

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

Parameters
string$sql
Returns
bool

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 205 of file DatabasePostgres.php.

◆ lastErrno()

Wikimedia\Rdbms\DatabasePostgres::lastErrno ( )

◆ lastError()

Wikimedia\Rdbms\DatabasePostgres::lastError ( )

Get a description of the last error.

See also
https://secure.php.net/mysql_error
Returns
string

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 352 of file DatabasePostgres.php.

References Wikimedia\Rdbms\Database\getLastPHPError().

Referenced by Wikimedia\Rdbms\DatabasePostgres\open().

◆ limitResult()

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.

Parameters
string$sqlSQL query we will append the limit too
int$limitThe SQL limit
int | bool$offsetThe SQL offset (default false)
Exceptions
DBUnexpectedError
Returns
string

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 773 of file DatabasePostgres.php.

◆ listTables()

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

List all tables on the database.

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

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 874 of file DatabasePostgres.php.

References $fname, $vars, as, Wikimedia\Rdbms\DatabasePostgres\getCoreSchemas(), and Wikimedia\Rdbms\Database\query().

◆ lock()

Wikimedia\Rdbms\DatabasePostgres::lock (   $lockName,
  $method,
  $timeout = 5 
)

Acquire a named lock.

Named locks are not related to transactions

Parameters
string$lockNameName of lock to aquire
string$methodName of the calling method
int$timeoutAcquisition timeout in seconds
Returns
bool
Exceptions
DBError

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 1407 of file DatabasePostgres.php.

References $res, Wikimedia\Rdbms\DatabasePostgres\addQuotes(), Wikimedia\Rdbms\DatabasePostgres\bigintFromLockName(), Wikimedia\Rdbms\DatabasePostgres\fetchObject(), Wikimedia\Rdbms\Database\query(), and use.

◆ lockIsFree()

Wikimedia\Rdbms\DatabasePostgres::lockIsFree (   $lockName,
  $method 
)

Check to see if a named lock is not locked by any thread (non-blocking)

Parameters
string$lockNameName of lock to poll
string$methodName of method calling us
Returns
bool
Exceptions
DBError
Since
1.20

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 1394 of file DatabasePostgres.php.

References Wikimedia\Rdbms\DatabasePostgres\addQuotes(), Wikimedia\Rdbms\DatabasePostgres\bigintFromLockName(), Wikimedia\Rdbms\DatabasePostgres\fetchObject(), and Wikimedia\Rdbms\Database\query().

◆ makeConnectionString()

Wikimedia\Rdbms\DatabasePostgres::makeConnectionString (   $vars)
private
Parameters
string[]$vars
Returns
string

Definition at line 192 of file DatabasePostgres.php.

References $name, $s, $value, $vars, and as.

Referenced by Wikimedia\Rdbms\DatabasePostgres\open().

◆ makeSelectOptions()

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.

Parameters
array$optionsAssociative array of options to be turned into an SQL query, valid keys are listed in the function.
Returns
array
See also
Database::select()

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 1301 of file DatabasePostgres.php.

References $options, as, Wikimedia\Rdbms\Database\makeGroupByWithHaving(), and Wikimedia\Rdbms\Database\makeOrderBy().

◆ makeUpdateOptionsArray()

Wikimedia\Rdbms\DatabasePostgres::makeUpdateOptionsArray (   $options)
protected

Make UPDATE options array for Database::makeUpdateOptions.

Parameters
array$options
Returns
array

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 643 of file DatabasePostgres.php.

References $options.

◆ nativeInsertSelect()

Wikimedia\Rdbms\DatabasePostgres::nativeInsertSelect (   $destTable,
  $srcTable,
  $varMap,
  $conds,
  $fname = __METHOD__,
  $insertOptions = [],
  $selectOptions = [],
  $selectJoinConds = [] 
)

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.

Todo:
FIXME: Implement this a little better (seperate select/insert)?
Parameters
string$destTable
array | string$srcTable
array$varMap
array$conds
string$fname
array$insertOptions
array$selectOptions
array$selectJoinConds
Returns
bool

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 674 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().

◆ nextSequenceValue()

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.

Deprecated:
since 1.30, no longer needed
Parameters
string$seqName
Returns
null|NextSequenceValue

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 737 of file DatabasePostgres.php.

◆ numFields()

Wikimedia\Rdbms\DatabasePostgres::numFields (   $res)

Get the number of fields in a result object.

See also
https://secure.php.net/mysql_num_fields
Parameters
mixed$resA SQL result
Returns
int

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 322 of file DatabasePostgres.php.

References $res.

◆ numRows()

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

Get the number of rows in a result object.

Parameters
mixed$resA SQL result
Returns
int

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 303 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().

◆ open()

◆ pg_array_parse()

Wikimedia\Rdbms\DatabasePostgres::pg_array_parse (   $text,
$output,
  $limit = false,
  $offset = 1 
)
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

Since
1.19
Parameters
string$textPostgreql array returned in a text form like {a,b}
string[]$output
int | bool$limit
int$offset
Returns
string[]

Definition at line 915 of file DatabasePostgres.php.

References $output.

Referenced by Wikimedia\Rdbms\DatabasePostgres\getSchemas().

◆ realTableName()

Wikimedia\Rdbms\DatabasePostgres::realTableName (   $name,
  $format = 'quoted' 
)
Parameters
string$name
string$format
Returns
string Qualified and encoded (if requested) table name

Definition at line 733 of file DatabasePostgres.php.

References $name, and tableName().

Referenced by Wikimedia\Rdbms\DatabasePostgres\relationExists().

◆ relationExists()

Wikimedia\Rdbms\DatabasePostgres::relationExists (   $table,
  $types,
  $schema = false 
)
private

Query whether a given relation exists (in the given schema, or the default mw one if not given)

Parameters
string$table
array | string$types
bool | string$schema
Returns
bool

Definition at line 1118 of file DatabasePostgres.php.

References $res, Wikimedia\Rdbms\Database\$schema, 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().

◆ remappedTableName()

Wikimedia\Rdbms\DatabasePostgres::remappedTableName (   $name)
Parameters
string$name
Returns
string Value of $name or remapped name if $name is a reserved keyword

Definition at line 724 of file DatabasePostgres.php.

References $name.

Referenced by Wikimedia\Rdbms\PostgresField\fromText(), and Wikimedia\Rdbms\DatabasePostgres\tableName().

◆ resetSequenceForTable()

◆ roleExists()

Wikimedia\Rdbms\DatabasePostgres::roleExists (   $roleName)

Returns true if a given role (i.e.

user) exists, false otherwise.

Parameters
string$roleName
Returns
bool

Definition at line 1231 of file DatabasePostgres.php.

References Wikimedia\Rdbms\Database\selectField().

◆ ruleExists()

Wikimedia\Rdbms\DatabasePostgres::ruleExists (   $table,
  $rule 
)

◆ schemaExists()

Wikimedia\Rdbms\DatabasePostgres::schemaExists (   $schema)

Query whether a given schema exists.

Returns true if it does, false if it doesn't.

Parameters
string$schema
Returns
bool

Definition at line 1215 of file DatabasePostgres.php.

References Wikimedia\Rdbms\Database\$schema, and Wikimedia\Rdbms\Database\selectField().

Referenced by Wikimedia\Rdbms\DatabasePostgres\determineCoreSchema().

◆ selectDB()

Wikimedia\Rdbms\DatabasePostgres::selectDB (   $db)

Postgres doesn't support selectDB in the same way MySQL does.

So if the DB name doesn't match the open connection, open a new one

Parameters
string$db
Returns
bool
Exceptions
DBUnexpectedError

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 180 of file DatabasePostgres.php.

References Wikimedia\Rdbms\DatabasePostgres\open(), server, and user.

◆ selectSQLText()

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().

See also
IDatabase::select()
Parameters
string | array$tableTable name
string | array$varsField names
string | array$condsConditions
string$fnameCaller function name
string | array$optionsQuery options
string | array$join_condsJoin conditions
Returns
string SQL query string

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 509 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().

◆ sequenceExists()

Wikimedia\Rdbms\DatabasePostgres::sequenceExists (   $sequence,
  $schema = false 
)

◆ serverIsReadOnly()

Wikimedia\Rdbms\DatabasePostgres::serverIsReadOnly ( )
Returns
bool Whether the DB is marked as read-only server-side
Since
1.28

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 1443 of file DatabasePostgres.php.

References $res, Wikimedia\Rdbms\DatabasePostgres\fetchObject(), and Wikimedia\Rdbms\Database\query().

◆ setSearchPath()

Wikimedia\Rdbms\DatabasePostgres::setSearchPath (   $search_path)
private

Update search_path, values should already be sanitized Values may contain magic keywords like "$user".

Since
1.19
Parameters
array$search_pathList of schemas to be searched by default

Definition at line 1009 of file DatabasePostgres.php.

References Wikimedia\Rdbms\Database\query().

Referenced by Wikimedia\Rdbms\DatabasePostgres\determineCoreSchema().

◆ streamStatementEnd()

Wikimedia\Rdbms\DatabasePostgres::streamStatementEnd ( $sql,
$newLine 
)

Called by sourceStream() to check if we've reached a statement end.

Parameters
string&$sqlSQL assembled so far
string&$newLineNew line about to be added to $sql
Returns
bool Whether $newLine contains end of the statement

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 1354 of file DatabasePostgres.php.

◆ strencode()

Wikimedia\Rdbms\DatabasePostgres::strencode (   $s)

Wrapper for addslashes()

Parameters
string$sString to be slashed.
Returns
string Slashed string.

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 1275 of file DatabasePostgres.php.

References $s, and Wikimedia\Rdbms\Database\getBindingHandle().

Referenced by Wikimedia\Rdbms\DatabasePostgres\indexUnique().

◆ tableExists()

Wikimedia\Rdbms\DatabasePostgres::tableExists (   $table,
  $fname = __METHOD__,
  $schema = false 
)

For backward compatibility, this function checks both tables and views.

Parameters
string$table
string$fname
bool | string$schema
Returns
bool

Definition at line 1150 of file DatabasePostgres.php.

References Wikimedia\Rdbms\Database\$schema, and Wikimedia\Rdbms\DatabasePostgres\relationExists().

◆ tableName()

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.

Note
This function does not sanitize user input. It is not safe to use this function to escape user input.
Parameters
string$nameDatabase table name
string$formatOne 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
Returns
string Full database name

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 713 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().

◆ textFieldSize()

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

Returns the size of a text field, or -1 for "unlimited".

Parameters
string$table
string$field
Returns
int

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 756 of file DatabasePostgres.php.

References $res, Wikimedia\Rdbms\DatabasePostgres\fetchObject(), Wikimedia\Rdbms\Database\query(), and Wikimedia\Rdbms\DatabasePostgres\tableName().

◆ timestamp()

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.

Parameters
string | int$ts
Returns
string

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 891 of file DatabasePostgres.php.

◆ triggerExists()

Wikimedia\Rdbms\DatabasePostgres::triggerExists (   $table,
  $trigger 
)

◆ unlock()

Wikimedia\Rdbms\DatabasePostgres::unlock (   $lockName,
  $method 
)

Release a lock.

Named locks are not related to transactions

Parameters
string$lockNameName of lock to release
string$methodName of the calling method
Returns
int Returns 1 if the lock was released, 0 if the lock was not established by this thread (in which case the lock is not released), and NULL if the named lock did not exist
Exceptions
DBError

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 1427 of file DatabasePostgres.php.

References Wikimedia\Rdbms\DatabasePostgres\addQuotes(), Wikimedia\Rdbms\DatabasePostgres\bigintFromLockName(), Wikimedia\Rdbms\DatabasePostgres\fetchObject(), and Wikimedia\Rdbms\Database\query().

◆ wasConnectionError()

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

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

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

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 787 of file DatabasePostgres.php.

◆ wasDeadlock()

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

Returns
bool

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 777 of file DatabasePostgres.php.

References Wikimedia\Rdbms\DatabasePostgres\lastErrno().

◆ wasKnownStatementRollbackError()

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

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 794 of file DatabasePostgres.php.

◆ wasLockTimeout()

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

Returns
bool

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 782 of file DatabasePostgres.php.

References Wikimedia\Rdbms\DatabasePostgres\lastErrno().

Member Data Documentation

◆ $connectString

string Wikimedia\Rdbms\DatabasePostgres::$connectString
private

Connect string to open a PostgreSQL connection.

Definition at line 43 of file DatabasePostgres.php.

◆ $coreSchema

string Wikimedia\Rdbms\DatabasePostgres::$coreSchema
private

Definition at line 45 of file DatabasePostgres.php.

Referenced by Wikimedia\Rdbms\DatabasePostgres\getCoreSchema().

◆ $keywordTableMap

string [] Wikimedia\Rdbms\DatabasePostgres::$keywordTableMap = []
private

Map of (reserved table name => alternate table name)

Definition at line 49 of file DatabasePostgres.php.

◆ $lastResultHandle

resource Wikimedia\Rdbms\DatabasePostgres::$lastResultHandle = null
protected

Definition at line 38 of file DatabasePostgres.php.

Referenced by Wikimedia\Rdbms\DatabasePostgres\doQuery().

◆ $numericVersion

float string Wikimedia\Rdbms\DatabasePostgres::$numericVersion = null
private

◆ $port

int bool Wikimedia\Rdbms\DatabasePostgres::$port
protected

Definition at line 35 of file DatabasePostgres.php.

◆ $tempSchema

string Wikimedia\Rdbms\DatabasePostgres::$tempSchema
private

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