Inheritance diagram for Wikimedia\Rdbms\DatabasePostgres:

[legend]

Collaboration diagram for Wikimedia\Rdbms\DatabasePostgres:

[legend]

Public Member Functions

__construct (array $params)

addQuotes ( $s)

Escape and quote a raw value string for use in a SQL query.

Parameters

Returns: string

Stable to override Stable to override

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

Return aggregated value alias.

Parameters

array	$valuedata
string	$valuename

Returns: array|string

Deprecated: Since 1.33

Stable to override Stable to override

buildConcat ( $stringList)

Build a concatenation list to feed into a SQL query.

Parameters

string[] $stringList Raw SQL expression list; caller is responsible for escaping

Returns: string

Stable to override Stable to override

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

buildStringCast ( $field)

Parameters

string $field Field or column to cast

Returns: string

Since: 1.28

Stable to override Stable to override

constraintExists ( $table, $constraint)

currentSequenceValue ( $seqName)

Return the current value of a sequence.

databasesAreIndependent ()

Returns true if DBs are assumed to be on potentially different servers.In systems like mysql/mariadb, different databases can easily be referenced on a single connection merely by name, even in a single query via JOIN. On the other hand, Postgres treats databases as logically separate, with different database users, requiring special mechanisms like postgres_fdw to "mount" foreign DBs. This is true even among DBs on the same server. Changing the selected database via selectDomain() requires a new connection.

Returns: bool

Since: 1.29

Stable to override Stable to override

dataSeek ( $res, $row)

Change the position of the cursor in a result object.

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

Exceptions

DBError

Stable to override Stable to override

determineCoreSchema ( $desiredSchema)

Determine default schema for the current application Adjust this session schema search path if desired schema exists and is not alread there.

doInsertNonConflicting ( $table, array $rows, $fname)

doLockTables (array $read, array $write, $method)

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

doQuery ( $sql)

doSelectDomain (DatabaseDomain $domain)

Stable to override.

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	$oldName	Name of table whose structure should be copied
string	$newName	Name of table to be created
bool	$temporary	Whether the new table should be temporary
string	$fname	Calling function name

Returns: bool True if operation was successful

Exceptions

RuntimeException

Stable to override Stable to override

encodeBlob ( $b)

Some DBMSs have a special format for inserting into blob fields, they don't allow simple quoted strings to be inserted.To insert into such a field, pass the data through this function before passing it to IDatabase::insert().

Parameters

string $b

Returns: string|Blob

Exceptions

DBError

Stable to override Stable to override

estimateRowCount ( $table, $var=' *', $conds='', $fname=__METHOD__, $options=[], $join_conds=[])

Estimate rows in dataset Returns estimated count, based on EXPLAIN output This is not necessarily an accurate estimate, so use sparingly Returns -1 if count cannot be found Takes same arguments as Database::select()

fetchObject ( $res)

Fetch the next row from the given result object, in object form.

fetchRow ( $res)

Fetch the next row from the given result object, in associative array form.

fieldInfo ( $table, $field)

fieldName ( $res, $n)

Get a field name in a result object.

fieldType ( $res, $index)

pg_field_type() wrapper

freeResult ( $res)

Free a result object returned by query() or select()It's usually not necessary to call this, just use unset() or let the variable holding the result object go out of scope.

Parameters

mixed $res A SQL result

Stable to override Stable to override

getCoreSchema ()

Return schema name for core application tables.

getCoreSchemas ()

Return schema names for temporary tables and core application tables.

getCurrentSchema ()

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

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

getServerVersion ()

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

getSoftwareLink ()

Returns a wikitext style link to the DB's website (e.g.

getType ()

