MediaWiki  1.23.8
DatabasePostgres Class Reference
Inheritance diagram for DatabasePostgres:
Collaboration diagram for DatabasePostgres:

Public Member Functions

 addQuotes ( $s)
 
 affectedRows ()
 Get the number of rows affected by the last write query. More...
 
 aggregateValue ( $valuedata, $valuename='value')
 Return aggregated value function call. More...
 
 buildConcat ( $stringList)
 Build a concatenation list to feed into a SQL query. More...
 
 buildGroupConcatField ( $delimiter, $table, $field, $conds='', $options=array(), $join_conds=array())
 
 cascadingDeletes ()
 Returns true if this database supports (and uses) cascading deletes. More...
 
 cleanupTriggers ()
 Returns true if this database supports (and uses) triggers (e.g. More...
 
 constraintExists ( $table, $constraint)
 
 currentSequenceValue ( $seqName)
 Return the current value of a sequence. More...
 
 dataSeek ( $res, $row)
 
 decodeBlob ( $b)
 Some DBMSs return a special placeholder object representing blob fields in result objects. More...
 
 determineCoreSchema ( $desiredSchema)
 Determine default schema for MediaWiki core Adjust this session schema search path if desired schema exists and is not alread there. More...
 
 doQuery ( $sql)
 The DBMS-dependent part of query() More...
 
 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. More...
 
 encodeBlob ( $b)
 
 estimateRowCount ( $table, $vars=' *', $conds='', $fname=__METHOD__, $options=array())
 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)
 
 fetchRow ( $res)
 Fetch the next row from the given result object, in associative array form. More...
 
 fieldInfo ( $table, $field)
 mysql_fetch_field() wrapper Returns false if the field doesn't exist More...
 
 fieldName ( $res, $n)
 Get a field name in a result object. More...
 
 fieldType ( $res, $index)
 pg_field_type() wrapper More...
 
 freeResult ( $res)
 
 functionalIndexes ()
 Returns true if this database can use functional indexes. More...
 
 getCoreSchema ()
 Return schema name fore core MediaWiki 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...
 
 getSearchEngine ()
 Get search engine class. 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 ()
 
 getSoftwareLink ()
 
 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)
 Returns is of attributes used in index. More...
 
 indexInfo ( $table, $index, $fname=__METHOD__)
 Returns information about an index If errors are explicitly ignored, returns NULL on failure. More...
 
 indexUnique ( $table, $index, $fname=__METHOD__)
 
 insert ( $table, $args, $fname=__METHOD__, $options=array())
 INSERT wrapper, inserts an array into a table. More...
 
 insertId ()
 Return the result of the last call to nextSequenceValue(); This must be called after nextSequenceValue(). More...
 
 insertSelect ( $destTable, $srcTable, $varMap, $conds, $fname=__METHOD__, $insertOptions=array(), $selectOptions=array())
 INSERT SELECT wrapper $varMap must be an associative array of the form array( '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. 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)
 See http://www.postgresql.org/docs/8.2/static/functions-admin.html#FUNCTIONS-ADVISORY-LOCKS. More...
 
 lockIsFree ( $lockName, $method)
 Check to see if a named lock is available. More...
 
 makeConnectionString ( $vars)
 
 makeSelectOptions ( $options)
 Various select options. More...
 
 nextSequenceValue ( $seqName)
 Return the next in a sequence, save the value for retrieval via insertId() 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)
 Usually aborts on failure. More...
 
 pg_array_parse ( $text, &$output, $limit=false, $offset=1)
 
 queryIgnore ( $sql, $fname=__METHOD__)
 
 realTableName ( $name, $format='quoted')
 
 realTimestamps ()
 Returns true if this database uses timestamps rather than integers. 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...
 
 reportQueryError ( $error, $errno, $sql, $fname, $tempIgnore=false)
 Report a query error. More...
 
 roleExists ( $roleName)
 Returns true if a given role (i.e. More...
 
 ruleExists ( $table, $rule)
 
 schemaExists ( $schema)
 Query whether a given schema exists. More...
 
 searchableIPs ()
 Returns true if this database can do a native search on IP columns e.g. More...
 
 selectDB ( $db)
 Postgres doesn't support selectDB in the same way MySQL does. More...
 
 selectSQLText ( $table, $vars, $conds='', $fname=__METHOD__, $options=array(), $join_conds=array())
 Change the FOR UPDATE option as necessary based on the join conditions. More...
 
 sequenceExists ( $sequence, $schema=false)
 
 setSearchPath ( $search_path)
 Update search_path, values should already be sanitized Values may contain magic keywords like "$user". More...
 
 streamStatementEnd (&$sql, &$newLine)
 Called by sourceStream() to check if we've reached a statement end. More...
 
 strencode ( $s)
 Wrapper for addslashes() More...
 
 strictIPs ()
 Returns true if this database is strict about what can be put into an IP field. 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)
 See http://www.postgresql.org/docs/8.2/static/functions-admin.html#FUNCTIONS-ADVISORY-LOCKSFROM PG DOCS: http://www.postgresql.org/docs/8.2/static/functions-admin.html#FUNCTIONS-ADVISORY-LOCKS. More...
 
 wasDeadlock ()
 Determines if the last failure was due to a deadlock STUB. More...
 
