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

Public Member Functions

 __construct (array $params)
 Constructor and database handle and attempt to connect to the DB server.
 
 addQuotes ( $s)
 
 affectedRows ()
 Get the number of rows affected by the last write query.
 
 aggregateValue ( $valuedata, $valuename='value')
 Return aggregated value function call.
 
 buildConcat ( $stringList)
 Build a concatenation list to feed into a SQL query.
 
 buildGroupConcatField ( $delimiter, $table, $field, $conds='', $options=[], $join_conds=[])
 
 buildStringCast ( $field)
 
 constraintExists ( $table, $constraint)
 
 currentSequenceValue ( $seqName)
 Return the current value of a sequence.
 
 dataSeek ( $res, $row)
 
 decodeBlob ( $b)
 Some DBMSs return a special placeholder object representing blob fields in result objects.
 
 determineCoreSchema ( $desiredSchema)
 Determine default schema for the current application Adjust this session schema search path if desired schema exists and is not alread there.
 
 doQuery ( $sql)
 The DBMS-dependent part of query()
 
 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.
 
 encodeBlob ( $b)
 
 estimateRowCount ( $table, $vars=' *', $conds='', $fname=__METHOD__, $options=[])
 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()
 
 fetchObject ( $res)
 
 fetchRow ( $res)
 Fetch the next row from the given result object, in associative array form.
 
 fieldInfo ( $table, $field)
 mysql_fetch_field() wrapper Returns false if the field doesn't exist
 
 fieldName ( $res, $n)
 Get a field name in a result object.
 
 fieldType ( $res, $index)
 pg_field_type() wrapper
 
 freeResult ( $res)
 
 getCoreSchema ()
 Return schema name for core application tables.
 
 getCurrentSchema ()
 Return current schema (executes SELECT current_schema()) Needs transaction.
 
 getDBname ()
 Get the current DB name.
 
 getSchemas ()
 Return list of schemas which are accessible without schema name This is list does not contain magic keywords like "$user" Needs transaction.
 
 getSearchPath ()
 Return search patch for schemas This is different from getSchemas() since it contain magic keywords (like "$user").
 
 getServer ()
 Get the server hostname or IP address.
 
 getServerVersion ()
 
 getSoftwareLink ()
 
 getType ()
 Get the type of the DBMS, as it appears in $wgDBtype.
 
 hasConstraint ( $name)
 
 implicitGroupby ()
 Returns true if this database does an implicit sort when doing GROUP BY.
 
 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.
 
 indexAttributes ( $index, $schema=false)
 Returns is of attributes used in index.
 
 indexInfo ( $table, $index, $fname=__METHOD__)
 Returns information about an index If errors are explicitly ignored, returns NULL on failure.
 
 indexUnique ( $table, $index, $fname=__METHOD__)
 
 insert ( $table, $args, $fname=__METHOD__, $options=[])
 INSERT wrapper, inserts an array into a table.
 
 insertId ()
 Return the result of the last call to nextSequenceValue(); This must be called after nextSequenceValue().
 
 lastErrno ()
 Get the last error number.
 
 lastError ()
 Get a description of the last error.
 
 limitResult ( $sql, $limit, $offset=false)
 Construct a LIMIT query with optional offset.
 
 listTables ( $prefix=null, $fname=__METHOD__)
 List all tables on the database.
 
 lock ( $lockName, $method, $timeout=5)
 See http://www.postgresql.org/docs/8.2/static/functions-admin.html#FUNCTIONS-ADVISORY-LOCKS.
 
 lockIsFree ( $lockName, $method)
 Check to see if a named lock is available.
 
 makeConnectionString ( $vars)
 
 makeSelectOptions ( $options)
 Various select options.
 
 nativeInsertSelect ( $destTable, $srcTable, $varMap, $conds, $fname=__METHOD__, $insertOptions=[], $selectOptions=[])
 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.
 
 nextSequenceValue ( $seqName)
 Return the next in a sequence, save the value for retrieval via insertId()
 
 numFields ( $res)
 Get the number of fields in a result object.
 
 numRows ( $res)
 Get the number of rows in a result object.
 
 open ( $server, $user, $password, $dbName)
 Usually aborts on failure.
 
 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 http://www.php.net/manual/en/ref.pgsql.php.
 
 queryIgnore ( $sql, $fname=__METHOD__)
 
 realTableName ( $name, $format='quoted')
 
 relationExists ( $table, $types, $schema=false)
 Query whether a given relation exists (in the given schema, or the default mw one if not given)
 
 remappedTableName ( $name)
 
 reportQueryError ( $error, $errno, $sql, $fname, $tempIgnore=false)
 Report a query error.
 
 roleExists ( $roleName)
 Returns true if a given role (i.e.
 
 ruleExists ( $table, $rule)
 
 schemaExists ( $schema)
 Query whether a given schema exists.
 
 selectDB ( $db)
 Postgres doesn't support selectDB in the same way MySQL does.
 
 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.
 
 sequenceExists ( $sequence, $schema=false)
 
 setSearchPath ( $search_path)
 Update search_path, values should already be sanitized Values may contain magic keywords like "$user".
 
 streamStatementEnd (&$sql, &$newLine)
 Called by sourceStream() to check if we've reached a statement end.
 
 strencode ( $s)
 Wrapper for addslashes()
 
 tableExists ( $table, $fname=__METHOD__, $schema=false)
 For backward compatibility, this function checks both tables and views.
 
 tableName ( $name, $format='quoted')
 Format a table name ready for use in constructing an SQL query.
 
 textFieldSize ( $table, $field)
 Returns the size of a text field, or -1 for "unlimited".
 
 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.
 
 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.
 
 wasDeadlock ()
 Determines if the last failure was due to a deadlock.
 
- Public Member Functions inherited from Database
 __clone ()
 Make sure that copies do not share the same client binding handle.
 
 __destruct ()
 Run a few simple sanity checks and close dangling connections.
 
 __sleep ()
 Called by serialize.
 
 __toString ()
 
 addIdentifierQuotes ( $s)
 Quotes an identifier using backticks or "double quotes" depending on the database type.
 
 anyChar ()
 Returns a token for buildLike() that denotes a '_' to be used in a LIKE query.
 
 anyString ()
 Returns a token for buildLike() that denotes a '' to be used in a LIKE query.
 
 begin ( $fname=__METHOD__, $mode=self::TRANSACTION_EXPLICIT)
 Begin a transaction.
 
 bitAnd ( $fieldLeft, $fieldRight)
 
 bitNot ( $field)
 
 bitOr ( $fieldLeft, $fieldRight)
 
 bufferResults ( $buffer=null)
 Turns buffering of SQL result sets on (true) or off (false).
 
 buildGroupConcatField ( $delim, $table, $field, $conds='', $join_conds=[])
 Build a GROUP_CONCAT or equivalent statement for a query.
 
 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().
 
 clearFlag ( $flag, $remember=self::REMEMBER_NOTHING)
 Clear a flag for this connection.
 
 close ()
 Closes a database connection.
 
 commit ( $fname=__METHOD__, $flush='')
 Commits a transaction previously started using begin().
 
 conditional ( $cond, $trueVal, $falseVal)
 Returns an SQL expression for a simple conditional.
 
 connectionErrorLogger ( $errno, $errstr)
 This method should not be used outside of Database classes.
 
 dbSchema ( $schema=null)
 Get/set the db schema.
 
 deadlockLoop ()
 Perform a deadlock-prone transaction.
 
 decodeExpiry ( $expiry, $format=TS_MW)
 Decode an expiry time into a DBMS independent format.
 
 delete ( $table, $conds, $fname=__METHOD__)
 DELETE query wrapper.
 
 deleteJoin ( $delTable, $joinTable, $delVar, $joinVar, $conds, $fname=__METHOD__)
 DELETE where the condition is a join.
 
 doAtomicSection ( $fname, callable $callback)
 Run a callback to do an atomic set of updates for this database.
 
 doneWrites ()
 Returns true if the connection may have been used for write queries.
 
 dropTable ( $tableName, $fName=__METHOD__)
 Delete a table.
 
 encodeExpiry ( $expiry)
 Encode an expiry time into the DBMS dependent format.
 
 endAtomic ( $fname=__METHOD__)
 Ends an atomic section of SQL statements.
 
 explicitTrxActive ()
 
 fieldExists ( $table, $field, $fname=__METHOD__)
 Determines whether a field exists in a table.
 
 flushSnapshot ( $fname=__METHOD__)
 Commit any transaction but error out if writes or callbacks are pending.
 
 getDomainID ()
 
 getFlag ( $flag)
 Returns a boolean whether the flag $flag is set for this connection.
 
 getInfinity ()
 Find out when 'infinity' is.
 
 getLag ()
 Get replica DB lag.
 
 getLBInfo ( $name=null)
 Get properties passed down from the server info array of the load balancer.
 
 getMasterPos ()
 Get the position of this master.
 
 getProperty ( $name)
 
 getReplicaPos ()
 Get the replication position of this replica DB.
 
 getScopedLockAndFlush ( $lockKey, $fname, $timeout)
 Acquire a named lock, flush any transaction, and return an RAII style unlocker object.
 
 getSearchEngine ()
 
 getServerInfo ()
 A string describing the current software version, and possibly other details in a user-friendly way.
 
 getServerUptime ()
 Determines how long the server has been up.
 
 getSessionLagStatus ()
 Get the replica DB lag when the current transaction started or a general lag estimate if not transaction is active.
 
 getWikiID ()
 Alias for getDomainID()
 
 ignoreIndexClause ( $index)
 IGNORE INDEX clause.
 
 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.
 
 indexUnique ( $table, $index)
 Determines if a given index is unique.
 
 insertSelect ( $destTable, $srcTable, $varMap, $conds, $fname=__METHOD__, $insertOptions=[], $selectOptions=[])
 INSERT SELECT wrapper.
 
 isOpen ()
 Is a connection to the database open?
 
 isQuotedIdentifier ( $name)
 Returns if the given identifier looks quoted or not according to the database convention for quoting identifiers .
 
 isReadOnly ()
 
 lastDoneWrites ()
 Returns the last time the connection may have been used for write queries.
 
 lastQuery ()
 Return the last query that went through IDatabase::query()
 
 listViews ( $prefix=null, $fname=__METHOD__)
 Lists all the VIEWs in the database.
 
 lockTables ( $read, $write, $method, $lowPriority=true)
 Lock specific tables.
 
 makeList ( $a, $mode=self::LIST_COMMA)
 Makes an encoded list of strings from an array.
 
 makeWhereFrom2d ( $data, $baseKey, $subKey)
 Build a partial where clause from a 2-d array such as used for LinkBatch.
 
 masterPosWait (DBMasterPos $pos, $timeout)
 Wait for the replica DB to catch up to a given master position.
 
 maxListLen ()
 Return the maximum number of items allowed in a list, or 0 for unlimited.
 
 namedLocksEnqueue ()
 Check to see if a named lock used by lock() use blocking queues.
 
 onTransactionIdle (callable $callback, $fname=__METHOD__)
 Run a callback as soon as there is no transaction pending.
 
 onTransactionPreCommitOrIdle (callable $callback, $fname=__METHOD__)
 Run a callback before the current transaction commits or now if there is none.
 
 onTransactionResolution (callable $callback, $fname=__METHOD__)
 Run a callback as soon as the current transaction commits or rolls back.
 
 pendingWriteCallers ()
 Get the list of method names that did write queries for this transaction.
 
 pendingWriteQueryDuration ( $type=self::ESTIMATE_TOTAL)
 Get the time spend running write queries for this transaction.
 
 ping (&$rtt=null)
 Ping the server and try to reconnect if it there is no connection.
 
 query ( $sql, $fname=__METHOD__, $tempIgnore=false)
 Run an SQL query and return the result.
 
 replace ( $table, $uniqueIndexes, $rows, $fname=__METHOD__)
 REPLACE query wrapper.
 
 reportConnectionError ( $error='Unknown error')
 
 restoreFlags ( $state=self::RESTORE_PRIOR)
 Restore the flags to their prior state before the last setFlag/clearFlag call.
 
 rollback ( $fname=__METHOD__, $flush='')
 Rollback a transaction previously started using begin().
 
 runOnTransactionIdleCallbacks ( $trigger)
 Actually run and consume any "on transaction idle/resolution" callbacks.
 
 runOnTransactionPreCommitCallbacks ()
 Actually run and consume any "on transaction pre-commit" callbacks.
 
 runTransactionListenerCallbacks ( $trigger)
 Actually run any "transaction listener" callbacks.
 
 select ( $table, $vars, $conds='', $fname=__METHOD__, $options=[], $join_conds=[])
 Execute a SELECT query constructed using the various parameters provided.
 
 selectField ( $table, $var, $cond='', $fname=__METHOD__, $options=[])
 A SELECT wrapper which returns a single field from a single result row.
 
 selectFieldValues ( $table, $var, $cond='', $fname=__METHOD__, $options=[], $join_conds=[])
 
 selectRow ( $table, $vars, $conds, $fname=__METHOD__, $options=[], $join_conds=[])
 Single row SELECT wrapper.
 
 selectRowCount ( $tables, $vars=' *', $conds='', $fname=__METHOD__, $options=[], $join_conds=[])
 Get the number of rows in dataset.
 
 serverIsReadOnly ()
 
 setBigSelects ( $value=true)
 Allow or deny "big selects" for this session only.
 
 setFlag ( $flag, $remember=self::REMEMBER_NOTHING)
 Set a flag for this connection.
 
 setLazyMasterHandle (IDatabase $conn)
 Set a lazy-connecting DB handle to the master DB (for replication status purposes)
 
 setLBInfo ( $name, $value=null)
 Set the LB info array, or a member of it.
 
 setLogger (LoggerInterface $logger)
 
 setSchemaVars ( $vars)
 Set variables to be used in sourceFile/sourceStream, in preference to the ones in $GLOBALS.
 
 setSessionOptions (array $options)
 Override database's default behavior.
 
 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.
 
 setTransactionListener ( $name, callable $callback=null)
 Run a callback each time any transaction commits or rolls back.
 
 setTrxEndCallbackSuppression ( $suppress)
 Whether to disable running of post-COMMIT/ROLLBACK callbacks.
 
 sourceFile ( $filename, callable $lineCallback=null, callable $resultCallback=null, $fname=false, callable $inputCallback=null)
 Read and execute SQL commands from a file.
 
 sourceStream ( $fp, callable $lineCallback=null, callable $resultCallback=null, $fname=__METHOD__, callable $inputCallback=null)
 Read and execute commands from an open file handle.
 
 startAtomic ( $fname=__METHOD__)
 Begin an atomic section of statements.
 
 strreplace ( $orig, $old, $new)
 Returns a comand for str_replace function in SQL query.
 
 tableExists ( $table, $fname=__METHOD__)
 Query whether a given table exists.
 
 tableNames ()
 Fetch a number of table names into an array This is handy when you need to construct SQL for joins.
 
 tableNamesN ()
 Fetch a number of table names into an zero-indexed numerical array This is handy when you need to construct SQL for joins.
 
 tablePrefix ( $prefix=null)
 Get/set the table prefix.
 
 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.
 
 trxLevel ()
 Gets the current transaction level.
 
 trxTimestamp ()
 Get the UNIX timestamp of the time that the transaction was established.
 
 unionQueries ( $sqls, $all)
 Construct a UNION query This is used for providing overload point for other DB abstractions not compatible with the MySQL syntax.
 
 unionSupportsOrderAndLimit ()
 Returns true if current database backend supports ORDER BY or LIMIT for separate subqueries within the UNION construct.
 
 unlockTables ( $method)
 Unlock specific tables.
 
 update ( $table, $values, $conds, $fname=__METHOD__, $options=[])
 UPDATE wrapper.
 
 upsert ( $table, array $rows, array $uniqueIndexes, array $set, $fname=__METHOD__)
 INSERT ON DUPLICATE KEY UPDATE wrapper, upserts an array into a table.
 
 useIndexClause ( $index)
 USE INDEX clause.
 
 wasConnectionError ( $errno)
 Do not use this method outside of Database/DBError classes.
 
 wasErrorReissuable ()
 Determines if the last query error was due to a dropped connection and should be dealt with by pinging the connection and reissuing the query.
 
 wasLockTimeout ()
 Determines if the last failure was due to a lock timeout.
 
 wasReadOnlyError ()
 Determines if the last failure was due to the database being read-only.
 
 writesOrCallbacksPending ()
 Returns true if there is a transaction open with possible write queries or transaction pre-commit/idle callbacks waiting on it to finish.
 
 writesPending ()
 
- Public Member Functions inherited from IDatabase
 selectFieldValues ( $table, $var, $cond='', $fname=__METHOD__, $options=[])
 A SELECT wrapper which returns a list of single field values from result rows.
 

Protected Member Functions

 closeConnection ()
 Closes a database connection, if it is open Returns success, true if already closed.
 
 dumpError ()
 
 replaceVars ( $ins)
 Postgres specific version of replaceVars.
 
- Protected Member Functions inherited from Database
 assertOpen ()
 Make sure isOpen() returns true as a sanity check.
 
 doBegin ( $fname)
 Issues the BEGIN command to the database server.
 
 doCommit ( $fname)
 Issues the COMMIT command to the database server.
 
 doRollback ( $fname)
 Issues the ROLLBACK command to the database server.
 
 escapeLikeInternal ( $s)
 
 fieldNamesWithAlias ( $fields)
 Gets an array of aliased field names.
 
 fieldNameWithAlias ( $name, $alias=false)
 Get an aliased field name e.g.
 
 getApproximateLagStatus ()
 Get a replica DB lag estimate for this server.
 
 getBindingHandle ()
 Get the underlying binding handle, mConn.
 
 getDefaultSchemaVars ()
 Get schema variables to use if none have been set via setSchemaVars().
 
 getLastPHPError ()
 
 getLazyMasterHandle ()
 
 getLogContext (array $extras=[])
 Create a log context to pass to PSR-3 logger functions.
 
 getQueryVerb ( $sql)
 
 getReadOnlyReason ()
 
 getSchemaVars ()
 Get schema variables.
 
 getTransactionLagStatus ()
 Get the replica DB lag when the current transaction started.
 
 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.
 
 indexName ( $index)
 Get the name of an index in a given table.
 
 installErrorHandler ()
 
 isTransactableQuery ( $sql)
 Determine whether a SQL statement is sensitive to isolation level.
 
 isWriteQuery ( $sql)
 Determine whether a query writes to the DB.
 
 makeGroupByWithHaving ( $options)
 Returns an optional GROUP BY with an optional HAVING.
 
 makeInsertOptions ( $options)
 Helper for Database::insert().
 
 makeOrderBy ( $options)
 Returns an optional ORDER BY.
 
 makeUpdateOptions ( $options)
 Make UPDATE options for the Database::update function.
 
 makeUpdateOptionsArray ( $options)
 Make UPDATE options array for Database::makeUpdateOptions.
 
 nativeReplace ( $table, $rows, $fname)
 REPLACE query wrapper for MySQL and SQLite, which have a native REPLACE statement.
 
 pendingWriteAndCallbackCallers ()
 
 reconnect ()
 
 registerTempTableOperation ( $sql)
 
 requiresDatabaseUser ()
 
 restoreErrorHandler ()
 
 resultObject ( $result)
 Take the result from a query, and wrap it in a ResultWrapper if necessary.
 
 tableNamesWithAlias ( $tables)
 Gets an array of aliased table names.
 
 tableNamesWithIndexClauseOrJOIN ( $tables, $use_index=[], $ignore_index=[], $join_conds=[])
 Get the aliased table name clause for a FROM clause which might have a JOIN and/or USE INDEX or IGNORE INDEX clause.
 
 tableNameWithAlias ( $name, $alias=false)
 Get an aliased table name e.g.
 

Protected Attributes

int $mAffectedRows = null
 The number of rows affected as an integer.
 
resource $mLastResult = null
 
int bool $port
 
- Protected Attributes inherited from Database
string $agent
 Agent name for query profiling.
 
bool $cliMode
 Whether this PHP instance is for a CLI script.
 
LoggerInterface $connLogger
 
DatabaseDomain $currentDomain
 
string $delimiter = ';'
 
callback $errorLogger
 Error logging callback.
 
string bool null $htmlErrors
 Stashed value of html_errors INI setting.
 
float $lastPing = 0.0
 UNIX timestamp.
 
resource null $mConn = null
 Database connection.
 
string $mDBname
 
bool null $mDefaultBigSelects = null
 
integer $mFlags
 
string $mLastQuery = ''
 SQL query.
 
float bool $mLastWriteTime = false
 UNIX timestamp of last write query.
 
array $mLBInfo = []
 
bool $mOpened = false
 
string $mPassword
 
string bool $mPHPError = false
 
string $mSchema = ''
 
array bool $mSchemaVars = false
 
string $mServer
 
array $mSessionTempTables = []
 Map of (table name => 1) for TEMPORARY tables.
 
array $mSessionVars = []
 
string $mTablePrefix = ''
 
array[] $mTrxEndCallbacks = []
 List of (callable, method name)
 
bool $mTrxEndCallbacksSuppressed = false
 Whether to suppress triggering of transaction end callbacks.
 
array[] $mTrxIdleCallbacks = []
 List of (callable, method name)
 
int $mTrxLevel = 0
 Either 1 if a transaction is active or 0 otherwise.
 
array[] $mTrxPreCommitCallbacks = []
 List of (callable, method name)
 
callable[] $mTrxRecurringCallbacks = []
 Map of (name => callable)
 
string $mTrxShortId = ''
 Either a short hexidecimal string if a transaction is active or "".
 
string $mUser
 
array null $preparedArgs
 
object string $profiler
 Class name or object With profileIn/profileOut methods.
 
LoggerInterface $queryLogger
 
BagOStuff $srvCache
 APC cache.
 
 $tableAliases = []
 
TransactionProfiler $trxProfiler
 

Private Member Functions

 bigintFromLockName ( $lockName)
 

Private Attributes

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

Additional Inherited Members

- Static Public Member Functions inherited from Database
static factory ( $dbType, $p=[])
 Construct a Database subclass instance given a database type and parameters.
 
static getCacheSetOptions (IDatabase $db1)
 Merge the result of getSessionLagStatus() for several DBs using the most pessimistic values to estimate the lag of any data derived from them in combination.
 
- Public Attributes inherited from Database
const DEADLOCK_DELAY_MAX = 1500000
 Maximum time to wait before retry.
 
const DEADLOCK_DELAY_MIN = 500000
 Minimum time to wait before retry, in microseconds.
 
const DEADLOCK_TRIES = 4
 Number of times to re-try an operation in case of deadlock.
 
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.
 
const SLOW_WRITE_SEC = .500
 
const SMALL_WRITE_ROWS = 100
 
const TINY_WRITE_SEC = .010
 
- Static Protected Member Functions inherited from Database
static generalizeSQL ( $sql)
 Removes most variables from an SQL query and replaces them with X or N for numbers.
 

Detailed Description

Definition at line 28 of file DatabasePostgres.php.

Constructor & Destructor Documentation

◆ __construct()

DatabasePostgres::__construct ( array  $params)

Constructor and database handle and attempt to connect to the DB server.

IDatabase classes should not be constructed directly in external code. Database::factory() should be used instead.

Parameters
array$paramsParameters passed from Database::factory()

Reimplemented from Database.

Definition at line 46 of file DatabasePostgres.php.

References $params, and port().

Member Function Documentation

◆ addQuotes()

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

Reimplemented from Database.

Definition at line 1262 of file DatabasePostgres.php.

References $s, and Database\getBindingHandle().

Referenced by buildGroupConcatField(), constraintExists(), PostgresField\fromText(), listTables(), lock(), lockIsFree(), relationExists(), triggerExists(), and unlock().

◆ 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 IDatabase.

Definition at line 396 of file DatabasePostgres.php.

References $mAffectedRows.

◆ aggregateValue()

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

Return aggregated value function call.

Parameters
array$valuedata
string$valuename
Returns
array

Reimplemented from Database.

Definition at line 943 of file DatabasePostgres.php.

◆ bigintFromLockName()

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

Definition at line 1457 of file DatabasePostgres.php.

Referenced by lock(), lockIsFree(), and unlock().

◆ 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 Database.

Definition at line 1353 of file DatabasePostgres.php.

◆ buildGroupConcatField()

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

Definition at line 1357 of file DatabasePostgres.php.

References Database\$delimiter, addQuotes(), and selectSQLText().

◆ buildStringCast()

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

Reimplemented from Database.

Definition at line 1370 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 Database.

Definition at line 189 of file DatabasePostgres.php.

◆ constraintExists()

DatabasePostgres::constraintExists (   $table,
  $constraint 
)

Definition at line 1172 of file DatabasePostgres.php.

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

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

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

◆ dataSeek()

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

Implements IDatabase.

Definition at line 368 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 | Blob$b
Returns
string

Reimplemented from Database.

Definition at line 1243 of file DatabasePostgres.php.

◆ determineCoreSchema()

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

References Database\addIdentifierQuotes(), Database\begin(), Database\commit(), getCurrentSchema(), getSchemas(), getSearchPath(), schemaExists(), and setSearchPath().

Referenced by open().

◆ 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 Database.

Definition at line 193 of file DatabasePostgres.php.

References $mLastResult, $res, and Database\getBindingHandle().

Referenced by hasConstraint(), and open().

◆ dumpError()

DatabasePostgres::dumpError ( )
protected

Definition at line 213 of file DatabasePostgres.php.

References as.

◆ 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
RuntimeException
Returns
bool True if operation was successful

Reimplemented from Database.

Definition at line 859 of file DatabasePostgres.php.

References $fname, Database\addIdentifierQuotes(), and Database\query().

◆ encodeBlob()

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

Reimplemented from Database.

Definition at line 1239 of file DatabasePostgres.php.

◆ estimateRowCount()

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

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

Definition at line 422 of file DatabasePostgres.php.

References $count, $fname, $options, $res, $vars, fetchRow(), and select().

◆ fetchObject()

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

Implements IDatabase.

Definition at line 277 of file DatabasePostgres.php.

References $res, and Database\getBindingHandle().

Referenced by PostgresField\fromText(), lock(), lockIsFree(), textFieldSize(), and 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 IDatabase::query(), etc.
Returns
array|bool
Exceptions
DBUnexpectedErrorThrown if the database returns an error

Implements IDatabase.

Definition at line 299 of file DatabasePostgres.php.

References $res, and Database\getBindingHandle().

Referenced by currentSequenceValue(), estimateRowCount(), getCurrentSchema(), getSchemas(), getSearchPath(), and nextSequenceValue().

◆ 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 IDatabase.

Definition at line 1217 of file DatabasePostgres.php.

References PostgresField\fromText().

◆ 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 IDatabase.

Definition at line 345 of file DatabasePostgres.php.

References $res.

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

References $res.

◆ freeResult()

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

Reimplemented from Database.

Definition at line 260 of file DatabasePostgres.php.

References $res.

◆ getCoreSchema()

DatabasePostgres::getCoreSchema ( )

Return schema name for core application tables.

Since
1.19
Returns
string Core schema name

Definition at line 1068 of file DatabasePostgres.php.

References $mCoreSchema.

Referenced by constraintExists(), PostgresField\fromText(), hasConstraint(), indexAttributes(), listTables(), relationExists(), ruleExists(), and triggerExists().

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

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

Referenced by determineCoreSchema().

◆ getDBname()

DatabasePostgres::getDBname ( )

Get the current DB name.

Returns
string

Reimplemented from Database.

Definition at line 1345 of file DatabasePostgres.php.

References Database\$mDBname.

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

References $res, fetchRow(), pg_array_parse(), and Database\query().

Referenced by determineCoreSchema().

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

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

Referenced by determineCoreSchema().

◆ getServer()

DatabasePostgres::getServer ( )

Get the server hostname or IP address.

Returns
string

Reimplemented from Database.

Definition at line 1349 of file DatabasePostgres.php.

References Database\$mServer.

◆ getServerVersion()

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

Implements IDatabase.

Definition at line 1075 of file DatabasePostgres.php.

References $numericVersion, and Database\getBindingHandle().

Referenced by insert(), and open().

◆ getSoftwareLink()

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

Implements IDatabase.

Definition at line 950 of file DatabasePostgres.php.

◆ getType()

DatabasePostgres::getType ( )

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

Returns
string

Implements IDatabase.

Definition at line 51 of file DatabasePostgres.php.

◆ hasConstraint()

DatabasePostgres::hasConstraint (   $name)

◆ implicitGroupby()

DatabasePostgres::implicitGroupby ( )

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

Returns
bool

Reimplemented from Database.

Definition at line 55 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 Database.

Definition at line 59 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 471 of file DatabasePostgres.php.

References $res, as, FROM, getCoreSchema(), and Database\query().

◆ 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

Reimplemented from Database.

Definition at line 448 of file DatabasePostgres.php.

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

◆ indexUnique()

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

Definition at line 528 of file DatabasePostgres.php.

References $fname, $res, Database\indexName(), Database\query(), and strencode().

◆ insert()

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

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

Definition at line 583 of file DatabasePostgres.php.

References $args, $fname, $keys, $options, $res, as, getServerVersion(), Database\makeList(), Database\query(), and tableName().

◆ insertId()

DatabasePostgres::insertId ( )

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

Returns
int|null

Implements IDatabase.

Definition at line 359 of file DatabasePostgres.php.

References $mInsertId.

◆ lastErrno()

DatabasePostgres::lastErrno ( )

Get the last error number.

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

Implements IDatabase.

Definition at line 388 of file DatabasePostgres.php.

Referenced by wasDeadlock().

◆ lastError()

DatabasePostgres::lastError ( )

Get a description of the last error.

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

Implements IDatabase.

Definition at line 376 of file DatabasePostgres.php.

References Database\getLastPHPError().

Referenced by open().

◆ 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 Database.

Definition at line 851 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
DBError
Returns
array

Reimplemented from Database.

Definition at line 869 of file DatabasePostgres.php.

References $fname, $vars, addQuotes(), as, getCoreSchema(), and Database\query().

◆ 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 Database.

Definition at line 1412 of file DatabasePostgres.php.

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

◆ 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 Database.

Definition at line 1396 of file DatabasePostgres.php.

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

◆ makeConnectionString()

DatabasePostgres::makeConnectionString (   $vars)

Definition at line 175 of file DatabasePostgres.php.

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

Referenced by open().

◆ 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 Database.

Definition at line 1310 of file DatabasePostgres.php.

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

Referenced by nativeInsertSelect().

◆ nativeInsertSelect()

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

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
Returns
bool

Reimplemented from Database.

Definition at line 709 of file DatabasePostgres.php.

References $fname, $res, list, LIST_AND, Database\makeList(), makeSelectOptions(), Database\query(), and tableName().

◆ 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 Database.

Definition at line 809 of file DatabasePostgres.php.

References $mInsertId, $res, fetchRow(), and Database\query().

◆ 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 IDatabase.

Definition at line 337 of file DatabasePostgres.php.

References $res.

◆ numRows()

DatabasePostgres::numRows (   $res)

Get the number of rows in a result object.

Parameters
mixed$resA SQL result
Returns
int

Implements IDatabase.

Definition at line 318 of file DatabasePostgres.php.

References $res, and Database\getBindingHandle().

Referenced by hasConstraint().

◆ open()

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

Usually aborts on failure.

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

Implements IDatabase.

Definition at line 84 of file DatabasePostgres.php.

References Database\$mConn, $user, Database\close(), determineCoreSchema(), doQuery(), getServerVersion(), Database\installErrorHandler(), lastError(), makeConnectionString(), port(), Database\query(), and Database\restoreErrorHandler().

Referenced by selectDB().

◆ pg_array_parse()

DatabasePostgres::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 http://www.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 910 of file DatabasePostgres.php.

References $limit, $output, and pg_array_parse().

Referenced by getSchemas(), and pg_array_parse().

◆ queryIgnore()

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

Definition at line 252 of file DatabasePostgres.php.

References $fname, and Database\query().

◆ realTableName()

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

Definition at line 799 of file DatabasePostgres.php.

References $name.

Referenced by relationExists().

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

References $count, $res, addQuotes(), getCoreSchema(), Database\query(), and realTableName().

Referenced by sequenceExists(), and tableExists().

◆ remappedTableName()

DatabasePostgres::remappedTableName (   $name)
Parameters
string$name
Returns
string Value of $name or remapped name if $name is a reserved keyword @TODO: dependency inject these...

Definition at line 784 of file DatabasePostgres.php.

References $name.

Referenced by PostgresField\fromText(), and tableName().

◆ 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 Database.

Definition at line 1288 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 Database.

Definition at line 234 of file DatabasePostgres.php.

References $fname, Database\ignoreErrors(), and rollback.

◆ roleExists()

DatabasePostgres::roleExists (   $roleName)

Returns true if a given role (i.e.

user) exists, false otherwise.

Parameters
string$roleName
Returns
bool

Definition at line 1205 of file DatabasePostgres.php.

References Database\selectField().

◆ ruleExists()

DatabasePostgres::ruleExists (   $table,
  $rule 
)

Definition at line 1160 of file DatabasePostgres.php.

References getCoreSchema(), and Database\selectField().

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

References Database\selectField().

Referenced by determineCoreSchema().

◆ 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 Database.

Definition at line 167 of file DatabasePostgres.php.

References open().

◆ selectSQLText()

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

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.
See also
IDatabase::select()

Reimplemented from Database.

Definition at line 541 of file DatabasePostgres.php.

References $fname, $options, $vars, and as.

Referenced by buildGroupConcatField().

◆ sequenceExists()

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

Definition at line 1133 of file DatabasePostgres.php.

References relationExists().

◆ setSearchPath()

DatabasePostgres::setSearchPath (   $search_path)

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

References Database\query().

Referenced by determineCoreSchema().

◆ 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 Database.

Definition at line 1374 of file DatabasePostgres.php.

◆ strencode()

DatabasePostgres::strencode (   $s)

Wrapper for addslashes()

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

Reimplemented from Database.

Definition at line 1253 of file DatabasePostgres.php.

References $s, and Database\getBindingHandle().

Referenced by indexUnique().

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

References relationExists().

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

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

Definition at line 772 of file DatabasePostgres.php.

References $name, and remappedTableName().

◆ 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 Database.

Definition at line 834 of file DatabasePostgres.php.

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

◆ 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 Database.

Definition at line 886 of file DatabasePostgres.php.

References TS_POSTGRES.

◆ triggerExists()

DatabasePostgres::triggerExists (   $table,
  $trigger 
)

Definition at line 1137 of file DatabasePostgres.php.

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

◆ unlock()

DatabasePostgres::unlock (   $lockName,
  $method 
)

◆ wasDeadlock()

DatabasePostgres::wasDeadlock ( )

Determines if the last failure was due to a deadlock.

Returns
bool

Reimplemented from Database.

Definition at line 855 of file DatabasePostgres.php.

References lastErrno().

Member Data Documentation

◆ $connectString

string DatabasePostgres::$connectString
private

Connect string to open a PostgreSQL connection.

Definition at line 42 of file DatabasePostgres.php.

◆ $mAffectedRows

int DatabasePostgres::$mAffectedRows = null
protected

The number of rows affected as an integer.

Definition at line 35 of file DatabasePostgres.php.

Referenced by affectedRows().

◆ $mCoreSchema

string DatabasePostgres::$mCoreSchema
private

Definition at line 44 of file DatabasePostgres.php.

Referenced by getCoreSchema().

◆ $mInsertId

int DatabasePostgres::$mInsertId = null
private

Definition at line 38 of file DatabasePostgres.php.

Referenced by insertId(), and nextSequenceValue().

◆ $mLastResult

resource DatabasePostgres::$mLastResult = null
protected

Definition at line 33 of file DatabasePostgres.php.

Referenced by doQuery().

◆ $numericVersion

float string DatabasePostgres::$numericVersion = null
private

Definition at line 40 of file DatabasePostgres.php.

Referenced by getServerVersion().

◆ $port

int bool DatabasePostgres::$port
protected

Definition at line 30 of file DatabasePostgres.php.


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