Get the type of the DBMS (e.g.

hasConstraint ( $name)

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

Stable to override Stable to override

indexAttributes ( $index, $schema=false)

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

Get information about an index into an object.

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

Determines if a given index is unique.

Parameters

string	$table
string	$index
string	$fname	Calling function name

Returns: bool

Stable to override Stable to override

insertId ()

Get the inserted value of an auto-increment row.

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

Parameters

string	$sql	SQL query we will append the limit too
int	$limit	The SQL limit
int \| bool	$offset	The SQL offset (default false)

Returns: string

Since: 1.34

Stable to override Stable to override

listTables ( $prefix='', $fname=__METHOD__)

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

Acquire a named lock.Named locks are not related to transactions

Parameters

string	$lockName	Name of lock to aquire
string	$method	Name of the calling method
int	$timeout	Acquisition timeout in seconds (0 means non-blocking)

Returns: bool Success

Exceptions

DBError If an error occurs, see IDatabase::query()

Stable to override Stable to override

lockIsFree ( $lockName, $method)

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

Parameters

string	$lockName	Name of lock to poll
string	$method	Name of method calling us

Returns: bool

Exceptions

DBError If an error occurs, see IDatabase::query()

Since: 1.20

Stable to override Stable to override

nextSequenceValue ( $seqName)

Deprecated method, calls should be removed.

numFields ( $res)

Get the number of fields in a result object.

numRows ( $res)

Get the number of rows in a query result.

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

remappedTableName ( $name)

roleExists ( $roleName)

Returns true if a given role (i.e.

ruleExists ( $table, $rule)

schemaExists ( $schema)

Query whether a given schema exists.

selectSQLText ( $table, $vars, $conds='', $fname=__METHOD__, $options=[], $join_conds=[])

Take the same arguments as IDatabase::select() and return the SQL it would use.This can be useful for making UNION queries, where the SQL text of each query is needed. In general, however, callers outside of Database classes should just use select().

See also: IDatabase::select()

Parameters

string \| array	$table	Table name
string \| array	$vars	Field names
string \| array	$conds	Conditions
string	$fname	Caller function name
string \| array	$options	Query options
string \| array	$join_conds	Join conditions

Returns: string SQL query string

Stable to override Stable to override

sequenceExists ( $sequence, $schema=false)

serverIsReadOnly ()

Returns: bool Whether the DB is marked as read-only server-side

Since: 1.28

Stable to override Stable to override

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.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	$name	Database table name
string	$format	One of: quoted - Automatically pass the table name through addIdentifierQuotes() so that it can be used in a query. raw - Do not add identifier quotes to the table name

Returns: string Full database name

Stable to override Stable to override

textFieldSize ( $table, $field)

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

Parameters

string	$table
string	$field

Returns: int

Stable to override Stable to override

timestamp ( $ts=0)

Convert a timestamp in one of the formats accepted by ConvertibleTimestamp to the format used for inserting into timestamp fields in this DBMS.The result is unquoted, and needs to be passed through addQuotes() before it can be included in raw SQL.

Parameters

string | int $ts

Returns: string

Stable to override Stable to override

triggerExists ( $table, $trigger)

unlock ( $lockName, $method)

Release a lock.Named locks are not related to transactions

Parameters

string	$lockName	Name of lock to release
string	$method	Name of the calling method

Returns: bool Success

Exceptions

DBError If an error occurs, see IDatabase::query()

Stable to override Stable to override

wasConnectionError ( $errno)

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

wasDeadlock ()

Determines if the last failure was due to a deadlock.Note that during a deadlock, the prior transaction will have been lost

Returns: bool

Stable to override Stable to override

wasLockTimeout ()

Determines if the last failure was due to a lock timeout.Note that during a lock wait timeout, the prior transaction will have been lost

Returns: bool

Stable to override Stable to override

Public Member Functions inherited from Wikimedia\Rdbms\Database

__clone ()

Make sure that copies do not share the same client binding handle.

__destruct ()

Run a few simple sanity checks and close dangling connections.

__sleep ()

Called by serialize.

__toString ()

Get a debugging string that mentions the database type, the ID of this instance, and the ID of any underlying connection resource or driver object if one is present.

addIdentifierQuotes ( $s)

Escape a SQL identifier (e.g.table, column, database) for use in a SQL queryDepending on the database this will either be backticks or "double quotes"

Parameters

string $s

Returns: string

Since: 1.33

Stable to override

affectedRows ()

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

anyChar ()

Returns a token for buildLike() that denotes a '_' to be used in a LIKE query.

anyString ()

Returns a token for buildLike() that denotes a '' to be used in a LIKE query.

assertNoOpenTransactions ()

Assert that all explicit transactions or atomic sections have been closed.

begin ( $fname=__METHOD__, $mode=self::TRANSACTION_EXPLICIT)

Begin a transaction.

bitAnd ( $fieldLeft, $fieldRight)

Parameters

string \| int	$fieldLeft
string \| int	$fieldRight

Returns: string

Stable to override

bitNot ( $field)

Parameters

string | int $field

Returns: string

Stable to override

bitOr ( $fieldLeft, $fieldRight)

Parameters

string \| int	$fieldLeft
string \| int	$fieldRight

Returns: string

Stable to override

buildGreatest ( $fields, $values)

Build a GREATEST function statement comparing columns/values.Integer and float values in $values will not be quotedIf $fields is an array, then each value with a string key is treated as an expression (which must be manually quoted); such string keys do not appear in the SQL and are only descriptive aliases.

Parameters

string \| string[]	$fields	Name(s) of column(s) with values to compare
string \| int \| float \| string[] \| int[] \| float[]	$values	Values to compare

Returns: mixed

Since: 1.35

Stable to override

buildGroupConcatField ( $delim, $table, $field, $conds='', $join_conds=[])

Build a GROUP_CONCAT or equivalent statement for a query.This is useful for combining a field for several rows into a single string. NULL values will not appear in the output, duplicated values will appear, and the resulting delimiter-separated values have no defined sort order. Code using the results may need to use the PHP unique() or sort() methods.

Parameters

string	$delim	Glue to bind the results together
string \| array	$table	Table name
string	$field	Field name
string \| array	$conds	Conditions
string \| array	$join_conds	Join conditions

Returns: string SQL text

Since: 1.23

Stable to override

buildIntegerCast ( $field)

Parameters

string $field Field or column to cast

Returns: string

Since: 1.31

Stable to override

buildLeast ( $fields, $values)

Build a LEAST function statement comparing columns/values.Integer and float values in $values will not be quotedIf $fields is an array, then each value with a string key is treated as an expression (which must be manually quoted); such string keys do not appear in the SQL and are only descriptive aliases.

Parameters

string \| string[]	$fields	Name(s) of column(s) with values to compare
string \| int \| float \| string[] \| int[] \| float[]	$values	Values to compare

Returns: mixed

Since: 1.35

Stable to override

buildLike ( $param,... $params)

LIKE statement wrapper.This takes a variable-length argument list with parts of pattern to match containing either string literals that will be escaped or tokens returned by anyChar() or anyString(). Alternatively, the function could be provided with an array of aforementioned parameters.Example: $dbr->buildLike( 'My_page_title/', $dbr->anyString() ) returns a LIKE clause that searches for subpages of 'My page title'. Alternatively: $pattern = [ 'My_page_title/', $dbr->anyString() ]; $query .= $dbr->buildLike( $pattern );

Since: 1.16

Parameters

array[] \| string \| LikeMatch	$param
	string\|LikeMatch	...$params

Returns: string Fully built LIKE statement

Stable to override

buildSelectSubquery ( $table, $vars, $conds='', $fname=__METHOD__, $options=[], $join_conds=[])

Equivalent to IDatabase::selectSQLText() except wraps the result in Subquery.

buildSubstring ( $input, $startPosition, $length=null)

Stable to override

cancelAtomic ( $fname=__METHOD__, AtomicSectionIdentifier $sectionId=null)

Cancel an atomic section of SQL statements.

clearFlag ( $flag, $remember=self::REMEMBER_NOTHING)

Clear a flag for this connection.

close ( $fname=__METHOD__, $owner=null)

Close the database connection.

commit ( $fname=__METHOD__, $flush=self::FLUSHING_ONE)

Commits a transaction previously started using begin()

conditional ( $cond, $trueVal, $falseVal)

Returns an SQL expression for a simple conditional.This doesn't need to be overridden unless CASE isn't supported in the RDBMS.

Parameters

string \| array	$cond	SQL expression which will result in a boolean value
string	$trueVal	SQL expression to return if true
string	$falseVal	SQL expression to return if false

Returns: string SQL fragment

Stable to override

connectionErrorLogger ( $errno, $errstr)

Error handler for logging errors during database connection This method should not be used outside of Database classes.

dbSchema ( $schema=null)

Get/set the db schema.

deadlockLoop (... $args)

Perform a deadlock-prone transaction.This function invokes a callback function to perform a set of write queries. If a deadlock occurs during the processing, the transaction will be rolled back and the callback function will be called again.Avoid using this method outside of Job or Maintenance classes.Usage: $dbw->deadlockLoop( callback, ... );Extra arguments are passed through to the specified callback function. This method requires that no transactions are already active to avoid causing premature commits or exceptions.Returns whatever the callback function returned on its successful, iteration, or false on error, for example if the retry limit was reached.

Parameters

mixed ...$args

Returns: mixed

Exceptions

DBUnexpectedError
Exception

Stable to override

decodeExpiry ( $expiry, $format=TS_MW)

Decode an expiry time into a DBMS independent format.

delete ( $table, $conds, $fname=__METHOD__)

Delete all rows in a table that match a condition.

deleteJoin ( $delTable, $joinTable, $delVar, $joinVar, $conds, $fname=__METHOD__)

DELETE where the condition is a join.MySQL overrides this to use a multi-table DELETE syntax, in other databases we use sub-selectsFor safety, an empty $conds will not delete everything. If you want to delete all rows where the join condition matches, set $conds=IDatabase::ALL_ROWS.DO NOT put the join condition in $conds.

Parameters

string	$delTable	The table to delete from.
string	$joinTable	The other table.
string	$delVar	The variable to join on, in the first table.
string	$joinVar	The variable to join on, in the second table.
array \| string	$conds	Condition array of field names mapped to variables, ANDed together in the WHERE clause
string	$fname	Calling function name (use METHOD) for logs/profiling

Exceptions

DBError If an error occurs, see IDatabase::query()

Stable to override

doAtomicSection ( $fname, callable $callback, $cancelable=self::ATOMIC_NOT_CANCELABLE)

Perform an atomic section of reversable SQL statements from a callback.

dropTable ( $table, $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__, $flush=self::FLUSHING_ONE)

Commit any transaction but error out if writes or callbacks are pending.

getDBname ()

Get the current DB name.

getDomainID ()

Return the currently selected domain ID.

getFlag ( $flag)

Returns a boolean whether the flag $flag is set for this connection.

getInfinity ()

Find out when 'infinity' is.Most DBMSes support this. This is a special keyword for timestamps in PostgreSQL, and works with CHAR(14) as well because "i" sorts after all numbers.

Returns: string

Stable to override

getLag ()

Get the amount of replication lag for this database server.

getLBInfo ( $name=null)

Get properties passed down from the server info array of the load balancer.

getMasterPos ()

Get the position of this master.

Returns: DBMasterPos|bool False if this is not a master

Exceptions

DBError If an error occurs, see IDatabase::query()

Stable to override

getReplicaPos ()

Get the replication position of this replica DB.

Returns: DBMasterPos|bool False if this is not a replica DB

Exceptions

DBError If an error occurs, see IDatabase::query()

Stable to override

getScopedLockAndFlush ( $lockKey, $fname, $timeout)

Acquire a named lock, flush any transaction, and return an RAII style unlocker object.

getServer ()

Get the server hostname or IP address.

getServerInfo ()

Get a human-readable string describing the current software version.

getServerUptime ()

Determines how long the server has been up.

Returns: int

Exceptions

DBError

Stable to override

getSessionLagStatus ()

Get the replica DB lag when the current transaction started or a general lag estimate if not transaction is active.

getTopologyRole ()

Get the replication topology role of this server.

getTopologyRootMaster ()

Get the host (or address) of the root master server for the replication topology.

ignoreIndexClause ( $index)

IGNORE INDEX clause.

indexExists ( $table, $index, $fname=__METHOD__)

Determines whether an index exists.

initConnection ()

Initialize the connection to the database over the wire (or to local files)

insert ( $table, $rows, $fname=__METHOD__, $options=[])

Insert the given row(s) into a table.

insertSelect ( $destTable, $srcTable, $varMap, $conds, $fname=__METHOD__, $insertOptions=[], $selectOptions=[], $selectJoinConds=[])

INSERT SELECT wrapper.

isOpen ()

isQuotedIdentifier ( $name)

Returns if the given identifier looks quoted or not according to the database convention for quoting identifiers.

isReadOnly ()

lastDoneWrites ()

Get the last time the connection may have been used for a write query.

lastQuery ()

Get the last query that sent on account of IDatabase::query()

listViews ( $prefix=null, $fname=__METHOD__)

Lists all the VIEWs in the database.

Parameters

string \| null	$prefix	Only show VIEWs with this prefix, eg. unit_test_
string	$fname	Name of calling function

Exceptions

RuntimeException

Returns: array

Stable to override

lockForUpdate ( $table, $conds='', $fname=__METHOD__, $options=[], $join_conds=[])

Lock all rows meeting the given conditions/options FOR UPDATE.

lockTables (array $read, array $write, $method)

Lock specific tables.

makeList (array $a, $mode=self::LIST_COMMA)

Makes an encoded list of strings from an array.

makeWhereFrom2d ( $data, $baseKey, $subKey)

Build a partial where clause from a 2-d array such as used for LinkBatch.

masterPosWait (DBMasterPos $pos, $timeout)

Wait for the replica DB to catch up to a given master position.Note that this does not start any new transactions. If any existing transaction is flushed, and this is called, then queries will reflect the point the DB was synced up to (on success) without interference from REPEATABLE-READ snapshots.

Parameters

DBMasterPos	$pos
int	$timeout	The maximum number of seconds to wait for synchronisation

Returns: int|null Zero if the replica DB was past that position already, greater than zero if we waited for some period of time, less than zero if it timed out, and null on error

Exceptions

DBError If an error occurs, see IDatabase::query()

Stable to override

maxListLen ()

Return the maximum number of items allowed in a list, or 0 for unlimited.

Returns: int

Stable to override

namedLocksEnqueue ()

Check to see if a named lock used by lock() use blocking queues.

Returns: bool

Since: 1.26

Stable to override

newSelectQueryBuilder ()

Create an empty SelectQueryBuilder which can be used to run queries against this connection.

Returns: SelectQueryBuilder

onAtomicSectionCancel (callable $callback, $fname=__METHOD__)

Run a callback when the atomic section is cancelled.

onTransactionCommitOrIdle (callable $callback, $fname=__METHOD__)

Run a callback as soon as there is no transaction pending.

onTransactionIdle (callable $callback, $fname=__METHOD__)

Alias for onTransactionCommitOrIdle() for backwards-compatibility.

onTransactionPreCommitOrIdle (callable $callback, $fname=__METHOD__)

Run a callback before the current transaction commits or now if there is none.

onTransactionResolution (callable $callback, $fname=__METHOD__)

Run a callback as soon as the current transaction commits or rolls back.

pendingWriteAndCallbackCallers ()

List the methods that have write queries or callbacks for the current transaction.

pendingWriteCallers ()

Get the list of method names that did write queries for this transaction.

pendingWriteQueryDuration ( $type=self::ESTIMATE_TOTAL)

Get the time spend running write queries for this transaction.

pendingWriteRowsAffected ()

Get the number of affected rows from pending write queries.

ping (&$rtt=null)

Ping the server and try to reconnect if it there is no connection.

preCommitCallbacksPending ()

query ( $sql, $fname=__METHOD__, $flags=self::QUERY_NORMAL)

Run an SQL query and return the result.

replace ( $table, $uniqueKeys, $rows, $fname=__METHOD__)

Insert row(s) into a table, deleting all conflicting rows beforehand.

reportQueryError ( $error, $errno, $sql, $fname, $ignore=false)

Report a query error.

restoreFlags ( $state=self::RESTORE_PRIOR)

Restore the flags to their prior state before the last setFlag/clearFlag call.

rollback ( $fname=__METHOD__, $flush=self::FLUSHING_ONE)

Rollback a transaction previously started using begin()

runOnTransactionIdleCallbacks ( $trigger)

Actually consume and run any "on transaction idle/resolution" callbacks.

runOnTransactionPreCommitCallbacks ()

Actually consume and run any "on transaction pre-commit" callbacks.

runTransactionListenerCallbacks ( $trigger)

Actually run any "transaction listener" callbacks.

select ( $table, $vars, $conds='', $fname=__METHOD__, $options=[], $join_conds=[])

Execute a SELECT query constructed using the various parameters provided.

selectDB ( $db)

Change the current database.

selectDomain ( $domain)

Set the current domain (database, schema, and table prefix)

selectField ( $table, $var, $cond='', $fname=__METHOD__, $options=[], $join_conds=[])

A SELECT wrapper which returns a single field from a single result row.

selectFieldValues ( $table, $var, $cond='', $fname=__METHOD__, $options=[], $join_conds=[])

A SELECT wrapper which returns a list of single field values from result rows.

selectRow ( $table, $vars, $conds, $fname=__METHOD__, $options=[], $join_conds=[])

Wrapper to IDatabase::select() that only fetches one row (via LIMIT)

selectRowCount ( $tables, $var=' *', $conds='', $fname=__METHOD__, $options=[], $join_conds=[])

Get the number of rows in dataset.

setBigSelects ( $value=true)

Allow or deny "big selects" for this session only.This is done by setting the sql_big_selects session variable.This is a MySQL-specific feature.

Parameters

bool | string $value True for allow, false for deny, or "default" to restore the initial value

Stable to override

setFlag ( $flag, $remember=self::REMEMBER_NOTHING)

Set a flag for this connection.

setIndexAliases (array $aliases)

Convert certain index names to alternative names before querying the DB.Note that this applies to indexes regardless of the table they belong to.This can be employed when an index was renamed X => Y in code, but the new Y-named indexes were not yet built on all DBs. After all the Y-named ones are added by the DBA, the aliases can be removed, and then the old X-named indexes dropped.

Parameters

string[] $aliases

Since: 1.31

Stable to override

setLBInfo ( $nameOrArray, $value=null)

Set the entire array or a particular key of the managing load balancer info array.

setLogger (LoggerInterface $logger)

Set the PSR-3 logger interface to use for query logging.

setSchemaVars ( $vars)

Set schema variables to be used when streaming commands from SQL files or stdin.

setSessionOptions (array $options)

Override database's default behavior.$options include: 'connTimeout' : Set the connection timeout value in seconds. May be useful for very long batch queries such as full-wiki dumps, where a single query reads out over hours or days.

Parameters

array $options

Returns: void

Exceptions

DBError If an error occurs, see IDatabase::query()

Stable to override

setTableAliases (array $aliases)

Make certain table names use their own database, schema, and table prefix when passed into SQL queries pre-escaped and without a qualified database name.For example, "user" can be converted to "myschema.mydbname.user" for convenience. Appearances like user, somedb.user, somedb.someschema.user will used literally.Calling this twice will completely clear any old table aliases. Also, note that callers are responsible for making sure the schemas and databases actually exist.

Parameters

array[] $aliases Map of (table => (dbname, schema, prefix) map)

Since: 1.28

Stable to override

setTransactionListener ( $name, callable $callback=null)

Run a callback after each time any transaction commits or rolls back.

setTrxEndCallbackSuppression ( $suppress)

Whether to disable running of post-COMMIT/ROLLBACK callbacks.

sourceFile ( $filename, callable $lineCallback=null, callable $resultCallback=null, $fname=false, callable $inputCallback=null)

Read and execute SQL commands from a file.

sourceStream ( $fp, callable $lineCallback=null, callable $resultCallback=null, $fname=__METHOD__, callable $inputCallback=null)

Read and execute commands from an open file handle.

startAtomic ( $fname=__METHOD__, $cancelable=self::ATOMIC_NOT_CANCELABLE)

Begin an atomic section of SQL statements.

strreplace ( $orig, $old, $new)

Returns a SQL expression for simple string replacement (e.g.REPLACE() in mysql)

Parameters

string	$orig	Column to modify
string	$old	Column to seek
string	$new	Column to replace with

Returns: string

Stable to override

tableExists ( $table, $fname=__METHOD__)

Query whether a given table exists.

tableLocksHaveTransactionScope ()

Checks if table locks acquired by lockTables() are transaction-bound in their scope.

tableNames (... $tables)

Fetch a number of table names into an array This is handy when you need to construct SQL for joins.

tableNamesN (... $tables)

Fetch a number of table names into an zero-indexed numerical array This is handy when you need to construct SQL for joins.

tablePrefix ( $prefix=null)

Get/set the table prefix.

timestampOrNull ( $ts=null)

Convert a timestamp in one of the formats accepted by ConvertibleTimestamp to the format used for inserting into timestamp fields in this DBMS.

truncate ( $tables, $fname=__METHOD__)

Delete all data in a table(s) and reset any sequences owned by that table(s)

trxLevel ()

Gets the current transaction level.

trxStatus ()

trxTimestamp ()

Get the UNIX timestamp of the time that the transaction was established.

unionConditionPermutations ( $table, $vars, array $permute_conds, $extra_conds='', $fname=__METHOD__, $options=[], $join_conds=[])

Construct a UNION query for permutations of conditions.

unionQueries ( $sqls, $all)

Construct a UNION query.This is used for providing overload point for other DB abstractions not compatible with the MySQL syntax.

Parameters

array	$sqls	SQL statements to combine
bool	$all	Either IDatabase::UNION_ALL or IDatabase::UNION_DISTINCT

Returns: string SQL fragment

Stable to override

unionSupportsOrderAndLimit ()

Determine if the RDBMS supports ORDER BY and LIMIT for separate subqueries within UNION.

Returns: bool

Stable to override

unlockTables ( $method)

Unlock all tables locked via lockTables()

update ( $table, $set, $conds, $fname=__METHOD__, $options=[])

Update all rows in a table that match a given condition.

upsert ( $table, array $rows, $uniqueKeys, array $set, $fname=__METHOD__)

Upsert the given row(s) into a table.

useIndexClause ( $index)

USE INDEX clause.

wasConnectionLoss ()

Determines if the last query error was due to a dropped connection.Note that during a connection loss, the prior transaction will have been lost

Returns: bool

Since: 1.31

Stable to override

wasErrorReissuable ()

Determines if the last query error was due to something outside of the query itself.

wasReadOnlyError ()

Determines if the last failure was due to the database being read-only.

Returns: bool

Stable to override

writesOrCallbacksPending ()

Whether there is a transaction open with either possible write queries or unresolved pre-commit/commit/resolution callbacks pending.

writesPending ()

Public Member Functions inherited from Wikimedia\Rdbms\IDatabase

buildSubString ( $input, $startPosition, $length=null)

Build a SUBSTRING function.

Protected Member Functions
	closeConnection ()
	Closes underlying database connection.

	doInsertSelectNative ( $destTable, $srcTable, array $varMap, $conds, $fname, array $insertOptions, array $selectOptions, $selectJoinConds)
	INSERT SELECT wrapper $varMap must be an associative array of the form [ 'dest1' => 'source1', ... ] Source items may be literals rather then field names, but strings should be quoted with Database::addQuotes() $conds may be "*" to copy the whole table srcTable may be an array of tables.

	doTruncate (array $tables, $fname)

	dumpError ()

	fetchAffectedRowCount ()

	isTransactableQuery ( $sql)
	Determine whether a SQL statement is sensitive to isolation level.

	makeInsertNonConflictingVerbAndOptions ()
	Stable to override.

	makeSelectOptions (array $options)
	Returns an optional USE INDEX clause to go after the table, and a string to go at the end of the query.

	makeUpdateOptionsArray ( $options)
	Make UPDATE options array for Database::makeUpdateOptions.

	open ( $server, $user, $password, $dbName, $schema, $tablePrefix)
	Open a new connection to the database (closing any existing one)

	relationSchemaQualifier ()
	Stable to override.

	wasKnownStatementRollbackError ()
	Stable to override.

Protected Member Functions inherited from Wikimedia\Rdbms\Database
	assertBuildSubstringParams ( $startPosition, $length)
	Check type and bounds for parameters to self::buildSubstring()

	assertConditionIsNotEmpty ( $conds, string $fname, bool $deprecate)
	Check type and bounds conditions parameters for update.

	assertHasConnectionHandle ()
	Make sure there is an open connection handle (alive or not) as a sanity check.

	assertIsWritableMaster ()
	Make sure that this server is not marked as a replica nor read-only as a sanity check.

	buildSuperlative ( $sqlfunc, $fields, $values)
	Build a superlative function statement comparing columns/values.

	doBegin ( $fname)
	Issues the BEGIN command to the database server.

	doCommit ( $fname)
	Issues the COMMIT command to the database server.

	doDropTable ( $table, $fname)

	doGetLag ()
	Stable to override

	doHandleSessionLossPreconnect ()
	Reset any additional subclass trx* and session* fields Stable to override.

	doInitConnection ()
	Actually connect to the database over the wire (or to local files)

	doInsert ( $table, array $rows, $fname)

	doInsertSelectGeneric ( $destTable, $srcTable, array $varMap, $conds, $fname, array $insertOptions, array $selectOptions, $selectJoinConds)
	Implementation of insertSelect() based on select() and insert()

	doReleaseSavepoint ( $identifier, $fname)
	Release a savepoint.

	doReplace ( $table, array $uniqueKeys, array $rows, $fname)

	doRollback ( $fname)
	Issues the ROLLBACK command to the database server.

	doRollbackToSavepoint ( $identifier, $fname)
	Rollback to a savepoint.

	doSavepoint ( $identifier, $fname)
	Create a savepoint.

	doUnlockTables ( $method)
	Helper function for unlockTables() that handles the actual table unlocking.

	doUpsert ( $table, array $rows, array $uniqueKeys, array $set, $fname)

	escapeLikeInternal ( $s, $escapeChar='`')
	Stable to override.

	executeQuery ( $sql, $fname, $flags)
	Execute a query, retrying it if there is a recoverable connection loss.

	extractSingleFieldFromList ( $var)

	fieldHasBit ( $field, $flags)

	fieldNamesWithAlias ( $fields)
	Gets an array of aliased field names.

	fieldNameWithAlias ( $name, $alias=false)
	Get an aliased field name e.g.

	getApproximateLagStatus ()
	Get a replica DB lag estimate for this server at the start of a transaction.

	getBindingHandle ()
	Get the underlying binding connection handle.

	getDefaultSchemaVars ()
	Get schema variables to use if none have been set via setSchemaVars().

	getLastPHPError ()

	getLazyMasterHandle ()
	Get a handle to the master server of the cluster to which this server belongs.

	getLogContext (array $extras=[])
	Create a log context to pass to PSR-3 logger functions.

	getQueryVerb ( $sql)

	getReadOnlyReason ()

	getRecordedTransactionLagStatus ()
	Get the replica DB lag when the current transaction started.

	getSchemaVars ()
	Get schema variables.

	getTempTableWrites ( $sql, $pseudoPermanent)

	getTransactionRoundId ()

	indexName ( $index)
	Allows for index remapping in queries where this is not consistent across DBMS.

	installErrorHandler ()
	Set a custom error handler for logging errors during database connection.

	isFlagInOptions ( $option, array $options)

	isInsertSelectSafe (array $insertOptions, array $selectOptions)
	Stable to override.

	isPristineTemporaryTable ( $table)
	Check if the table is both a TEMPORARY table and has not yet received CRUD operations.

	isWriteQuery ( $sql, $flags)
	Determine whether a query writes to the DB.

	makeConditionCollidesUponKeys (array $rows, array $uniqueKeys)

	makeGroupByWithHaving ( $options)
	Returns an optional GROUP BY with an optional HAVING.

	makeInsertLists (array $rows)
	Make SQL lists of columns, row tuples for INSERT/VALUES expressions.

	makeOrderBy ( $options)
	Returns an optional ORDER BY.

	makeUpdateOptions ( $options)
	Make UPDATE options for the Database::update function.

	newExceptionAfterConnectError ( $error)

	normalizeConditions ( $conds, $fname)

	normalizeOptions ( $options)

	normalizeRowArray (array $rowOrRows)

	normalizeUpsertKeys ( $uniqueKeys)

	qualifiedTableComponents ( $name)
	Get the table components needed for a query given the currently selected database.

	registerTempWrites ( $ret, array $changes)

	replaceLostConnection ( $fname)
	Close any existing (dead) database connection and open a new connection.

	replaceVars ( $ins)
	Database independent variable replacement.

	restoreErrorHandler ()
	Restore the previous error handler and return the last PHP error for this DB.

	resultObject ( $result)
	Take a query result and wrap it in an iterable result wrapper if necessary.

	tableNamesWithIndexClauseOrJOIN ( $tables, $use_index=[], $ignore_index=[], $join_conds=[])
	Get the aliased table name clause for a FROM clause which might have a JOIN and/or USE INDEX or IGNORE INDEX clause.

	tableNameWithAlias ( $table, $alias=false)
	Get an aliased table name.

	wasQueryTimeout ( $error, $errno)
	Checks whether the cause of the error is detected to be a timeout.

Static Protected Member Functions
static	getAttributes ()
	Stable to override.

Private Member Functions
	bigintFromLockName ( $lockName)

	makeConnectionString ( $vars)

	pg_array_parse ( $text, &$output, $limit=false, $offset=1)
	Posted by cc[plus]php[at]c2se[dot]com on 25-Mar-2009 09:12 to https://www.php.net/manual/en/ref.pgsql.php.

	relationExists ( $table, $types, $schema=false)
	Query whether a given relation exists (in the given schema, or the default mw one if not given)

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

Private Attributes
string	$coreSchema

string[]	$keywordTableMap = []
	Map of (reserved table name => alternate table name)

resource null	$lastResultHandle

float string	$numericVersion

int null	$port

string	$tempSchema

Additional Inherited Members
Static Public Member Functions inherited from Wikimedia\Rdbms\Database
static	attributesFromType ( $dbType, $driver=null)

static	factory ( $type, $params=[], $connect=self::NEW_CONNECTED)
	Construct a Database subclass instance given a database type and parameters.

static	getCacheSetOptions (IDatabase $db1, IDatabase $db2=null)
	Merge the result of getSessionLagStatus() for several DBs using the most pessimistic values to estimate the lag of any data derived from them in combination.

Protected Attributes inherited from Wikimedia\Rdbms\Database
integer null	$affectedRowCount
	Rows affected by the last query to query() or its CRUD wrappers.

string	$agent
	Agent name for query profiling.

bool	$cliMode
	Whether this PHP instance is for a CLI script.

object resource null	$conn
	Database connection.

array	$connectionParams
	Parameters used by initConnection() to establish a connection.

string[] int[] float[]	$connectionVariables
	SQL variables values to use for all new connections.

LoggerInterface	$connLogger

DatabaseDomain	$currentDomain

string	$delimiter = ';'
	Current SQL query delimiter.

callable	$deprecationLogger
	Deprecation logging callback.

callable	$errorLogger
	Error logging callback.

int	$flags
	Current bit field of class DBO_* constants.

string[]	$indexAliases = []
	Current map of (index alias => index)

array	$lbInfo = []
	Current LoadBalancer tracking information.

int	$nonNativeInsertSelectBatchSize
	Row batch size to use for emulated INSERT SELECT queries.

string	$password
	Password used to establish the current connection.

callable null	$profiler

LoggerInterface	$queryLogger

LoggerInterface	$replLogger

array null	$schemaVars
	Current variables use for schema element placeholders.

string	$server
	Server that this instance is currently connected to.

array	$sessionDirtyTempTables = []
	Map of (table name => 1) for current TEMPORARY tables.

array	$sessionNamedLocks = []
	Map of (name => 1) for locks obtained via lock()

array	$sessionTempTables = []
	Map of (table name => 1) for current TEMPORARY tables.

BagOStuff	$srvCache
	APC cache.

array[]	$tableAliases = []
	Current map of (table => (dbname, schema, prefix) map)

string	$topologyRole
	Replication topology role of the server; one of the class ROLE_* constants.

string null	$topologyRootMaster
	Host (or address) of the root master server for the replication topology.

TransactionProfiler	$trxProfiler

string	$user
	User that this instance is currently connected under the name of.

Static Protected Attributes inherited from Wikimedia\Rdbms\Database
static int	$DBO_MUTABLE
	Bit field of all DBO_* flags that can be changed after connection.

static string[]	$MUTABLE_FLAGS
	List of DBO_* flags that can be changed after connection.

Detailed Description

Definition at line 33 of file DatabasePostgres.php.

Constructor & Destructor Documentation

◆ __construct()

Wikimedia\Rdbms\DatabasePostgres::__construct ( array $params )

See also: Database::__construct()

Parameters

array

$params

Additional parameters include:

keywordTableMap : Map of reserved table names to alternative table names to use

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 53 of file DatabasePostgres.php.

Member Function Documentation

◆ addQuotes()

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

Escape and quote a raw value string for use in a SQL query.

Parameters

Returns: string

Stable to override Stable to override

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 1262 of file DatabasePostgres.php.

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

◆ aggregateValue()

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

Return aggregated value alias.

Parameters

array	$valuedata
string	$valuename

Returns: array|string

Deprecated: Since 1.33

Stable to override Stable to override

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 890 of file DatabasePostgres.php.

◆ bigintFromLockName()

Wikimedia\Rdbms\DatabasePostgres::bigintFromLockName ( $lockName )

private

Parameters

string $lockName

Returns: string Integer

Definition at line 1452 of file DatabasePostgres.php.

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

◆ buildConcat()

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

Build a concatenation list to feed into a SQL query.

Parameters

string[] $stringList Raw SQL expression list; caller is responsible for escaping

Returns: string

Stable to override Stable to override

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 1314 of file DatabasePostgres.php.

◆ buildGroupConcatField()

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

Definition at line 1318 of file DatabasePostgres.php.

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

◆ buildStringCast()

Wikimedia\Rdbms\DatabasePostgres::buildStringCast ( $field )

Parameters

string $field Field or column to cast

Returns: string

Since: 1.28

Stable to override Stable to override

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 1326 of file DatabasePostgres.php.

◆ closeConnection()

Wikimedia\Rdbms\DatabasePostgres::closeConnection ( )

protected

Closes underlying database connection.

Returns: bool Whether connection was closed successfully

Since: 1.20

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 199 of file DatabasePostgres.php.

◆ constraintExists()

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

Definition at line 1168 of file DatabasePostgres.php.

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

◆ currentSequenceValue()

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

Return the current value of a sequence.

Assumes it has been nextval'ed in this session.

Parameters

string $seqName

Returns: int

Definition at line 700 of file DatabasePostgres.php.

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

◆ databasesAreIndependent()

Wikimedia\Rdbms\DatabasePostgres::databasesAreIndependent ( )

Returns true if DBs are assumed to be on potentially different servers.In systems like mysql/mariadb, different databases can easily be referenced on a single connection merely by name, even in a single query via JOIN. On the other hand, Postgres treats databases as logically separate, with different database users, requiring special mechanisms like postgres_fdw to "mount" foreign DBs. This is true even among DBs on the same server. Changing the selected database via selectDomain() requires a new connection.

Returns: bool

Since: 1.29

Stable to override Stable to override

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 163 of file DatabasePostgres.php.

◆ dataSeek()

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

Change the position of the cursor in a result object.

See also: https://www.php.net/mysql_data_seek

Parameters

mixed	$res	A SQL result
int	$row

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 335 of file DatabasePostgres.php.

References $res, and Wikimedia\Rdbms\ResultWrapper\unwrap().

◆ decodeBlob()

Wikimedia\Rdbms\DatabasePostgres::decodeBlob ( $b )

Some DBMSs return a special placeholder object representing blob fields in result objects.Pass the object through this function to return the original string.

Parameters

string | Blob $b

Returns: string

Exceptions

DBError

Stable to override Stable to override

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 1247 of file DatabasePostgres.php.

◆ determineCoreSchema()

Wikimedia\Rdbms\DatabasePostgres::determineCoreSchema ( $desiredSchema )

Determine default schema for the current application Adjust this session schema search path if desired schema exists and is not alread there.

We need to have name of the core schema stored to be able to query database metadata.

This will be also called by the installer after the schema is created

Since: 1.19

Parameters

string $desiredSchema

Definition at line 991 of file DatabasePostgres.php.

References Wikimedia\Rdbms\Database\addIdentifierQuotes(), Wikimedia\Rdbms\DatabasePostgres\getCurrentSchema(), Wikimedia\Rdbms\DatabasePostgres\getSchemas(), Wikimedia\Rdbms\DatabasePostgres\getSearchPath(), Wikimedia\Rdbms\DatabasePostgres\schemaExists(), Wikimedia\Rdbms\DatabasePostgres\setSearchPath(), and Wikimedia\Rdbms\Database\trxLevel().

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

◆ doInsertNonConflicting()

Wikimedia\Rdbms\DatabasePostgres::doInsertNonConflicting	(		$table,
		array	$rows,
			$fname )

See also: Database::insert() Stable to override

Parameters

string	$table
array	$rows	Non-empty list of rows
string	$fname

Since: 1.35

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 559 of file DatabasePostgres.php.

References Wikimedia\Rdbms\Database\$affectedRowCount, Wikimedia\Rdbms\Database\cancelAtomic(), Wikimedia\Rdbms\Database\endAtomic(), Wikimedia\Rdbms\DatabasePostgres\getServerVersion(), Wikimedia\Rdbms\Database\makeInsertLists(), Wikimedia\Rdbms\Database\query(), Wikimedia\Rdbms\Database\startAtomic(), and Wikimedia\Rdbms\DatabasePostgres\tableName().

◆ doInsertSelectNative()

Wikimedia\Rdbms\DatabasePostgres::doInsertSelectNative	(		$destTable,
			$srcTable,
		array	$varMap,
			$conds,
			$fname,
		array	$insertOptions,
		array	$selectOptions,
			$selectJoinConds )

protected

INSERT SELECT wrapper $varMap must be an associative array of the form [ 'dest1' => 'source1', ... ] Source items may be literals rather then field names, but strings should be quoted with Database::addQuotes() $conds may be "*" to copy the whole table srcTable may be an array of tables.

Todo: FIXME: Implement this a little better (separate select/insert)?

Parameters

string	$destTable
array \| string	$srcTable
array	$varMap
array	$conds
string	$fname
array	$insertOptions
array	$selectOptions
array	$selectJoinConds

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 625 of file DatabasePostgres.php.

References Wikimedia\Rdbms\Database\doInsertSelectGeneric(), Wikimedia\Rdbms\DatabasePostgres\getServerVersion(), Wikimedia\Rdbms\Database\query(), Wikimedia\Rdbms\DatabasePostgres\selectSQLText(), and Wikimedia\Rdbms\DatabasePostgres\tableName().

◆ doLockTables()

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

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

Stable to override

Parameters

array	$read	Array of tables to lock for read access
array	$write	Array of tables to lock for write access
string	$method	Name of caller

Returns: true

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 1343 of file DatabasePostgres.php.

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

◆ doQuery()

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

Parameters

string $sql

Returns: bool|mixed|resource

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 212 of file DatabasePostgres.php.

References Wikimedia\Rdbms\Database\$conn, Wikimedia\Rdbms\DatabasePostgres\$lastResultHandle, $res, and Wikimedia\Rdbms\Database\getBindingHandle().

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

◆ doSelectDomain()

Wikimedia\Rdbms\DatabasePostgres::doSelectDomain ( DatabaseDomain $domain )

Stable to override.

Parameters

DatabaseDomain $domain

Exceptions

DBConnectionError
DBError

Since: 1.32

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 167 of file DatabasePostgres.php.

References Wikimedia\Rdbms\DatabaseDomain\getDatabase(), Wikimedia\Rdbms\Database\getDBname(), Wikimedia\Rdbms\DatabaseDomain\getSchema(), Wikimedia\Rdbms\DatabaseDomain\getTablePrefix(), and Wikimedia\Rdbms\DatabasePostgres\open().

◆ doTruncate()

Wikimedia\Rdbms\DatabasePostgres::doTruncate	(	array	$tables,
			$fname )

protected

See also: Database::truncate() Stable to override

Parameters

string[]	$tables
string	$fname

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 807 of file DatabasePostgres.php.

References Wikimedia\Rdbms\Database\query(), and Wikimedia\Rdbms\Database\tableNamesN().

◆ dumpError()

Wikimedia\Rdbms\DatabasePostgres::dumpError ( )

protected

Definition at line 231 of file DatabasePostgres.php.

◆ duplicateTableStructure()

Wikimedia\Rdbms\DatabasePostgres::duplicateTableStructure	(	$oldName,
		$newName,
		$temporary = false,
		$fname = __METHOD__ )

Creates a new table with structure copied from existing table.Note that unlike most database abstraction functions, this function does not automatically append database prefix, because it works at a lower abstraction level. The table names passed to this function shall not be quoted (this function calls addIdentifierQuotes() when needed).

Parameters

string	$oldName	Name of table whose structure should be copied
string	$newName	Name of table to be created
bool	$temporary	Whether the new table should be temporary
string	$fname	Calling function name

Returns: bool True if operation was successful

Exceptions

RuntimeException

Stable to override Stable to override

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 755 of file DatabasePostgres.php.

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

◆ encodeBlob()

Wikimedia\Rdbms\DatabasePostgres::encodeBlob ( $b )

Some DBMSs have a special format for inserting into blob fields, they don't allow simple quoted strings to be inserted.To insert into such a field, pass the data through this function before passing it to IDatabase::insert().

Parameters

string $b

Returns: string|Blob

Exceptions

DBError

Stable to override Stable to override

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 1243 of file DatabasePostgres.php.

◆ estimateRowCount()

Wikimedia\Rdbms\DatabasePostgres::estimateRowCount	(	$table,
		$var = '*',
		$conds = '',
		$fname = __METHOD__,
		$options = [],
		$join_conds = [] )

Estimate rows in dataset Returns estimated count, based on EXPLAIN output This is not necessarily an accurate estimate, so use sparingly Returns -1 if count cannot be found Takes same arguments as Database::select()

Parameters

string	$table
string	$var
string	$conds
string	$fname
array	$options
array	$join_conds

Returns: int

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 382 of file DatabasePostgres.php.

References $res, Wikimedia\Rdbms\Database\extractSingleFieldFromList(), Wikimedia\Rdbms\DatabasePostgres\fetchRow(), Wikimedia\Rdbms\Database\normalizeConditions(), and Wikimedia\Rdbms\Database\select().

◆ fetchAffectedRowCount()

Wikimedia\Rdbms\DatabasePostgres::fetchAffectedRowCount ( )

protected

Returns: int Number of retrieved rows according to the driver

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 359 of file DatabasePostgres.php.

◆ fetchObject()

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

Fetch the next row from the given result object, in object form.

Fields can be retrieved with $row->fieldname, with fields acting like member variables. If no more rows are available, false is returned.

Parameters

IResultWrapper | stdClass $res Object as returned from IDatabase::query(), etc.

Returns: stdClass|bool

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 261 of file DatabasePostgres.php.

References Wikimedia\Rdbms\Database\$conn, $res, Wikimedia\Rdbms\Database\getBindingHandle(), and Wikimedia\Rdbms\ResultWrapper\unwrap().

Referenced by Wikimedia\Rdbms\DatabasePostgres\duplicateTableStructure(), Wikimedia\Rdbms\PostgresField\fromText(), Wikimedia\Rdbms\DatabasePostgres\getCoreSchemas(), Wikimedia\Rdbms\DatabasePostgres\lock(), Wikimedia\Rdbms\DatabasePostgres\lockIsFree(), Wikimedia\Rdbms\DatabasePostgres\serverIsReadOnly(), Wikimedia\Rdbms\DatabasePostgres\textFieldSize(), and Wikimedia\Rdbms\DatabasePostgres\unlock().

◆ fetchRow()

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

Fetch the next row from the given result object, in associative array form.

Fields are retrieved with $row['fieldname']. If no more rows are available, false is returned.

Parameters

IResultWrapper $res Result object as returned from IDatabase::query(), etc.

Returns: array|bool

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 280 of file DatabasePostgres.php.

References Wikimedia\Rdbms\Database\$conn, $res, Wikimedia\Rdbms\Database\getBindingHandle(), and Wikimedia\Rdbms\ResultWrapper\unwrap().

Referenced by Wikimedia\Rdbms\DatabasePostgres\currentSequenceValue(), Wikimedia\Rdbms\DatabasePostgres\estimateRowCount(), Wikimedia\Rdbms\DatabasePostgres\getCurrentSchema(), Wikimedia\Rdbms\DatabasePostgres\getSchemas(), Wikimedia\Rdbms\DatabasePostgres\getSearchPath(), and Wikimedia\Rdbms\DatabasePostgres\insertId().

◆ fieldInfo()

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

Parameters

string	$table
string	$field

Returns: PostgresField|null

Implements Wikimedia\Rdbms\IMaintainableDatabase.

Definition at line 1229 of file DatabasePostgres.php.

References Wikimedia\Rdbms\PostgresField\fromText().

◆ fieldName()

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

Get a field name in a result object.

See also: https://www.php.net/mysql_field_name

Parameters

mixed	$res	A SQL result
int	$n

Returns: string

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 320 of file DatabasePostgres.php.

References $res, and Wikimedia\Rdbms\ResultWrapper\unwrap().

◆ fieldType()

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

pg_field_type() wrapper

Parameters

ResultWrapper \| resource	$res	ResultWrapper or PostgreSQL query result resource
int	$index	Field number, starting from 0

Returns: string

Definition at line 1239 of file DatabasePostgres.php.

References $res, and Wikimedia\Rdbms\ResultWrapper\unwrap().

◆ freeResult()

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

Free a result object returned by query() or select()It's usually not necessary to call this, just use unset() or let the variable holding the result object go out of scope.

Parameters

mixed $res A SQL result

Stable to override Stable to override

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 252 of file DatabasePostgres.php.

References $res, and Wikimedia\Rdbms\ResultWrapper\unwrap().

◆ getAttributes()

static Wikimedia\Rdbms\DatabasePostgres::getAttributes ( )

staticprotected

Stable to override.

Returns: array Map of (Database::ATTR_* constant => value)

Since: 1.31

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 1444 of file DatabasePostgres.php.

References true.

◆ getCoreSchema()

Wikimedia\Rdbms\DatabasePostgres::getCoreSchema ( )

Return schema name for core application tables.

Since: 1.19

Returns: string Core schema name

Definition at line 1029 of file DatabasePostgres.php.

References Wikimedia\Rdbms\DatabasePostgres\$coreSchema.

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

◆ getCoreSchemas()

Wikimedia\Rdbms\DatabasePostgres::getCoreSchemas ( )

Return schema names for temporary tables and core application tables.

Since: 1.31

Returns: string[] schema names

Definition at line 1039 of file DatabasePostgres.php.

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

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

◆ getCurrentSchema()

Wikimedia\Rdbms\DatabasePostgres::getCurrentSchema ( )

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

Since: 1.19

Returns: string Default schema for the current session

Definition at line 905 of file DatabasePostgres.php.

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

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

◆ getSchemas()

Wikimedia\Rdbms\DatabasePostgres::getSchemas ( )

Return list of schemas which are accessible without schema name This is list does not contain magic keywords like "$user" Needs transaction.

See also: getSearchPath(); setSearchPath()

Since: 1.19

Returns: array List of actual schemas for the current sesson

Definition at line 926 of file DatabasePostgres.php.

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

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

◆ getSearchPath()

Wikimedia\Rdbms\DatabasePostgres::getSearchPath ( )

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

Needs transaction

Since: 1.19

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

Definition at line 949 of file DatabasePostgres.php.

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

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

◆ getServerVersion()

Wikimedia\Rdbms\DatabasePostgres::getServerVersion ( )

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

Returns: string Version information from the database server.

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 1058 of file DatabasePostgres.php.

References Wikimedia\Rdbms\Database\$conn, Wikimedia\Rdbms\DatabasePostgres\$numericVersion, and Wikimedia\Rdbms\Database\getBindingHandle().

Referenced by Wikimedia\Rdbms\DatabasePostgres\doInsertNonConflicting(), and Wikimedia\Rdbms\DatabasePostgres\doInsertSelectNative().

◆ getSoftwareLink()

Wikimedia\Rdbms\DatabasePostgres::getSoftwareLink ( )

Returns a wikitext style link to the DB's website (e.g.

"[https://www.mysql.com/ MySQL]")

Should at least contain plain text, if for some reason your database has no website.

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

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 894 of file DatabasePostgres.php.

◆ getType()

Wikimedia\Rdbms\DatabasePostgres::getType ( )

Get the type of the DBMS (e.g.

"mysql", "sqlite")

Returns: string

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 60 of file DatabasePostgres.php.

◆ hasConstraint()

Wikimedia\Rdbms\DatabasePostgres::hasConstraint ( $name )

Definition at line 68 of file DatabasePostgres.php.

References $res, Wikimedia\Rdbms\DatabasePostgres\addQuotes(), Wikimedia\Rdbms\DatabasePostgres\doQuery(), Wikimedia\Rdbms\DatabasePostgres\getCoreSchemas(), and Wikimedia\Rdbms\DatabasePostgres\numRows().

◆ implicitOrderby()

Wikimedia\Rdbms\DatabasePostgres::implicitOrderby ( )

Returns true if this database does an implicit order by when the column has an index For example: SELECT page_title FROM page LIMIT 1.

Returns: bool

Stable to override Stable to override

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 64 of file DatabasePostgres.php.

◆ indexAttributes()

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

Definition at line 423 of file DatabasePostgres.php.

References Wikimedia\Rdbms\Database\$flags, $res, Wikimedia\Rdbms\DatabasePostgres\addQuotes(), Wikimedia\Rdbms\DatabasePostgres\getCoreSchemas(), n, and Wikimedia\Rdbms\Database\query().

◆ indexInfo()

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

Get information about an index into an object.

Stable to override

Parameters

string	$table	Table name
string	$index	Index name
string	$fname	Calling function name

Returns: mixed Database-specific index description class or false if the index does not exist

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 405 of file DatabasePostgres.php.

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

◆ indexUnique()

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

Determines if a given index is unique.

Parameters

string	$table
string	$index
string	$fname	Calling function name

Returns: bool

Stable to override Stable to override

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 487 of file DatabasePostgres.php.

References Wikimedia\Rdbms\Database\$flags, $res, Wikimedia\Rdbms\Database\indexName(), Wikimedia\Rdbms\Database\query(), and Wikimedia\Rdbms\DatabasePostgres\strencode().

◆ insertId()

Wikimedia\Rdbms\DatabasePostgres::insertId ( )

Get the inserted value of an auto-increment row.

This should only be called after an insert that used an auto-incremented value. If no such insert was previously done in the current database session, the return value is undefined.

Returns: int

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 324 of file DatabasePostgres.php.

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

◆ isTransactableQuery()

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

protected

Determine whether a SQL statement is sensitive to isolation level.

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

Main purpose: Used by query() to decide whether to begin a transaction before the current query (in DBO_TRX mode, on by default).

Stable to override

Parameters

string $sql

Returns: bool

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 203 of file DatabasePostgres.php.

◆ lastErrno()

Wikimedia\Rdbms\DatabasePostgres::lastErrno ( )

Get the last error number.

See also: https://www.php.net/mysql_errno

Returns: int

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 351 of file DatabasePostgres.php.

Referenced by Wikimedia\Rdbms\DatabasePostgres\wasDeadlock(), and Wikimedia\Rdbms\DatabasePostgres\wasLockTimeout().

◆ lastError()

Wikimedia\Rdbms\DatabasePostgres::lastError ( )

Get a description of the last error.

See also: https://www.php.net/mysql_error

Returns: string

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 339 of file DatabasePostgres.php.

References Wikimedia\Rdbms\Database\getLastPHPError().

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

◆ limitResult()

Wikimedia\Rdbms\DatabasePostgres::limitResult	(	$sql,
		$limit,
		$offset = false )

Construct a LIMIT query with optional offset.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.

Parameters

string	$sql	SQL query we will append the limit too
int	$limit	The SQL limit
int \| bool	$offset	The SQL offset (default false)

Returns: string

Since: 1.34

Stable to override Stable to override

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 730 of file DatabasePostgres.php.

◆ listTables()

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

Parameters

string	$prefix	Only show tables with this prefix, e.g. mw_
string	$fname	Calling function name

Returns: string[] SecurityCheck-SQLInjection array_map not recognized T204911

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 819 of file DatabasePostgres.php.

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

◆ lock()

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

Acquire a named lock.Named locks are not related to transactions

Parameters

string	$lockName	Name of lock to aquire
string	$method	Name of the calling method
int	$timeout	Acquisition timeout in seconds (0 means non-blocking)

Returns: bool Success

Exceptions

DBError If an error occurs, see IDatabase::query()

Stable to override Stable to override

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 1389 of file DatabasePostgres.php.

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

◆ lockIsFree()

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

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

Parameters

string	$lockName	Name of lock to poll
string	$method	Name of method calling us

Returns: bool

Exceptions

DBError If an error occurs, see IDatabase::query()

Since: 1.20

Stable to override Stable to override

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 1372 of file DatabasePostgres.php.

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

◆ makeConnectionString()

Wikimedia\Rdbms\DatabasePostgres::makeConnectionString ( $vars )

private

Parameters

string[] $vars

Returns: string

Definition at line 190 of file DatabasePostgres.php.

References $s.

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

◆ makeInsertNonConflictingVerbAndOptions()

Wikimedia\Rdbms\DatabasePostgres::makeInsertNonConflictingVerbAndOptions ( )

protected

Stable to override.

Returns: string[] ("INSERT"-style SQL verb, "ON CONFLICT"-style clause or "")

Since: 1.35

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 555 of file DatabasePostgres.php.

◆ makeSelectOptions()

Wikimedia\Rdbms\DatabasePostgres::makeSelectOptions ( array $options )

protected

Returns an optional USE INDEX clause to go after the table, and a string to go at the end of the query.

See also: Database::select()

Stable to override

Parameters

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

Returns: array

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 1285 of file DatabasePostgres.php.

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

◆ makeUpdateOptionsArray()

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

protected

Make UPDATE options array for Database::makeUpdateOptions.

Stable to override

Parameters

array $options

Returns: array

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 599 of file DatabasePostgres.php.

References Wikimedia\Rdbms\Database\normalizeOptions().

◆ nextSequenceValue()

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

Deprecated method, calls should be removed.

This was formerly used for PostgreSQL to handle self::insertId() auto-incrementing fields. It is no longer necessary since DatabasePostgres::insertId() has been reimplemented using lastval()

Implementations should return null if inserting NULL into an auto-incrementing field works, otherwise it should return an instance of NextSequenceValue and filter it on calls to relevant methods.

Deprecated: since 1.30, no longer needed

Parameters

string $seqName

Returns: null|NextSequenceValue

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 690 of file DatabasePostgres.php.

◆ numFields()

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

Get the number of fields in a result object.

See also: https://www.php.net/mysql_num_fields

Parameters

mixed $res A SQL result

Returns: int

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 316 of file DatabasePostgres.php.

References $res, and Wikimedia\Rdbms\ResultWrapper\unwrap().

◆ numRows()

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

Get the number of rows in a query result.

Returns zero if the query did not return any rows or was a write query.

Parameters

mixed $res A SQL result

Returns: int

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 296 of file DatabasePostgres.php.

References Wikimedia\Rdbms\Database\$conn, $res, Wikimedia\Rdbms\Database\getBindingHandle(), and Wikimedia\Rdbms\ResultWrapper\unwrap().

Referenced by Wikimedia\Rdbms\DatabasePostgres\hasConstraint(), Wikimedia\Rdbms\DatabasePostgres\roleExists(), and Wikimedia\Rdbms\DatabasePostgres\schemaExists().

◆ open()

Wikimedia\Rdbms\DatabasePostgres::open	(	$server,
		$user,
		$password,
		$dbName,
		$schema,
		$tablePrefix )

protected

Open a new connection to the database (closing any existing one)

Parameters

string \| null	$server	Database server host
string \| null	$user	Database user name
string \| null	$password	Database user password
string \| null	$dbName	Database name
string \| null	$schema	Database schema name
string	$tablePrefix	Table prefix

Exceptions

DBConnectionError

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 82 of file DatabasePostgres.php.

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

◆ pg_array_parse()

Wikimedia\Rdbms\DatabasePostgres::pg_array_parse	(		$text,
		&	$output,
			$limit = false,
			$offset = 1 )

private

Posted by cc[plus]php[at]c2se[dot]com on 25-Mar-2009 09:12 to https://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	$text	Postgreql array returned in a text form like {a,b}
string[]	&$output
int \| bool	$limit
int	$offset

Returns: string[]

Definition at line 863 of file DatabasePostgres.php.

References Wikimedia\Rdbms\DatabasePostgres\pg_array_parse().

Referenced by Wikimedia\Rdbms\DatabasePostgres\getSchemas(), and Wikimedia\Rdbms\DatabasePostgres\pg_array_parse().

◆ realTableName()

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

Parameters

string	$name
string	$format

Returns: string Qualified and encoded (if requested) table name

Definition at line 686 of file DatabasePostgres.php.

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

◆ relationExists()

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

private

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

Parameters

string	$table
array \| string	$types
bool \| string	$schema

Returns: bool

Definition at line 1085 of file DatabasePostgres.php.

References $res, Wikimedia\Rdbms\DatabasePostgres\addQuotes(), Wikimedia\Rdbms\DatabasePostgres\getCoreSchemas(), Wikimedia\Rdbms\Database\query(), and Wikimedia\Rdbms\DatabasePostgres\realTableName().

Referenced by Wikimedia\Rdbms\DatabasePostgres\sequenceExists(), and Wikimedia\Rdbms\DatabasePostgres\tableExists().

◆ relationSchemaQualifier()

Wikimedia\Rdbms\DatabasePostgres::relationSchemaQualifier ( )

protected

Stable to override.

Returns: string Schema to use to qualify relations in queries

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 154 of file DatabasePostgres.php.

◆ remappedTableName()

Wikimedia\Rdbms\DatabasePostgres::remappedTableName ( $name )

Parameters

string $name

Returns: string Value of $name or remapped name if $name is a reserved keyword

Definition at line 677 of file DatabasePostgres.php.

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

◆ roleExists()

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

Returns true if a given role (i.e.

user) exists, false otherwise.

Parameters

string $roleName

Returns: bool

Definition at line 1213 of file DatabasePostgres.php.

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

◆ ruleExists()

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

Definition at line 1155 of file DatabasePostgres.php.

References Wikimedia\Rdbms\DatabasePostgres\getCoreSchemas(), and Wikimedia\Rdbms\Database\selectField().

◆ schemaExists()

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

Query whether a given schema exists.

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

Parameters

string $schema

Returns: bool

Definition at line 1193 of file DatabasePostgres.php.

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

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

◆ selectSQLText()

Wikimedia\Rdbms\DatabasePostgres::selectSQLText	(	$table,
		$vars,
		$conds = '',
		$fname = __METHOD__,
		$options = [],
		$join_conds = [] )

Take the same arguments as IDatabase::select() and return the SQL it would use.This can be useful for making UNION queries, where the SQL text of each query is needed. In general, however, callers outside of Database classes should just use select().

See also: IDatabase::select()

Parameters

string \| array	$table	Table name
string \| array	$vars	Field names
string \| array	$conds	Conditions
string	$fname	Caller function name
string \| array	$options	Query options
string \| array	$join_conds	Join conditions

Returns: string SQL query string

Stable to override Stable to override

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 501 of file DatabasePostgres.php.

References Wikimedia\Rdbms\Database\addIdentifierQuotes().

Referenced by Wikimedia\Rdbms\DatabasePostgres\buildGroupConcatField(), and Wikimedia\Rdbms\DatabasePostgres\doInsertSelectNative().

◆ sequenceExists()

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

Definition at line 1125 of file DatabasePostgres.php.

References Wikimedia\Rdbms\DatabasePostgres\relationExists().

◆ serverIsReadOnly()

Wikimedia\Rdbms\DatabasePostgres::serverIsReadOnly ( )

Returns: bool Whether the DB is marked as read-only server-side

Since: 1.28

Stable to override Stable to override

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 1433 of file DatabasePostgres.php.

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

◆ setSearchPath()

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

private

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

Since: 1.19

Parameters

string[] $search_path List of schemas to be searched by default

Definition at line 969 of file DatabasePostgres.php.

References Wikimedia\Rdbms\Database\query().

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

◆ streamStatementEnd()

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

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

Stable to override

Parameters

string	&$sql	SQL assembled so far
string	&$newLine	New line about to be added to $sql

Returns: bool Whether $newLine contains end of the statement

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 1330 of file DatabasePostgres.php.

◆ strencode()

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

Wrapper for addslashes()

Stable to override

Parameters

string $s String to be slashed.

Returns: string Slashed string.

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 1257 of file DatabasePostgres.php.

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

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

◆ tableExists()

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

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

Parameters

string	$table
string	$fname
bool \| string	$schema

Returns: bool

Definition at line 1121 of file DatabasePostgres.php.

References Wikimedia\Rdbms\DatabasePostgres\relationExists().

◆ tableName()

Wikimedia\Rdbms\DatabasePostgres::tableName	(		$name,
			$format = 'quoted' )

Format a table name ready for use in constructing an SQL query.This does two important things: it quotes the table names to clean them up, and it adds a table prefix if only given a table name with no quotes.All functions of this object which require a table name call this function themselves. Pass the canonical name to such functions. This is only needed when calling query() directly.

Note: This function does not sanitize user input. It is not safe to use this function to escape user input.

Parameters

string	$name	Database table name
string	$format	One of: quoted - Automatically pass the table name through addIdentifierQuotes() so that it can be used in a query. raw - Do not add identifier quotes to the table name

Returns: string Full database name

Stable to override Stable to override

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 666 of file DatabasePostgres.php.

References Wikimedia\Rdbms\DatabasePostgres\remappedTableName().

Referenced by Wikimedia\Rdbms\DatabasePostgres\doInsertNonConflicting(), Wikimedia\Rdbms\DatabasePostgres\doInsertSelectNative(), Wikimedia\Rdbms\DatabasePostgres\doLockTables(), and Wikimedia\Rdbms\DatabasePostgres\textFieldSize().

◆ textFieldSize()

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

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

Parameters

string	$table
string	$field

Returns: int

Stable to override Stable to override

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 712 of file DatabasePostgres.php.

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

◆ timestamp()

Wikimedia\Rdbms\DatabasePostgres::timestamp ( $ts = 0 )

Convert a timestamp in one of the formats accepted by ConvertibleTimestamp to the format used for inserting into timestamp fields in this DBMS.The result is unquoted, and needs to be passed through addQuotes() before it can be included in raw SQL.

Parameters

string | int $ts

Returns: string

Stable to override Stable to override

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 839 of file DatabasePostgres.php.

◆ triggerExists()

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

Definition at line 1129 of file DatabasePostgres.php.

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

◆ unlock()

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

Release a lock.Named locks are not related to transactions

Parameters

string	$lockName	Name of lock to release
string	$method	Name of the calling method

Returns: bool Success

Exceptions

DBError If an error occurs, see IDatabase::query()

Stable to override Stable to override

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 1413 of file DatabasePostgres.php.

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

◆ wasConnectionError()

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

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

Stable to override

Parameters

int | string $errno

Returns: bool Whether the given query error was a connection drop

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 744 of file DatabasePostgres.php.

◆ wasDeadlock()

Wikimedia\Rdbms\DatabasePostgres::wasDeadlock ( )

Determines if the last failure was due to a deadlock.Note that during a deadlock, the prior transaction will have been lost

Returns: bool

Stable to override Stable to override

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 734 of file DatabasePostgres.php.

References Wikimedia\Rdbms\DatabasePostgres\lastErrno().

◆ wasKnownStatementRollbackError()

Wikimedia\Rdbms\DatabasePostgres::wasKnownStatementRollbackError ( )

protected

Stable to override.

Returns: bool Whether it is known that the last query error only caused statement rollback

Note: This is for backwards compatibility for callers catching DBError exceptions in order to ignore problems like duplicate key errors or foriegn key violations

Since: 1.31

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 751 of file DatabasePostgres.php.

◆ wasLockTimeout()

Wikimedia\Rdbms\DatabasePostgres::wasLockTimeout ( )

Determines if the last failure was due to a lock timeout.Note that during a lock wait timeout, the prior transaction will have been lost

Returns: bool

Stable to override Stable to override

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 739 of file DatabasePostgres.php.

References Wikimedia\Rdbms\DatabasePostgres\lastErrno().

Member Data Documentation

◆ $coreSchema

string Wikimedia\Rdbms\DatabasePostgres::$coreSchema

private

Definition at line 37 of file DatabasePostgres.php.

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

◆ $keywordTableMap

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

private

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

Definition at line 41 of file DatabasePostgres.php.

◆ $lastResultHandle

resource null Wikimedia\Rdbms\DatabasePostgres::$lastResultHandle

private

Definition at line 46 of file DatabasePostgres.php.

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

◆ $numericVersion

float string Wikimedia\Rdbms\DatabasePostgres::$numericVersion

private

Definition at line 43 of file DatabasePostgres.php.

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

◆ $port

int null Wikimedia\Rdbms\DatabasePostgres::$port

private

Definition at line 35 of file DatabasePostgres.php.

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

◆ $tempSchema

string Wikimedia\Rdbms\DatabasePostgres::$tempSchema

private

Definition at line 39 of file DatabasePostgres.php.

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

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

includes/libs/rdbms/database/DatabasePostgres.php

Public Member Functions

Protected Member Functions

Static Protected Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addQuotes()

◆ aggregateValue()

◆ bigintFromLockName()

◆ buildConcat()

◆ buildGroupConcatField()

◆ buildStringCast()

◆ closeConnection()

◆ constraintExists()

◆ currentSequenceValue()

◆ databasesAreIndependent()

◆ dataSeek()

◆ decodeBlob()

◆ determineCoreSchema()

◆ doInsertNonConflicting()

◆ doInsertSelectNative()

◆ doLockTables()

◆ doQuery()

◆ doSelectDomain()

◆ doTruncate()

◆ dumpError()

◆ duplicateTableStructure()

◆ encodeBlob()

◆ estimateRowCount()

◆ fetchAffectedRowCount()

◆ fetchObject()

◆ fetchRow()

◆ fieldInfo()

◆ fieldName()

◆ fieldType()

◆ freeResult()

◆ getAttributes()

◆ getCoreSchema()

◆ getCoreSchemas()

◆ getCurrentSchema()

◆ getSchemas()

◆ getSearchPath()

◆ getServerVersion()

◆ getSoftwareLink()

◆ getType()

◆ hasConstraint()

◆ implicitOrderby()

◆ indexAttributes()

◆ indexInfo()

◆ indexUnique()

◆ insertId()

◆ isTransactableQuery()

◆ lastErrno()

◆ lastError()

◆ limitResult()

◆ listTables()

◆ lock()

◆ lockIsFree()

◆ makeConnectionString()

◆ makeInsertNonConflictingVerbAndOptions()

◆ makeSelectOptions()

◆ makeUpdateOptionsArray()

◆ nextSequenceValue()

◆ numFields()

◆ numRows()

◆ open()

◆ pg_array_parse()

◆ realTableName()

◆ relationExists()

◆ relationSchemaQualifier()

◆ remappedTableName()

◆ roleExists()

◆ ruleExists()

◆ schemaExists()

◆ selectSQLText()

◆ sequenceExists()