- Public Member Functions inherited from DatabaseBase
 __construct ( $params=null)
 Constructor. More...
 
 __destruct ()
 Run a few simple sanity checks. More...
 
 __sleep ()
 Called by serialize. More...
 
 __toString ()
 
 addIdentifierQuotes ( $s)
 Quotes an identifier using backticks or "double quotes" depending on the database type. 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__)
 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=array())
 Build a GROUP_CONCAT or equivalent statement for a query. More...
 
 buildLike ()
 LIKE statement wrapper, receives a variable-length argument list with parts of pattern to match containing either string literals that will be escaped or tokens returned by anyChar() or anyString(). More...
 
 clearFlag ( $flag)
 Clear a flag for this connection. More...
 
 clearViewsCache ()
 Reset the views process cache set by listViews() More...
 
 close ()
 Closes a database connection. More...
 
 commit ( $fname=__METHOD__, $flush='')
 Commits a transaction previously started using begin(). More...
 
 conditional ( $cond, $trueVal, $falseVal)
 Returns an SQL expression for a simple conditional. More...
 
 connectionErrorHandler ( $errno, $errstr)
 
 dbSchema ( $schema=null)
 Get/set the db schema. More...
 
 deadlockLoop ()
 Perform a deadlock-prone transaction. More...
 
 debug ( $debug=null)
 Boolean, controls output of large amounts of debug information. 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...
 
 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...
 
 errorCount ( $count=null)
 Get/set the number of errors logged. More...
 
 execute ( $prepared, $args=null)
 Execute a prepared query with the various arguments. More...
 
 fieldExists ( $table, $field, $fname=__METHOD__)
 Determines whether a field exists in a table. More...
 
 fieldNamesWithAlias ( $fields)
 Gets an array of aliased field names. More...
 
 fieldNameWithAlias ( $name, $alias=false)
 Get an aliased field name e.g. More...
 
 fillPrepared ( $preparedQuery, $args)
 For faking prepared SQL statements on DBs that don't support it directly. More...
 
 getDelimiter ()
 
 getFlag ( $flag)
 Returns a boolean whether the flag $flag is set for this connection. More...
 
 getInfinity ()
 Find out when 'infinity' is. More...
 
 getLag ()
 Get slave lag. More...
 
 getLBInfo ( $name=null)
 Get properties passed down from the server info array of the load balancer. More...
 
 getMasterPos ()
 Get the position of this master. More...
 
 getProperty ( $name)
 General read-only accessor. More...
 
 getSchemaPath ()
 Return a path to the DBMS-specific schema file, otherwise default to tables.sql. 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 STUB. More...
 
 getSlavePos ()
 Get the replication position of this slave. More...
 
 getWikiID ()
 
 ignoreErrors ( $ignoreErrors=null)
 Turns on (false) or off (true) the automatic generation and sending of a "we're sorry, but there has been a database error" page on database errors. More...
 
 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...
 
 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...
 
 isView ( $name)
 Differentiates between a TABLE and a VIEW. More...
 
 isWriteQuery ( $sql)
 Determine whether a query writes to the DB. More...
 
 lastQuery ()
 Return the last query that went through DatabaseBase::query() More...
 
 listViews ( $prefix=null, $fname=__METHOD__)
 Lists all the VIEWs in the database. More...
 
 lockTables ( $read, $write, $method, $lowPriority=true)
 Lock specific tables. More...
 
 lowPriorityOption ()
 A string to insert into queries to show that they're low-priority, like MySQL's LOW_PRIORITY. More...
 
 makeGroupByWithHaving ( $options)
 Returns an optional GROUP BY with an optional HAVING. More...
 
 makeList ( $a, $mode=LIST_COMMA)
 Makes an encoded list of strings from an array. More...
 
 makeOrderBy ( $options)
 Returns an optional ORDER BY. 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 slave 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...
 
 onTransactionIdle ( $callback)
 Run an anonymous function as soon as there is no transaction pending. More...
 
 onTransactionPreCommitOrIdle ( $callback)
 Run an anonymous function before the current transaction commits or now if there is none. More...
 
 patchPath ( $patch)
 Get the full path of a patch file. More...
 
 ping ()
 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')
 
 resultObject ( $result)
 Take the result from a query, and wrap it in a ResultWrapper if necessary. More...
 
 rollback ( $fname=__METHOD__, $flush='')
 Rollback a transaction previously started using begin(). More...
 
 select ( $table, $vars, $conds='', $fname=__METHOD__, $options=array(), $join_conds=array())
 Execute a SELECT query constructed using the various parameters provided. More...
 
 selectField ( $table, $var, $cond='', $fname=__METHOD__, $options=array())
 A SELECT wrapper which returns a single field from a single result row. More...
 
 selectRow ( $table, $vars, $conds, $fname=__METHOD__, $options=array(), $join_conds=array())
 Single row SELECT wrapper. More...
 
 setBigSelects ( $value=true)
 Allow or deny "big selects" for this session only. More...
 
 setFakeMaster ( $enabled=true)
 Make this connection a fake master. More...
 
 setFakeSlaveLag ( $lag)
 Set lag time in seconds for a fake slave. More...
 
 setFileHandle ( $fh)
 Set the filehandle to copy write statements to. More...
 
 setFlag ( $flag)
 Set a flag for this connection. More...
 
 setLBInfo ( $name, $value=null)
 Set the LB info array, or a member of it. 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...
 
 sourceFile ( $filename, $lineCallback=false, $resultCallback=false, $fname=false, $inputCallback=false)
 Read and execute SQL commands from a file. More...
 
 sourceStream ( $fp, $lineCallback=false, $resultCallback=false, $fname=__METHOD__, $inputCallback=false)
 Read and execute commands from an open file handle. More...
 
 startAtomic ( $fname=__METHOD__)
 Begin an atomic section of statements. More...
 
 strreplace ( $orig, $old, $new)
 Returns a comand for str_replace function in SQL query. More...
 
 tableExists ( $table, $fname=__METHOD__)
 Query whether a given table exists. 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...
 
 tableNamesWithAlias ( $tables)
 Gets an array of aliased table names. More...
 
 tableNameWithAlias ( $name, $alias=false)
 Get an aliased table name e.g. 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...
 
 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 specific tables. More...
 
 update ( $table, $values, $conds, $fname=__METHOD__, $options=array())
 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...
 
 wasErrorReissuable ()
 Determines if the last query error was something that should be dealt with by pinging the connection and reissuing the query. More...
 
 wasLockTimeout ()
 Determines if the last failure was due to a lock timeout STUB. More...
 
 wasReadOnlyError ()
 Determines if the last failure was due to the database being read-only. More...
 
 writesOrCallbacksPending ()
 Returns true if there is a transaction open with possible write queries or transaction pre-commit/idle callbacks waiting on it to finish. More...
 

