3 * This is the Postgres database abstraction layer.
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 * http://www.gnu.org/copyleft/gpl.html
23 use Wikimedia\Timestamp\ConvertibleTimestamp
;
24 use Wikimedia\WaitConditionLoop
;
25 use Wikimedia\Rdbms\Blob
;
26 use Wikimedia\Rdbms\PostgresBlob
;
27 use Wikimedia\Rdbms\PostgresField
;
28 use Wikimedia\Rdbms\ResultWrapper
;
33 class DatabasePostgres
extends Database
{
38 protected $mLastResult = null;
39 /** @var int The number of rows affected as an integer */
40 protected $mAffectedRows = null;
43 private $mInsertId = null;
44 /** @var float|string */
45 private $numericVersion = null;
46 /** @var string Connect string to open a PostgreSQL connection */
47 private $connectString;
50 /** @var string[] Map of (reserved table name => alternate table name) */
51 private $keywordTableMap = [];
54 * @see Database::__construct()
55 * @param array $params Additional parameters include:
56 * - keywordTableMap : Map of reserved table names to alternative table names to use
58 public function __construct( array $params ) {
59 $this->port
= isset( $params['port'] ) ?
$params['port'] : false;
60 $this->keywordTableMap
= isset( $params['keywordTableMap'] )
61 ?
$params['keywordTableMap']
64 parent
::__construct( $params );
67 public function getType() {
71 public function implicitGroupby() {
75 public function implicitOrderby() {
79 public function hasConstraint( $name ) {
80 $conn = $this->getBindingHandle();
82 $sql = "SELECT 1 FROM pg_catalog.pg_constraint c, pg_catalog.pg_namespace n " .
83 "WHERE c.connamespace = n.oid AND conname = '" .
84 pg_escape_string( $conn, $name ) . "' AND n.nspname = '" .
85 pg_escape_string( $conn, $this->getCoreSchema() ) . "'";
86 $res = $this->doQuery( $sql );
88 return $this->numRows( $res );
91 public function open( $server, $user, $password, $dbName ) {
92 # Test for Postgres support, to avoid suppressed fatal error
93 if ( !function_exists( 'pg_connect' ) ) {
94 throw new DBConnectionError(
96 "Postgres functions missing, have you compiled PHP with the --with-pgsql\n" .
97 "option? (Note: if you recently installed PHP, you may need to restart your\n" .
98 "webserver and database)\n"
102 $this->mServer
= $server;
103 $this->mUser
= $user;
104 $this->mPassword
= $password;
105 $this->mDBname
= $dbName;
110 'password' => $password
112 if ( $server != false && $server != '' ) {
113 $connectVars['host'] = $server;
115 if ( (int)$this->port
> 0 ) {
116 $connectVars['port'] = (int)$this->port
;
118 if ( $this->mFlags
& self
::DBO_SSL
) {
119 $connectVars['sslmode'] = 1;
122 $this->connectString
= $this->makeConnectionString( $connectVars );
124 $this->installErrorHandler();
127 // Use new connections to let LoadBalancer/LBFactory handle reuse
128 $this->mConn
= pg_connect( $this->connectString
, PGSQL_CONNECT_FORCE_NEW
);
129 } catch ( Exception
$ex ) {
130 $this->restoreErrorHandler();
134 $phpError = $this->restoreErrorHandler();
136 if ( !$this->mConn
) {
137 $this->queryLogger
->debug(
138 "DB connection error\n" .
139 "Server: $server, Database: $dbName, User: $user, Password: " .
140 substr( $password, 0, 3 ) . "...\n"
142 $this->queryLogger
->debug( $this->lastError() . "\n" );
143 throw new DBConnectionError( $this, str_replace( "\n", ' ', $phpError ) );
146 $this->mOpened
= true;
148 # If called from the command-line (e.g. importDump), only show errors
149 if ( $this->cliMode
) {
150 $this->doQuery( "SET client_min_messages = 'ERROR'" );
153 $this->query( "SET client_encoding='UTF8'", __METHOD__
);
154 $this->query( "SET datestyle = 'ISO, YMD'", __METHOD__
);
155 $this->query( "SET timezone = 'GMT'", __METHOD__
);
156 $this->query( "SET standard_conforming_strings = on", __METHOD__
);
157 if ( $this->getServerVersion() >= 9.0 ) {
158 $this->query( "SET bytea_output = 'escape'", __METHOD__
); // PHP bug 53127
161 $this->determineCoreSchema( $this->mSchema
);
162 // The schema to be used is now in the search path; no need for explicit qualification
169 * Postgres doesn't support selectDB in the same way MySQL does. So if the
170 * DB name doesn't match the open connection, open a new one
174 public function selectDB( $db ) {
175 if ( $this->mDBname
!== $db ) {
176 return (bool)$this->open( $this->mServer
, $this->mUser
, $this->mPassword
, $db );
183 * @param string[] $vars
186 private function makeConnectionString( $vars ) {
188 foreach ( $vars as $name => $value ) {
189 $s .= "$name='" . str_replace( "'", "\\'", $value ) . "' ";
195 protected function closeConnection() {
196 return $this->mConn ?
pg_close( $this->mConn
) : true;
199 public function doQuery( $sql ) {
200 $conn = $this->getBindingHandle();
202 $sql = mb_convert_encoding( $sql, 'UTF-8' );
203 // Clear previously left over PQresult
204 while ( $res = pg_get_result( $conn ) ) {
205 pg_free_result( $res );
207 if ( pg_send_query( $conn, $sql ) === false ) {
208 throw new DBUnexpectedError( $this, "Unable to post new query to PostgreSQL\n" );
210 $this->mLastResult
= pg_get_result( $conn );
211 $this->mAffectedRows
= null;
212 if ( pg_result_error( $this->mLastResult
) ) {
216 return $this->mLastResult
;
219 protected function dumpError() {
223 PGSQL_DIAG_MESSAGE_PRIMARY
,
224 PGSQL_DIAG_MESSAGE_DETAIL
,
225 PGSQL_DIAG_MESSAGE_HINT
,
226 PGSQL_DIAG_STATEMENT_POSITION
,
227 PGSQL_DIAG_INTERNAL_POSITION
,
228 PGSQL_DIAG_INTERNAL_QUERY
,
230 PGSQL_DIAG_SOURCE_FILE
,
231 PGSQL_DIAG_SOURCE_LINE
,
232 PGSQL_DIAG_SOURCE_FUNCTION
234 foreach ( $diags as $d ) {
235 $this->queryLogger
->debug( sprintf( "PgSQL ERROR(%d): %s\n",
236 $d, pg_result_error_field( $this->mLastResult
, $d ) ) );
240 public function reportQueryError( $error, $errno, $sql, $fname, $tempIgnore = false ) {
242 /* Check for constraint violation */
243 if ( $errno === '23505' ) {
244 parent
::reportQueryError( $error, $errno, $sql, $fname, $tempIgnore );
249 /* Transaction stays in the ERROR state until rolled back */
250 if ( $this->mTrxLevel
) {
251 $this->rollback( __METHOD__
);
253 parent
::reportQueryError( $error, $errno, $sql, $fname, false );
256 public function freeResult( $res ) {
257 if ( $res instanceof ResultWrapper
) {
260 MediaWiki\
suppressWarnings();
261 $ok = pg_free_result( $res );
262 MediaWiki\restoreWarnings
();
264 throw new DBUnexpectedError( $this, "Unable to free Postgres result\n" );
268 public function fetchObject( $res ) {
269 if ( $res instanceof ResultWrapper
) {
272 MediaWiki\
suppressWarnings();
273 $row = pg_fetch_object( $res );
274 MediaWiki\restoreWarnings
();
275 # @todo FIXME: HACK HACK HACK HACK debug
277 # @todo hashar: not sure if the following test really trigger if the object
279 $conn = $this->getBindingHandle();
280 if ( pg_last_error( $conn ) ) {
281 throw new DBUnexpectedError(
283 'SQL error: ' . htmlspecialchars( pg_last_error( $conn ) )
290 public function fetchRow( $res ) {
291 if ( $res instanceof ResultWrapper
) {
294 MediaWiki\
suppressWarnings();
295 $row = pg_fetch_array( $res );
296 MediaWiki\restoreWarnings
();
298 $conn = $this->getBindingHandle();
299 if ( pg_last_error( $conn ) ) {
300 throw new DBUnexpectedError(
302 'SQL error: ' . htmlspecialchars( pg_last_error( $conn ) )
309 public function numRows( $res ) {
310 if ( $res instanceof ResultWrapper
) {
313 MediaWiki\
suppressWarnings();
314 $n = pg_num_rows( $res );
315 MediaWiki\restoreWarnings
();
317 $conn = $this->getBindingHandle();
318 if ( pg_last_error( $conn ) ) {
319 throw new DBUnexpectedError(
321 'SQL error: ' . htmlspecialchars( pg_last_error( $conn ) )
328 public function numFields( $res ) {
329 if ( $res instanceof ResultWrapper
) {
333 return pg_num_fields( $res );
336 public function fieldName( $res, $n ) {
337 if ( $res instanceof ResultWrapper
) {
341 return pg_field_name( $res, $n );
345 * Return the result of the last call to nextSequenceValue();
346 * This must be called after nextSequenceValue().
350 public function insertId() {
351 return $this->mInsertId
;
354 public function dataSeek( $res, $row ) {
355 if ( $res instanceof ResultWrapper
) {
359 return pg_result_seek( $res, $row );
362 public function lastError() {
363 if ( $this->mConn
) {
364 if ( $this->mLastResult
) {
365 return pg_result_error( $this->mLastResult
);
367 return pg_last_error();
371 return $this->getLastPHPError() ?
: 'No database connection';
374 public function lastErrno() {
375 if ( $this->mLastResult
) {
376 return pg_result_error_field( $this->mLastResult
, PGSQL_DIAG_SQLSTATE
);
382 public function affectedRows() {
383 if ( !is_null( $this->mAffectedRows
) ) {
384 // Forced result for simulated queries
385 return $this->mAffectedRows
;
387 if ( empty( $this->mLastResult
) ) {
391 return pg_affected_rows( $this->mLastResult
);
395 * Estimate rows in dataset
396 * Returns estimated count, based on EXPLAIN output
397 * This is not necessarily an accurate estimate, so use sparingly
398 * Returns -1 if count cannot be found
399 * Takes same arguments as Database::select()
401 * @param string $table
402 * @param string $vars
403 * @param string $conds
404 * @param string $fname
405 * @param array $options
408 public function estimateRowCount( $table, $vars = '*', $conds = '',
409 $fname = __METHOD__
, $options = []
411 $options['EXPLAIN'] = true;
412 $res = $this->select( $table, $vars, $conds, $fname, $options );
415 $row = $this->fetchRow( $res );
417 if ( preg_match( '/rows=(\d+)/', $row[0], $count ) ) {
418 $rows = (int)$count[1];
425 public function indexInfo( $table, $index, $fname = __METHOD__
) {
426 $sql = "SELECT indexname FROM pg_indexes WHERE tablename='$table'";
427 $res = $this->query( $sql, $fname );
431 foreach ( $res as $row ) {
432 if ( $row->indexname
== $this->indexName( $index ) ) {
440 public function indexAttributes( $index, $schema = false ) {
441 if ( $schema === false ) {
442 $schema = $this->getCoreSchema();
445 * A subquery would be not needed if we didn't care about the order
446 * of attributes, but we do
448 $sql = <<<__INDEXATTR__
452 i.indoption[s.g] as option,
455 (SELECT generate_series(array_lower(isub.indkey,1), array_upper(isub.indkey,1)) AS g
459 ON cis.oid=isub.indexrelid
461 ON cis.relnamespace = ns.oid
462 WHERE cis.relname='$index' AND ns.nspname='$schema') AS s,
468 ON ci.oid=i.indexrelid
470 ON ct.oid = i.indrelid
472 ON ci.relnamespace = n.oid
474 ci.relname='$index' AND n.nspname='$schema'
475 AND attrelid = ct.oid
476 AND i.indkey[s.g] = attnum
477 AND i.indclass[s.g] = opcls.oid
478 AND pg_am.oid = opcls.opcmethod
480 $res = $this->query( $sql, __METHOD__ );
483 foreach ( $res as $row ) {
497 public function indexUnique( $table, $index, $fname = __METHOD__ ) {
498 $sql = "SELECT indexname FROM pg_indexes WHERE tablename='{$table}'" .
499 " AND indexdef LIKE 'CREATE UNIQUE%(" .
500 $this->strencode( $this->indexName( $index ) ) .
502 $res = $this->query( $sql, $fname );
507 return $res->numRows() > 0;
510 public function selectSQLText(
511 $table, $vars, $conds = '', $fname = __METHOD__, $options = [], $join_conds = []
513 // Change the FOR UPDATE option as necessary based on the join conditions. Then pass
514 // to the parent function to get the actual SQL text.
515 // In Postgres when using FOR UPDATE, only the main table and tables that are inner joined
516 // can be locked. That means tables in an outer join cannot be FOR UPDATE locked. Trying to
517 // do so causes a DB error. This wrapper checks which tables can be locked and adjusts it
519 // MySQL uses "ORDER BY NULL" as an optimization hint, but that is illegal in PostgreSQL.
520 if ( is_array( $options ) ) {
521 $forUpdateKey = array_search( 'FOR UPDATE', $options, true );
522 if ( $forUpdateKey !== false && $join_conds ) {
523 unset( $options[$forUpdateKey] );
525 foreach ( $join_conds as $table_cond => $join_cond ) {
526 if ( 0 === preg_match( '/^(?:LEFT|RIGHT|FULL)(?: OUTER)? JOIN$/i', $join_cond[0] ) ) {
527 $options['FOR UPDATE'][] = $table_cond;
532 if ( isset( $options['ORDER BY'] ) && $options['ORDER BY'] == 'NULL' ) {
533 unset( $options['ORDER BY'] );
537 return parent::selectSQLText( $table, $vars, $conds, $fname, $options, $join_conds );
541 * INSERT wrapper, inserts an array into a table
543 * $args may be a single associative array, or an array of these with numeric keys,
544 * for multi-row insert (Postgres version 8.2 and above only).
546 * @param string $table Name of the table to insert to.
547 * @param array $args Items to insert into the table.
548 * @param string $fname Name of the function, for profiling
549 * @param array|string $options String or array. Valid options: IGNORE
550 * @return bool Success of insert operation. IGNORE always returns true.
552 public function insert( $table, $args, $fname = __METHOD__, $options = [] ) {
553 if ( !count( $args ) ) {
557 $table = $this->tableName( $table );
558 if ( !isset( $this->numericVersion ) ) {
559 $this->getServerVersion();
562 if ( !is_array( $options ) ) {
563 $options = [ $options ];
566 if ( isset( $args[0] ) && is_array( $args[0] ) ) {
568 $keys = array_keys( $args[0] );
571 $keys = array_keys( $args );
574 // If IGNORE is set, we use savepoints to emulate mysql's behavior
575 $savepoint = $olde = null;
576 $numrowsinserted = 0;
577 if ( in_array( 'IGNORE', $options ) ) {
578 $savepoint = new SavepointPostgres( $this, 'mw', $this->queryLogger );
579 $olde = error_reporting( 0 );
580 // For future use, we may want to track the number of actual inserts
581 // Right now, insert (all writes) simply return true/false
584 $sql = "INSERT INTO $table (" . implode( ',', $keys ) . ') VALUES ';
587 if ( $this->numericVersion >= 8.2 && !$savepoint ) {
589 foreach ( $args as $row ) {
595 $sql .= '(' . $this->makeList( $row ) . ')';
597 $res = (bool)$this->query( $sql, $fname, $savepoint );
601 foreach ( $args as $row ) {
603 $tempsql .= '(' . $this->makeList( $row ) . ')';
606 $savepoint->savepoint();
609 $tempres = (bool)$this->query( $tempsql, $fname, $savepoint );
612 $bar = pg_result_error( $this->mLastResult );
613 if ( $bar != false ) {
614 $savepoint->rollback();
616 $savepoint->release();
621 // If any of them fail, we fail overall for this function call
622 // Note that this will be ignored if IGNORE is set
629 // Not multi, just a lone insert
631 $savepoint->savepoint();
634 $sql .= '(' . $this->makeList( $args ) . ')';
635 $res = (bool)$this->query( $sql, $fname, $savepoint );
637 $bar = pg_result_error( $this->mLastResult );
638 if ( $bar != false ) {
639 $savepoint->rollback();
641 $savepoint->release();
647 error_reporting( $olde );
648 $savepoint->commit();
650 // Set the affected row count for the whole operation
651 $this->mAffectedRows = $numrowsinserted;
653 // IGNORE always returns true
661 * INSERT SELECT wrapper
662 * $varMap must be an associative array of the form [ 'dest1' => 'source1', ... ]
663 * Source items may be literals rather then field names, but strings should
664 * be quoted with Database::addQuotes()
665 * $conds may be "*" to copy the whole table
666 * srcTable may be an array of tables.
667 * @todo FIXME: Implement this a little better (seperate select/insert)?
669 * @param string $destTable
670 * @param array|string $srcTable
671 * @param array $varMap
672 * @param array $conds
673 * @param string $fname
674 * @param array $insertOptions
675 * @param array $selectOptions
678 public function nativeInsertSelect(
679 $destTable, $srcTable, $varMap, $conds, $fname = __METHOD__,
680 $insertOptions = [], $selectOptions = []
682 $destTable = $this->tableName( $destTable );
684 if ( !is_array( $insertOptions ) ) {
685 $insertOptions = [ $insertOptions ];
689 * If IGNORE is set, we use savepoints to emulate mysql's behavior
690 * Ignore LOW PRIORITY option, since it is MySQL-specific
692 $savepoint = $olde = null;
693 $numrowsinserted = 0;
694 if ( in_array( 'IGNORE', $insertOptions ) ) {
695 $savepoint = new SavepointPostgres( $this, 'mw', $this->queryLogger );
696 $olde = error_reporting( 0 );
697 $savepoint->savepoint();
700 if ( !is_array( $selectOptions ) ) {
701 $selectOptions = [ $selectOptions ];
703 list( $startOpts, $useIndex, $tailOpts, $ignoreIndex ) =
704 $this->makeSelectOptions( $selectOptions );
705 if ( is_array( $srcTable ) ) {
706 $srcTable = implode( ',', array_map( [ $this, 'tableName' ], $srcTable ) );
708 $srcTable = $this->tableName( $srcTable );
711 $sql = "INSERT INTO $destTable (" . implode( ',', array_keys( $varMap ) ) . ')' .
712 " SELECT $startOpts " . implode( ',', $varMap ) .
713 " FROM $srcTable $useIndex $ignoreIndex ";
715 if ( $conds != '*' ) {
716 $sql .= ' WHERE ' . $this->makeList( $conds, LIST_AND );
719 $sql .= " $tailOpts";
721 $res = (bool)$this->query( $sql, $fname, $savepoint );
723 $bar = pg_result_error( $this->mLastResult );
724 if ( $bar != false ) {
725 $savepoint->rollback();
727 $savepoint->release();
730 error_reporting( $olde );
731 $savepoint->commit();
733 // Set the affected row count for the whole operation
734 $this->mAffectedRows = $numrowsinserted;
736 // IGNORE always returns true
743 public function tableName( $name, $format = 'quoted' ) {
744 // Replace reserved words with better ones
745 $name = $this->remappedTableName( $name );
747 return parent::tableName( $name, $format );
751 * @param string $name
752 * @return string Value of $name or remapped name if $name is a reserved keyword
754 public function remappedTableName( $name ) {
755 return isset( $this->keywordTableMap[$name] ) ? $this->keywordTableMap[$name] : $name;
759 * @param string $name
760 * @param string $format
761 * @return string Qualified and encoded (if requested) table name
763 public function realTableName( $name, $format = 'quoted' ) {
764 return parent::tableName( $name, $format );
767 public function nextSequenceValue( $seqName ) {
768 $safeseq = str_replace( "'", "''", $seqName );
769 $res = $this->query( "SELECT nextval('$safeseq')" );
770 $row = $this->fetchRow( $res );
771 $this->mInsertId = $row[0];
773 return $this->mInsertId;
777 * Return the current value of a sequence. Assumes it has been nextval'ed in this session.
779 * @param string $seqName
782 public function currentSequenceValue( $seqName ) {
783 $safeseq = str_replace( "'", "''", $seqName );
784 $res = $this->query( "SELECT currval('$safeseq')" );
785 $row = $this->fetchRow( $res );
791 public function textFieldSize( $table, $field ) {
792 $table = $this->tableName( $table );
793 $sql = "SELECT t.typname as ftype,a.atttypmod as size
794 FROM pg_class c, pg_attribute a, pg_type t
795 WHERE relname='$table' AND a.attrelid=c.oid AND
796 a.atttypid=t.oid and a.attname='$field'";
797 $res = $this->query( $sql );
798 $row = $this->fetchObject( $res );
799 if ( $row->ftype == 'varchar' ) {
800 $size = $row->size - 4;
808 public function limitResult( $sql, $limit, $offset = false ) {
809 return "$sql LIMIT $limit " . ( is_numeric( $offset ) ? " OFFSET {$offset} " : '' );
812 public function wasDeadlock() {
813 return $this->lastErrno() == '40P01';
816 public function duplicateTableStructure(
817 $oldName, $newName, $temporary = false, $fname = __METHOD__
819 $newName = $this->addIdentifierQuotes( $newName );
820 $oldName = $this->addIdentifierQuotes( $oldName );
822 return $this->query( 'CREATE ' . ( $temporary ? 'TEMPORARY ' : '' ) . " TABLE $newName " .
823 "(LIKE $oldName INCLUDING DEFAULTS)", $fname );
826 public function listTables( $prefix = null, $fname = __METHOD__ ) {
827 $eschema = $this->addQuotes( $this->getCoreSchema() );
828 $result = $this->query(
829 "SELECT tablename FROM pg_tables WHERE schemaname = $eschema", $fname );
832 foreach ( $result as $table ) {
833 $vars = get_object_vars( $table );
834 $table = array_pop( $vars );
835 if ( !$prefix || strpos( $table, $prefix ) === 0 ) {
836 $endArray[] = $table;
843 public function timestamp( $ts = 0 ) {
844 $ct = new ConvertibleTimestamp( $ts );
846 return $ct->getTimestamp( TS_POSTGRES );
850 * Posted by cc[plus]php[at]c2se[dot]com on 25-Mar-2009 09:12
851 * to https://secure.php.net/manual/en/ref.pgsql.php
853 * Parsing a postgres array can be a tricky problem, he's my
854 * take on this, it handles multi-dimensional arrays plus
855 * escaping using a nasty regexp to determine the limits of each
858 * This should really be handled by PHP PostgreSQL module
861 * @param string $text Postgreql array returned in a text form like {a,b}
862 * @param string $output
863 * @param int|bool $limit
867 private function pg_array_parse( $text, &$output, $limit = false, $offset = 1 ) {
868 if ( false === $limit ) {
869 $limit = strlen( $text ) - 1;
872 if ( '{}' == $text ) {
876 if ( '{' != $text[$offset] ) {
877 preg_match( "/(\\{?\"([^\"\\\\]|\\\\.)*\"|[^,{}]+)+([,}]+)/",
878 $text, $match, 0, $offset );
879 $offset += strlen( $match[0] );
880 $output[] = ( '"' != $match[1][0]
882 : stripcslashes( substr( $match[1], 1, -1 ) ) );
883 if ( '},' == $match[3] ) {
887 $offset = $this->pg_array_parse( $text, $output, $limit, $offset + 1 );
889 } while ( $limit > $offset );
894 public function aggregateValue( $valuedata, $valuename = 'value' ) {
898 public function getSoftwareLink() {
899 return '[{{int:version-db-postgres-url}} PostgreSQL]';
903 * Return current schema (executes SELECT current_schema())
907 * @return string Default schema for the current session
909 public function getCurrentSchema() {
910 $res = $this->query( "SELECT current_schema()", __METHOD__ );
911 $row = $this->fetchRow( $res );
917 * Return list of schemas which are accessible without schema name
918 * This is list does not contain magic keywords like "$user"
921 * @see getSearchPath()
922 * @see setSearchPath()
924 * @return array List of actual schemas for the current sesson
926 public function getSchemas() {
927 $res = $this->query( "SELECT current_schemas(false)", __METHOD__ );
928 $row = $this->fetchRow( $res );
931 /* PHP pgsql support does not support array type, "{a,b}" string is returned */
933 return $this->pg_array_parse( $row[0], $schemas );
937 * Return search patch for schemas
938 * This is different from getSchemas() since it contain magic keywords
943 * @return array How to search for table names schemas for the current user
945 public function getSearchPath() {
946 $res = $this->query( "SHOW search_path", __METHOD__ );
947 $row = $this->fetchRow( $res );
949 /* PostgreSQL returns SHOW values as strings */
951 return explode( ",", $row[0] );
955 * Update search_path, values should already be sanitized
956 * Values may contain magic keywords like "$user"
959 * @param array $search_path List of schemas to be searched by default
961 private function setSearchPath( $search_path ) {
962 $this->query( "SET search_path = " . implode( ", ", $search_path ) );
966 * Determine default schema for the current application
967 * Adjust this session schema search path if desired schema exists
968 * and is not alread there.
970 * We need to have name of the core schema stored to be able
971 * to query database metadata.
973 * This will be also called by the installer after the schema is created
977 * @param string $desiredSchema
979 public function determineCoreSchema( $desiredSchema ) {
980 $this->begin( __METHOD__, self::TRANSACTION_INTERNAL );
981 if ( $this->schemaExists( $desiredSchema ) ) {
982 if ( in_array( $desiredSchema, $this->getSchemas() ) ) {
983 $this->mCoreSchema = $desiredSchema;
984 $this->queryLogger->debug(
985 "Schema \"" . $desiredSchema . "\" already in the search path\n" );
988 * Prepend our schema (e.g. 'mediawiki') in front
992 $search_path = $this->getSearchPath();
993 array_unshift( $search_path,
994 $this->addIdentifierQuotes( $desiredSchema ) );
995 $this->setSearchPath( $search_path );
996 $this->mCoreSchema = $desiredSchema;
997 $this->queryLogger->debug(
998 "Schema \"" . $desiredSchema . "\" added to the search path\n" );
1001 $this->mCoreSchema = $this->getCurrentSchema();
1002 $this->queryLogger->debug(
1003 "Schema \"" . $desiredSchema . "\" not found, using current \"" .
1004 $this->mCoreSchema . "\"\n" );
1006 /* Commit SET otherwise it will be rollbacked on error or IGNORE SELECT */
1007 $this->commit( __METHOD__, self::FLUSHING_INTERNAL );
1011 * Return schema name for core application tables
1014 * @return string Core schema name
1016 public function getCoreSchema() {
1017 return $this->mCoreSchema;
1020 public function getServerVersion() {
1021 if ( !isset( $this->numericVersion ) ) {
1022 $conn = $this->getBindingHandle();
1023 $versionInfo = pg_version( $conn );
1024 if ( version_compare( $versionInfo['client'], '7.4.0', 'lt' ) ) {
1025 // Old client, abort install
1026 $this->numericVersion = '7.3 or earlier';
1027 } elseif ( isset( $versionInfo['server'] ) ) {
1029 $this->numericVersion = $versionInfo['server'];
1031 // T18937: broken pgsql extension from PHP<5.3
1032 $this->numericVersion = pg_parameter_status( $conn, 'server_version' );
1036 return $this->numericVersion;
1040 * Query whether a given relation exists (in the given schema, or the
1041 * default mw one if not given)
1042 * @param string $table
1043 * @param array|string $types
1044 * @param bool|string $schema
1047 private function relationExists( $table, $types, $schema = false ) {
1048 if ( !is_array( $types ) ) {
1049 $types = [ $types ];
1051 if ( $schema === false ) {
1052 $schema = $this->getCoreSchema();
1054 $etable = $this->addQuotes( $table );
1055 $eschema = $this->addQuotes( $schema );
1056 $sql = "SELECT 1 FROM pg_catalog.pg_class c, pg_catalog.pg_namespace n "
1057 . "WHERE c.relnamespace = n.oid AND c.relname = $etable AND n.nspname = $eschema "
1058 . "AND c.relkind IN ('" . implode( "','", $types ) . "')";
1059 $res = $this->query( $sql );
1060 $count = $res ? $res->numRows() : 0;
1062 return (bool)$count;
1066 * For backward compatibility, this function checks both tables and views.
1067 * @param string $table
1068 * @param string $fname
1069 * @param bool|string $schema
1072 public function tableExists( $table, $fname = __METHOD__, $schema = false ) {
1073 return $this->relationExists( $table, [ 'r', 'v' ], $schema );
1076 public function sequenceExists( $sequence, $schema = false ) {
1077 return $this->relationExists( $sequence, 'S', $schema );
1080 public function triggerExists( $table, $trigger ) {
1082 SELECT 1 FROM pg_class, pg_namespace, pg_trigger
1083 WHERE relnamespace=pg_namespace.oid AND relkind='r'
1084 AND tgrelid=pg_class.oid
1085 AND nspname=%s AND relname=%s AND tgname=%s
1087 $res = $this->query(
1090 $this->addQuotes( $this->getCoreSchema() ),
1091 $this->addQuotes( $table ),
1092 $this->addQuotes( $trigger )
1098 $rows = $res->numRows();
1103 public function ruleExists( $table, $rule ) {
1104 $exists = $this->selectField( 'pg_rules', 'rulename',
1106 'rulename' => $rule,
1107 'tablename' => $table,
1108 'schemaname' => $this->getCoreSchema()
1112 return $exists === $rule;
1115 public function constraintExists( $table, $constraint ) {
1116 $sql = sprintf( "SELECT 1 FROM information_schema.table_constraints " .
1117 "WHERE constraint_schema = %s AND table_name = %s AND constraint_name = %s",
1118 $this->addQuotes( $this->getCoreSchema() ),
1119 $this->addQuotes( $table ),
1120 $this->addQuotes( $constraint )
1122 $res = $this->query( $sql );
1126 $rows = $res->numRows();
1132 * Query whether a given schema exists. Returns true if it does, false if it doesn't.
1133 * @param string $schema
1136 public function schemaExists( $schema ) {
1137 if ( !strlen( $schema ) ) {
1138 return false; // short-circuit
1141 $exists = $this->selectField(
1142 '"pg_catalog"."pg_namespace"', 1, [ 'nspname' => $schema ], __METHOD__ );
1144 return (bool)$exists;
1148 * Returns true if a given role (i.e. user) exists, false otherwise.
1149 * @param string $roleName
1152 public function roleExists( $roleName ) {
1153 $exists = $this->selectField( '"pg_catalog"."pg_roles"', 1,
1154 [ 'rolname' => $roleName ], __METHOD__ );
1156 return (bool)$exists;
1160 * @var string $table
1161 * @var string $field
1162 * @return PostgresField|null
1164 public function fieldInfo( $table, $field ) {
1165 return PostgresField::fromText( $this, $table, $field );
1169 * pg_field_type() wrapper
1170 * @param ResultWrapper|resource $res ResultWrapper or PostgreSQL query result resource
1171 * @param int $index Field number, starting from 0
1174 public function fieldType( $res, $index ) {
1175 if ( $res instanceof ResultWrapper ) {
1176 $res = $res->result;
1179 return pg_field_type( $res, $index );
1182 public function encodeBlob( $b ) {
1183 return new PostgresBlob( pg_escape_bytea( $b ) );
1186 public function decodeBlob( $b ) {
1187 if ( $b instanceof PostgresBlob ) {
1189 } elseif ( $b instanceof Blob ) {
1193 return pg_unescape_bytea( $b );
1196 public function strencode( $s ) {
1197 // Should not be called by us
1198 return pg_escape_string( $this->getBindingHandle(), $s );
1201 public function addQuotes( $s ) {
1202 $conn = $this->getBindingHandle();
1204 if ( is_null( $s ) ) {
1206 } elseif ( is_bool( $s ) ) {
1207 return intval( $s );
1208 } elseif ( $s instanceof Blob ) {
1209 if ( $s instanceof PostgresBlob ) {
1212 $s = pg_escape_bytea( $conn, $s->fetch() );
1217 return "'" . pg_escape_string( $conn, $s ) . "'";
1221 * Postgres specific version of replaceVars.
1222 * Calls the parent version in Database.php
1224 * @param string $ins SQL string, read from a stream (usually tables.sql)
1225 * @return string SQL string
1227 protected function replaceVars( $ins ) {
1228 $ins = parent::replaceVars( $ins );
1230 if ( $this->numericVersion >= 8.3 ) {
1231 // Thanks for not providing backwards-compatibility, 8.3
1232 $ins = preg_replace( "/to_tsvector\s*\(\s*'default'\s*,/", 'to_tsvector(', $ins );
1235 if ( $this->numericVersion <= 8.1 ) { // Our minimum version
1236 $ins = str_replace( 'USING gin', 'USING gist', $ins );
1242 public function makeSelectOptions( $options ) {
1243 $preLimitTail = $postLimitTail = '';
1244 $startOpts = $useIndex = $ignoreIndex = '';
1247 foreach ( $options as $key => $option ) {
1248 if ( is_numeric( $key ) ) {
1249 $noKeyOptions[$option] = true;
1253 $preLimitTail .= $this->makeGroupByWithHaving( $options );
1255 $preLimitTail .= $this->makeOrderBy( $options );
1257 if ( isset( $options['FOR UPDATE'] ) ) {
1258 $postLimitTail .= ' FOR UPDATE OF ' .
1259 implode( ', ', array_map( [ $this, 'tableName' ], $options['FOR UPDATE'] ) );
1260 } elseif ( isset( $noKeyOptions['FOR UPDATE'] ) ) {
1261 $postLimitTail .= ' FOR UPDATE';
1264 if ( isset( $noKeyOptions['DISTINCT'] ) || isset( $noKeyOptions['DISTINCTROW'] ) ) {
1265 $startOpts .= 'DISTINCT';
1268 return [ $startOpts, $useIndex, $preLimitTail, $postLimitTail, $ignoreIndex ];
1271 public function getDBname() {
1272 return $this->mDBname;
1275 public function getServer() {
1276 return $this->mServer;
1279 public function buildConcat( $stringList ) {
1280 return implode( ' || ', $stringList );
1283 public function buildGroupConcatField(
1284 $delimiter, $table, $field, $conds = '', $options = [], $join_conds = []
1286 $fld = "array_to_string(array_agg($field)," . $this->addQuotes( $delimiter ) . ')';
1288 return '(' . $this->selectSQLText( $table, $fld, $conds, null, [], $join_conds ) . ')';
1291 public function buildStringCast( $field ) {
1292 return $field . '::text';
1295 public function streamStatementEnd( &$sql, &$newLine ) {
1296 # Allow dollar quoting for function declarations
1297 if ( substr( $newLine, 0, 4 ) == '$mw$' ) {
1298 if ( $this->delimiter ) {
1299 $this->delimiter = false;
1301 $this->delimiter = ';';
1305 return parent::streamStatementEnd( $sql, $newLine );
1308 public function lockIsFree( $lockName, $method ) {
1309 // http://www.postgresql.org/docs/8.2/static/functions-admin.html#FUNCTIONS-ADVISORY-LOCKS
1310 $key = $this->addQuotes( $this->bigintFromLockName( $lockName ) );
1311 $result = $this->query( "SELECT (CASE(pg_try_advisory_lock($key))
1312 WHEN 'f' THEN 'f' ELSE pg_advisory_unlock($key) END) AS lockstatus", $method );
1313 $row = $this->fetchObject( $result );
1315 return ( $row->lockstatus === 't' );
1318 public function lock( $lockName, $method, $timeout = 5 ) {
1319 // http://www.postgresql.org/docs/8.2/static/functions-admin.html#FUNCTIONS-ADVISORY-LOCKS
1320 $key = $this->addQuotes( $this->bigintFromLockName( $lockName ) );
1321 $loop = new WaitConditionLoop(
1322 function () use ( $lockName, $key, $timeout, $method ) {
1323 $res = $this->query( "SELECT pg_try_advisory_lock($key) AS lockstatus", $method );
1324 $row = $this->fetchObject( $res );
1325 if ( $row->lockstatus === 't' ) {
1326 parent::lock( $lockName, $method, $timeout ); // record
1330 return WaitConditionLoop::CONDITION_CONTINUE;
1335 return ( $loop->invoke() === $loop::CONDITION_REACHED );
1338 public function unlock( $lockName, $method ) {
1339 // http://www.postgresql.org/docs/8.2/static/functions-admin.html#FUNCTIONS-ADVISORY-LOCKS
1340 $key = $this->addQuotes( $this->bigintFromLockName( $lockName ) );
1341 $result = $this->query( "SELECT pg_advisory_unlock($key) as lockstatus", $method );
1342 $row = $this->fetchObject( $result );
1344 if ( $row->lockstatus === 't' ) {
1345 parent::unlock( $lockName, $method ); // record
1349 $this->queryLogger->debug( __METHOD__ . " failed to release lock\n" );
1355 * @param string $lockName
1356 * @return string Integer
1358 private function bigintFromLockName( $lockName ) {
1359 return Wikimedia\base_convert( substr( sha1( $lockName ), 0, 15 ), 16, 10 );