Inheritance diagram for Wikimedia\Rdbms\DatabasePostgres:

[legend]

Collaboration diagram for Wikimedia\Rdbms\DatabasePostgres:

[legend]

Public Member Functions
	__construct (array $params)

	addQuotes ( $s)
	Adds quotes and backslashes.

	affectedRows ()
	Get the number of rows affected by the last write query.

	aggregateValue ( $valuedata, $valuename='value')
	Return aggregated value alias.

	buildConcat ( $stringList)
	Build a concatenation list to feed into a SQL query.

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

	buildStringCast ( $field)

	constraintExists ( $table, $constraint)

	currentSequenceValue ( $seqName)
	Return the current value of a sequence.

	databasesAreIndependent ()
	Returns true if DBs are assumed to be on potentially different servers.

	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.

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

	doLockTables (array $read, array $write, $method)
	Helper function for lockTables() that handles the actual table locking.

	doQuery ( $sql)
	The DBMS-dependent part of query()

	duplicateTableStructure ( $oldName, $newName, $temporary=false, $fname=__METHOD__)
	Creates a new table with structure copied from existing table.

	encodeBlob ( $b)
	Some DBMSs have a special format for inserting into blob fields, they don't allow simple quoted strings to be inserted.

	estimateRowCount ( $table, $vars=' *', $conds='', $fname=__METHOD__, $options=[])
	Estimate rows in dataset Returns estimated count, based on EXPLAIN output This is not necessarily an accurate estimate, so use sparingly Returns -1 if count cannot be found Takes same arguments as Database::select()

	fetchObject ( $res)
	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().

	getCoreSchema ()
	Return schema name for core application tables.

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

	getDBname ()
	Get the current DB name.

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

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

	getServer ()
	Get the server hostname or IP address.

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

	getSoftwareLink ()
	Returns a wikitext link to the DB's website, e.g., return "[https://www.mysql.com/ MySQL]"; Should at least contain plain text, if for some reason your database has no website.

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

	hasConstraint ( $name)

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

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

	indexAttributes ( $index, $schema=false)

	indexInfo ( $table, $index, $fname=__METHOD__)
	Get information about an index into an object.

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

	insert ( $table, $args, $fname=__METHOD__, $options=[])
	INSERT wrapper, inserts an array into a table.

	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.

	listTables ( $prefix=null, $fname=__METHOD__)
	List all tables on the database.

	lock ( $lockName, $method, $timeout=5)
	Acquire a named lock.

	lockIsFree ( $lockName, $method)
	Check to see if a named lock is available (non-blocking)

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

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

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

	open ( $server, $user, $password, $dbName)
	Open a connection to the database.

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

	remappedTableName ( $name)

	reportQueryError ( $error, $errno, $sql, $fname, $tempIgnore=false)
	Report a query error.

	roleExists ( $roleName)
	Returns true if a given role (i.e.

	ruleExists ( $table, $rule)

	schemaExists ( $schema)
	Query whether a given schema exists.

	selectDB ( $db)
	Postgres doesn't support selectDB in the same way MySQL does.

	selectSQLText ( $table, $vars, $conds='', $fname=__METHOD__, $options=[], $join_conds=[])
	The equivalent of IDatabase::select() except that the constructed SQL is returned, instead of being immediately executed.

	sequenceExists ( $sequence, $schema=false)

	serverIsReadOnly ()

	streamStatementEnd (&$sql, &$newLine)
	Called by sourceStream() to check if we've reached a statement end.

	strencode ( $s)
	Wrapper for addslashes()

	tableExists ( $table, $fname=__METHOD__, $schema=false)
	For backward compatibility, this function checks both tables and views.

	tableName ( $name, $format='quoted')
	Format a table name ready for use in constructing an SQL query.

	textFieldSize ( $table, $field)
	Returns the size of a text field, or -1 for "unlimited".

	timestamp ( $ts=0)
	Convert a timestamp in one of the formats accepted by wfTimestamp() to the format used for inserting into timestamp fields in this DBMS.

	triggerExists ( $table, $trigger)

	unlock ( $lockName, $method)
	Release a lock.

	wasDeadlock ()
	Determines if the last failure was due to a deadlock.

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

	addIdentifierQuotes ( $s)
	Quotes an identifier using `backticks` or "double quotes" depending on the database type.

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

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

	begin ( $fname=__METHOD__, $mode=self::TRANSACTION_EXPLICIT)
	Begin a transaction.

	bitAnd ( $fieldLeft, $fieldRight)

	bitNot ( $field)

	bitOr ( $fieldLeft, $fieldRight)

	bufferResults ( $buffer=null)
	Turns buffering of SQL result sets on (true) or off (false).

	buildGroupConcatField ( $delim, $table, $field, $conds='', $join_conds=[])
	Build a GROUP_CONCAT or equivalent statement for a query.

	buildLike ()
	LIKE statement wrapper, receives a variable-length argument list with parts of pattern to match containing either string literals that will be escaped or tokens returned by anyChar() or anyString().

	clearFlag ( $flag, $remember=self::REMEMBER_NOTHING)
	Clear a flag for this connection.

	close ()
	Closes a database connection.

	commit ( $fname=__METHOD__, $flush='')
	Commits a transaction previously started using begin().

	conditional ( $cond, $trueVal, $falseVal)
	Returns an SQL expression for a simple conditional.

	connectionErrorLogger ( $errno, $errstr)
	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 ()
	Perform a deadlock-prone transaction.

	decodeExpiry ( $expiry, $format=TS_MW)
	Decode an expiry time into a DBMS independent format.

	delete ( $table, $conds, $fname=__METHOD__)
	DELETE query wrapper.

	deleteJoin ( $delTable, $joinTable, $delVar, $joinVar, $conds, $fname=__METHOD__)
	DELETE where the condition is a join.

	doAtomicSection ( $fname, callable $callback)
	Run a callback to do an atomic set of updates for this database.

	doneWrites ()
	Returns true if the connection may have been used for write queries.

	dropTable ( $tableName, $fName=__METHOD__)
	Delete a table.

	encodeExpiry ( $expiry)
	Encode an expiry time into the DBMS dependent format.

	endAtomic ( $fname=__METHOD__)
	Ends an atomic section of SQL statements.

	explicitTrxActive ()

	fieldExists ( $table, $field, $fname=__METHOD__)
	Determines whether a field exists in a table.

	flushSnapshot ( $fname=__METHOD__)
	Commit any transaction but error out if writes or callbacks are pending.

	getDomainID ()

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

	getInfinity ()
	Find out when 'infinity' is.

	getLag ()
	Get replica DB lag.

	getLBInfo ( $name=null)
	Get properties passed down from the server info array of the load balancer.

	getMasterPos ()
	Get the position of this master.

	getProperty ( $name)

	getReplicaPos ()
	Get the replication position of this replica DB.

	getScopedLockAndFlush ( $lockKey, $fname, $timeout)
	Acquire a named lock, flush any transaction, and return an RAII style unlocker object.

	getServerInfo ()
	A string describing the current software version, and possibly other details in a user-friendly way.

	getServerUptime ()
	Determines how long the server has been up.

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

	getWikiID ()
	Alias for getDomainID()

	ignoreIndexClause ( $index)
	IGNORE INDEX clause.

	indexExists ( $table, $index, $fname=__METHOD__)
	Determines whether an index exists Usually throws a DBQueryError on failure If errors are explicitly ignored, returns NULL on failure.

	indexUnique ( $table, $index)
	Determines if a given index is unique.

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

	isOpen ()
	Is a connection to the database open?

	isQuotedIdentifier ( $name)
	Returns if the given identifier looks quoted or not according to the database convention for quoting identifiers .

	isReadOnly ()

	lastDoneWrites ()
	Returns the last time the connection may have been used for write queries.

	lastQuery ()
	Return the last query that went through IDatabase::query()

	listViews ( $prefix=null, $fname=__METHOD__)
	Lists all the VIEWs in the database.

	lockTables (array $read, array $write, $method)
	Lock specific tables.

	makeList ( $a, $mode=self::LIST_COMMA)
	Makes an encoded list of strings from an array.

	makeWhereFrom2d ( $data, $baseKey, $subKey)
	Build a partial where clause from a 2-d array such as used for LinkBatch.

	masterPosWait (DBMasterPos $pos, $timeout)
	Wait for the replica DB to catch up to a given master position.

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

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

	onTransactionIdle (callable $callback, $fname=__METHOD__)
	Run a callback as soon as there is no transaction pending.

	onTransactionPreCommitOrIdle (callable $callback, $fname=__METHOD__)
	Run a callback before the current transaction commits or now if there is none.

	onTransactionResolution (callable $callback, $fname=__METHOD__)
	Run a callback as soon as the current transaction commits or rolls back.

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

	pendingWriteQueryDuration ( $type=self::ESTIMATE_TOTAL)
	Get the time spend running write queries for this transaction.

	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.

	query ( $sql, $fname=__METHOD__, $tempIgnore=false)
	Run an SQL query and return the result.

	replace ( $table, $uniqueIndexes, $rows, $fname=__METHOD__)
	REPLACE query wrapper.

	reportConnectionError ( $error='Unknown error')

	restoreFlags ( $state=self::RESTORE_PRIOR)
	Restore the flags to their prior state before the last setFlag/clearFlag call.

	rollback ( $fname=__METHOD__, $flush='')
	Rollback a transaction previously started using begin().

	runOnTransactionIdleCallbacks ( $trigger)
	Actually run and consume any "on transaction idle/resolution" callbacks.

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

	runTransactionListenerCallbacks ( $trigger)
	Actually run any "transaction listener" callbacks.

	select ( $table, $vars, $conds='', $fname=__METHOD__, $options=[], $join_conds=[])
	Execute a SELECT query constructed using the various parameters provided.

	selectField ( $table, $var, $cond='', $fname=__METHOD__, $options=[], $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=[])
	Single row SELECT wrapper.

	selectRowCount ( $tables, $vars=' *', $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.

	setFlag ( $flag, $remember=self::REMEMBER_NOTHING)
	Set a flag for this connection.

	setLazyMasterHandle (IDatabase $conn)
	Set a lazy-connecting DB handle to the master DB (for replication status purposes)

	setLBInfo ( $name, $value=null)
	Set the LB info array, or a member of it.

	setLogger (LoggerInterface $logger)
	Set the PSR-3 logger interface to use for query logging.

	setSchemaVars ( $vars)
	Set variables to be used in sourceFile/sourceStream, in preference to the ones in $GLOBALS.

	setSessionOptions (array $options)
	Override database's default behavior.

	setTableAliases (array $aliases)
	Make certain table names use their own database, schema, and table prefix when passed into SQL queries pre-escaped and without a qualified database name.

	setTransactionListener ( $name, callable $callback=null)
	Run a callback each time any transaction commits or rolls back.

	setTrxEndCallbackSuppression ( $suppress)
	Whether to disable running of post-COMMIT/ROLLBACK callbacks.

	sourceFile ( $filename, callable $lineCallback=null, callable $resultCallback=null, $fname=false, callable $inputCallback=null)
	Read and execute SQL commands from a file.

	sourceStream ( $fp, callable $lineCallback=null, callable $resultCallback=null, $fname=__METHOD__, callable $inputCallback=null)
	Read and execute commands from an open file handle.

	startAtomic ( $fname=__METHOD__)
	Begin an atomic section of statements.

	strreplace ( $orig, $old, $new)
	Returns a command for str_replace function in SQL query.

	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 ()
	Fetch a number of table names into an array This is handy when you need to construct SQL for joins.

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

	tablePrefix ( $prefix=null)
	Get/set the table prefix.

	timestampOrNull ( $ts=null)
	Convert a timestamp in one of the formats accepted by wfTimestamp() to the format used for inserting into timestamp fields in this DBMS.

	trxLevel ()
	Gets the current transaction level.

	trxTimestamp ()
	Get the UNIX timestamp of the time that the transaction was established.

	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.

	unionSupportsOrderAndLimit ()
	Returns true if current database backend supports ORDER BY or LIMIT for separate subqueries within the UNION construct.

	unlockTables ( $method)
	Unlock all tables locked via lockTables()

	update ( $table, $values, $conds, $fname=__METHOD__, $options=[])
	UPDATE wrapper.

	upsert ( $table, array $rows, array $uniqueIndexes, array $set, $fname=__METHOD__)
	INSERT ON DUPLICATE KEY UPDATE wrapper, upserts an array into a table.

	useIndexClause ( $index)
	USE INDEX clause.

	wasConnectionError ( $errno)
	Do not use this method outside of Database/DBError classes.

	wasErrorReissuable ()
	Determines if the last query error was due to a dropped connection and should be dealt with by pinging the connection and reissuing the query.

	wasLockTimeout ()
	Determines if the last failure was due to a lock timeout.

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

	writesOrCallbacksPending ()
	Returns true if there is a transaction open with possible write queries or transaction pre-commit/idle callbacks waiting on it to finish.

	writesPending ()

Protected Member Functions
	closeConnection ()
	Closes underlying database connection.

	dumpError ()

	replaceVars ( $ins)
	Postgres specific version of replaceVars.

Protected Member Functions inherited from Wikimedia\Rdbms\Database
	assertOpen ()
	Make sure isOpen() returns true as a sanity check.

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

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

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

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

	escapeLikeInternal ( $s, $escapeChar='`')

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

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

	getApproximateLagStatus ()
	Get a replica DB lag estimate for this server.

	getBindingHandle ()
	Get the underlying binding handle, mConn.

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

	getLastPHPError ()

	getLazyMasterHandle ()

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

	getQueryVerb ( $sql)

	getReadOnlyReason ()

	getSchemaVars ()
	Get schema variables.

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

	ignoreErrors ( $ignoreErrors=null)
	Turns on (false) or off (true) the automatic generation and sending of a "we're sorry, but there has been a database error" page on database errors.

	indexName ( $index)
	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.

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

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

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

	makeInsertOptions ( $options)
	Helper for Database::insert().

	makeOrderBy ( $options)
	Returns an optional ORDER BY.

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

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

	nativeReplace ( $table, $rows, $fname)
	REPLACE query wrapper for MySQL and SQLite, which have a native REPLACE statement.

	pendingWriteAndCallbackCallers ()
	Get the list of method names that have pending write queries or callbacks for this transaction.

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

	reconnect ()
	Close existing database connection and open a new connection.

	registerTempTableOperation ( $sql)

	requiresDatabaseUser ()

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

	resultObject ( $result)
	Take the result from a query, and wrap it in a ResultWrapper if necessary.

	tableNamesWithAlias ( $tables)
	Gets an array of aliased table names.

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

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

Protected Attributes
int	$mAffectedRows = null
	The number of rows affected as an integer.

resource	$mLastResult = null

int bool	$port

Protected Attributes inherited from Wikimedia\Rdbms\Database
string	$agent
	Agent name for query profiling.

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

LoggerInterface	$connLogger

DatabaseDomain	$currentDomain

string	$delimiter = ';'

callback	$errorLogger
	Error logging callback.

string bool null	$htmlErrors
	Stashed value of html_errors INI setting.

float	$lastPing = 0.0
	UNIX timestamp.

resource null	$mConn = null
	Database connection.

string	$mDBname

bool null	$mDefaultBigSelects = null

int	$mFlags

string	$mLastQuery = ''
	SQL query.

float bool	$mLastWriteTime = false
	UNIX timestamp of last write query.

array	$mLBInfo = []

bool	$mOpened = false

string	$mPassword

string bool	$mPHPError = false

string	$mSchema = ''

array bool	$mSchemaVars = false

string	$mServer

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

array	$mSessionVars = []

string	$mTablePrefix = ''

array[]	$mTrxEndCallbacks = []
	List of (callable, method name)

bool	$mTrxEndCallbacksSuppressed = false
	Whether to suppress triggering of transaction end callbacks.

array[]	$mTrxIdleCallbacks = []
	List of (callable, method name)

int	$mTrxLevel = 0
	Either 1 if a transaction is active or 0 otherwise.

array[]	$mTrxPreCommitCallbacks = []
	List of (callable, method name)

callable[]	$mTrxRecurringCallbacks = []
	Map of (name => callable)

string	$mTrxShortId = ''
	Either a short hexidecimal string if a transaction is active or "".

string	$mUser

array null	$preparedArgs

object string	$profiler
	Class name or object With profileIn/profileOut methods.

LoggerInterface	$queryLogger

BagOStuff	$srvCache
	APC cache.

	$tableAliases = []

TransactionProfiler	$trxProfiler

Private Member Functions
	bigintFromLockName ( $lockName)

	makeConnectionString ( $vars)

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

	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	$connectString
	Connect string to open a PostgreSQL connection.

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

string	$mCoreSchema

float string	$numericVersion = null

Additional Inherited Members
Static Public Member Functions inherited from Wikimedia\Rdbms\Database
static	factory ( $dbType, $p=[])
	Construct a Database subclass instance given a database type and parameters.

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

Public Attributes inherited from Wikimedia\Rdbms\Database
const	DEADLOCK_DELAY_MAX = 1500000
	Maximum time to wait before retry.

const	DEADLOCK_DELAY_MIN = 500000
	Minimum time to wait before retry, in microseconds.

const	DEADLOCK_TRIES = 4
	Number of times to re-try an operation in case of deadlock.

const	PING_QUERY = 'SELECT 1 AS ping'

const	PING_TTL = 1.0
	How long before it is worth doing a dummy query to test the connection.

const	SLOW_WRITE_SEC = 0.500

const	SMALL_WRITE_ROWS = 100

const	TINY_WRITE_SEC = 0.010

Static Protected Member Functions inherited from Wikimedia\Rdbms\Database
static	generalizeSQL ( $sql)
	Removes most variables from an SQL query and replaces them with X or N for numbers.

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

References $params.

Member Function Documentation

◆ addQuotes()

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

Adds quotes and backslashes.

Parameters

string | int | null | bool | Blob $s

Returns: string|int

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 1202 of file DatabasePostgres.php.

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

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

◆ affectedRows()

Wikimedia\Rdbms\DatabasePostgres::affectedRows ( )

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

See also: https://secure.php.net/mysql_affected_rows

Returns: int

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 387 of file DatabasePostgres.php.

References Wikimedia\Rdbms\DatabasePostgres\$mAffectedRows.

◆ aggregateValue()

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

Return aggregated value alias.

Parameters

array	$valuedata
string	$valuename

Returns: string

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 894 of file DatabasePostgres.php.

◆ bigintFromLockName()

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

private

Parameters

string $lockName

Returns: string Integer

Definition at line 1395 of file DatabasePostgres.php.

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

◆ buildConcat()

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

Build a concatenation list to feed into a SQL query.

Parameters

array $stringList List of raw SQL expressions; caller is responsible for any quoting

Returns: string

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 1282 of file DatabasePostgres.php.

◆ buildGroupConcatField()

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

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

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 1294 of file DatabasePostgres.php.

◆ closeConnection()

Wikimedia\Rdbms\DatabasePostgres::closeConnection ( )

protected

Closes underlying database connection.

Since: 1.20

Returns: bool Whether connection was closed successfully

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 201 of file DatabasePostgres.php.

◆ constraintExists()

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

Definition at line 1116 of file DatabasePostgres.php.

References $res, $rows, Wikimedia\Rdbms\DatabasePostgres\addQuotes(), Wikimedia\Rdbms\DatabasePostgres\getCoreSchema(), and 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 782 of file DatabasePostgres.php.

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

◆ databasesAreIndependent()

Wikimedia\Rdbms\DatabasePostgres::databasesAreIndependent ( )

Returns true if DBs are assumed to be on potentially different servers.

In systems like mysql/mariadb, different databases can easily be referenced on a single connection merely by name, even in a single query via JOIN. On the other hand, Postgres treats databases as fully separate, only allowing mechanisms like postgres_fdw to effectively "mount" foreign DBs. This is true even among DBs on the same server.

Returns: bool

Since: 1.29

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 169 of file DatabasePostgres.php.

◆ dataSeek()

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

Change the position of the cursor in a result object.

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

Parameters

mixed	$res	A SQL result
int	$row

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 359 of file DatabasePostgres.php.

References $res.

◆ decodeBlob()

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

Some DBMSs return a special placeholder object representing blob fields in result objects.

Pass the object through this function to return the original string.

Parameters

string | Blob $b

Returns: string

Reimplemented from Wikimedia\Rdbms\Database.

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

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

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

◆ doLockTables()

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

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

Parameters

array	$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 1311 of file DatabasePostgres.php.

References query, and tableName().

◆ doQuery()

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

The DBMS-dependent part of query()

Parameters

string $sql SQL query.

Returns: ResultWrapper|bool Result object to feed to fetchObject, fetchRow, ...; or false on failure

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 205 of file DatabasePostgres.php.

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

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

◆ dumpError()

Wikimedia\Rdbms\DatabasePostgres::dumpError ( )

protected

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

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 816 of file DatabasePostgres.php.

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

◆ encodeBlob()

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

Some DBMSs have a special format for inserting into blob fields, they don't allow simple quoted strings to be inserted.

To insert into such a field, pass the data through this function before passing it to IDatabase::insert().

Parameters

string $b

Returns: string|Blob

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 1183 of file DatabasePostgres.php.

◆ estimateRowCount()

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

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

Parameters

string	$table
string	$vars
string	$conds
string	$fname
array	$options

Returns: int

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 413 of file DatabasePostgres.php.

References $fname, $options, $res, $rows, $vars, Wikimedia\Rdbms\DatabasePostgres\fetchRow(), and select().

◆ 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

Exceptions

DBUnexpectedError Thrown if the database returns an error

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 277 of file DatabasePostgres.php.

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

Referenced by Wikimedia\Rdbms\PostgresField\fromText(), 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

Exceptions

DBUnexpectedError Thrown if the database returns an error

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 299 of file DatabasePostgres.php.

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

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

◆ fieldInfo()

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

Parameters

string	$table
string	$field

Returns: PostgresField|null

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 1165 of file DatabasePostgres.php.

References Wikimedia\Rdbms\PostgresField\fromText().

◆ fieldName()

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

Get a field name in a result object.

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

Parameters

mixed	$res	A SQL result
int	$n

Returns: string

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 345 of file DatabasePostgres.php.

References $res.

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

References $res.

◆ freeResult()

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

Free a result object returned by query() or select().

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

Parameters

mixed $res A SQL result

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 265 of file DatabasePostgres.php.

References $res.

◆ getCoreSchema()

Wikimedia\Rdbms\DatabasePostgres::getCoreSchema ( )

Return schema name for core application tables.

Since: 1.19

Returns: string Core schema name

Definition at line 1016 of file DatabasePostgres.php.

References Wikimedia\Rdbms\DatabasePostgres\$mCoreSchema.

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

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

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

◆ getDBname()

Wikimedia\Rdbms\DatabasePostgres::getDBname ( )

Get the current DB name.

Returns: string

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 1274 of file DatabasePostgres.php.

References Wikimedia\Rdbms\Database\$mDBname.

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

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

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

◆ getServer()

Wikimedia\Rdbms\DatabasePostgres::getServer ( )

Get the server hostname or IP address.

Returns: string

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 1278 of file DatabasePostgres.php.

References Wikimedia\Rdbms\Database\$mServer.

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

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

Referenced by Wikimedia\Rdbms\DatabasePostgres\insert(), and Wikimedia\Rdbms\DatabasePostgres\open().

◆ getSoftwareLink()

Wikimedia\Rdbms\DatabasePostgres::getSoftwareLink ( )

Returns a wikitext link to the DB's website, e.g., return "[https://www.mysql.com/ MySQL]"; Should at least contain plain text, if for some reason your database has no website.

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

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 898 of file DatabasePostgres.php.

◆ getType()

Wikimedia\Rdbms\DatabasePostgres::getType ( )

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

Returns: string

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 65 of file DatabasePostgres.php.

◆ hasConstraint()

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

Definition at line 77 of file DatabasePostgres.php.

References $res, Wikimedia\Rdbms\DatabasePostgres\doQuery(), Wikimedia\Rdbms\Database\getBindingHandle(), Wikimedia\Rdbms\DatabasePostgres\getCoreSchema(), and Wikimedia\Rdbms\DatabasePostgres\numRows().

◆ implicitGroupby()

Wikimedia\Rdbms\DatabasePostgres::implicitGroupby ( )

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

Returns: bool

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

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 69 of file DatabasePostgres.php.

◆ implicitOrderby()

Wikimedia\Rdbms\DatabasePostgres::implicitOrderby ( )

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

Returns: bool

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 73 of file DatabasePostgres.php.

◆ indexAttributes()

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

Definition at line 445 of file DatabasePostgres.php.

References $res, FROM, Wikimedia\Rdbms\DatabasePostgres\getCoreSchema(), and query.

◆ indexInfo()

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

Get information about an index into an object.

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

References $fname, $res, and query.

◆ indexUnique()

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

Definition at line 502 of file DatabasePostgres.php.

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

◆ insert()

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

INSERT wrapper, inserts an array into a table.

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

Parameters

string	$table	Name of the table to insert to.
array	$args	Items to insert into the table.
string	$fname	Name of the function, for profiling
array \| string	$options	String or array. Valid options: IGNORE

Returns: bool Success of insert operation. IGNORE always returns true.

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 577 of file DatabasePostgres.php.

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

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

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

◆ lastErrno()

Wikimedia\Rdbms\DatabasePostgres::lastErrno ( )

Get the last error number.

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

Returns: int

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 379 of file DatabasePostgres.php.

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

◆ lastError()

Wikimedia\Rdbms\DatabasePostgres::lastError ( )

Get a description of the last error.

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

Returns: string

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 367 of file DatabasePostgres.php.

References Wikimedia\Rdbms\Database\getLastPHPError().

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

◆ limitResult()

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

Construct a LIMIT query with optional offset.

This is used for query pages. The SQL should be adjusted so that only the first $limit rows are returned. If $offset is provided as well, then the first $offset rows should be discarded, and the next $limit rows should be returned. If the result of the query is not ordered, then the rows to be returned are theoretically arbitrary.

$sql is expected to be a SELECT, if that makes a difference.

The version provided by default works in MySQL and SQLite. It will very likely need to be overridden for most other DBMSes.

Parameters

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

Exceptions

DBUnexpectedError

Returns: string

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 808 of file DatabasePostgres.php.

◆ listTables()

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

List all tables on the database.

Parameters

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

Exceptions

DBError

Returns: array

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 826 of file DatabasePostgres.php.

References $fname, $vars, Wikimedia\Rdbms\DatabasePostgres\addQuotes(), Wikimedia\Rdbms\DatabasePostgres\getCoreSchema(), and 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

Returns: bool

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 1348 of file DatabasePostgres.php.

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

◆ lockIsFree()

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

Check to see if a named lock is available (non-blocking)

Parameters

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

Returns: bool

Since: 1.20

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 1338 of file DatabasePostgres.php.

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

◆ makeConnectionString()

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

private

Parameters

string[] $vars

Returns: string

Definition at line 192 of file DatabasePostgres.php.

References $s, $value, and $vars.

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

◆ makeSelectOptions()

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

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

Parameters

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

Returns: array

See also: Database::select()

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 1245 of file DatabasePostgres.php.

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

◆ nativeInsertSelect()

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

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

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

Parameters

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

Returns: bool

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 704 of file DatabasePostgres.php.

References $fname, and $res.

◆ nextSequenceValue()

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

Deprecated method, calls should be removed.

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

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

Deprecated: since 1.30, no longer needed

Parameters

string $seqName

Returns: null|NextSequenceValue

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 772 of file DatabasePostgres.php.

◆ numFields()

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

Get the number of fields in a result object.

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

Parameters

mixed $res A SQL result

Returns: int

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 337 of file DatabasePostgres.php.

References $res.

◆ numRows()

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

Get the number of rows in a result object.

Parameters

mixed $res A SQL result

Returns: int

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 318 of file DatabasePostgres.php.

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

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

◆ open()

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

Open a connection to the database.

Usually aborts on failure

Parameters

string	$server	Database server host
string	$user	Database user name
string	$password	Database user password
string	$dbName	Database name

Returns: bool

Exceptions

DBConnectionError

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 89 of file DatabasePostgres.php.

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

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

◆ pg_array_parse()

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

private

Posted by cc[plus]php[at]c2se[dot]com on 25-Mar-2009 09:12 to https://secure.php.net/manual/en/ref.pgsql.php.

Parsing a postgres array can be a tricky problem, he's my take on this, it handles multi-dimensional arrays plus escaping using a nasty regexp to determine the limits of each data-item.

This should really be handled by PHP PostgreSQL module

Since: 1.19

Parameters

string	$text	Postgreql array returned in a text form like {a,b}
string[]	$output
int \| bool	$limit
int	$offset

Returns: string[]

Definition at line 867 of file DatabasePostgres.php.

References $output, and 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 768 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 1047 of file DatabasePostgres.php.

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

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

◆ remappedTableName()

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

Parameters

string $name

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

Definition at line 759 of file DatabasePostgres.php.

References $name.

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

◆ replaceVars()

Wikimedia\Rdbms\DatabasePostgres::replaceVars ( $ins )

protected

Postgres specific version of replaceVars.

Calls the parent version in Database.php

Parameters

string $ins SQL string, read from a stream (usually tables.sql)

Returns: string SQL string

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 1230 of file DatabasePostgres.php.

◆ reportQueryError()

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

Report a query error.

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

Parameters

string	$error
int	$errno
string	$sql
string	$fname
bool	$tempIgnore

Exceptions

DBQueryError

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 246 of file DatabasePostgres.php.

References $fname, and rollback.

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

References Wikimedia\Rdbms\Database\selectField().

◆ ruleExists()

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

Definition at line 1104 of file DatabasePostgres.php.

References Wikimedia\Rdbms\DatabasePostgres\getCoreSchema(), 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 1137 of file DatabasePostgres.php.

References Wikimedia\Rdbms\Database\selectField().

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

◆ selectDB()

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

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

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

Parameters

string $db

Returns: bool

Exceptions

DBUnexpectedError

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 180 of file DatabasePostgres.php.

References Wikimedia\Rdbms\DatabasePostgres\open().

◆ selectSQLText()

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

The equivalent of IDatabase::select() except that the constructed SQL is returned, instead of being immediately executed.

This can be useful for doing UNION queries, where the SQL text of each query is needed. In general, however, callers outside of Database classes should just use select().

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.

See also: IDatabase::select()

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 515 of file DatabasePostgres.php.

References $fname, $name, $options, $vars, and Wikimedia\Rdbms\Database\addIdentifierQuotes().

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

◆ sequenceExists()

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

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

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 1384 of file DatabasePostgres.php.

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

◆ setSearchPath()

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

private

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

Since: 1.19

Parameters

array $search_path List of schemas to be searched by default

Definition at line 961 of file DatabasePostgres.php.

References query.

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

◆ streamStatementEnd()

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

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

Parameters

string	&$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 1298 of file DatabasePostgres.php.

◆ strencode()

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

Wrapper for addslashes()

Parameters

string $s String to be slashed.

Returns: string Slashed string.

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 1197 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 1073 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

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 748 of file DatabasePostgres.php.

References Wikimedia\Rdbms\DatabasePostgres\remappedTableName().

◆ textFieldSize()

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

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

Parameters

string	$table
string	$field

Returns: int

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 791 of file DatabasePostgres.php.

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

◆ timestamp()

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

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

The result is unquoted, and needs to be passed through addQuotes() before it can be included in raw SQL.

Parameters

string | int $ts

Returns: string

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 843 of file DatabasePostgres.php.

◆ triggerExists()

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

Definition at line 1081 of file DatabasePostgres.php.

References $res, $rows, Wikimedia\Rdbms\DatabasePostgres\addQuotes(), FROM, Wikimedia\Rdbms\DatabasePostgres\getCoreSchema(), and 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: int Returns 1 if the lock was released, 0 if the lock was not established by this thread (in which case the lock is not released), and NULL if the named lock did not exist

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 1368 of file DatabasePostgres.php.

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

◆ wasDeadlock()

Wikimedia\Rdbms\DatabasePostgres::wasDeadlock ( )

Determines if the last failure was due to a deadlock.

Returns: bool

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 812 of file DatabasePostgres.php.

References Wikimedia\Rdbms\DatabasePostgres\lastErrno().

Member Data Documentation

◆ $connectString

string Wikimedia\Rdbms\DatabasePostgres::$connectString

private

Connect string to open a PostgreSQL connection.

Definition at line 45 of file DatabasePostgres.php.

◆ $keywordTableMap

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

private

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

Definition at line 49 of file DatabasePostgres.php.

◆ $mAffectedRows

int Wikimedia\Rdbms\DatabasePostgres::$mAffectedRows = null

protected

The number of rows affected as an integer.

Definition at line 40 of file DatabasePostgres.php.

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

◆ $mCoreSchema

string Wikimedia\Rdbms\DatabasePostgres::$mCoreSchema

private

Definition at line 47 of file DatabasePostgres.php.

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

◆ $mLastResult

resource Wikimedia\Rdbms\DatabasePostgres::$mLastResult = null

protected

Definition at line 38 of file DatabasePostgres.php.

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

◆ $numericVersion

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

private

Definition at line 43 of file DatabasePostgres.php.

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

◆ $port

int bool Wikimedia\Rdbms\DatabasePostgres::$port

protected

Definition at line 35 of file DatabasePostgres.php.

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

includes/libs/rdbms/database/DatabasePostgres.php

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addQuotes()

◆ affectedRows()

◆ aggregateValue()

◆ bigintFromLockName()

◆ buildConcat()

◆ buildGroupConcatField()

◆ buildStringCast()

◆ closeConnection()

◆ constraintExists()

◆ currentSequenceValue()

◆ databasesAreIndependent()

◆ dataSeek()

◆ decodeBlob()

◆ determineCoreSchema()

◆ doLockTables()

◆ doQuery()

◆ dumpError()

◆ duplicateTableStructure()

◆ encodeBlob()

◆ estimateRowCount()

◆ fetchObject()

◆ fetchRow()

◆ fieldInfo()

◆ fieldName()

◆ fieldType()

◆ freeResult()

◆ getCoreSchema()

◆ getCurrentSchema()

◆ getDBname()

◆ getSchemas()

◆ getSearchPath()

◆ getServer()

◆ getServerVersion()

◆ getSoftwareLink()

◆ getType()

◆ hasConstraint()

◆ implicitGroupby()

◆ implicitOrderby()

◆ indexAttributes()

◆ indexInfo()

◆ indexUnique()

◆ insert()

◆ insertId()

◆ lastErrno()

◆ lastError()

◆ limitResult()

◆ listTables()

◆ lock()

◆ lockIsFree()

◆ makeConnectionString()

◆ makeSelectOptions()

◆ nativeInsertSelect()

◆ nextSequenceValue()

◆ numFields()

◆ numRows()

◆ open()

◆ pg_array_parse()

◆ realTableName()

◆ relationExists()

◆ remappedTableName()

◆ replaceVars()

◆ reportQueryError()

◆ roleExists()

◆ ruleExists()

◆ schemaExists()

◆ selectDB()

◆ selectSQLText()

◆ sequenceExists()

◆ serverIsReadOnly()

◆ setSearchPath()