Protected Member Functions

 closeConnection ()
 Closes a database connection, if it is open Returns success, true if already closed. More...
 
 dumpError ()
 
 replaceVars ( $ins)
 Postgres specific version of replaceVars. More...
 
- Protected Member Functions inherited from DatabaseBase
 doBegin ( $fname)
 Issues the BEGIN command to the database server. More...
 
 doCommit ( $fname)
 Issues the COMMIT command to the database server. More...
 
 doRollback ( $fname)
 Issues the ROLLBACK command to the database server. More...
 
 escapeLikeInternal ( $s)
 
 fillPreparedArg ( $matches)
 preg_callback func for fillPrepared() The arguments should be in $this->preparedArgs and must not be touched while we're doing this. More...
 
 freePrepared ( $prepared)
 Free a prepared query, generated by prepare(). More...
 
 getDefaultSchemaVars ()
 Get schema variables to use if none have been set via setSchemaVars(). More...
 
 getSchemaVars ()
 Get schema variables. More...
 
 indexName ( $index)
 Get the name of an index in a given table. More...
 
 indexNameCallback ( $matches)
 Index name callback. More...
 
 installErrorHandler ()
 
 makeInsertOptions ( $options)
 Helper for DatabaseBase::insert(). More...
 
 makeUpdateOptions ( $options)
 Make UPDATE options for the DatabaseBase::update function. More...
 
 makeUpdateOptionsArray ( $options)
 Make UPDATE options array for DatabaseBase::makeUpdateOptions. More...
 
 nativeReplace ( $table, $rows, $fname)
 REPLACE query wrapper for MySQL and SQLite, which have a native REPLACE statement. More...
 
 prepare ( $sql, $func='DatabaseBase::prepare')
 Intended to be compatible with the PEAR::DB wrapper functions. More...
 
 replaceSchemaVars ( $ins)
 Database independent variable replacement. More...
 
 restoreErrorHandler ()
 
 runOnTransactionIdleCallbacks ()
 Actually any "on transaction idle" callbacks. More...
 
 runOnTransactionPreCommitCallbacks ()
 Actually any "on transaction pre-commit" callbacks. More...
 
 tableNameCallback ( $matches)
 Table name callback. More...
 
 tableNamesWithUseIndexOrJOIN ( $tables, $use_index=array(), $join_conds=array())
 Get the aliased table name clause for a FROM clause which might have a JOIN and/or USE INDEX clause. More...
 

