Wikimedia\Rdbms\DatabasePostgres Class Reference

Postgres database abstraction layer. More...

Inheritance diagram for Wikimedia\Rdbms\DatabasePostgres:

Collaboration diagram for Wikimedia\Rdbms\DatabasePostgres:

Public Member Functions
	__construct (array $params)
	addQuotes ( $s)
	Escape and quote a raw value string for use in a SQL query. Parameters string | int | float | null | bool | Blob $s Returns string Stability: 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 Stability: stable to override
	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 Stability: 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 already there.
	doLock (string $lockName, string $method, int $timeout)
	doLockIsFree (string $lockName, string $method)
	doSelectDomain (DatabaseDomain $domain)
	doSingleStatementQuery (string $sql)
	Run a query and return a QueryStatus instance with the query result information.
	doUnlock (string $lockName, string $method)
	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 Stability: 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 Stability: 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()
	fieldInfo ( $table, $field)
	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 RDBMS type of the server (e.g.
	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 Stability: stable to override
	insertId ()
	Get the inserted value of an auto-increment row.
	lastErrno ()
	Get the RDBMS-specific error code from the last query statement.
	lastError ()
	Get the RDBMS-specific error description from the last query statement.
	listTables ( $prefix='', $fname=__METHOD__)
	nextSequenceValue ( $seqName)
	Deprecated method, calls should be removed.
	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.
	sequenceExists ( $sequence, $schema=false)
	serverIsReadOnly ()
	Returns bool Whether the DB is marked as read-only server-side Exceptions DBError If an error occurs, { See also query} Since 1.28 Stability: 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.
	textFieldSize ( $table, $field)
	Returns the size of a text field, or -1 for "unlimited". Parameters string $table string $field Returns int Stability: stable to override
	triggerExists ( $table, $trigger)
	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 Stability: 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 Stability: 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 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.
	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.
	begin ( $fname=__METHOD__, $mode=self::TRANSACTION_EXPLICIT)
	Begin a transaction.
	bitAnd ( $fieldLeft, $fieldRight)
	bitNot ( $field)
	bitOr ( $fieldLeft, $fieldRight)
	buildConcat ( $stringList)
	Build a concatenation list to feed into a SQL query.
	buildExcludedValue ( $column)
	Build a reference to a column value from the conflicting proposed upsert() row.
	buildGreatest ( $fields, $values)
	Build a GREATEST function statement comparing columns/values.
	buildGroupConcatField ( $delim, $table, $field, $conds='', $join_conds=[])
	Build a GROUP_CONCAT or equivalent statement for a query.
	buildIntegerCast ( $field)
	buildLeast ( $fields, $values)
	Build a LEAST function statement comparing columns/values.
	buildLike ( $param,... $params)
	LIKE statement wrapper.
	buildSelectSubquery ( $table, $vars, $conds='', $fname=__METHOD__, $options=[], $join_conds=[])
	Equivalent to IDatabase::selectSQLText() except wraps the result in Subquery.
	buildStringCast ( $field)
	buildSubstring ( $input, $startPosition, $length=null)
	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__)
	Close the database connection.
	commit ( $fname=__METHOD__, $flush=self::FLUSHING_ONE)
	Commits a transaction previously started using begin()
	conditional ( $cond, $caseTrueExpression, $caseFalseExpression)
	Returns an SQL expression for a simple conditional.
	connectionErrorLogger ( $errno, $errstr)
	Error handler for logging errors during database connection.
	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
	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 all rows in a table that match a condition which includes a join.For 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 also query}
	doAtomicSection ( $fname, callable $callback, $cancelable=self::ATOMIC_NOT_CANCELABLE)
	Perform an atomic section of reversible 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 ()
	Check whether there is a transaction open at the specific request of a caller.
	factorConds ( $condsArray)
	Given an array of condition arrays representing an OR list of AND lists, for example:
	fieldExists ( $table, $field, $fname=__METHOD__)
	Determines whether a field exists in a table.
	flushSession ( $fname=__METHOD__, $flush=self::FLUSHING_ONE)
	Release important session-level state (named lock, table locks) as post-rollback cleanup.
	flushSnapshot ( $fname=__METHOD__, $flush=self::FLUSHING_ONE)
	Commit any transaction but error out if writes or callbacks are pending.
	getDBname ()
	Get the current database name; null if there isn't one.
	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.
	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.
	getPrimaryPos ()
	Get the position of this primary DB. Returns DBPrimaryPos|false False if this is not a primary DB Exceptions DBError If an error occurs, { See also query} Since 1.37
	getReplicaPos ()
	Get the replication position of this replica DB. Returns DBPrimaryPos|false False if this is not a replica DB Exceptions DBError If an error occurs, { See also query}
	getScopedLockAndFlush ( $lockKey, $fname, $timeout)
	Acquire a named lock, flush any transaction, and return an RAII style unlocker object.
	getServer ()
	Get the hostname or IP address of the server.
	getServerInfo ()
	Get a human-readable string describing the current software version.
	getServerName ()
	Get the readable name for the server.
	getSessionLagStatus ()
	Get the replica DB lag when the current transaction started or a general lag estimate if not transaction is active.
	getTableAliases ()
	Return current table aliases.
	getTopologyBasedServerId ()
	Get a non-recycled ID that uniquely identifies this server within the replication topology.
	getTopologyRole ()
	Get the replication topology role of this server.
	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.
	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 row(s) into a table, in the provided order.
	insertSelect ( $destTable, $srcTable, $varMap, $conds, $fname=__METHOD__, $insertOptions=[], $selectOptions=[], $selectJoinConds=[])
	INSERT SELECT wrapper.
	isOpen ()
	isQuotedIdentifier ( $name)
	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()
	limitResult ( $sql, $limit, $offset=false)
	Construct a LIMIT query with optional offset.
	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
	lock ( $lockName, $method, $timeout=5, $flags=0)
	Acquire a named lock.Named locks are not related to transactions Parameters string $lockName Name of lock to acquire string $method Name of the calling method int $timeout Acquisition timeout in seconds (0 means non-blocking) int $flags Bit field of IDatabase::LOCK_* constants Returns bool|float|null Success (bool); acquisition time (float/null) if LOCK_TIMESTAMP Exceptions DBError If an error occurs, { See also query}
	lockForUpdate ( $table, $conds='', $fname=__METHOD__, $options=[], $join_conds=[])
	Lock all rows meeting the given conditions/options FOR UPDATE.
	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 also query} Since 1.20
	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.
	namedLocksEnqueue ()
	Check to see if a named lock used by lock() use blocking queues. Returns bool Since 1.26
	newSelectQueryBuilder ()
	Get a SelectQueryBuilder bound to this connection.
	onAtomicSectionCancel (callable $callback, $fname=__METHOD__)
	Run a callback when the atomic section is cancelled.
	onTransactionCommitOrIdle (callable $callback, $fname=__METHOD__)
	Run a callback when the current transaction commits or now if there is none.
	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 when the current transaction commits or rolls back.
	pendingWriteAndCallbackCallers ()
	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.
	primaryPosWait (DBPrimaryPos $pos, $timeout)
	Wait for the replica DB to catch up to a given primary DB 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 DBPrimaryPos $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 also query} Since 1.37
	query ( $sql, $fname=__METHOD__, $flags=0)
	Run an SQL query statement and return the result.
	queryMulti (array $sqls, string $fname=__METHOD__, int $flags=0, ?string $summarySql=null)
	Run a batch of SQL query statements and return the results.
	replace ( $table, $uniqueKeys, $rows, $fname=__METHOD__)
	Insert row(s) into a table, in the provided order, while deleting conflicting rows.
	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, array &$errors=[])
	Consume and run any "on transaction idle/resolution" callbacks.
	runOnTransactionPreCommitCallbacks ()
	runTransactionListenerCallbacks ( $trigger, array &$errors=[])
	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.
	selectSQLText ( $table, $vars, $conds='', $fname=__METHOD__, $options=[], $join_conds=[])
	Take the same arguments as IDatabase::select() and return the SQL it would use.
	sessionLocksPending ()
	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
	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.
	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 also query}
	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 after each time any transaction commits or rolls back.
	setTransactionManager (TransactionManager $transactionManager)
	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.
	tableExists ( $table, $fname=__METHOD__)
	Query whether a given table exists.
	tableName ( $name, $format='quoted')
	Format a table name ready for use in constructing an SQL query.
	tableNames (... $tables)
	Fetch a number of table names into an associative array.
	tableNamesN (... $tables)
	Fetch a number of table names into a zero-indexed numerical array.
	tablePrefix ( $prefix=null)
	Get/set the table prefix.
	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.
	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.
	unionSupportsOrderAndLimit ()
	Determine if the RDBMS supports ORDER BY and LIMIT for separate subqueries within UNION.
	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 also query}
	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 row(s) into a table, in the provided order, while updating conflicting rows.
	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
	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
	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\Platform\ISQLPlatform
	buildSubString ( $input, $startPosition, $length=null)
	Build a SUBSTRING function.

