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
24 class PostgresField
implements Field
{
25 private $name, $tablename, $type, $nullable, $max_length, $deferred, $deferrable, $conname,
26 $has_default, $default;
29 * @param $db DatabaseBase
32 * @return null|PostgresField
34 static function fromText( $db, $table, $field ) {
37 attnotnull, attlen, conname AS conname,
40 COALESCE(condeferred, 'f') AS deferred,
41 COALESCE(condeferrable, 'f') AS deferrable,
42 CASE WHEN typname = 'int2' THEN 'smallint'
43 WHEN typname = 'int4' THEN 'integer'
44 WHEN typname = 'int8' THEN 'bigint'
45 WHEN typname = 'bpchar' THEN 'char'
46 ELSE typname END AS typname
48 JOIN pg_namespace n ON (n.oid = c.relnamespace)
49 JOIN pg_attribute a ON (a.attrelid = c.oid)
50 JOIN pg_type t ON (t.oid = a.atttypid)
51 LEFT JOIN pg_constraint o ON (o.conrelid = c.oid AND a.attnum = ANY(o.conkey) AND o.contype = 'f')
52 LEFT JOIN pg_attrdef d on c.oid=d.adrelid and a.attnum=d.adnum
59 $table = $db->tableName( $table, 'raw' );
62 $db->addQuotes( $db->getCoreSchema() ),
63 $db->addQuotes( $table ),
64 $db->addQuotes( $field )
67 $row = $db->fetchObject( $res );
71 $n = new PostgresField
;
72 $n->type
= $row->typname
;
73 $n->nullable
= ( $row->attnotnull
== 'f' );
75 $n->tablename
= $table;
76 $n->max_length
= $row->attlen
;
77 $n->deferrable
= ( $row->deferrable
== 't' );
78 $n->deferred
= ( $row->deferred
== 't' );
79 $n->conname
= $row->conname
;
80 $n->has_default
= ( $row->atthasdef
=== 't' );
81 $n->default = $row->adsrc
;
90 function tableName() {
91 return $this->tablename
;
98 function isNullable() {
99 return $this->nullable
;
102 function maxLength() {
103 return $this->max_length
;
106 function is_deferrable() {
107 return $this->deferrable
;
110 function is_deferred() {
111 return $this->deferred
;
115 return $this->conname
;
121 function defaultValue() {
122 if ( $this->has_default
) {
123 return $this->default;
131 * Used to debug transaction processing
132 * Only used if $wgDebugDBTransactions is true
137 class PostgresTransactionState
{
139 static $WATCHED = array(
141 "desc" => "%s: Connection state changed from %s -> %s\n",
143 PGSQL_CONNECTION_OK
=> "OK",
144 PGSQL_CONNECTION_BAD
=> "BAD"
148 "desc" => "%s: Transaction state changed from %s -> %s\n",
150 PGSQL_TRANSACTION_IDLE
=> "IDLE",
151 PGSQL_TRANSACTION_ACTIVE
=> "ACTIVE",
152 PGSQL_TRANSACTION_INTRANS
=> "TRANS",
153 PGSQL_TRANSACTION_INERROR
=> "ERROR",
154 PGSQL_TRANSACTION_UNKNOWN
=> "UNKNOWN"
159 public function __construct( $conn ) {
160 $this->mConn
= $conn;
162 $this->mCurrentState
= $this->mNewState
;
165 public function update() {
166 $this->mNewState
= array(
167 pg_connection_status( $this->mConn
),
168 pg_transaction_status( $this->mConn
)
172 public function check() {
173 global $wgDebugDBTransactions;
175 if ( $wgDebugDBTransactions ) {
176 if ( $this->mCurrentState
!== $this->mNewState
) {
177 $old = reset( $this->mCurrentState
);
178 $new = reset( $this->mNewState
);
179 foreach ( self
::$WATCHED as $watched ) {
180 if ( $old !== $new ) {
181 $this->log_changed( $old, $new, $watched );
183 $old = next( $this->mCurrentState
);
184 $new = next( $this->mNewState
);
188 $this->mCurrentState
= $this->mNewState
;
191 protected function describe_changed( $status, $desc_table ) {
192 if ( isset( $desc_table[$status] ) ) {
193 return $desc_table[$status];
195 return "STATUS " . $status;
199 protected function log_changed( $old, $new, $watched ) {
200 wfDebug( sprintf( $watched["desc"],
202 $this->describe_changed( $old, $watched["states"] ),
203 $this->describe_changed( $new, $watched["states"] )
209 * Manage savepoints within a transaction
213 class SavepointPostgres
{
215 * Establish a savepoint within a transaction
221 public function __construct( $dbw, $id ) {
224 $this->didbegin
= false;
225 /* If we are not in a transaction, we need to be for savepoint trickery */
226 if ( !$dbw->trxLevel() ) {
227 $dbw->begin( "FOR SAVEPOINT" );
228 $this->didbegin
= true;
232 public function __destruct() {
233 if ( $this->didbegin
) {
234 $this->dbw
->rollback();
235 $this->didbegin
= false;
239 public function commit() {
240 if ( $this->didbegin
) {
241 $this->dbw
->commit();
242 $this->didbegin
= false;
246 protected function query( $keyword, $msg_ok, $msg_failed ) {
247 global $wgDebugDBTransactions;
248 if ( $this->dbw
->doQuery( $keyword . " " . $this->id
) !== false ) {
249 if ( $wgDebugDBTransactions ) {
250 wfDebug( sprintf( $msg_ok, $this->id
) );
253 wfDebug( sprintf( $msg_failed, $this->id
) );
257 public function savepoint() {
258 $this->query( "SAVEPOINT",
259 "Transaction state: savepoint \"%s\" established.\n",
260 "Transaction state: establishment of savepoint \"%s\" FAILED.\n"
264 public function release() {
265 $this->query( "RELEASE",
266 "Transaction state: savepoint \"%s\" released.\n",
267 "Transaction state: release of savepoint \"%s\" FAILED.\n"
271 public function rollback() {
272 $this->query( "ROLLBACK TO",
273 "Transaction state: savepoint \"%s\" rolled back.\n",
274 "Transaction state: rollback of savepoint \"%s\" FAILED.\n"
278 public function __toString() {
279 return (string)$this->id
;
286 class DatabasePostgres
extends DatabaseBase
{
287 var $mInsertId = null;
288 var $mLastResult = null;
289 var $numeric_version = null;
290 var $mAffectedRows = null;
296 function cascadingDeletes() {
300 function cleanupTriggers() {
304 function strictIPs() {
308 function realTimestamps() {
312 function implicitGroupby() {
316 function implicitOrderby() {
320 function searchableIPs() {
324 function functionalIndexes() {
328 function hasConstraint( $name ) {
329 $SQL = "SELECT 1 FROM pg_catalog.pg_constraint c, pg_catalog.pg_namespace n " .
330 "WHERE c.connamespace = n.oid AND conname = '" .
331 pg_escape_string( $this->mConn
, $name ) . "' AND n.nspname = '" .
332 pg_escape_string( $this->mConn
, $this->getCoreSchema() ) . "'";
333 $res = $this->doQuery( $SQL );
335 return $this->numRows( $res );
339 * Usually aborts on failure
340 * @param string $server
341 * @param string $user
342 * @param string $password
343 * @param string $dbName
344 * @throws DBConnectionError
345 * @return DatabaseBase|null
347 function open( $server, $user, $password, $dbName ) {
348 # Test for Postgres support, to avoid suppressed fatal error
349 if ( !function_exists( 'pg_connect' ) ) {
350 throw new DBConnectionError(
352 "Postgres functions missing, have you compiled PHP with the --with-pgsql\n" .
353 "option? (Note: if you recently installed PHP, you may need to restart your\n" .
354 "webserver and database)\n"
360 if ( !strlen( $user ) ) { # e.g. the class is being loaded
364 $this->mServer
= $server;
366 $this->mUser
= $user;
367 $this->mPassword
= $password;
368 $this->mDBname
= $dbName;
370 $connectVars = array(
373 'password' => $password
375 if ( $server != false && $server != '' ) {
376 $connectVars['host'] = $server;
378 if ( $port != false && $port != '' ) {
379 $connectVars['port'] = $port;
381 if ( $this->mFlags
& DBO_SSL
) {
382 $connectVars['sslmode'] = 1;
385 $this->connectString
= $this->makeConnectionString( $connectVars, PGSQL_CONNECT_FORCE_NEW
);
387 $this->installErrorHandler();
390 $this->mConn
= pg_connect( $this->connectString
);
391 } catch ( Exception
$ex ) {
392 $this->restoreErrorHandler();
396 $phpError = $this->restoreErrorHandler();
398 if ( !$this->mConn
) {
399 wfDebug( "DB connection error\n" );
400 wfDebug( "Server: $server, Database: $dbName, User: $user, Password: " .
401 substr( $password, 0, 3 ) . "...\n" );
402 wfDebug( $this->lastError() . "\n" );
403 throw new DBConnectionError( $this, str_replace( "\n", ' ', $phpError ) );
406 $this->mOpened
= true;
407 $this->mTransactionState
= new PostgresTransactionState( $this->mConn
);
409 global $wgCommandLineMode;
410 # If called from the command-line (e.g. importDump), only show errors
411 if ( $wgCommandLineMode ) {
412 $this->doQuery( "SET client_min_messages = 'ERROR'" );
415 $this->query( "SET client_encoding='UTF8'", __METHOD__
);
416 $this->query( "SET datestyle = 'ISO, YMD'", __METHOD__
);
417 $this->query( "SET timezone = 'GMT'", __METHOD__
);
418 $this->query( "SET standard_conforming_strings = on", __METHOD__
);
419 if ( $this->getServerVersion() >= 9.0 ) {
420 $this->query( "SET bytea_output = 'escape'", __METHOD__
); // PHP bug 53127
423 global $wgDBmwschema;
424 $this->determineCoreSchema( $wgDBmwschema );
430 * Postgres doesn't support selectDB in the same way MySQL does. So if the
431 * DB name doesn't match the open connection, open a new one
434 function selectDB( $db ) {
435 if ( $this->mDBname
!== $db ) {
436 return (bool)$this->open( $this->mServer
, $this->mUser
, $this->mPassword
, $db );
442 function makeConnectionString( $vars ) {
444 foreach ( $vars as $name => $value ) {
445 $s .= "$name='" . str_replace( "'", "\\'", $value ) . "' ";
452 * Closes a database connection, if it is open
453 * Returns success, true if already closed
456 protected function closeConnection() {
457 return pg_close( $this->mConn
);
460 public function doQuery( $sql ) {
461 if ( function_exists( 'mb_convert_encoding' ) ) {
462 $sql = mb_convert_encoding( $sql, 'UTF-8' );
464 $this->mTransactionState
->check();
465 if ( pg_send_query( $this->mConn
, $sql ) === false ) {
466 throw new DBUnexpectedError( $this, "Unable to post new query to PostgreSQL\n" );
468 $this->mLastResult
= pg_get_result( $this->mConn
);
469 $this->mTransactionState
->check();
470 $this->mAffectedRows
= null;
471 if ( pg_result_error( $this->mLastResult
) ) {
475 return $this->mLastResult
;
478 protected function dumpError() {
482 PGSQL_DIAG_MESSAGE_PRIMARY
,
483 PGSQL_DIAG_MESSAGE_DETAIL
,
484 PGSQL_DIAG_MESSAGE_HINT
,
485 PGSQL_DIAG_STATEMENT_POSITION
,
486 PGSQL_DIAG_INTERNAL_POSITION
,
487 PGSQL_DIAG_INTERNAL_QUERY
,
489 PGSQL_DIAG_SOURCE_FILE
,
490 PGSQL_DIAG_SOURCE_LINE
,
491 PGSQL_DIAG_SOURCE_FUNCTION
493 foreach ( $diags as $d ) {
494 wfDebug( sprintf( "PgSQL ERROR(%d): %s\n",
495 $d, pg_result_error_field( $this->mLastResult
, $d ) ) );
499 function reportQueryError( $error, $errno, $sql, $fname, $tempIgnore = false ) {
500 /* Transaction stays in the ERROR state until rolledback */
502 /* Check for constraint violation */
503 if ( $errno === '23505' ) {
504 parent
::reportQueryError( $error, $errno, $sql, $fname, $tempIgnore );
509 /* Don't ignore serious errors */
510 $this->rollback( __METHOD__
);
511 parent
::reportQueryError( $error, $errno, $sql, $fname, false );
514 function queryIgnore( $sql, $fname = __METHOD__
) {
515 return $this->query( $sql, $fname, true );
518 function freeResult( $res ) {
519 if ( $res instanceof ResultWrapper
) {
522 wfSuppressWarnings();
523 $ok = pg_free_result( $res );
526 throw new DBUnexpectedError( $this, "Unable to free Postgres result\n" );
530 function fetchObject( $res ) {
531 if ( $res instanceof ResultWrapper
) {
534 wfSuppressWarnings();
535 $row = pg_fetch_object( $res );
537 # @todo FIXME: HACK HACK HACK HACK debug
539 # @todo hashar: not sure if the following test really trigger if the object
541 if ( pg_last_error( $this->mConn
) ) {
542 throw new DBUnexpectedError(
544 'SQL error: ' . htmlspecialchars( pg_last_error( $this->mConn
) )
551 function fetchRow( $res ) {
552 if ( $res instanceof ResultWrapper
) {
555 wfSuppressWarnings();
556 $row = pg_fetch_array( $res );
558 if ( pg_last_error( $this->mConn
) ) {
559 throw new DBUnexpectedError(
561 'SQL error: ' . htmlspecialchars( pg_last_error( $this->mConn
) )
568 function numRows( $res ) {
569 if ( $res instanceof ResultWrapper
) {
572 wfSuppressWarnings();
573 $n = pg_num_rows( $res );
575 if ( pg_last_error( $this->mConn
) ) {
576 throw new DBUnexpectedError(
578 'SQL error: ' . htmlspecialchars( pg_last_error( $this->mConn
) )
585 function numFields( $res ) {
586 if ( $res instanceof ResultWrapper
) {
590 return pg_num_fields( $res );
593 function fieldName( $res, $n ) {
594 if ( $res instanceof ResultWrapper
) {
598 return pg_field_name( $res, $n );
602 * Return the result of the last call to nextSequenceValue();
603 * This must be called after nextSequenceValue().
605 * @return integer|null
607 function insertId() {
608 return $this->mInsertId
;
611 function dataSeek( $res, $row ) {
612 if ( $res instanceof ResultWrapper
) {
616 return pg_result_seek( $res, $row );
619 function lastError() {
620 if ( $this->mConn
) {
621 if ( $this->mLastResult
) {
622 return pg_result_error( $this->mLastResult
);
624 return pg_last_error();
627 return 'No database connection';
631 function lastErrno() {
632 if ( $this->mLastResult
) {
633 return pg_result_error_field( $this->mLastResult
, PGSQL_DIAG_SQLSTATE
);
639 function affectedRows() {
640 if ( !is_null( $this->mAffectedRows
) ) {
641 // Forced result for simulated queries
642 return $this->mAffectedRows
;
644 if ( empty( $this->mLastResult
) ) {
648 return pg_affected_rows( $this->mLastResult
);
652 * Estimate rows in dataset
653 * Returns estimated count, based on EXPLAIN output
654 * This is not necessarily an accurate estimate, so use sparingly
655 * Returns -1 if count cannot be found
656 * Takes same arguments as Database::select()
659 function estimateRowCount( $table, $vars = '*', $conds = '',
660 $fname = __METHOD__
, $options = array()
662 $options['EXPLAIN'] = true;
663 $res = $this->select( $table, $vars, $conds, $fname, $options );
666 $row = $this->fetchRow( $res );
668 if ( preg_match( '/rows=(\d+)/', $row[0], $count ) ) {
677 * Returns information about an index
678 * If errors are explicitly ignored, returns NULL on failure
681 function indexInfo( $table, $index, $fname = __METHOD__
) {
682 $sql = "SELECT indexname FROM pg_indexes WHERE tablename='$table'";
683 $res = $this->query( $sql, $fname );
687 foreach ( $res as $row ) {
688 if ( $row->indexname
== $this->indexName( $index ) ) {
697 * Returns is of attributes used in index
702 function indexAttributes( $index, $schema = false ) {
703 if ( $schema === false ) {
704 $schema = $this->getCoreSchema();
707 * A subquery would be not needed if we didn't care about the order
708 * of attributes, but we do
710 $sql = <<<__INDEXATTR__
714 i.indoption[s.g] as option,
717 (SELECT generate_series(array_lower(isub.indkey,1), array_upper(isub.indkey,1)) AS g
721 ON cis.oid=isub.indexrelid
723 ON cis.relnamespace = ns.oid
724 WHERE cis.relname='$index' AND ns.nspname='$schema') AS s,
730 ON ci.oid=i.indexrelid
732 ON ct.oid = i.indrelid
734 ON ci.relnamespace = n.oid
736 ci.relname='$index' AND n.nspname='$schema'
737 AND attrelid = ct.oid
738 AND i.indkey[s.g] = attnum
739 AND i.indclass[s.g] = opcls.oid
740 AND pg_am.oid = opcls.opcmethod
742 $res = $this->query( $sql, __METHOD__ );
745 foreach ( $res as $row ) {
759 function indexUnique( $table, $index, $fname = __METHOD__ ) {
760 $sql = "SELECT indexname FROM pg_indexes WHERE tablename='{$table}'" .
761 " AND indexdef LIKE 'CREATE UNIQUE%(" .
762 $this->strencode( $this->indexName( $index ) ) .
764 $res = $this->query( $sql, $fname );
769 return $res->numRows() > 0;
773 * INSERT wrapper, inserts an array into a table
775 * $args may be a single associative array, or an array of these with numeric keys,
776 * for multi-row insert (Postgres version 8.2 and above only).
778 * @param $table String: Name of the table to insert to.
779 * @param $args Array: Items to insert into the table.
780 * @param $fname String: Name of the function, for profiling
781 * @param string $options or Array. Valid options: IGNORE
783 * @return bool Success of insert operation. IGNORE always returns true.
785 function insert( $table, $args, $fname = __METHOD__, $options = array() ) {
786 if ( !count( $args ) ) {
790 $table = $this->tableName( $table );
791 if ( !isset( $this->numeric_version ) ) {
792 $this->getServerVersion();
795 if ( !is_array( $options ) ) {
796 $options = array( $options );
799 if ( isset( $args[0] ) && is_array( $args[0] ) ) {
801 $keys = array_keys( $args[0] );
804 $keys = array_keys( $args );
807 // If IGNORE is set, we use savepoints to emulate mysql's behavior
809 if ( in_array( 'IGNORE', $options ) ) {
810 $savepoint = new SavepointPostgres( $this, 'mw' );
811 $olde = error_reporting( 0 );
812 // For future use, we may want to track the number of actual inserts
813 // Right now, insert (all writes) simply return true/false
814 $numrowsinserted = 0;
817 $sql = "INSERT INTO $table (" . implode( ',', $keys ) . ') VALUES ';
820 if ( $this->numeric_version >= 8.2 && !$savepoint ) {
822 foreach ( $args as $row ) {
828 $sql .= '(' . $this->makeList( $row ) . ')';
830 $res = (bool)$this->query( $sql, $fname, $savepoint );
834 foreach ( $args as $row ) {
836 $tempsql .= '(' . $this->makeList( $row ) . ')';
839 $savepoint->savepoint();
842 $tempres = (bool)$this->query( $tempsql, $fname, $savepoint );
845 $bar = pg_last_error();
846 if ( $bar != false ) {
847 $savepoint->rollback();
849 $savepoint->release();
854 // If any of them fail, we fail overall for this function call
855 // Note that this will be ignored if IGNORE is set
862 // Not multi, just a lone insert
864 $savepoint->savepoint();
867 $sql .= '(' . $this->makeList( $args ) . ')';
868 $res = (bool)$this->query( $sql, $fname, $savepoint );
870 $bar = pg_last_error();
871 if ( $bar != false ) {
872 $savepoint->rollback();
874 $savepoint->release();
880 error_reporting( $olde );
881 $savepoint->commit();
883 // Set the affected row count for the whole operation
884 $this->mAffectedRows = $numrowsinserted;
886 // IGNORE always returns true
894 * INSERT SELECT wrapper
895 * $varMap must be an associative array of the form array( 'dest1' => 'source1', ...)
896 * Source items may be literals rather then field names, but strings should
897 * be quoted with Database::addQuotes()
898 * $conds may be "*" to copy the whole table
899 * srcTable may be an array of tables.
900 * @todo FIXME: Implement this a little better (seperate select/insert)?
903 function insertSelect( $destTable, $srcTable, $varMap, $conds, $fname = __METHOD__,
904 $insertOptions = array(), $selectOptions = array() ) {
905 $destTable = $this->tableName( $destTable );
907 if ( !is_array( $insertOptions ) ) {
908 $insertOptions = array( $insertOptions );
912 * If IGNORE is set, we use savepoints to emulate mysql's behavior
913 * Ignore LOW PRIORITY option, since it is MySQL-specific
916 if ( in_array( 'IGNORE', $insertOptions ) ) {
917 $savepoint = new SavepointPostgres( $this, 'mw' );
918 $olde = error_reporting( 0 );
919 $numrowsinserted = 0;
920 $savepoint->savepoint();
923 if ( !is_array( $selectOptions ) ) {
924 $selectOptions = array( $selectOptions );
926 list( $startOpts, $useIndex, $tailOpts ) = $this->makeSelectOptions( $selectOptions );
927 if ( is_array( $srcTable ) ) {
928 $srcTable = implode( ',', array_map( array( &$this, 'tableName' ), $srcTable ) );
930 $srcTable = $this->tableName( $srcTable );
933 $sql = "INSERT INTO $destTable (" . implode( ',', array_keys( $varMap ) ) . ')' .
934 " SELECT $startOpts " . implode( ',', $varMap ) .
935 " FROM $srcTable $useIndex";
937 if ( $conds != '*' ) {
938 $sql .= ' WHERE ' . $this->makeList( $conds, LIST_AND );
941 $sql .= " $tailOpts";
943 $res = (bool)$this->query( $sql, $fname, $savepoint );
945 $bar = pg_last_error();
946 if ( $bar != false ) {
947 $savepoint->rollback();
949 $savepoint->release();
952 error_reporting( $olde );
953 $savepoint->commit();
955 // Set the affected row count for the whole operation
956 $this->mAffectedRows = $numrowsinserted;
958 // IGNORE always returns true
965 function tableName( $name, $format = 'quoted' ) {
966 # Replace reserved words with better ones
969 return $this->realTableName( 'mwuser', $format );
971 return $this->realTableName( 'pagecontent', $format );
973 return $this->realTableName( $name, $format );
977 /* Don't cheat on installer */
978 function realTableName( $name, $format = 'quoted' ) {
979 return parent::tableName( $name, $format );
983 * Return the next in a sequence, save the value for retrieval via insertId()
986 function nextSequenceValue( $seqName ) {
987 $safeseq = str_replace( "'", "''", $seqName );
988 $res = $this->query( "SELECT nextval('$safeseq')" );
989 $row = $this->fetchRow( $res );
990 $this->mInsertId = $row[0];
992 return $this->mInsertId;
996 * Return the current value of a sequence. Assumes it has been nextval'ed in this session.
999 function currentSequenceValue( $seqName ) {
1000 $safeseq = str_replace( "'", "''", $seqName );
1001 $res = $this->query( "SELECT currval('$safeseq')" );
1002 $row = $this->fetchRow( $res );
1008 # Returns the size of a text field, or -1 for "unlimited"
1009 function textFieldSize( $table, $field ) {
1010 $table = $this->tableName( $table );
1011 $sql = "SELECT t.typname as ftype,a.atttypmod as size
1012 FROM pg_class c, pg_attribute a, pg_type t
1013 WHERE relname='$table' AND a.attrelid=c.oid AND
1014 a.atttypid=t.oid and a.attname='$field'";
1015 $res = $this->query( $sql );
1016 $row = $this->fetchObject( $res );
1017 if ( $row->ftype == 'varchar' ) {
1018 $size = $row->size - 4;
1026 function limitResult( $sql, $limit, $offset = false ) {
1027 return "$sql LIMIT $limit " . ( is_numeric( $offset ) ? " OFFSET {$offset} " : '' );
1030 function wasDeadlock() {
1031 return $this->lastErrno() == '40P01';
1034 function duplicateTableStructure( $oldName, $newName, $temporary = false, $fname = __METHOD__ ) {
1035 $newName = $this->addIdentifierQuotes( $newName );
1036 $oldName = $this->addIdentifierQuotes( $oldName );
1038 return $this->query( 'CREATE ' . ( $temporary ? 'TEMPORARY ' : '' ) . " TABLE $newName " .
1039 "(LIKE $oldName INCLUDING DEFAULTS)", $fname );
1042 function listTables( $prefix = null, $fname = __METHOD__ ) {
1043 $eschema = $this->addQuotes( $this->getCoreSchema() );
1044 $result = $this->query( "SELECT tablename FROM pg_tables WHERE schemaname = $eschema", $fname );
1045 $endArray = array();
1047 foreach ( $result as $table ) {
1048 $vars = get_object_vars( $table );
1049 $table = array_pop( $vars );
1050 if ( !$prefix || strpos( $table, $prefix ) === 0 ) {
1051 $endArray[] = $table;
1058 function timestamp( $ts = 0 ) {
1059 return wfTimestamp( TS_POSTGRES, $ts );
1063 * Posted by cc[plus]php[at]c2se[dot]com on 25-Mar-2009 09:12
1064 * to http://www.php.net/manual/en/ref.pgsql.php
1066 * Parsing a postgres array can be a tricky problem, he's my
1067 * take on this, it handles multi-dimensional arrays plus
1068 * escaping using a nasty regexp to determine the limits of each
1071 * This should really be handled by PHP PostgreSQL module
1074 * @param $text string: postgreql array returned in a text form like {a,b}
1075 * @param $output string
1077 * @param $offset int
1080 function pg_array_parse( $text, &$output, $limit = false, $offset = 1 ) {
1081 if ( false === $limit ) {
1082 $limit = strlen( $text ) - 1;
1085 if ( '{}' == $text ) {
1089 if ( '{' != $text[$offset] ) {
1090 preg_match( "/(\\{?\"([^\"\\\\]|\\\\.)*\"|[^,{}]+)+([,}]+)/",
1091 $text, $match, 0, $offset );
1092 $offset += strlen( $match[0] );
1093 $output[] = ( '"' != $match[1][0]
1095 : stripcslashes( substr( $match[1], 1, -1 ) ) );
1096 if ( '},' == $match[3] ) {
1100 $offset = $this->pg_array_parse( $text, $output, $limit, $offset + 1 );
1102 } while ( $limit > $offset );
1108 * Return aggregated value function call
1110 public function aggregateValue( $valuedata, $valuename = 'value' ) {
1115 * @return string wikitext of a link to the server software's web site
1117 public function getSoftwareLink() {
1118 return '[http://www.postgresql.org/ PostgreSQL]';
1122 * Return current schema (executes SELECT current_schema())
1126 * @return string return default schema for the current session
1128 function getCurrentSchema() {
1129 $res = $this->query( "SELECT current_schema()", __METHOD__ );
1130 $row = $this->fetchRow( $res );
1136 * Return list of schemas which are accessible without schema name
1137 * This is list does not contain magic keywords like "$user"
1140 * @see getSearchPath()
1141 * @see setSearchPath()
1143 * @return array list of actual schemas for the current sesson
1145 function getSchemas() {
1146 $res = $this->query( "SELECT current_schemas(false)", __METHOD__ );
1147 $row = $this->fetchRow( $res );
1150 /* PHP pgsql support does not support array type, "{a,b}" string is returned */
1152 return $this->pg_array_parse( $row[0], $schemas );
1156 * Return search patch for schemas
1157 * This is different from getSchemas() since it contain magic keywords
1162 * @return array how to search for table names schemas for the current user
1164 function getSearchPath() {
1165 $res = $this->query( "SHOW search_path", __METHOD__ );
1166 $row = $this->fetchRow( $res );
1168 /* PostgreSQL returns SHOW values as strings */
1170 return explode( ",", $row[0] );
1174 * Update search_path, values should already be sanitized
1175 * Values may contain magic keywords like "$user"
1178 * @param $search_path array list of schemas to be searched by default
1180 function setSearchPath( $search_path ) {
1181 $this->query( "SET search_path = " . implode( ", ", $search_path ) );
1185 * Determine default schema for MediaWiki core
1186 * Adjust this session schema search path if desired schema exists
1187 * and is not alread there.
1189 * We need to have name of the core schema stored to be able
1190 * to query database metadata.
1192 * This will be also called by the installer after the schema is created
1195 * @param $desired_schema string
1197 function determineCoreSchema( $desired_schema ) {
1198 $this->begin( __METHOD__ );
1199 if ( $this->schemaExists( $desired_schema ) ) {
1200 if ( in_array( $desired_schema, $this->getSchemas() ) ) {
1201 $this->mCoreSchema = $desired_schema;
1202 wfDebug( "Schema \"" . $desired_schema . "\" already in the search path\n" );
1205 * Prepend our schema (e.g. 'mediawiki') in front
1206 * of the search path
1209 $search_path = $this->getSearchPath();
1210 array_unshift( $search_path,
1211 $this->addIdentifierQuotes( $desired_schema ) );
1212 $this->setSearchPath( $search_path );
1213 $this->mCoreSchema = $desired_schema;
1214 wfDebug( "Schema \"" . $desired_schema . "\" added to the search path\n" );
1217 $this->mCoreSchema = $this->getCurrentSchema();
1218 wfDebug( "Schema \"" . $desired_schema . "\" not found, using current \"" .
1219 $this->mCoreSchema . "\"\n" );
1221 /* Commit SET otherwise it will be rollbacked on error or IGNORE SELECT */
1222 $this->commit( __METHOD__ );
1226 * Return schema name fore core MediaWiki tables
1229 * @return string core schema name
1231 function getCoreSchema() {
1232 return $this->mCoreSchema;
1236 * @return string Version information from the database
1238 function getServerVersion() {
1239 if ( !isset( $this->numeric_version ) ) {
1240 $versionInfo = pg_version( $this->mConn );
1241 if ( version_compare( $versionInfo['client'], '7.4.0', 'lt' ) ) {
1242 // Old client, abort install
1243 $this->numeric_version = '7.3 or earlier';
1244 } elseif ( isset( $versionInfo['server'] ) ) {
1246 $this->numeric_version = $versionInfo['server'];
1248 // Bug 16937: broken pgsql extension from PHP<5.3
1249 $this->numeric_version = pg_parameter_status( $this->mConn, 'server_version' );
1253 return $this->numeric_version;
1257 * Query whether a given relation exists (in the given schema, or the
1258 * default mw one if not given)
1261 function relationExists( $table, $types, $schema = false ) {
1262 if ( !is_array( $types ) ) {
1263 $types = array( $types );
1266 $schema = $this->getCoreSchema();
1268 $table = $this->realTableName( $table, 'raw' );
1269 $etable = $this->addQuotes( $table );
1270 $eschema = $this->addQuotes( $schema );
1271 $SQL = "SELECT 1 FROM pg_catalog.pg_class c, pg_catalog.pg_namespace n "
1272 . "WHERE c.relnamespace = n.oid AND c.relname = $etable AND n.nspname = $eschema "
1273 . "AND c.relkind IN ('" . implode( "','", $types ) . "')";
1274 $res = $this->query( $SQL );
1275 $count = $res ? $res->numRows() : 0;
1277 return (bool)$count;
1281 * For backward compatibility, this function checks both tables and
1285 function tableExists( $table, $fname = __METHOD__, $schema = false ) {
1286 return $this->relationExists( $table, array( 'r', 'v' ), $schema );
1289 function sequenceExists( $sequence, $schema = false ) {
1290 return $this->relationExists( $sequence, 'S', $schema );
1293 function triggerExists( $table, $trigger ) {
1295 SELECT 1 FROM pg_class, pg_namespace, pg_trigger
1296 WHERE relnamespace=pg_namespace.oid AND relkind='r'
1297 AND tgrelid=pg_class.oid
1298 AND nspname=%s AND relname=%s AND tgname=%s
1300 $res = $this->query(
1303 $this->addQuotes( $this->getCoreSchema() ),
1304 $this->addQuotes( $table ),
1305 $this->addQuotes( $trigger )
1311 $rows = $res->numRows();
1316 function ruleExists( $table, $rule ) {
1317 $exists = $this->selectField( 'pg_rules', 'rulename',
1319 'rulename' => $rule,
1320 'tablename' => $table,
1321 'schemaname' => $this->getCoreSchema()
1325 return $exists === $rule;
1328 function constraintExists( $table, $constraint ) {
1329 $SQL = sprintf( "SELECT 1 FROM information_schema.table_constraints " .
1330 "WHERE constraint_schema = %s AND table_name = %s AND constraint_name = %s",
1331 $this->addQuotes( $this->getCoreSchema() ),
1332 $this->addQuotes( $table ),
1333 $this->addQuotes( $constraint )
1335 $res = $this->query( $SQL );
1339 $rows = $res->numRows();
1345 * Query whether a given schema exists. Returns true if it does, false if it doesn't.
1348 function schemaExists( $schema ) {
1349 $exists = $this->selectField( '"pg_catalog"."pg_namespace"', 1,
1350 array( 'nspname' => $schema ), __METHOD__ );
1352 return (bool)$exists;
1356 * Returns true if a given role (i.e. user) exists, false otherwise.
1359 function roleExists( $roleName ) {
1360 $exists = $this->selectField( '"pg_catalog"."pg_roles"', 1,
1361 array( 'rolname' => $roleName ), __METHOD__ );
1363 return (bool)$exists;
1366 function fieldInfo( $table, $field ) {
1367 return PostgresField::fromText( $this, $table, $field );
1371 * pg_field_type() wrapper
1374 function fieldType( $res, $index ) {
1375 if ( $res instanceof ResultWrapper ) {
1376 $res = $res->result;
1379 return pg_field_type( $res, $index );
1386 function encodeBlob( $b ) {
1387 return new Blob( pg_escape_bytea( $this->mConn, $b ) );
1390 function decodeBlob( $b ) {
1391 if ( $b instanceof Blob ) {
1395 return pg_unescape_bytea( $b );
1398 function strencode( $s ) { # Should not be called by us
1399 return pg_escape_string( $this->mConn, $s );
1403 * @param $s null|bool|Blob
1404 * @return int|string
1406 function addQuotes( $s ) {
1407 if ( is_null( $s ) ) {
1409 } elseif ( is_bool( $s ) ) {
1410 return intval( $s );
1411 } elseif ( $s instanceof Blob ) {
1412 return "'" . $s->fetch( $s ) . "'";
1415 return "'" . pg_escape_string( $this->mConn, $s ) . "'";
1419 * Postgres specific version of replaceVars.
1420 * Calls the parent version in Database.php
1424 * @param string $ins SQL string, read from a stream (usually tables.sql)
1426 * @return string SQL string
1428 protected function replaceVars( $ins ) {
1429 $ins = parent::replaceVars( $ins );
1431 if ( $this->numeric_version >= 8.3 ) {
1432 // Thanks for not providing backwards-compatibility, 8.3
1433 $ins = preg_replace( "/to_tsvector\s*\(\s*'default'\s*,/", 'to_tsvector(', $ins );
1436 if ( $this->numeric_version <= 8.1 ) { // Our minimum version
1437 $ins = str_replace( 'USING gin', 'USING gist', $ins );
1444 * Various select options
1448 * @param array $options an associative array of options to be turned into
1449 * an SQL query, valid keys are listed in the function.
1452 function makeSelectOptions( $options ) {
1453 $preLimitTail = $postLimitTail = '';
1454 $startOpts = $useIndex = '';
1456 $noKeyOptions = array();
1457 foreach ( $options as $key => $option ) {
1458 if ( is_numeric( $key ) ) {
1459 $noKeyOptions[$option] = true;
1463 $preLimitTail .= $this->makeGroupByWithHaving( $options );
1465 $preLimitTail .= $this->makeOrderBy( $options );
1467 //if ( isset( $options['LIMIT'] ) ) {
1468 // $tailOpts .= $this->limitResult( '', $options['LIMIT'],
1469 // isset( $options['OFFSET'] ) ? $options['OFFSET']
1473 if ( isset( $noKeyOptions['FOR UPDATE'] ) ) {
1474 $postLimitTail .= ' FOR UPDATE';
1476 if ( isset( $noKeyOptions['DISTINCT'] ) || isset( $noKeyOptions['DISTINCTROW'] ) ) {
1477 $startOpts .= 'DISTINCT';
1480 return array( $startOpts, $useIndex, $preLimitTail, $postLimitTail );
1483 function setFakeMaster( $enabled = true ) {
1486 function getDBname() {
1487 return $this->mDBname;
1490 function getServer() {
1491 return $this->mServer;
1494 function buildConcat( $stringList ) {
1495 return implode( ' || ', $stringList );
1498 public function buildGroupConcatField(
1499 $delimiter, $table, $field, $conds = '', $options = array(), $join_conds = array()
1501 $fld = "array_to_string(array_agg($field)," . $this->addQuotes( $delimiter ) . ')';
1503 return '(' . $this->selectSQLText( $table, $fld, $conds, null, array(), $join_conds ) . ')';
1506 public function getSearchEngine() {
1507 return 'SearchPostgres';
1510 public function streamStatementEnd( &$sql, &$newLine ) {
1511 # Allow dollar quoting for function declarations
1512 if ( substr( $newLine, 0, 4 ) == '$mw$' ) {
1513 if ( $this->delimiter ) {
1514 $this->delimiter = false;
1516 $this->delimiter = ';';
1520 return parent::streamStatementEnd( $sql, $newLine );
1524 * Check to see if a named lock is available. This is non-blocking.
1525 * See http://www.postgresql.org/docs/8.2/static/functions-admin.html#FUNCTIONS-ADVISORY-LOCKS
1527 * @param string $lockName name of lock to poll
1528 * @param string $method name of method calling us
1532 public function lockIsFree( $lockName, $method ) {
1533 $key = $this->addQuotes( $this->bigintFromLockName( $lockName ) );
1534 $result = $this->query( "SELECT (CASE(pg_try_advisory_lock($key))
1535 WHEN 'f' THEN 'f' ELSE pg_advisory_unlock($key) END) AS lockstatus", $method );
1536 $row = $this->fetchObject( $result );
1538 return ( $row->lockstatus === 't' );
1542 * See http://www.postgresql.org/docs/8.2/static/functions-admin.html#FUNCTIONS-ADVISORY-LOCKS
1543 * @param $lockName string
1544 * @param $method string
1545 * @param $timeout int
1548 public function lock( $lockName, $method, $timeout = 5 ) {
1549 $key = $this->addQuotes( $this->bigintFromLockName( $lockName ) );
1550 for ( $attempts = 1; $attempts <= $timeout; ++$attempts ) {
1551 $result = $this->query(
1552 "SELECT pg_try_advisory_lock($key) AS lockstatus", $method );
1553 $row = $this->fetchObject( $result );
1554 if ( $row->lockstatus === 't' ) {
1560 wfDebug( __METHOD__ . " failed to acquire lock\n" );
1566 * See http://www.postgresql.org/docs/8.2/static/functions-admin.html#FUNCTIONS-ADVISORY-LOCKSFROM
1567 * PG DOCS: http://www.postgresql.org/docs/8.2/static/functions-admin.html#FUNCTIONS-ADVISORY-LOCKS
1568 * @param $lockName string
1569 * @param $method string
1572 public function unlock( $lockName, $method ) {
1573 $key = $this->addQuotes( $this->bigintFromLockName( $lockName ) );
1574 $result = $this->query( "SELECT pg_advisory_unlock($key) as lockstatus", $method );
1575 $row = $this->fetchObject( $result );
1577 return ( $row->lockstatus === 't' );
1581 * @param string $lockName
1582 * @return string Integer
1584 private function bigintFromLockName( $lockName ) {
1585 return wfBaseConvert( substr( sha1( $lockName ), 0, 15 ), 16, 10 );
1587 } // end DatabasePostgres class