Protected Attributes

int $mAffectedRows = null
 The number of rows affected as an integer *. More...
 
resource $mLastResult = null
 
- Protected Attributes inherited from DatabaseBase
string[] $allViews = null
 
 $delimiter = ';'
 
resource $fileHandle = null
 
 $htmlErrors
 
resource $mConn = null
 Database connection *. More...
 
 $mDefaultBigSelects = null
 
 $mDoneWrites = false
 
 $mErrorCount = 0
 
 $mFlags
 
 $mForeign
 
 $mLastQuery = ''
 
 $mLBInfo = array()
 
 $mOpened = false
 
 $mPHPError = false
 
 $mSchema
 
 $mSchemaVars = false
 
 $mServer
 
 $mTablePrefix
 
callable[] $mTrxIdleCallbacks = array()
 
int $mTrxLevel = 0
 Either 1 if a transaction is active or 0 otherwise. More...
 
callable[] $mTrxPreCommitCallbacks = array()
 
 $preparedArgs
 

Private Member Functions

 bigintFromLockName ( $lockName)
 

Private Attributes

string $connectString
 Connect string to open a PostgreSQL connection *. More...
 
string $mCoreSchema
 
int $mInsertId = null
 
PostgresTransactionState $mTransactionState
 
float string $numericVersion = null
 

Additional Inherited Members

- Static Public Member Functions inherited from DatabaseBase
static factory ( $dbType, $p=array())
 Given a DB type, construct the name of the appropriate child class of DatabaseBase. More...
 
static generalizeSQL ( $sql)
 Removes most variables from an SQL query and replaces them with X or N for numbers. More...
 
- Public Attributes inherited from DatabaseBase
 $mDBname
 
 $mPassword
 
 $mUser
 
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...
 

Detailed Description

Definition at line 268 of file DatabasePostgres.php.

Member Function Documentation

◆ addQuotes()

DatabasePostgres::addQuotes (   $s)
Parameters
null | bool | Blob$s
Returns
int|string

Reimplemented from DatabaseBase.

Definition at line 1479 of file DatabasePostgres.php.

Referenced by schemaExists().

◆ affectedRows()

DatabasePostgres::affectedRows ( )

Get the number of rows affected by the last write query.

See also
http://www.php.net/mysql_affected_rows
Returns
int

Implements DatabaseType.

Definition at line 645 of file DatabasePostgres.php.

◆ aggregateValue()

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

Return aggregated value function call.

Reimplemented from DatabaseBase.

Definition at line 1172 of file DatabasePostgres.php.

References $output.

◆ bigintFromLockName()

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

Definition at line 1652 of file DatabasePostgres.php.

◆ buildConcat()

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

Definition at line 1562 of file DatabasePostgres.php.

References $options.

◆ buildGroupConcatField()

DatabasePostgres::buildGroupConcatField (   $delimiter,
  $table,
  $field,
  $conds = '',
  $options = array(),
  $join_conds = array() 
)

Definition at line 1566 of file DatabasePostgres.php.

◆ cascadingDeletes()

DatabasePostgres::cascadingDeletes ( )

Returns true if this database supports (and uses) cascading deletes.

Returns
bool

Reimplemented from DatabaseBase.

Definition at line 287 of file DatabasePostgres.php.

◆ cleanupTriggers()

DatabasePostgres::cleanupTriggers ( )

Returns true if this database supports (and uses) triggers (e.g.

on the page table)

Returns
bool

Reimplemented from DatabaseBase.