Static Public Member Functions
static	getAttributes ()
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 ... $dbs)
	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 Member Functions
	closeConnection ()
	Closes underlying database connection.
	doFlushSession ( $fname)
	Reset the server-side session state for named locks and table locks.
	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.
	doMultiStatementQuery (array $sqls)
	Execute a batch of query statements, aborting remaining statements if one fails.
	doTruncate (array $tables, $fname)
	dumpError ()
	fetchAffectedRowCount ()
	isConnectionError ( $errno)
	Do not use this method outside of Database/DBError classes.
	isKnownStatementRollbackError ( $errno)
	isQueryTimeoutError ( $errno)
	Checks whether the cause of the error is detected to be a timeout.
	open ( $server, $user, $password, $db, $schema, $tablePrefix)
	Open a new connection to the database (closing any existing one)
Protected Member Functions inherited from Wikimedia\Rdbms\Database
	assertHasConnectionHandle ()
	Make sure there is an open connection handle (alive or not)
	assertIsWritablePrimary ()
	Make sure that this server is not marked as a replica nor read-only.
	commenceCriticalSection (string $fname)
	Demark the start of a critical section of session/transaction state changes.
	completeCriticalSection (string $fname, ?CriticalSectionScope $csm, Throwable $trxError=null)
	Demark the completion of a critical section of session/transaction state changes.
	doBegin ( $fname)
	Issues the BEGIN command to the database server.
	doCommit ( $fname)
	Issues the COMMIT command to the database server.
	doGetLag ()
	Get the amount of replication lag for this database server.
	doHandleSessionLossPreconnect ()
	Reset any additional subclass trx* and session* fields.
	doInitConnection ()
	Actually connect to the database over the wire (or to local files)
	doInsertSelectGeneric ( $destTable, $srcTable, array $varMap, $conds, $fname, array $insertOptions, array $selectOptions, $selectJoinConds)
	Implementation of insertSelect() based on select() and insert()
	doReplace ( $table, array $identityKey, array $rows, $fname)
	doUpsert (string $table, array $rows, array $identityKey, array $set, string $fname)
	Perform an UPSERT query.
	executeQuery ( $sqls, $fname, $flags, $summarySql)
	Execute a set of queries without enforcing public (non-Database) caller restrictions.
	fieldHasBit (int $flags, int $bit)
	getApproximateLagStatus ()
	Get a replica DB lag estimate for this server at the start of a transaction.
	getBindingHandle ()
	Get the underlying binding connection handle.
	getLastPHPError ()
	getLogContext (array $extras=[])
	Create a log context to pass to PSR-3 logger functions.
	getReadOnlyReason ()
	getRecordedTransactionLagStatus ()
	Get the replica DB lag when the current transaction started.
	getTempTableWrites ( $sql, $pseudoPermanent)
	getTransactionRoundId ()
	indexName ( $index)
	installErrorHandler ()
	Set a custom error handler for logging errors during database connection.
	isInsertSelectSafe (array $insertOptions, array $selectOptions)
	isPristineTemporaryTable ( $table)
	Check if the table is both a TEMPORARY table and has not yet received CRUD operations.
	newExceptionAfterConnectError ( $error)
	registerTempWrites ( $ret, array $changes)
	replaceLostConnection ( $lastErrno, $fname)
	Close any existing (dead) database connection and open a new connection.
	restoreErrorHandler ()
	Restore the previous error handler and return the last PHP error for this DB.

