3 * This is the Postgres database abstraction layer.
9 class PostgresField
implements Field
{
10 private $name, $tablename, $type, $nullable, $max_length, $deferred, $deferrable, $conname;
12 static function fromText($db, $table, $field) {
17 attnotnull, attlen, COALESCE(conname, '') AS conname,
18 COALESCE(condeferred, 'f') AS deferred,
19 COALESCE(condeferrable, 'f') AS deferrable,
20 CASE WHEN typname = 'int2' THEN 'smallint'
21 WHEN typname = 'int4' THEN 'integer'
22 WHEN typname = 'int8' THEN 'bigint'
23 WHEN typname = 'bpchar' THEN 'char'
24 ELSE typname END AS typname
26 JOIN pg_namespace n ON (n.oid = c.relnamespace)
27 JOIN pg_attribute a ON (a.attrelid = c.oid)
28 JOIN pg_type t ON (t.oid = a.atttypid)
29 LEFT JOIN pg_constraint o ON (o.conrelid = c.oid AND a.attnum = ANY(o.conkey) AND o.contype = 'f')
36 $table = $db->tableName( $table );
39 $db->addQuotes( $wgDBmwschema ),
40 $db->addQuotes( $table ),
41 $db->addQuotes( $field )
44 $row = $db->fetchObject( $res );
48 $n = new PostgresField
;
49 $n->type
= $row->typname
;
50 $n->nullable
= ( $row->attnotnull
== 'f' );
52 $n->tablename
= $table;
53 $n->max_length
= $row->attlen
;
54 $n->deferrable
= ( $row->deferrable
== 't' );
55 $n->deferred
= ( $row->deferred
== 't' );
56 $n->conname
= $row->conname
;
64 function tableName() {
65 return $this->tablename
;
72 function isNullable() {
73 return $this->nullable
;
76 function maxLength() {
77 return $this->max_length
;
80 function is_deferrable() {
81 return $this->deferrable
;
84 function is_deferred() {
85 return $this->deferred
;
89 return $this->conname
;
97 class DatabasePostgres
extends DatabaseBase
{
98 var $mInsertId = null;
99 var $mLastResult = null;
100 var $numeric_version = null;
101 var $mAffectedRows = null;
103 function __construct( $server = false, $user = false, $password = false, $dbName = false,
106 $this->mFlags
= $flags;
107 $this->open( $server, $user, $password, $dbName );
114 function cascadingDeletes() {
117 function cleanupTriggers() {
120 function strictIPs() {
123 function realTimestamps() {
126 function implicitGroupby() {
129 function implicitOrderby() {
132 function searchableIPs() {
135 function functionalIndexes() {
139 function hasConstraint( $name ) {
140 global $wgDBmwschema;
141 $SQL = "SELECT 1 FROM pg_catalog.pg_constraint c, pg_catalog.pg_namespace n WHERE c.connamespace = n.oid AND conname = '" .
142 pg_escape_string( $this->mConn
, $name ) . "' AND n.nspname = '" . pg_escape_string( $this->mConn
, $wgDBmwschema ) ."'";
143 $res = $this->doQuery( $SQL );
144 return $this->numRows( $res );
147 static function newFromParams( $server, $user, $password, $dbName, $flags = 0 ) {
148 return new DatabasePostgres( $server, $user, $password, $dbName, $flags );
152 * Usually aborts on failure
154 function open( $server, $user, $password, $dbName ) {
155 # Test for Postgres support, to avoid suppressed fatal error
156 if ( !function_exists( 'pg_connect' ) ) {
157 throw new DBConnectionError( $this, "Postgres functions missing, have you compiled PHP with the --with-pgsql option?\n (Note: if you recently installed PHP, you may need to restart your webserver and database)\n" );
162 if ( !strlen( $user ) ) { # e.g. the class is being loaded
166 $this->mServer
= $server;
167 $this->mPort
= $port = $wgDBport;
168 $this->mUser
= $user;
169 $this->mPassword
= $password;
170 $this->mDBname
= $dbName;
172 $connectVars = array(
175 'password' => $password
177 if ( $server != false && $server != '' ) {
178 $connectVars['host'] = $server;
180 if ( $port != false && $port != '' ) {
181 $connectVars['port'] = $port;
183 $connectString = $this->makeConnectionString( $connectVars, PGSQL_CONNECT_FORCE_NEW
);
185 $this->installErrorHandler();
186 $this->mConn
= pg_connect( $connectString );
187 $phpError = $this->restoreErrorHandler();
189 if ( !$this->mConn
) {
190 wfDebug( "DB connection error\n" );
191 wfDebug( "Server: $server, Database: $dbName, User: $user, Password: " . substr( $password, 0, 3 ) . "...\n" );
192 wfDebug( $this->lastError() . "\n" );
193 throw new DBConnectionError( $this, $phpError );
196 $this->mOpened
= true;
198 global $wgCommandLineMode;
199 # If called from the command-line (e.g. importDump), only show errors
200 if ( $wgCommandLineMode ) {
201 $this->doQuery( "SET client_min_messages = 'ERROR'" );
204 $this->doQuery( "SET client_encoding='UTF8'" );
206 global $wgDBmwschema, $wgDBts2schema;
207 if ( isset( $wgDBmwschema ) && isset( $wgDBts2schema )
208 && $wgDBmwschema !== 'mediawiki'
209 && preg_match( '/^\w+$/', $wgDBmwschema )
210 && preg_match( '/^\w+$/', $wgDBts2schema )
212 $safeschema = $this->addIdentifierQuotes( $wgDBmwschema );
213 $this->doQuery( "SET search_path = $safeschema, $wgDBts2schema, public" );
219 function makeConnectionString( $vars ) {
221 foreach ( $vars as $name => $value ) {
222 $s .= "$name='" . str_replace( "'", "\\'", $value ) . "' ";
228 function initial_setup( $superuser, $password, $dbName ) {
229 // If this is the initial connection, setup the schema stuff and possibly create the user
230 global $wgDBname, $wgDBuser, $wgDBpassword, $wgDBmwschema, $wgDBts2schema;
232 print '<li>Checking the version of Postgres...';
233 $version = $this->getServerVersion();
235 if ( $version < $PGMINVER ) {
236 print "<b>FAILED</b>. Required version is $PGMINVER. You have " . htmlspecialchars( $version ) . "</li>\n";
239 print 'version ' . htmlspecialchars( $this->numeric_version
) . " is OK.</li>\n";
241 $safeuser = $this->addIdentifierQuotes( $wgDBuser );
242 // Are we connecting as a superuser for the first time?
244 // Are we really a superuser? Check out our rights
246 CASE WHEN usesuper IS TRUE THEN
247 CASE WHEN usecreatedb IS TRUE THEN 3 ELSE 1 END
248 ELSE CASE WHEN usecreatedb IS TRUE THEN 2 ELSE 0 END
250 FROM pg_catalog.pg_user WHERE usename = " . $this->addQuotes( $superuser );
251 $rows = $this->numRows( $res = $this->doQuery( $SQL ) );
253 print '<li>ERROR: Could not read permissions for user "' . htmlspecialchars( $superuser ) . "\"</li>\n";
256 $perms = pg_fetch_result( $res, 0, 0 );
258 $SQL = "SELECT 1 FROM pg_catalog.pg_user WHERE usename = " . $this->addQuotes( $wgDBuser );
259 $rows = $this->numRows( $this->doQuery( $SQL ) );
261 print '<li>User "' . htmlspecialchars( $wgDBuser ) . '" already exists, skipping account creation.</li>';
263 if ( $perms != 1 && $perms != 3 ) {
264 print '<li>ERROR: the user "' . htmlspecialchars( $superuser ) . '" cannot create other users. ';
265 print 'Please use a different Postgres user.</li>';
268 print '<li>Creating user <b>' . htmlspecialchars( $wgDBuser ) . '</b>...';
269 $safepass = $this->addQuotes( $wgDBpassword );
270 $SQL = "CREATE USER $safeuser NOCREATEDB PASSWORD $safepass";
271 $this->doQuery( $SQL );
274 // User now exists, check out the database
275 if ( $dbName != $wgDBname ) {
276 $SQL = "SELECT 1 FROM pg_catalog.pg_database WHERE datname = " . $this->addQuotes( $wgDBname );
277 $rows = $this->numRows( $this->doQuery( $SQL ) );
279 print '<li>Database "' . htmlspecialchars( $wgDBname ) . '" already exists, skipping database creation.</li>';
282 print '<li>ERROR: the user "' . htmlspecialchars( $superuser ) . '" cannot create databases. ';
283 print 'Please use a different Postgres user.</li>';
286 print '<li>Creating database <b>' . htmlspecialchars( $wgDBname ) . '</b>...';
287 $safename = $this->addIdentifierQuotes( $wgDBname );
288 $SQL = "CREATE DATABASE $safename OWNER $safeuser ";
289 $this->doQuery( $SQL );
291 // Hopefully tsearch2 and plpgsql are in template1...
294 // Reconnect to check out tsearch2 rights for this user
295 print '<li>Connecting to "' . htmlspecialchars( $wgDBname ) . '" as superuser "' .
296 htmlspecialchars( $superuser ) . '" to check rights...';
298 $connectVars = array();
299 if ( $this->mServer
!= false && $this->mServer
!= '' ) {
300 $connectVars['host'] = $this->mServer
;
302 if ( $this->mPort
!= false && $this->mPort
!= '' ) {
303 $connectVars['port'] = $this->mPort
;
305 $connectVars['dbname'] = $wgDBname;
306 $connectVars['user'] = $superuser;
307 $connectVars['password'] = $password;
309 @$this->mConn
= pg_connect( $this->makeConnectionString( $connectVars ) );
310 if ( !$this->mConn
) {
311 print "<b>FAILED TO CONNECT!</b></li>";
317 if ( $this->numeric_version
< 8.3 ) {
319 print '<li>Checking that tsearch2 is installed in the database "' .
320 htmlspecialchars( $wgDBname ) . '"...';
321 if ( !$this->tableExists( 'pg_ts_cfg', $wgDBts2schema ) ) {
322 print '<b>FAILED</b>. tsearch2 must be installed in the database "' .
323 htmlspecialchars( $wgDBname ) . '".';
324 print 'Please see <a href="http://www.devx.com/opensource/Article/21674/0/page/2">this article</a>';
325 print " for instructions or ask on #postgresql on irc.freenode.net</li>\n";
329 print '<li>Ensuring that user "' . htmlspecialchars( $wgDBuser ) .
330 '" has select rights on the tsearch2 tables...';
331 foreach ( array( 'cfg', 'cfgmap', 'dict', 'parser' ) as $table ) {
332 $SQL = "GRANT SELECT ON pg_ts_$table TO $safeuser";
333 $this->doQuery( $SQL );
338 // Setup the schema for this user if needed
339 $result = $this->schemaExists( $wgDBmwschema );
340 $safeschema = $this->addIdentifierQuotes( $wgDBmwschema );
342 print '<li>Creating schema <b>' . htmlspecialchars( $wgDBmwschema ) . '</b> ...';
343 $result = $this->doQuery( "CREATE SCHEMA $safeschema AUTHORIZATION $safeuser" );
345 print "<b>FAILED</b>.</li>\n";
350 print "<li>Schema already exists, explicitly granting rights...\n";
351 $safeschema2 = $this->addQuotes( $wgDBmwschema );
352 $SQL = "SELECT 'GRANT ALL ON '||pg_catalog.quote_ident(relname)||' TO $safeuser;'\n".
353 "FROM pg_catalog.pg_class p, pg_catalog.pg_namespace n\n".
354 "WHERE relnamespace = n.oid AND n.nspname = $safeschema2\n".
355 "AND p.relkind IN ('r','S','v')\n";
357 $SQL .= "SELECT 'GRANT ALL ON FUNCTION '||pg_catalog.quote_ident(proname)||'('||\n".
358 "pg_catalog.oidvectortypes(p.proargtypes)||') TO $safeuser;'\n".
359 "FROM pg_catalog.pg_proc p, pg_catalog.pg_namespace n\n".
360 "WHERE p.pronamespace = n.oid AND n.nspname = $safeschema2";
361 $res = $this->doQuery( $SQL );
363 print "<b>FAILED</b>. Could not set rights for the user.</li>\n";
366 $this->doQuery( "SET search_path = $safeschema" );
367 $rows = $this->numRows( $res );
370 $this->doQuery( pg_fetch_result( $res, $rows, 0 ) );
375 // Install plpgsql if needed
376 $this->setup_plpgsql();
378 return true; // Reconnect as regular user
382 if ( !defined( 'POSTGRES_SEARCHPATH' ) ) {
384 if ( $this->numeric_version
< 8.3 ) {
385 // Do we have the basic tsearch2 table?
386 print '<li>Checking for tsearch2 in the schema "' . htmlspecialchars( $wgDBts2schema ) . '"...';
387 if ( !$this->tableExists( 'pg_ts_dict', $wgDBts2schema ) ) {
388 print '<b>FAILED</b>. Make sure tsearch2 is installed. See <a href="';
389 print 'http://www.devx.com/opensource/Article/21674/0/page/2">this article</a>';
390 print " for instructions.</li>\n";
395 // Does this user have the rights to the tsearch2 tables?
396 $ctype = pg_fetch_result( $this->doQuery( 'SHOW lc_ctype' ), 0, 0 );
397 print '<li>Checking tsearch2 permissions...';
398 // Let's check all four, just to be safe
399 error_reporting( 0 );
400 $ts2tables = array( 'cfg', 'cfgmap', 'dict', 'parser' );
401 $safetsschema = $this->addIdentifierQuotes( $wgDBts2schema );
402 foreach ( $ts2tables as $tname ) {
403 $SQL = "SELECT count(*) FROM $safetsschema.pg_ts_$tname";
404 $res = $this->doQuery( $SQL );
406 print "<b>FAILED</b> to access " . htmlspecialchars( "pg_ts_$tname" ) .
407 ". Make sure that the user \"". htmlspecialchars( $wgDBuser ) .
408 "\" has SELECT access to all four tsearch2 tables</li>\n";
412 $SQL = "SELECT ts_name FROM $safetsschema.pg_ts_cfg WHERE locale = " . $this->addQuotes( $ctype ) ;
413 $SQL .= " ORDER BY CASE WHEN ts_name <> 'default' THEN 1 ELSE 0 END";
414 $res = $this->doQuery( $SQL );
415 error_reporting( E_ALL
);
417 print "<b>FAILED</b>. Could not determine the tsearch2 locale information</li>\n";
422 // Will the current locale work? Can we force it to?
423 print '<li>Verifying tsearch2 locale with ' . htmlspecialchars( $ctype ) . '...';
424 $rows = $this->numRows( $res );
427 print "<b>not found</b></li>\n";
428 print '<li>Attempting to set default tsearch2 locale to "' . htmlspecialchars( $ctype ) . '"...';
431 $tsname = pg_fetch_result( $res, 0, 0 );
432 if ( $tsname != 'default' ) {
433 print "<b>not set to default (" . htmlspecialchars( $tsname ) . ")</b>";
434 print "<li>Attempting to change tsearch2 default locale to \"" .
435 htmlspecialchars( $ctype ) . "\"...";
439 if ( $resetlocale ) {
440 $SQL = "UPDATE $safetsschema.pg_ts_cfg SET locale = " . $this->addQuotes( $ctype ) . " WHERE ts_name = 'default'";
441 $res = $this->doQuery( $SQL );
443 print '<b>FAILED</b>. ';
444 print 'Please make sure that the locale in pg_ts_cfg for "default" is set to "' .
445 htmlspecialchars( $ctype ) . "\"</li>\n";
451 // Final test: try out a simple tsearch2 query
452 $SQL = "SELECT $safetsschema.to_tsvector('default','MediaWiki tsearch2 testing')";
453 $res = $this->doQuery( $SQL );
455 print '<b>FAILED</b>. Specifically, "' . htmlspecialchars( $SQL ) . '" did not work.</li>';
461 // Install plpgsql if needed
462 $this->setup_plpgsql();
464 // Does the schema already exist? Who owns it?
465 $result = $this->schemaExists( $wgDBmwschema );
467 print '<li>Creating schema <b>' . htmlspecialchars( $wgDBmwschema ) . '</b> ...';
468 error_reporting( 0 );
469 $safeschema = $this->addIdentifierQuotes( $wgDBmwschema );
470 $result = $this->doQuery( "CREATE SCHEMA $safeschema" );
471 error_reporting( E_ALL
);
473 print '<b>FAILED</b>. The user "' . htmlspecialchars( $wgDBuser ) .
474 '" must be able to access the schema. '.
475 'You can try making them the owner of the database, or try creating the schema with a '.
476 'different user, and then grant access to the "' .
477 htmlspecialchars( $wgDBuser ) . "\" user.</li>\n";
481 } elseif ( $result != $wgDBuser ) {
482 print '<li>Schema "' . htmlspecialchars( $wgDBmwschema ) . '" exists but is not owned by "' .
483 htmlspecialchars( $wgDBuser ) . "\". Not ideal.</li>\n";
485 print '<li>Schema "' . htmlspecialchars( $wgDBmwschema ) . '" exists and is owned by "' .
486 htmlspecialchars( $wgDBuser ) . "\". Excellent.</li>\n";
489 // Always return GMT time to accomodate the existing integer-based timestamp assumption
490 print "<li>Setting the timezone to GMT for user \"" . htmlspecialchars( $wgDBuser ) . '" ...';
491 $SQL = "ALTER USER $safeuser SET timezone = 'GMT'";
492 $result = pg_query( $this->mConn
, $SQL );
494 print "<b>FAILED</b>.</li>\n";
498 // Set for the rest of this session
499 $SQL = "SET timezone = 'GMT'";
500 $result = pg_query( $this->mConn
, $SQL );
502 print "<li>Failed to set timezone</li>\n";
506 print '<li>Setting the datestyle to ISO, YMD for user "' . htmlspecialchars( $wgDBuser ) . '" ...';
507 $SQL = "ALTER USER $safeuser SET datestyle = 'ISO, YMD'";
508 $result = pg_query( $this->mConn
, $SQL );
510 print "<b>FAILED</b>.</li>\n";
514 // Set for the rest of this session
515 $SQL = "SET datestyle = 'ISO, YMD'";
516 $result = pg_query( $this->mConn
, $SQL );
518 print "<li>Failed to set datestyle</li>\n";
522 // Fix up the search paths if needed
523 print '<li>Setting the search path for user "' . htmlspecialchars( $wgDBuser ) . '" ...';
524 $path = $this->addIdentifierQuotes( $wgDBmwschema );
525 if ( $wgDBts2schema !== $wgDBmwschema ) {
526 $path .= ', '. $this->addIdentifierQuotes( $wgDBts2schema );
528 if ( $wgDBmwschema !== 'public' && $wgDBts2schema !== 'public' ) {
531 $SQL = "ALTER USER $safeuser SET search_path = $path";
532 $result = pg_query( $this->mConn
, $SQL );
534 print "<b>FAILED</b>.</li>\n";
538 // Set for the rest of this session
539 $SQL = "SET search_path = $path";
540 $result = pg_query( $this->mConn
, $SQL );
542 print "<li>Failed to set search_path</li>\n";
545 define( 'POSTGRES_SEARCHPATH', $path );
549 function setup_plpgsql() {
550 print '<li>Checking for PL/pgSQL ...';
551 $SQL = "SELECT 1 FROM pg_catalog.pg_language WHERE lanname = 'plpgsql'";
552 $rows = $this->numRows( $this->doQuery( $SQL ) );
554 // plpgsql is not installed, but if we have a pg_pltemplate table, we should be able to create it
555 print 'not installed. Attempting to install PL/pgSQL ...';
556 $SQL = "SELECT 1 FROM pg_catalog.pg_class c JOIN pg_catalog.pg_namespace n ON (n.oid = c.relnamespace) ".
557 "WHERE relname = 'pg_pltemplate' AND nspname='pg_catalog'";
558 $rows = $this->numRows( $this->doQuery( $SQL ) );
561 $olde = error_reporting( 0 );
562 error_reporting( $olde - E_WARNING
);
563 $result = $this->doQuery( 'CREATE LANGUAGE plpgsql' );
564 error_reporting( $olde );
566 print '<b>FAILED</b>. You need to install the language PL/pgSQL in the database <tt>' .
567 htmlspecialchars( $wgDBname ) . '</tt></li>';
571 print '<b>FAILED</b>. You need to install the language PL/pgSQL in the database <tt>' .
572 htmlspecialchars( $wgDBname ) . '</tt></li>';
580 * Closes a database connection, if it is open
581 * Returns success, true if already closed
584 $this->mOpened
= false;
585 if ( $this->mConn
) {
586 return pg_close( $this->mConn
);
592 function doQuery( $sql ) {
593 if ( function_exists( 'mb_convert_encoding' ) ) {
594 $sql = mb_convert_encoding( $sql, 'UTF-8' );
596 $this->mLastResult
= pg_query( $this->mConn
, $sql );
597 $this->mAffectedRows
= null; // use pg_affected_rows(mLastResult)
598 return $this->mLastResult
;
601 function queryIgnore( $sql, $fname = 'DatabasePostgres::queryIgnore' ) {
602 return $this->query( $sql, $fname, true );
605 function freeResult( $res ) {
606 if ( $res instanceof ResultWrapper
) {
609 if ( !@pg_free_result
( $res ) ) {
610 throw new DBUnexpectedError( $this, "Unable to free Postgres result\n" );
614 function fetchObject( $res ) {
615 if ( $res instanceof ResultWrapper
) {
618 @$row = pg_fetch_object( $res );
619 # FIXME: HACK HACK HACK HACK debug
622 # hashar : not sure if the following test really trigger if the object
624 if( pg_last_error( $this->mConn
) ) {
625 throw new DBUnexpectedError( $this, 'SQL error: ' . htmlspecialchars( pg_last_error( $this->mConn
) ) );
630 function fetchRow( $res ) {
631 if ( $res instanceof ResultWrapper
) {
634 @$row = pg_fetch_array( $res );
635 if( pg_last_error( $this->mConn
) ) {
636 throw new DBUnexpectedError( $this, 'SQL error: ' . htmlspecialchars( pg_last_error( $this->mConn
) ) );
641 function numRows( $res ) {
642 if ( $res instanceof ResultWrapper
) {
645 @$n = pg_num_rows( $res );
646 if( pg_last_error( $this->mConn
) ) {
647 throw new DBUnexpectedError( $this, 'SQL error: ' . htmlspecialchars( pg_last_error( $this->mConn
) ) );
652 function numFields( $res ) {
653 if ( $res instanceof ResultWrapper
) {
656 return pg_num_fields( $res );
659 function fieldName( $res, $n ) {
660 if ( $res instanceof ResultWrapper
) {
663 return pg_field_name( $res, $n );
667 * This must be called after nextSequenceVal
669 function insertId() {
670 return $this->mInsertId
;
673 function dataSeek( $res, $row ) {
674 if ( $res instanceof ResultWrapper
) {
677 return pg_result_seek( $res, $row );
680 function lastError() {
681 if ( $this->mConn
) {
682 return pg_last_error();
684 return 'No database connection';
687 function lastErrno() {
688 return pg_last_error() ?
1 : 0;
691 function affectedRows() {
692 if ( !is_null( $this->mAffectedRows
) ) {
693 // Forced result for simulated queries
694 return $this->mAffectedRows
;
696 if( empty( $this->mLastResult
) ) {
699 return pg_affected_rows( $this->mLastResult
);
703 * Estimate rows in dataset
704 * Returns estimated count, based on EXPLAIN output
705 * This is not necessarily an accurate estimate, so use sparingly
706 * Returns -1 if count cannot be found
707 * Takes same arguments as Database::select()
709 function estimateRowCount( $table, $vars = '*', $conds='', $fname = 'DatabasePostgres::estimateRowCount', $options = array() ) {
710 $options['EXPLAIN'] = true;
711 $res = $this->select( $table, $vars, $conds, $fname, $options );
714 $row = $this->fetchRow( $res );
716 if( preg_match( '/rows=(\d+)/', $row[0], $count ) ) {
724 * Returns information about an index
725 * If errors are explicitly ignored, returns NULL on failure
727 function indexInfo( $table, $index, $fname = 'DatabasePostgres::indexInfo' ) {
728 $sql = "SELECT indexname FROM pg_indexes WHERE tablename='$table'";
729 $res = $this->query( $sql, $fname );
733 foreach ( $res as $row ) {
734 if ( $row->indexname
== $this->indexName( $index ) ) {
741 function indexUnique( $table, $index, $fname = 'DatabasePostgres::indexUnique' ) {
742 $sql = "SELECT indexname FROM pg_indexes WHERE tablename='{$table}'".
743 " AND indexdef LIKE 'CREATE UNIQUE%(" .
744 $this->strencode( $this->indexName( $index ) ) .
746 $res = $this->query( $sql, $fname );
750 foreach ( $res as $row ) {
757 * INSERT wrapper, inserts an array into a table
759 * $args may be a single associative array, or an array of these with numeric keys,
760 * for multi-row insert (Postgres version 8.2 and above only).
762 * @param $table String: Name of the table to insert to.
763 * @param $args Array: Items to insert into the table.
764 * @param $fname String: Name of the function, for profiling
765 * @param $options String or Array. Valid options: IGNORE
767 * @return bool Success of insert operation. IGNORE always returns true.
769 function insert( $table, $args, $fname = 'DatabasePostgres::insert', $options = array() ) {
770 if ( !count( $args ) ) {
774 $table = $this->tableName( $table );
775 if (! isset( $this->numeric_version
) ) {
776 $this->getServerVersion();
779 if ( !is_array( $options ) ) {
780 $options = array( $options );
783 if ( isset( $args[0] ) && is_array( $args[0] ) ) {
785 $keys = array_keys( $args[0] );
788 $keys = array_keys( $args );
791 // If IGNORE is set, we use savepoints to emulate mysql's behavior
792 $ignore = in_array( 'IGNORE', $options ) ?
'mw' : '';
794 // If we are not in a transaction, we need to be for savepoint trickery
797 if ( !$this->mTrxLevel
) {
801 $olde = error_reporting( 0 );
802 // For future use, we may want to track the number of actual inserts
803 // Right now, insert (all writes) simply return true/false
804 $numrowsinserted = 0;
807 $sql = "INSERT INTO $table (" . implode( ',', $keys ) . ') VALUES ';
810 if ( $this->numeric_version
>= 8.2 && !$ignore ) {
812 foreach ( $args as $row ) {
818 $sql .= '(' . $this->makeList( $row ) . ')';
820 $res = (bool)$this->query( $sql, $fname, $ignore );
824 foreach ( $args as $row ) {
826 $tempsql .= '(' . $this->makeList( $row ) . ')';
829 pg_query( $this->mConn
, "SAVEPOINT $ignore" );
832 $tempres = (bool)$this->query( $tempsql, $fname, $ignore );
835 $bar = pg_last_error();
836 if ( $bar != false ) {
837 pg_query( $this->mConn
, "ROLLBACK TO $ignore" );
839 pg_query( $this->mConn
, "RELEASE $ignore" );
844 // If any of them fail, we fail overall for this function call
845 // Note that this will be ignored if IGNORE is set
852 // Not multi, just a lone insert
854 pg_query($this->mConn
, "SAVEPOINT $ignore");
857 $sql .= '(' . $this->makeList( $args ) . ')';
858 $res = (bool)$this->query( $sql, $fname, $ignore );
860 $bar = pg_last_error();
861 if ( $bar != false ) {
862 pg_query( $this->mConn
, "ROLLBACK TO $ignore" );
864 pg_query( $this->mConn
, "RELEASE $ignore" );
870 $olde = error_reporting( $olde );
875 // Set the affected row count for the whole operation
876 $this->mAffectedRows
= $numrowsinserted;
878 // IGNORE always returns true
886 * INSERT SELECT wrapper
887 * $varMap must be an associative array of the form array( 'dest1' => 'source1', ...)
888 * Source items may be literals rather then field names, but strings should be quoted with Database::addQuotes()
889 * $conds may be "*" to copy the whole table
890 * srcTable may be an array of tables.
891 * @todo FIXME: implement this a little better (seperate select/insert)?
893 function insertSelect( $destTable, $srcTable, $varMap, $conds, $fname = 'DatabasePostgres::insertSelect',
894 $insertOptions = array(), $selectOptions = array() )
896 $destTable = $this->tableName( $destTable );
898 // If IGNORE is set, we use savepoints to emulate mysql's behavior
899 $ignore = in_array( 'IGNORE', $insertOptions ) ?
'mw' : '';
901 if( is_array( $insertOptions ) ) {
902 $insertOptions = implode( ' ', $insertOptions );
904 if( !is_array( $selectOptions ) ) {
905 $selectOptions = array( $selectOptions );
907 list( $startOpts, $useIndex, $tailOpts ) = $this->makeSelectOptions( $selectOptions );
908 if( is_array( $srcTable ) ) {
909 $srcTable = implode( ',', array_map( array( &$this, 'tableName' ), $srcTable ) );
911 $srcTable = $this->tableName( $srcTable );
914 // If we are not in a transaction, we need to be for savepoint trickery
917 if( !$this->mTrxLevel
) {
921 $olde = error_reporting( 0 );
922 $numrowsinserted = 0;
923 pg_query( $this->mConn
, "SAVEPOINT $ignore");
926 $sql = "INSERT INTO $destTable (" . implode( ',', array_keys( $varMap ) ) . ')' .
927 " SELECT $startOpts " . implode( ',', $varMap ) .
928 " FROM $srcTable $useIndex";
930 if ( $conds != '*' ) {
931 $sql .= ' WHERE ' . $this->makeList( $conds, LIST_AND
);
934 $sql .= " $tailOpts";
936 $res = (bool)$this->query( $sql, $fname, $ignore );
938 $bar = pg_last_error();
939 if( $bar != false ) {
940 pg_query( $this->mConn
, "ROLLBACK TO $ignore" );
942 pg_query( $this->mConn
, "RELEASE $ignore" );
945 $olde = error_reporting( $olde );
950 // Set the affected row count for the whole operation
951 $this->mAffectedRows
= $numrowsinserted;
953 // IGNORE always returns true
960 function tableName( $name ) {
961 # Replace reserved words with better ones
966 return 'pagecontent';
973 * Return the next in a sequence, save the value for retrieval via insertId()
975 function nextSequenceValue( $seqName ) {
976 $safeseq = str_replace( "'", "''", $seqName );
977 $res = $this->query( "SELECT nextval('$safeseq')" );
978 $row = $this->fetchRow( $res );
979 $this->mInsertId
= $row[0];
980 return $this->mInsertId
;
984 * Return the current value of a sequence. Assumes it has been nextval'ed in this session.
986 function currentSequenceValue( $seqName ) {
987 $safeseq = str_replace( "'", "''", $seqName );
988 $res = $this->query( "SELECT currval('$safeseq')" );
989 $row = $this->fetchRow( $res );
995 * REPLACE query wrapper
996 * Postgres simulates this with a DELETE followed by INSERT
997 * $row is the row to insert, an associative array
998 * $uniqueIndexes is an array of indexes. Each element may be either a
999 * field name or an array of field names
1001 * It may be more efficient to leave off unique indexes which are unlikely to collide.
1002 * However if you do this, you run the risk of encountering errors which wouldn't have
1005 function replace( $table, $uniqueIndexes, $rows, $fname = 'DatabasePostgres::replace' ) {
1006 $table = $this->tableName( $table );
1008 if ( count( $rows ) == 0 ) {
1013 if ( !is_array( reset( $rows ) ) ) {
1014 $rows = array( $rows );
1017 foreach( $rows as $row ) {
1018 # Delete rows which collide
1019 if ( $uniqueIndexes ) {
1020 $sql = "DELETE FROM $table WHERE ";
1022 foreach ( $uniqueIndexes as $index ) {
1029 if ( is_array( $index ) ) {
1031 foreach ( $index as $col ) {
1037 $sql .= $col.'=' . $this->addQuotes( $row[$col] );
1040 $sql .= $index.'=' . $this->addQuotes( $row[$index] );
1044 $this->query( $sql, $fname );
1047 # Now insert the row
1048 $sql = "INSERT INTO $table (" . $this->makeList( array_keys( $row ), LIST_NAMES
) .') VALUES (' .
1049 $this->makeList( $row, LIST_COMMA
) . ')';
1050 $this->query( $sql, $fname );
1054 # DELETE where the condition is a join
1055 function deleteJoin( $delTable, $joinTable, $delVar, $joinVar, $conds, $fname = 'DatabasePostgres::deleteJoin' ) {
1057 throw new DBUnexpectedError( $this, 'DatabasePostgres::deleteJoin() called with empty $conds' );
1060 $delTable = $this->tableName( $delTable );
1061 $joinTable = $this->tableName( $joinTable );
1062 $sql = "DELETE FROM $delTable WHERE $delVar IN (SELECT $joinVar FROM $joinTable ";
1063 if ( $conds != '*' ) {
1064 $sql .= 'WHERE ' . $this->makeList( $conds, LIST_AND
);
1068 $this->query( $sql, $fname );
1071 # Returns the size of a text field, or -1 for "unlimited"
1072 function textFieldSize( $table, $field ) {
1073 $table = $this->tableName( $table );
1074 $sql = "SELECT t.typname as ftype,a.atttypmod as size
1075 FROM pg_class c, pg_attribute a, pg_type t
1076 WHERE relname='$table' AND a.attrelid=c.oid AND
1077 a.atttypid=t.oid and a.attname='$field'";
1078 $res =$this->query( $sql );
1079 $row = $this->fetchObject( $res );
1080 if ( $row->ftype
== 'varchar' ) {
1081 $size = $row->size
- 4;
1088 function limitResult( $sql, $limit, $offset = false ) {
1089 return "$sql LIMIT $limit " . ( is_numeric( $offset ) ?
" OFFSET {$offset} " : '' );
1092 function wasDeadlock() {
1093 return $this->lastErrno() == '40P01';
1096 function duplicateTableStructure( $oldName, $newName, $temporary = false, $fname = 'DatabasePostgres::duplicateTableStructure' ) {
1097 return $this->query( 'CREATE ' . ( $temporary ?
'TEMPORARY ' : '' ) . " TABLE $newName (LIKE $oldName INCLUDING DEFAULTS)", $fname );
1100 function timestamp( $ts = 0 ) {
1101 return wfTimestamp( TS_POSTGRES
, $ts );
1105 * Return aggregated value function call
1107 function aggregateValue( $valuedata, $valuename = 'value' ) {
1111 function reportQueryError( $error, $errno, $sql, $fname, $tempIgnore = false ) {
1112 // Ignore errors during error handling to avoid infinite recursion
1113 $ignore = $this->ignoreErrors( true );
1114 $this->mErrorCount++
;
1116 if ( $ignore ||
$tempIgnore ) {
1117 wfDebug( "SQL ERROR (ignored): $error\n" );
1118 $this->ignoreErrors( $ignore );
1120 $message = "A database error has occurred. Did you forget to run maintenance/update.php after upgrading? See: http://www.mediawiki.org/wiki/Manual:Upgrading#Run_the_update_script\n" .
1122 "Function: $fname\n" .
1123 "Error: $errno $error\n";
1124 throw new DBUnexpectedError( $this, $message );
1129 * @return string wikitext of a link to the server software's web site
1131 public static function getSoftwareLink() {
1132 return '[http://www.postgresql.org/ PostgreSQL]';
1136 * @return string Version information from the database
1138 function getServerVersion() {
1139 if ( !isset( $this->numeric_version
) ) {
1140 $versionInfo = pg_version( $this->mConn
);
1141 if ( version_compare( $versionInfo['client'], '7.4.0', 'lt' ) ) {
1142 // Old client, abort install
1143 $this->numeric_version
= '7.3 or earlier';
1144 } elseif ( isset( $versionInfo['server'] ) ) {
1146 $this->numeric_version
= $versionInfo['server'];
1148 // Bug 16937: broken pgsql extension from PHP<5.3
1149 $this->numeric_version
= pg_parameter_status( $this->mConn
, 'server_version' );
1152 return $this->numeric_version
;
1156 * Query whether a given relation exists (in the given schema, or the
1157 * default mw one if not given)
1159 function relationExists( $table, $types, $schema = false ) {
1160 global $wgDBmwschema;
1161 if ( !is_array( $types ) ) {
1162 $types = array( $types );
1165 $schema = $wgDBmwschema;
1167 $etable = $this->addQuotes( $table );
1168 $eschema = $this->addQuotes( $schema );
1169 $SQL = "SELECT 1 FROM pg_catalog.pg_class c, pg_catalog.pg_namespace n "
1170 . "WHERE c.relnamespace = n.oid AND c.relname = $etable AND n.nspname = $eschema "
1171 . "AND c.relkind IN ('" . implode( "','", $types ) . "')";
1172 $res = $this->query( $SQL );
1173 $count = $res ?
$res->numRows() : 0;
1174 return (bool)$count;
1178 * For backward compatibility, this function checks both tables and
1181 function tableExists( $table, $schema = false ) {
1182 return $this->relationExists( $table, array( 'r', 'v' ), $schema );
1185 function sequenceExists( $sequence, $schema = false ) {
1186 return $this->relationExists( $sequence, 'S', $schema );
1189 function triggerExists( $table, $trigger ) {
1190 global $wgDBmwschema;
1193 SELECT 1 FROM pg_class, pg_namespace, pg_trigger
1194 WHERE relnamespace=pg_namespace.oid AND relkind='r'
1195 AND tgrelid=pg_class.oid
1196 AND nspname=%s AND relname=%s AND tgname=%s
1198 $res = $this->query(
1201 $this->addQuotes( $wgDBmwschema ),
1202 $this->addQuotes( $table ),
1203 $this->addQuotes( $trigger )
1209 $rows = $res->numRows();
1213 function ruleExists( $table, $rule ) {
1214 global $wgDBmwschema;
1215 $exists = $this->selectField( 'pg_rules', 'rulename',
1217 'rulename' => $rule,
1218 'tablename' => $table,
1219 'schemaname' => $wgDBmwschema
1222 return $exists === $rule;
1225 function constraintExists( $table, $constraint ) {
1226 global $wgDBmwschema;
1227 $SQL = sprintf( "SELECT 1 FROM information_schema.table_constraints ".
1228 "WHERE constraint_schema = %s AND table_name = %s AND constraint_name = %s",
1229 $this->addQuotes( $wgDBmwschema ),
1230 $this->addQuotes( $table ),
1231 $this->addQuotes( $constraint )
1233 $res = $this->query( $SQL );
1237 $rows = $res->numRows();
1242 * Query whether a given schema exists. Returns the name of the owner
1244 function schemaExists( $schema ) {
1245 $eschema = str_replace( "'", "''", $schema );
1246 $SQL = "SELECT rolname FROM pg_catalog.pg_namespace n, pg_catalog.pg_roles r "
1247 ."WHERE n.nspowner=r.oid AND n.nspname = '$eschema'";
1248 $res = $this->query( $SQL );
1249 if ( $res && $res->numRows() ) {
1250 $row = $res->fetchObject();
1251 $owner = $row->rolname
;
1258 function fieldInfo( $table, $field ) {
1259 return PostgresField
::fromText( $this, $table, $field );
1263 * pg_field_type() wrapper
1265 function fieldType( $res, $index ) {
1266 if ( $res instanceof ResultWrapper
) {
1267 $res = $res->result
;
1269 return pg_field_type( $res, $index );
1272 /* Not even sure why this is used in the main codebase... */
1273 function limitResultForUpdate( $sql, $num ) {
1277 function encodeBlob( $b ) {
1278 return new Blob( pg_escape_bytea( $this->mConn
, $b ) );
1281 function decodeBlob( $b ) {
1282 if ( $b instanceof Blob
) {
1285 return pg_unescape_bytea( $b );
1288 function strencode( $s ) { # Should not be called by us
1289 return pg_escape_string( $this->mConn
, $s );
1292 function addQuotes( $s ) {
1293 if ( is_null( $s ) ) {
1295 } elseif ( is_bool( $s ) ) {
1296 return intval( $s );
1297 } elseif ( $s instanceof Blob
) {
1298 return "'" . $s->fetch( $s ) . "'";
1300 return "'" . pg_escape_string( $this->mConn
, $s ) . "'";
1303 function addIdentifierQuotes( $s ) {
1304 return '"' . str_replace( '"', '""', $s ) . '"';
1308 * Postgres specific version of replaceVars.
1309 * Calls the parent version in Database.php
1313 * @param $ins String: SQL string, read from a stream (usually tables.sql)
1315 * @return string SQL string
1317 protected function replaceVars( $ins ) {
1318 $ins = parent
::replaceVars( $ins );
1320 if ( $this->numeric_version
>= 8.3 ) {
1321 // Thanks for not providing backwards-compatibility, 8.3
1322 $ins = preg_replace( "/to_tsvector\s*\(\s*'default'\s*,/", 'to_tsvector(', $ins );
1325 if ( $this->numeric_version
<= 8.1 ) { // Our minimum version
1326 $ins = str_replace( 'USING gin', 'USING gist', $ins );
1333 * Various select options
1337 * @param $options Array: an associative array of options to be turned into
1338 * an SQL query, valid keys are listed in the function.
1341 function makeSelectOptions( $options ) {
1342 $preLimitTail = $postLimitTail = '';
1343 $startOpts = $useIndex = '';
1345 $noKeyOptions = array();
1346 foreach ( $options as $key => $option ) {
1347 if ( is_numeric( $key ) ) {
1348 $noKeyOptions[$option] = true;
1352 if ( isset( $options['GROUP BY'] ) ) {
1353 $preLimitTail .= ' GROUP BY ' . $options['GROUP BY'];
1355 if ( isset( $options['HAVING'] ) ) {
1356 $preLimitTail .= " HAVING {$options['HAVING']}";
1358 if ( isset( $options['ORDER BY'] ) ) {
1359 $preLimitTail .= ' ORDER BY ' . $options['ORDER BY'];
1362 //if ( isset( $options['LIMIT'] ) ) {
1363 // $tailOpts .= $this->limitResult( '', $options['LIMIT'],
1364 // isset( $options['OFFSET'] ) ? $options['OFFSET']
1368 if ( isset( $noKeyOptions['FOR UPDATE'] ) ) {
1369 $postLimitTail .= ' FOR UPDATE';
1371 if ( isset( $noKeyOptions['LOCK IN SHARE MODE'] ) ) {
1372 $postLimitTail .= ' LOCK IN SHARE MODE';
1374 if ( isset( $noKeyOptions['DISTINCT'] ) ||
isset( $noKeyOptions['DISTINCTROW'] ) ) {
1375 $startOpts .= 'DISTINCT';
1378 return array( $startOpts, $useIndex, $preLimitTail, $postLimitTail );
1381 function setFakeMaster( $enabled = true ) {}
1383 function getDBname() {
1384 return $this->mDBname
;
1387 function getServer() {
1388 return $this->mServer
;
1391 function buildConcat( $stringList ) {
1392 return implode( ' || ', $stringList );
1395 public function getSearchEngine() {
1396 return 'SearchPostgres';
1398 } // end DatabasePostgres class