Definition at line 291 of file DatabasePostgres.php.

◆ closeConnection()

DatabasePostgres::closeConnection ( )
protected

Closes a database connection, if it is open Returns success, true if already closed.

Returns
bool

Reimplemented from DatabaseBase.

Definition at line 448 of file DatabasePostgres.php.

References open().

◆ constraintExists()

DatabasePostgres::constraintExists (   $table,
  $constraint 
)

Definition at line 1397 of file DatabasePostgres.php.

◆ currentSequenceValue()

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 1061 of file DatabasePostgres.php.

References $res, and DatabaseBase\query().

◆ dataSeek()

DatabasePostgres::dataSeek (   $res,
  $row 
)
Parameters
mixed$res
int$row
Returns
bool

Implements DatabaseType.

Definition at line 617 of file DatabasePostgres.php.

References $res.

◆ decodeBlob()

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$b
Returns
string

Reimplemented from DatabaseBase.

Definition at line 1463 of file DatabasePostgres.php.

◆ determineCoreSchema()

DatabasePostgres::determineCoreSchema (   $desiredSchema)

Determine default schema for MediaWiki core 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 1260 of file DatabasePostgres.php.

◆ doQuery()

DatabasePostgres::doQuery (   $sql)

The DBMS-dependent part of query()

Parameters
string$sqlSQL query.
Returns
ResultWrapper|bool Result object to feed to fetchObject, fetchRow, ...; or false on failure

Reimplemented from DatabaseBase.

Definition at line 452 of file DatabasePostgres.php.

◆ dumpError()

DatabasePostgres::dumpError ( )
protected

Definition at line 470 of file DatabasePostgres.php.

◆ duplicateTableStructure()

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
Exceptions
MWException
Returns
bool True if operation was successful

Reimplemented from DatabaseBase.

Definition at line 1096 of file DatabasePostgres.php.

◆ encodeBlob()

DatabasePostgres::encodeBlob (   $b)
Parameters
string$b
Returns
Blob

Reimplemented from DatabaseBase.

Definition at line 1459 of file DatabasePostgres.php.

References PostgresField\fromText().

◆ estimateRowCount()

DatabasePostgres::estimateRowCount (   $table,
  $vars = '*',
  $conds = '',
  $fname = __METHOD__,
  $options = array() 
)

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$vars
string$conds
string$fname
array$options
Returns
int

Reimplemented from DatabaseBase.

Definition at line 671 of file DatabasePostgres.php.

◆ fetchObject()

DatabasePostgres::fetchObject (   $res)
Parameters
ResultWrapper | stdClass$res
Returns
stdClass
Exceptions
DBUnexpectedError

Implements DatabaseType.

Definition at line 531 of file DatabasePostgres.php.

References $ok, $res, wfRestoreWarnings(), and wfSuppressWarnings().

Referenced by unlock().

◆ fetchRow()

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
ResultWrapper$resResult object as returned from DatabaseBase::query(), etc.
Returns
array|bool
Exceptions
DBUnexpectedErrorThrown if the database returns an error

Implements DatabaseType.

Definition at line 552 of file DatabasePostgres.php.

◆ fieldInfo()

DatabasePostgres::fieldInfo (   $table,
  $field 
)

mysql_fetch_field() wrapper Returns false if the field doesn't exist

Parameters
string$tableTable name
string$fieldField name
Returns
Field

Implements DatabaseType.

Definition at line 1437 of file DatabasePostgres.php.

◆ fieldName()

DatabasePostgres::fieldName (   $res,
  $n 
)

Get a field name in a result object.

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

Implements DatabaseType.

Definition at line 594 of file DatabasePostgres.php.

◆ fieldType()

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 1447 of file DatabasePostgres.php.

◆ freeResult()

DatabasePostgres::freeResult (   $res)
Parameters
stdClass | ResultWrapper$res
Exceptions
DBUnexpectedError

Reimplemented from DatabaseBase.

Definition at line 514 of file DatabasePostgres.php.

References $error, and $fname.

◆ functionalIndexes()

DatabasePostgres::functionalIndexes ( )

Returns true if this database can use functional indexes.

Returns
bool

Reimplemented from DatabaseBase.

Definition at line 315 of file DatabasePostgres.php.

◆ getCoreSchema()

DatabasePostgres::getCoreSchema ( )

Return schema name fore core MediaWiki tables.

Since
1.19
Returns
string core schema name

Definition at line 1294 of file DatabasePostgres.php.

Referenced by schemaExists().