Protected Attributes
PostgresPlatform	$platform
Protected Attributes inherited from Wikimedia\Rdbms\Database
int 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< string, mixed >	$connectionParams
	Connection parameters used by initConnection() and open()
string[] int[] float[]	$connectionVariables
	SQL variables values to use for all new connections.
LoggerInterface	$connLogger
CriticalSectionProvider null	$csProvider
DatabaseDomain	$currentDomain
string false	$delimiter = ';'
	Current SQL query delimiter.
callable	$deprecationLogger
	Deprecation logging callback.
callable	$errorLogger
	Error logging callback.
int	$flags
	Current bit field of class DBO_* constants.
array	$lbInfo = []
	Current LoadBalancer tracking information.
int	$nonNativeInsertSelectBatchSize
	Row batch size to use for emulated INSERT SELECT queries.
string null	$password
	Password used to establish the current connection.
SQLPlatform	$platform
callable null	$profiler
LoggerInterface	$queryLogger
LoggerInterface	$replLogger
string null	$server
	Server that this instance is currently connected to.
string null	$serverName
	Readable name or host/IP of the database server.
array< string, array >	$sessionNamedLocks = []
	Map of (name => (UNIX time,trx ID)) for current lock() mutexes.
array< string, array >	$sessionTempTables = []
	Map of (name => (type,pristine,trx ID)) for current temp tables.