◆ getCurrentSchema()

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 1190 of file DatabasePostgres.php.

◆ getDBname()

DatabasePostgres::getDBname ( )

Get the current DB name.

Reimplemented from DatabaseBase.

Definition at line 1554 of file DatabasePostgres.php.

◆ getSchemas()

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 1207 of file DatabasePostgres.php.

◆ getSearchEngine()

DatabasePostgres::getSearchEngine ( )

Get search engine class.

All subclasses of this need to implement this if they wish to use searching.

Returns
string

Reimplemented from DatabaseBase.

Definition at line 1574 of file DatabasePostgres.php.

◆ getSearchPath()

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 1226 of file DatabasePostgres.php.

◆ getServer()

DatabasePostgres::getServer ( )

Get the server hostname or IP address.

Reimplemented from DatabaseBase.

Definition at line 1558 of file DatabasePostgres.php.

◆ getServerVersion()

DatabasePostgres::getServerVersion ( )
Returns
string Version information from the database

Implements DatabaseType.

Definition at line 1301 of file DatabasePostgres.php.

◆ getSoftwareLink()

DatabasePostgres::getSoftwareLink ( )
Returns
string Wikitext of a link to the server software's web site

Implements DatabaseType.

Definition at line 1179 of file DatabasePostgres.php.

References $output.

◆ getType()

DatabasePostgres::getType ( )

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

Returns
string

Implements DatabaseType.

Definition at line 283 of file DatabasePostgres.php.

◆ hasConstraint()

DatabasePostgres::hasConstraint (   $name)

Definition at line 319 of file DatabasePostgres.php.

◆ implicitGroupby()

DatabasePostgres::implicitGroupby ( )

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

Returns
bool

Reimplemented from DatabaseBase.

Definition at line 303 of file DatabasePostgres.php.

◆ implicitOrderby()

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

Definition at line 307 of file DatabasePostgres.php.

◆ indexAttributes()

DatabasePostgres::indexAttributes (   $index,
  $schema = false 
)

Returns is of attributes used in index.

Since
1.19
Parameters
string$index
bool | string$schema
Returns
array

Definition at line 720 of file DatabasePostgres.php.

◆ indexInfo()

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

Returns information about an index If errors are explicitly ignored, returns NULL on failure.

Parameters
string$table
string$index
string$fname
Returns
bool|null

Implements DatabaseType.

Definition at line 697 of file DatabasePostgres.php.

◆ indexUnique()

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

Definition at line 777 of file DatabasePostgres.php.

References $res, array(), and as.

◆ insert()

DatabasePostgres::insert (   $table,
  $args,
  $fname = __METHOD__,
  $options = array() 
)

INSERT wrapper, inserts an array into a table.

$args may be a single associative array, or an array of these with numeric keys, for multi-row insert (Postgres version 8.2 and above only).

Parameters
string$tableName of the table to insert to.
array$argsItems to insert into the table.
string$fnameName of the function, for profiling
array | string$optionsString or array. Valid options: IGNORE
Returns
bool Success of insert operation. IGNORE always returns true.

Reimplemented from DatabaseBase.

Definition at line 835 of file DatabasePostgres.php.

◆ insertId()

DatabasePostgres::insertId ( )

Return the result of the last call to nextSequenceValue(); This must be called after nextSequenceValue().

Returns
int|null

Implements DatabaseType.

Definition at line 608 of file DatabasePostgres.php.

References $res.

◆ insertSelect()

DatabasePostgres::insertSelect (   $destTable,
  $srcTable,
  $varMap,
  $conds,
  $fname = __METHOD__,
  $insertOptions = array(),
  $selectOptions = array() 
)

INSERT SELECT wrapper $varMap must be an associative array of the form array( '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
Returns
bool

Reimplemented from DatabaseBase.

Definition at line 961 of file DatabasePostgres.php.

◆ lastErrno()

DatabasePostgres::lastErrno ( )

Get the last error number.

See also
http://www.php.net/mysql_errno
Returns
int

Implements DatabaseType.

Definition at line 637 of file DatabasePostgres.php.

◆ lastError()

DatabasePostgres::lastError ( )

Get a description of the last error.

See also
http://www.php.net/mysql_error
Returns
string

Implements DatabaseType.

Definition at line 625 of file DatabasePostgres.php.

◆ limitResult()

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

Definition at line 1088 of file DatabasePostgres.php.

◆ listTables()

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
MWException

Reimplemented from DatabaseBase.

Definition at line 1104 of file DatabasePostgres.php.

◆ lock()

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

See http://www.postgresql.org/docs/8.2/static/functions-admin.html#FUNCTIONS-ADVISORY-LOCKS.

Parameters
string$lockName
string$method
int$timeout
Returns
bool

Reimplemented from DatabaseBase.

Definition at line 1616 of file DatabasePostgres.php.

◆ lockIsFree()

DatabasePostgres::lockIsFree (   $lockName,
  $method 
)

Check to see if a named lock is available.

This is non-blocking. See http://www.postgresql.org/docs/8.2/static/functions-admin.html#FUNCTIONS-ADVISORY-LOCKS

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

Reimplemented from DatabaseBase.

Definition at line 1600 of file DatabasePostgres.php.

◆ makeConnectionString()

DatabasePostgres::makeConnectionString (   $vars)

Definition at line 434 of file DatabasePostgres.php.

◆ makeSelectOptions()

DatabasePostgres::makeSelectOptions (   $options)

Various select options.

Parameters
array$optionsan associative array of options to be turned into an SQL query, valid keys are listed in the function.
Returns
array

Reimplemented from DatabaseBase.

Definition at line 1520 of file DatabasePostgres.php.

◆ nextSequenceValue()

DatabasePostgres::nextSequenceValue (   $seqName)

Return the next in a sequence, save the value for retrieval via insertId()

Parameters
string$seqName
Returns
int|null

Reimplemented from DatabaseBase.

Definition at line 1046 of file DatabasePostgres.php.

References $name, and realTableName().

◆ numFields()

DatabasePostgres::numFields (   $res)

Get the number of fields in a result object.

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

Implements DatabaseType.

Definition at line 586 of file DatabasePostgres.php.

◆ numRows()

DatabasePostgres::numRows (   $res)

Get the number of rows in a result object.

Parameters
mixed$resA SQL result
Returns
int

Implements DatabaseType.

Definition at line 569 of file DatabasePostgres.php.

◆ open()

DatabasePostgres::open (   $server,
  $user,
  $password,
  $dbName 
)

Usually aborts on failure.

Parameters
string$server
string$user
string$password
string$dbName
Exceptions
DBConnectionError|Exception
Returns
DatabaseBase|null

Implements DatabaseType.

Definition at line 338 of file DatabasePostgres.php.

Referenced by closeConnection().

◆ pg_array_parse()

DatabasePostgres::pg_array_parse (   $text,
$output,
  $limit = false,
  $offset = 1 
)

Definition at line 1142 of file DatabasePostgres.php.

References TS_POSTGRES, and wfTimestamp().

◆ queryIgnore()

DatabasePostgres::queryIgnore (   $sql,
  $fname = __METHOD__ 
)

Definition at line 506 of file DatabasePostgres.php.

◆ realTableName()

DatabasePostgres::realTableName (   $name,
  $format = 'quoted' 
)

Definition at line 1036 of file DatabasePostgres.php.

Referenced by nextSequenceValue().

◆ realTimestamps()

DatabasePostgres::realTimestamps ( )

Returns true if this database uses timestamps rather than integers.

Returns
bool

Reimplemented from DatabaseBase.

Definition at line 299 of file DatabasePostgres.php.

◆ relationExists()

DatabasePostgres::relationExists (   $table,
  $types,
  $schema = false 
)

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 1327 of file DatabasePostgres.php.

◆ replaceVars()

DatabasePostgres::replaceVars (   $ins)
protected

Postgres specific version of replaceVars.

Calls the parent version in Database.php

Parameters
string$insSQL string, read from a stream (usually tables.sql)
Returns
string SQL string

Reimplemented from DatabaseBase.

Definition at line 1498 of file DatabasePostgres.php.

◆ reportQueryError()

DatabasePostgres::reportQueryError (   $error,
  $errno,
  $sql,
  $fname,
  $tempIgnore = false 
)

Report a query error.

Log the error, and if neither the object ignore flag nor the $tempIgnore flag is set, throw a DBQueryError.

Parameters
string$error
int$errno
string$sql
string$fname
bool$tempIgnore
Exceptions
DBQueryError

Reimplemented from DatabaseBase.

Definition at line 491 of file DatabasePostgres.php.

References array().

◆ roleExists()

DatabasePostgres::roleExists (   $roleName)

Returns true if a given role (i.e.

user) exists, false otherwise.

Parameters
string$roleName
Returns
bool

Definition at line 1430 of file DatabasePostgres.php.

◆ ruleExists()

DatabasePostgres::ruleExists (   $table,
  $rule 
)

Definition at line 1385 of file DatabasePostgres.php.

◆ schemaExists()

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 1418 of file DatabasePostgres.php.

References $res, addQuotes(), getCoreSchema(), and DatabaseBase\query().

◆ searchableIPs()

DatabasePostgres::searchableIPs ( )

Returns true if this database can do a native search on IP columns e.g.

this works as expected: .. WHERE rc_ip = '127.42.12.102/32';

Returns
bool

Reimplemented from DatabaseBase.

Definition at line 311 of file DatabasePostgres.php.

◆ selectDB()

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

Reimplemented from DatabaseBase.

Definition at line 426 of file DatabasePostgres.php.

◆ selectSQLText()

DatabasePostgres::selectSQLText (   $table,
  $vars,
  $conds = '',
  $fname = __METHOD__,
  $options = array(),
  $join_conds = array() 
)

Change the FOR UPDATE option as necessary based on the join conditions.

Then pass to the parent function to get the actual SQL text.

In Postgres when using FOR UPDATE, only the main table and tables that are inner joined can be locked. That means tables in an outer join cannot be FOR UPDATE locked. Trying to do so causes a DB error. This wrapper checks which tables can be locked and adjusts it accordingly.

MySQL uses "ORDER BY NULL" as an optimization hint, but that syntax is illegal in PostgreSQL.

Reimplemented from DatabaseBase.

Definition at line 800 of file DatabasePostgres.php.

◆ sequenceExists()

DatabasePostgres::sequenceExists (   $sequence,
  $schema = false 
)

Definition at line 1358 of file DatabasePostgres.php.

◆ setSearchPath()

DatabasePostgres::setSearchPath (   $search_path)

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

Since
1.19
Parameters
$search_patharray list of schemas to be searched by default

Definition at line 1242 of file DatabasePostgres.php.

◆ streamStatementEnd()

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

Definition at line 1578 of file DatabasePostgres.php.

◆ strencode()

DatabasePostgres::strencode (   $s)

Wrapper for addslashes()

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

Implements DatabaseType.

Definition at line 1471 of file DatabasePostgres.php.

◆ strictIPs()

DatabasePostgres::strictIPs ( )

Returns true if this database is strict about what can be put into an IP field.

Specifically, it uses a NULL value instead of an empty string.

Returns
bool

Reimplemented from DatabaseBase.

Definition at line 295 of file DatabasePostgres.php.

◆ tableExists()

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 1354 of file DatabasePostgres.php.

◆ tableName()

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.

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

Definition at line 1023 of file DatabasePostgres.php.

Referenced by wasDeadlock().

◆ textFieldSize()

DatabasePostgres::textFieldSize (   $table,
  $field 
)

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

Parameters
string$table
string$field
Returns
int

Reimplemented from DatabaseBase.

Definition at line 1071 of file DatabasePostgres.php.

◆ timestamp()

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

Definition at line 1120 of file DatabasePostgres.php.

◆ triggerExists()

DatabasePostgres::triggerExists (   $table,
  $trigger 
)

Definition at line 1362 of file DatabasePostgres.php.

◆ unlock()

DatabasePostgres::unlock (   $lockName,
  $method 
)

◆ wasDeadlock()

DatabasePostgres::wasDeadlock ( )

Determines if the last failure was due to a deadlock STUB.

Returns
bool

Reimplemented from DatabaseBase.

Definition at line 1092 of file DatabasePostgres.php.

References tableName().

Member Data Documentation

◆ $connectString

string DatabasePostgres::$connectString
private

Connect string to open a PostgreSQL connection *.

Definition at line 277 of file DatabasePostgres.php.

◆ $mAffectedRows

int DatabasePostgres::$mAffectedRows = null
protected

The number of rows affected as an integer *.

Definition at line 271 of file DatabasePostgres.php.

◆ $mCoreSchema

string DatabasePostgres::$mCoreSchema
private

Definition at line 281 of file DatabasePostgres.php.

◆ $mInsertId

int DatabasePostgres::$mInsertId = null
private

Definition at line 273 of file DatabasePostgres.php.

◆ $mLastResult

resource DatabasePostgres::$mLastResult = null
protected

Definition at line 269 of file DatabasePostgres.php.

◆ $mTransactionState

PostgresTransactionState DatabasePostgres::$mTransactionState
private

Definition at line 279 of file DatabasePostgres.php.

◆ $numericVersion

float string DatabasePostgres::$numericVersion = null
private

Definition at line 275 of file DatabasePostgres.php.


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