BagOStuff	$srvCache
	APC cache.
bool	$ssl
	Whether to use SSL connections.
IDatabase	$topologicalPrimaryConnRef
	Lazy handle to the most authoritative primary server for the dataset.
string	$topologyRole
	Replication topology role of the server; one of the class ROLE_* constants.
string null	$user
	User that this instance is currently connected under the name of.
const	CONN_HOST = 'host'
	Hostname or IP address to use on all connections.
const	CONN_INITIAL_DB = 'dbname'
	Database name to use on initial connection.
const	CONN_INITIAL_SCHEMA = 'schema'
	Schema name to use on initial connection.
const	CONN_INITIAL_TABLE_PREFIX = 'tablePrefix'
	Table prefix to use on initial connection.
const	CONN_PASSWORD = 'password'
	Database server password to use on all connections.
const	CONN_USER = 'user'
	Database server username to use on all connections.
const	DROPPED_CONN_BLAME_THRESHOLD_SEC = 3.0
	Assume that queries taking this long to yield connection loss errors are at fault.
const	ERR_ABORT_QUERY = 2
	Abort query (no retries) due to a statement rollback (session/transaction intact)
const	ERR_ABORT_SESSION = 8
	Abort and reset session due to server-side session-level state loss (locks, temp tables)
const	ERR_ABORT_TRX = 4
	Abort any current transaction, by rolling it back, due to an error during the query.
const	ERR_NONE = 0
	No errors occurred during the query.
const	ERR_RETRY_QUERY = 1
	Retry query due to a connection loss detected while sending the query (session intact)

Additional Inherited Members
Public Attributes inherited from Wikimedia\Rdbms\IDatabase
const	LOCK_TIMESTAMP = 1
	Flag to return the lock acquisition timestamp (null if not acquired)
Public Attributes inherited from Wikimedia\Rdbms\Platform\ISQLPlatform
const	QUERY_PSEUDO_PERMANENT = 2
	Track a TEMPORARY table CREATE as if it was for a permanent table (for testing)

Detailed Description

Postgres database abstraction layer.

Definition at line 31 of file DatabasePostgres.php.

Constructor & Destructor Documentation

__construct()

Wikimedia\Rdbms\DatabasePostgres::__construct

(

array

$params

)

See also

Database::__construct()

Parameters

array

$params

Additional parameters include: port: A port to append to the hostname keywordTableMap : Map of reserved table names to alternative table names to use This is is deprecated since 1.37. Reserved identifiers should be quoted where necessary,

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 54 of file DatabasePostgres.php.

References wfDeprecatedMsg().

Member Function Documentation

addQuotes()

Wikimedia\Rdbms\DatabasePostgres::addQuotes

(

$s

)

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

Parameters

string | int | float | null | bool | Blob

$s

Returns

string

Stability: stable

to override

Stability: stable

to override

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 1080 of file DatabasePostgres.php.

References $s.

Referenced by Wikimedia\Rdbms\PostgresField\fromText().

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

constraintExists()

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

Definition at line 994 of file DatabasePostgres.php.

References $res.

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

References $res.

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

Stability: stable

to override

Stability: stable

to override

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 147 of file DatabasePostgres.php.

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

Stability: stable

to override

Stability: stable

to override

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 1065 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 already 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 | null

$desiredSchema

Definition at line 817 of file DatabasePostgres.php.

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

doFlushSession()

Wikimedia\Rdbms\DatabasePostgres::doFlushSession ( $fname )

protected

Reset the server-side session state for named locks and table locks.

Connection and query errors will be suppressed and logged

Parameters

string

$fname

Since

1.38

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 1166 of file DatabasePostgres.php.

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

doLock()

Wikimedia\Rdbms\DatabasePostgres::doLock	(	string	$lockName,
		string	$method,
		int	$timeout )

See also

lock()

Parameters

string	$lockName
string	$method
int	$timeout

Returns

float|null UNIX timestamp of lock acquisition; null on failure

Exceptions

DBError

Stability: stable

to override

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 1127 of file DatabasePostgres.php.

References $res.

doLockIsFree()

Wikimedia\Rdbms\DatabasePostgres::doLockIsFree	(	string	$lockName,
		string	$method )

See also

lockIsFree()

Parameters

string	$lockName
string	$method

Returns

bool Success

Exceptions

DBError

Stability: stable

to override

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 1116 of file DatabasePostgres.php.

References $res.

doMultiStatementQuery()

Wikimedia\Rdbms\DatabasePostgres::doMultiStatementQuery ( array $sqls )

protected

Execute a batch of query statements, aborting remaining statements if one fails.

See also

Database::doQuery()

Stability: stable

to override

Parameters

string[]

$sqls

Non-empty map of (statement ID => SQL statement)

Returns

array<string,QueryStatus> Map of (statement ID => QueryStatus)

Since

1.39

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 215 of file DatabasePostgres.php.

doSelectDomain()

Wikimedia\Rdbms\DatabasePostgres::doSelectDomain

(

DatabaseDomain

$domain

)

Stability: stable

to override

Parameters

DatabaseDomain

$domain

Exceptions

DBConnectionError
DBError

Since

1.32

Reimplemented from Wikimedia\Rdbms\Database.

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

doSingleStatementQuery()

Wikimedia\Rdbms\DatabasePostgres::doSingleStatementQuery

(

string

$sql

)

Run a query and return a QueryStatus instance with the query result information.

This is meant to handle the basic command of actually sending a query to the server via the driver. No implicit transaction, reconnection, nor retry logic should happen here. The higher level query() method is designed to handle those sorts of concerns. This method should not trigger such higher level methods.

The lastError() and lastErrno() methods should meaningfully reflect what error, if any, occurred during the last call to this method. Methods like executeQuery(), query(), select(), insert(), update(), delete(), and upsert() implement their calls to doQuery() such that an immediately subsequent call to lastError()/lastErrno() meaningfully reflects any error that occurred during that public query method call.

For SELECT queries, the result field contains either:

• a) A driver-specific IResultWrapper describing the query results
• b) False, on any query failure

For non-SELECT queries, the result field contains either:

• a) A driver-specific IResultWrapper, only on success
• b) True, only on success (e.g. no meaningful result other than "OK")
• c) False, on any query failure

Parameters

string

$sql

Single-statement SQL query

Returns

QueryStatus

Since

1.39

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 188 of file DatabasePostgres.php.

doTruncate()

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

protected

See also

Database::truncate()

Stability: stable

to override

Parameters

string[]	$tables
string	$fname

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 643 of file DatabasePostgres.php.

doUnlock()

Wikimedia\Rdbms\DatabasePostgres::doUnlock	(	string	$lockName,
		string	$method )

See also

unlock()

Parameters

string	$lockName
string	$method

Returns

bool Success

Exceptions

DBError

Stability: stable

to override

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 1155 of file DatabasePostgres.php.

dumpError()

Wikimedia\Rdbms\DatabasePostgres::dumpError ( )

protected

Definition at line 256 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

Stability: stable

to override

Stability: stable

to override

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 591 of file DatabasePostgres.php.

References $res.

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

Stability: stable

to override

Stability: stable

to override

Reimplemented from Wikimedia\Rdbms\Database.

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

References $res.

fetchAffectedRowCount()

Wikimedia\Rdbms\DatabasePostgres::fetchAffectedRowCount ( )

protected

Returns

int Number of retrieved rows according to the driver

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 312 of file DatabasePostgres.php.

fieldInfo()

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

Parameters

string	$table
string	$field

Returns

PostgresField|null

Implements Wikimedia\Rdbms\IMaintainableDatabase.

Definition at line 1055 of file DatabasePostgres.php.

getAttributes()

static Wikimedia\Rdbms\DatabasePostgres::getAttributes ( )

static

Stability: stable

to override

Returns

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

Since

1.31

Reimplemented from Wikimedia\Rdbms\Database.

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

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

References $res.

Referenced by Wikimedia\Rdbms\PostgresField\fromText().

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

References $res.

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 session

Definition at line 752 of file DatabasePostgres.php.

References $res.

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

References $res.

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

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

getType()

Wikimedia\Rdbms\DatabasePostgres::getType

(

)

Get the RDBMS type of the server (e.g.

"mysql", "sqlite")

Returns

string

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 74 of file DatabasePostgres.php.

indexAttributes()

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

Definition at line 376 of file DatabasePostgres.php.

References $res, and n.

indexInfo()

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

Get information about an index into an object.

Stability: 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 358 of file DatabasePostgres.php.

References $res.

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

Stability: stable

to override

Stability: stable

to override

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 440 of file DatabasePostgres.php.

References $res.

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

References $res.

isConnectionError()

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

protected

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

Stability: stable

to override

Parameters

int | string

$errno

Returns

bool Whether the given query error was a connection drop

Since

1.38

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 575 of file DatabasePostgres.php.

isKnownStatementRollbackError()

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

protected

Stability: stable

to override

Parameters

int | string

$errno

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 foreign key violations

Since

1.39

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 587 of file DatabasePostgres.php.

isQueryTimeoutError()

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

protected

Checks whether the cause of the error is detected to be a timeout.

It returns false by default, and not all engines support detecting this yet. If this returns false, it will be treated as a generic query error.

Stability: stable

to override

Parameters

int | string

$errno

Error number

Returns

bool

Since

1.39

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 582 of file DatabasePostgres.php.

lastErrno()

Wikimedia\Rdbms\DatabasePostgres::lastErrno

(

)

Get the RDBMS-specific error code from the last query statement.

Returns

int|string Error code (integer or hexadecimal depending on RDBMS type)

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 301 of file DatabasePostgres.php.

lastError()

Wikimedia\Rdbms\DatabasePostgres::lastError

(

)

Get the RDBMS-specific error description from the last query statement.

Returns

string

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 289 of file DatabasePostgres.php.

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

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[]

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 655 of file DatabasePostgres.php.

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

open()

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

protected

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

Parameters

string | null

$server

Server host/address and optional port {

See also

connectionParams}

Parameters

string | null

$user

User name {

See also

connectionParams}

Parameters

string | null

$password

User password {

See also

connectionParams}

Parameters

string | null	$db	Database name
string | null	$schema	Database schema name
string	$tablePrefix

Exceptions

DBConnectionError

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 78 of file DatabasePostgres.php.

References Wikimedia\Rdbms\Database\$password, Wikimedia\Rdbms\Database\$server, Wikimedia\Rdbms\Database\$user, Wikimedia\Rdbms\Database\close(), Wikimedia\Rdbms\DatabasePostgres\determineCoreSchema(), Wikimedia\Rdbms\Database\installErrorHandler(), Wikimedia\Rdbms\DatabasePostgres\lastError(), Wikimedia\Rdbms\Database\newExceptionAfterConnectError(), Wikimedia\Rdbms\Database\query(), and Wikimedia\Rdbms\Database\restoreErrorHandler().

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

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

Deprecated

since 1.37. Reserved identifiers should be quoted where necessary

Definition at line 510 of file DatabasePostgres.php.

References wfDeprecated().

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

References $res.

ruleExists()

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

Definition at line 981 of file DatabasePostgres.php.

schemaExists()

Wikimedia\Rdbms\DatabasePostgres::schemaExists

(

$schema

)

Query whether a given schema exists.

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

Parameters

string | null

$schema

Returns

bool

Definition at line 1019 of file DatabasePostgres.php.

References $res.

sequenceExists()

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

Definition at line 951 of file DatabasePostgres.php.

serverIsReadOnly()

Wikimedia\Rdbms\DatabasePostgres::serverIsReadOnly

(

)

Returns

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

Exceptions

DBError

If an error occurs, {

See also

query}

Since

1.28

Stability: stable

to override

Stability: stable

to override

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 1177 of file DatabasePostgres.php.

References $res.

streamStatementEnd()

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

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

Stability: 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 1103 of file DatabasePostgres.php.

strencode()

Wikimedia\Rdbms\DatabasePostgres::strencode

(

$s

)

Wrapper for addslashes()

Stability: stable

to override

Parameters

string

$s

String to be slashed.

Returns

string Slashed string.

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 1075 of file DatabasePostgres.php.

References $s.

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

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

Stability: stable

to override

Stability: stable

to override

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 547 of file DatabasePostgres.php.

References $res.

triggerExists()

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

Definition at line 955 of file DatabasePostgres.php.

References $res.

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

Stability: stable

to override

Stability: stable

to override

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 565 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

Stability: stable

to override

Stability: stable

to override

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 570 of file DatabasePostgres.php.

Member Data Documentation

$platform

PostgresPlatform Wikimedia\Rdbms\DatabasePostgres::$platform

protected

Definition at line 45 of file DatabasePostgres.php.

---

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

• includes/libs/rdbms/database/DatabasePostgres.php