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 $safeuser = $this->addIdentifierQuotes( $wgDBuser );
233 // Are we connecting as a superuser for the first time?
235 // Are we really a superuser? Check out our rights
237 CASE WHEN usesuper IS TRUE THEN
238 CASE WHEN usecreatedb IS TRUE THEN 3 ELSE 1 END
239 ELSE CASE WHEN usecreatedb IS TRUE THEN 2 ELSE 0 END
241 FROM pg_catalog.pg_user WHERE usename = " . $this->addQuotes( $superuser );
242 $rows = $this->numRows( $res = $this->doQuery( $SQL ) );
244 print '<li>ERROR: Could not read permissions for user "' . htmlspecialchars( $superuser ) . "\"</li>\n";
247 $perms = pg_fetch_result( $res, 0, 0 );
249 $SQL = "SELECT 1 FROM pg_catalog.pg_user WHERE usename = " . $this->addQuotes( $wgDBuser );
250 $rows = $this->numRows( $this->doQuery( $SQL ) );
252 print '<li>User "' . htmlspecialchars( $wgDBuser ) . '" already exists, skipping account creation.</li>';
254 if ( $perms != 1 && $perms != 3 ) {
255 print '<li>ERROR: the user "' . htmlspecialchars( $superuser ) . '" cannot create other users. ';
256 print 'Please use a different Postgres user.</li>';
259 print '<li>Creating user <b>' . htmlspecialchars( $wgDBuser ) . '</b>...';
260 $safepass = $this->addQuotes( $wgDBpassword );
261 $SQL = "CREATE USER $safeuser NOCREATEDB PASSWORD $safepass";
262 $this->doQuery( $SQL );
265 // User now exists, check out the database
266 if ( $dbName != $wgDBname ) {
267 $SQL = "SELECT 1 FROM pg_catalog.pg_database WHERE datname = " . $this->addQuotes( $wgDBname );
268 $rows = $this->numRows( $this->doQuery( $SQL ) );
270 print '<li>Database "' . htmlspecialchars( $wgDBname ) . '" already exists, skipping database creation.</li>';
273 print '<li>ERROR: the user "' . htmlspecialchars( $superuser ) . '" cannot create databases. ';
274 print 'Please use a different Postgres user.</li>';
277 print '<li>Creating database <b>' . htmlspecialchars( $wgDBname ) . '</b>...';
278 $safename = $this->addIdentifierQuotes( $wgDBname );
279 $SQL = "CREATE DATABASE $safename OWNER $safeuser ";
280 $this->doQuery( $SQL );
282 // Hopefully tsearch2 and plpgsql are in template1...
285 // Reconnect to check out tsearch2 rights for this user
286 print '<li>Connecting to "' . htmlspecialchars( $wgDBname ) . '" as superuser "' .
287 htmlspecialchars( $superuser ) . '" to check rights...';
289 $connectVars = array();
290 if ( $this->mServer
!= false && $this->mServer
!= '' ) {
291 $connectVars['host'] = $this->mServer
;
293 if ( $this->mPort
!= false && $this->mPort
!= '' ) {
294 $connectVars['port'] = $this->mPort
;
296 $connectVars['dbname'] = $wgDBname;
297 $connectVars['user'] = $superuser;
298 $connectVars['password'] = $password;
300 @$this->mConn
= pg_connect( $this->makeConnectionString( $connectVars ) );
301 if ( !$this->mConn
) {
302 print "<b>FAILED TO CONNECT!</b></li>";
308 if ( $this->numeric_version
< 8.3 ) {
310 print '<li>Checking that tsearch2 is installed in the database "' .
311 htmlspecialchars( $wgDBname ) . '"...';
312 if ( !$this->tableExists( 'pg_ts_cfg', $wgDBts2schema ) ) {
313 print '<b>FAILED</b>. tsearch2 must be installed in the database "' .
314 htmlspecialchars( $wgDBname ) . '".';
315 print 'Please see <a href="http://www.devx.com/opensource/Article/21674/0/page/2">this article</a>';
316 print " for instructions or ask on #postgresql on irc.freenode.net</li>\n";
320 print '<li>Ensuring that user "' . htmlspecialchars( $wgDBuser ) .
321 '" has select rights on the tsearch2 tables...';
322 foreach ( array( 'cfg', 'cfgmap', 'dict', 'parser' ) as $table ) {
323 $SQL = "GRANT SELECT ON pg_ts_$table TO $safeuser";
324 $this->doQuery( $SQL );
329 // Setup the schema for this user if needed
330 $result = $this->schemaExists( $wgDBmwschema );
331 $safeschema = $this->addIdentifierQuotes( $wgDBmwschema );
333 print '<li>Creating schema <b>' . htmlspecialchars( $wgDBmwschema ) . '</b> ...';
334 $result = $this->doQuery( "CREATE SCHEMA $safeschema AUTHORIZATION $safeuser" );
336 print "<b>FAILED</b>.</li>\n";
341 print "<li>Schema already exists, explicitly granting rights...\n";
342 $safeschema2 = $this->addQuotes( $wgDBmwschema );
343 $SQL = "SELECT 'GRANT ALL ON '||pg_catalog.quote_ident(relname)||' TO $safeuser;'\n".
344 "FROM pg_catalog.pg_class p, pg_catalog.pg_namespace n\n".
345 "WHERE relnamespace = n.oid AND n.nspname = $safeschema2\n".
346 "AND p.relkind IN ('r','S','v')\n";
348 $SQL .= "SELECT 'GRANT ALL ON FUNCTION '||pg_catalog.quote_ident(proname)||'('||\n".
349 "pg_catalog.oidvectortypes(p.proargtypes)||') TO $safeuser;'\n".
350 "FROM pg_catalog.pg_proc p, pg_catalog.pg_namespace n\n".
351 "WHERE p.pronamespace = n.oid AND n.nspname = $safeschema2";
352 $res = $this->doQuery( $SQL );
354 print "<b>FAILED</b>. Could not set rights for the user.</li>\n";
357 $this->doQuery( "SET search_path = $safeschema" );
358 $rows = $this->numRows( $res );
361 $this->doQuery( pg_fetch_result( $res, $rows, 0 ) );
366 // Install plpgsql if needed
367 $this->setup_plpgsql();
369 return true; // Reconnect as regular user
373 if ( !defined( 'POSTGRES_SEARCHPATH' ) ) {
375 if ( $this->numeric_version
< 8.3 ) {
376 // Do we have the basic tsearch2 table?
377 print '<li>Checking for tsearch2 in the schema "' . htmlspecialchars( $wgDBts2schema ) . '"...';
378 if ( !$this->tableExists( 'pg_ts_dict', $wgDBts2schema ) ) {
379 print '<b>FAILED</b>. Make sure tsearch2 is installed. See <a href="';
380 print 'http://www.devx.com/opensource/Article/21674/0/page/2">this article</a>';
381 print " for instructions.</li>\n";
386 // Does this user have the rights to the tsearch2 tables?
387 $ctype = pg_fetch_result( $this->doQuery( 'SHOW lc_ctype' ), 0, 0 );
388 print '<li>Checking tsearch2 permissions...';
389 // Let's check all four, just to be safe
390 error_reporting( 0 );
391 $ts2tables = array( 'cfg', 'cfgmap', 'dict', 'parser' );
392 $safetsschema = $this->addIdentifierQuotes( $wgDBts2schema );
393 foreach ( $ts2tables as $tname ) {
394 $SQL = "SELECT count(*) FROM $safetsschema.pg_ts_$tname";
395 $res = $this->doQuery( $SQL );
397 print "<b>FAILED</b> to access " . htmlspecialchars( "pg_ts_$tname" ) .
398 ". Make sure that the user \"". htmlspecialchars( $wgDBuser ) .
399 "\" has SELECT access to all four tsearch2 tables</li>\n";
403 $SQL = "SELECT ts_name FROM $safetsschema.pg_ts_cfg WHERE locale = " . $this->addQuotes( $ctype ) ;
404 $SQL .= " ORDER BY CASE WHEN ts_name <> 'default' THEN 1 ELSE 0 END";
405 $res = $this->doQuery( $SQL );
406 error_reporting( E_ALL
);
408 print "<b>FAILED</b>. Could not determine the tsearch2 locale information</li>\n";
413 // Will the current locale work? Can we force it to?
414 print '<li>Verifying tsearch2 locale with ' . htmlspecialchars( $ctype ) . '...';
415 $rows = $this->numRows( $res );
418 print "<b>not found</b></li>\n";
419 print '<li>Attempting to set default tsearch2 locale to "' . htmlspecialchars( $ctype ) . '"...';
422 $tsname = pg_fetch_result( $res, 0, 0 );
423 if ( $tsname != 'default' ) {
424 print "<b>not set to default (" . htmlspecialchars( $tsname ) . ")</b>";
425 print "<li>Attempting to change tsearch2 default locale to \"" .
426 htmlspecialchars( $ctype ) . "\"...";
430 if ( $resetlocale ) {
431 $SQL = "UPDATE $safetsschema.pg_ts_cfg SET locale = " . $this->addQuotes( $ctype ) . " WHERE ts_name = 'default'";
432 $res = $this->doQuery( $SQL );
434 print '<b>FAILED</b>. ';
435 print 'Please make sure that the locale in pg_ts_cfg for "default" is set to "' .
436 htmlspecialchars( $ctype ) . "\"</li>\n";
442 // Final test: try out a simple tsearch2 query
443 $SQL = "SELECT $safetsschema.to_tsvector('default','MediaWiki tsearch2 testing')";
444 $res = $this->doQuery( $SQL );
446 print '<b>FAILED</b>. Specifically, "' . htmlspecialchars( $SQL ) . '" did not work.</li>';
452 // Install plpgsql if needed
453 $this->setup_plpgsql();
455 // Does the schema already exist? Who owns it?
456 $result = $this->schemaExists( $wgDBmwschema );
458 print '<li>Creating schema <b>' . htmlspecialchars( $wgDBmwschema ) . '</b> ...';
459 error_reporting( 0 );
460 $safeschema = $this->addIdentifierQuotes( $wgDBmwschema );
461 $result = $this->doQuery( "CREATE SCHEMA $safeschema" );
462 error_reporting( E_ALL
);
464 print '<b>FAILED</b>. The user "' . htmlspecialchars( $wgDBuser ) .
465 '" must be able to access the schema. '.
466 'You can try making them the owner of the database, or try creating the schema with a '.
467 'different user, and then grant access to the "' .
468 htmlspecialchars( $wgDBuser ) . "\" user.</li>\n";
472 } elseif ( $result != $wgDBuser ) {
473 print '<li>Schema "' . htmlspecialchars( $wgDBmwschema ) . '" exists but is not owned by "' .
474 htmlspecialchars( $wgDBuser ) . "\". Not ideal.</li>\n";
476 print '<li>Schema "' . htmlspecialchars( $wgDBmwschema ) . '" exists and is owned by "' .
477 htmlspecialchars( $wgDBuser ) . "\". Excellent.</li>\n";
480 // Always return GMT time to accomodate the existing integer-based timestamp assumption
481 print "<li>Setting the timezone to GMT for user \"" . htmlspecialchars( $wgDBuser ) . '" ...';
482 $SQL = "ALTER USER $safeuser SET timezone = 'GMT'";
483 $result = pg_query( $this->mConn
, $SQL );
485 print "<b>FAILED</b>.</li>\n";
489 // Set for the rest of this session
490 $SQL = "SET timezone = 'GMT'";
491 $result = pg_query( $this->mConn
, $SQL );
493 print "<li>Failed to set timezone</li>\n";
497 print '<li>Setting the datestyle to ISO, YMD for user "' . htmlspecialchars( $wgDBuser ) . '" ...';
498 $SQL = "ALTER USER $safeuser SET datestyle = 'ISO, YMD'";
499 $result = pg_query( $this->mConn
, $SQL );
501 print "<b>FAILED</b>.</li>\n";
505 // Set for the rest of this session
506 $SQL = "SET datestyle = 'ISO, YMD'";
507 $result = pg_query( $this->mConn
, $SQL );
509 print "<li>Failed to set datestyle</li>\n";
513 // Fix up the search paths if needed
514 print '<li>Setting the search path for user "' . htmlspecialchars( $wgDBuser ) . '" ...';
515 $path = $this->addIdentifierQuotes( $wgDBmwschema );
516 if ( $wgDBts2schema !== $wgDBmwschema ) {
517 $path .= ', '. $this->addIdentifierQuotes( $wgDBts2schema );
519 if ( $wgDBmwschema !== 'public' && $wgDBts2schema !== 'public' ) {
522 $SQL = "ALTER USER $safeuser SET search_path = $path";
523 $result = pg_query( $this->mConn
, $SQL );
525 print "<b>FAILED</b>.</li>\n";
529 // Set for the rest of this session
530 $SQL = "SET search_path = $path";
531 $result = pg_query( $this->mConn
, $SQL );
533 print "<li>Failed to set search_path</li>\n";
536 define( 'POSTGRES_SEARCHPATH', $path );
540 function setup_plpgsql() {
541 print '<li>Checking for PL/pgSQL ...';
542 $SQL = "SELECT 1 FROM pg_catalog.pg_language WHERE lanname = 'plpgsql'";
543 $rows = $this->numRows( $this->doQuery( $SQL ) );
545 // plpgsql is not installed, but if we have a pg_pltemplate table, we should be able to create it
546 print 'not installed. Attempting to install PL/pgSQL ...';
547 $SQL = "SELECT 1 FROM pg_catalog.pg_class c JOIN pg_catalog.pg_namespace n ON (n.oid = c.relnamespace) ".
548 "WHERE relname = 'pg_pltemplate' AND nspname='pg_catalog'";
549 $rows = $this->numRows( $this->doQuery( $SQL ) );
552 $olde = error_reporting( 0 );
553 error_reporting( $olde - E_WARNING
);
554 $result = $this->doQuery( 'CREATE LANGUAGE plpgsql' );
555 error_reporting( $olde );
557 print '<b>FAILED</b>. You need to install the language PL/pgSQL in the database <tt>' .
558 htmlspecialchars( $wgDBname ) . '</tt></li>';
562 print '<b>FAILED</b>. You need to install the language PL/pgSQL in the database <tt>' .
563 htmlspecialchars( $wgDBname ) . '</tt></li>';
571 * Closes a database connection, if it is open
572 * Returns success, true if already closed
575 $this->mOpened
= false;
576 if ( $this->mConn
) {
577 return pg_close( $this->mConn
);
583 function doQuery( $sql ) {
584 if ( function_exists( 'mb_convert_encoding' ) ) {
585 $sql = mb_convert_encoding( $sql, 'UTF-8' );
587 $this->mLastResult
= pg_query( $this->mConn
, $sql );
588 $this->mAffectedRows
= null; // use pg_affected_rows(mLastResult)
589 return $this->mLastResult
;
592 function queryIgnore( $sql, $fname = 'DatabasePostgres::queryIgnore' ) {
593 return $this->query( $sql, $fname, true );
596 function freeResult( $res ) {
597 if ( $res instanceof ResultWrapper
) {
600 if ( !@pg_free_result
( $res ) ) {
601 throw new DBUnexpectedError( $this, "Unable to free Postgres result\n" );
605 function fetchObject( $res ) {
606 if ( $res instanceof ResultWrapper
) {
609 @$row = pg_fetch_object( $res );
610 # FIXME: HACK HACK HACK HACK debug
613 # hashar : not sure if the following test really trigger if the object
615 if( pg_last_error( $this->mConn
) ) {
616 throw new DBUnexpectedError( $this, 'SQL error: ' . htmlspecialchars( pg_last_error( $this->mConn
) ) );
621 function fetchRow( $res ) {
622 if ( $res instanceof ResultWrapper
) {
625 @$row = pg_fetch_array( $res );
626 if( pg_last_error( $this->mConn
) ) {
627 throw new DBUnexpectedError( $this, 'SQL error: ' . htmlspecialchars( pg_last_error( $this->mConn
) ) );
632 function numRows( $res ) {
633 if ( $res instanceof ResultWrapper
) {
636 @$n = pg_num_rows( $res );
637 if( pg_last_error( $this->mConn
) ) {
638 throw new DBUnexpectedError( $this, 'SQL error: ' . htmlspecialchars( pg_last_error( $this->mConn
) ) );
643 function numFields( $res ) {
644 if ( $res instanceof ResultWrapper
) {
647 return pg_num_fields( $res );
650 function fieldName( $res, $n ) {
651 if ( $res instanceof ResultWrapper
) {
654 return pg_field_name( $res, $n );
658 * This must be called after nextSequenceVal
660 function insertId() {
661 return $this->mInsertId
;
664 function dataSeek( $res, $row ) {
665 if ( $res instanceof ResultWrapper
) {
668 return pg_result_seek( $res, $row );
671 function lastError() {
672 if ( $this->mConn
) {
673 return pg_last_error();
675 return 'No database connection';
678 function lastErrno() {
679 return pg_last_error() ?
1 : 0;
682 function affectedRows() {
683 if ( !is_null( $this->mAffectedRows
) ) {
684 // Forced result for simulated queries
685 return $this->mAffectedRows
;
687 if( empty( $this->mLastResult
) ) {
690 return pg_affected_rows( $this->mLastResult
);
694 * Estimate rows in dataset
695 * Returns estimated count, based on EXPLAIN output
696 * This is not necessarily an accurate estimate, so use sparingly
697 * Returns -1 if count cannot be found
698 * Takes same arguments as Database::select()
700 function estimateRowCount( $table, $vars = '*', $conds='', $fname = 'DatabasePostgres::estimateRowCount', $options = array() ) {
701 $options['EXPLAIN'] = true;
702 $res = $this->select( $table, $vars, $conds, $fname, $options );
705 $row = $this->fetchRow( $res );
707 if( preg_match( '/rows=(\d+)/', $row[0], $count ) ) {
715 * Returns information about an index
716 * If errors are explicitly ignored, returns NULL on failure
718 function indexInfo( $table, $index, $fname = 'DatabasePostgres::indexInfo' ) {
719 $sql = "SELECT indexname FROM pg_indexes WHERE tablename='$table'";
720 $res = $this->query( $sql, $fname );
724 foreach ( $res as $row ) {
725 if ( $row->indexname
== $this->indexName( $index ) ) {
732 function indexUnique( $table, $index, $fname = 'DatabasePostgres::indexUnique' ) {
733 $sql = "SELECT indexname FROM pg_indexes WHERE tablename='{$table}'".
734 " AND indexdef LIKE 'CREATE UNIQUE%(" .
735 $this->strencode( $this->indexName( $index ) ) .
737 $res = $this->query( $sql, $fname );
741 foreach ( $res as $row ) {
748 * INSERT wrapper, inserts an array into a table
750 * $args may be a single associative array, or an array of these with numeric keys,
751 * for multi-row insert (Postgres version 8.2 and above only).
753 * @param $table String: Name of the table to insert to.
754 * @param $args Array: Items to insert into the table.
755 * @param $fname String: Name of the function, for profiling
756 * @param $options String or Array. Valid options: IGNORE
758 * @return bool Success of insert operation. IGNORE always returns true.
760 function insert( $table, $args, $fname = 'DatabasePostgres::insert', $options = array() ) {
761 if ( !count( $args ) ) {
765 $table = $this->tableName( $table );
766 if (! isset( $this->numeric_version
) ) {
767 $this->getServerVersion();
770 if ( !is_array( $options ) ) {
771 $options = array( $options );
774 if ( isset( $args[0] ) && is_array( $args[0] ) ) {
776 $keys = array_keys( $args[0] );
779 $keys = array_keys( $args );
782 // If IGNORE is set, we use savepoints to emulate mysql's behavior
783 $ignore = in_array( 'IGNORE', $options ) ?
'mw' : '';
785 // If we are not in a transaction, we need to be for savepoint trickery
788 if ( !$this->mTrxLevel
) {
792 $olde = error_reporting( 0 );
793 // For future use, we may want to track the number of actual inserts
794 // Right now, insert (all writes) simply return true/false
795 $numrowsinserted = 0;
798 $sql = "INSERT INTO $table (" . implode( ',', $keys ) . ') VALUES ';
801 if ( $this->numeric_version
>= 8.2 && !$ignore ) {
803 foreach ( $args as $row ) {
809 $sql .= '(' . $this->makeList( $row ) . ')';
811 $res = (bool)$this->query( $sql, $fname, $ignore );
815 foreach ( $args as $row ) {
817 $tempsql .= '(' . $this->makeList( $row ) . ')';
820 pg_query( $this->mConn
, "SAVEPOINT $ignore" );
823 $tempres = (bool)$this->query( $tempsql, $fname, $ignore );
826 $bar = pg_last_error();
827 if ( $bar != false ) {
828 pg_query( $this->mConn
, "ROLLBACK TO $ignore" );
830 pg_query( $this->mConn
, "RELEASE $ignore" );
835 // If any of them fail, we fail overall for this function call
836 // Note that this will be ignored if IGNORE is set
843 // Not multi, just a lone insert
845 pg_query($this->mConn
, "SAVEPOINT $ignore");
848 $sql .= '(' . $this->makeList( $args ) . ')';
849 $res = (bool)$this->query( $sql, $fname, $ignore );
851 $bar = pg_last_error();
852 if ( $bar != false ) {
853 pg_query( $this->mConn
, "ROLLBACK TO $ignore" );
855 pg_query( $this->mConn
, "RELEASE $ignore" );
861 $olde = error_reporting( $olde );
866 // Set the affected row count for the whole operation
867 $this->mAffectedRows
= $numrowsinserted;
869 // IGNORE always returns true
877 * INSERT SELECT wrapper
878 * $varMap must be an associative array of the form array( 'dest1' => 'source1', ...)
879 * Source items may be literals rather then field names, but strings should be quoted with Database::addQuotes()
880 * $conds may be "*" to copy the whole table
881 * srcTable may be an array of tables.
882 * @todo FIXME: implement this a little better (seperate select/insert)?
884 function insertSelect( $destTable, $srcTable, $varMap, $conds, $fname = 'DatabasePostgres::insertSelect',
885 $insertOptions = array(), $selectOptions = array() )
887 $destTable = $this->tableName( $destTable );
889 // If IGNORE is set, we use savepoints to emulate mysql's behavior
890 $ignore = in_array( 'IGNORE', $insertOptions ) ?
'mw' : '';
892 if( is_array( $insertOptions ) ) {
893 $insertOptions = implode( ' ', $insertOptions );
895 if( !is_array( $selectOptions ) ) {
896 $selectOptions = array( $selectOptions );
898 list( $startOpts, $useIndex, $tailOpts ) = $this->makeSelectOptions( $selectOptions );
899 if( is_array( $srcTable ) ) {
900 $srcTable = implode( ',', array_map( array( &$this, 'tableName' ), $srcTable ) );
902 $srcTable = $this->tableName( $srcTable );
905 // If we are not in a transaction, we need to be for savepoint trickery
908 if( !$this->mTrxLevel
) {
912 $olde = error_reporting( 0 );
913 $numrowsinserted = 0;
914 pg_query( $this->mConn
, "SAVEPOINT $ignore");
917 $sql = "INSERT INTO $destTable (" . implode( ',', array_keys( $varMap ) ) . ')' .
918 " SELECT $startOpts " . implode( ',', $varMap ) .
919 " FROM $srcTable $useIndex";
921 if ( $conds != '*' ) {
922 $sql .= ' WHERE ' . $this->makeList( $conds, LIST_AND
);
925 $sql .= " $tailOpts";
927 $res = (bool)$this->query( $sql, $fname, $ignore );
929 $bar = pg_last_error();
930 if( $bar != false ) {
931 pg_query( $this->mConn
, "ROLLBACK TO $ignore" );
933 pg_query( $this->mConn
, "RELEASE $ignore" );
936 $olde = error_reporting( $olde );
941 // Set the affected row count for the whole operation
942 $this->mAffectedRows
= $numrowsinserted;
944 // IGNORE always returns true
951 function tableName( $name ) {
952 # Replace reserved words with better ones
957 return 'pagecontent';
964 * Return the next in a sequence, save the value for retrieval via insertId()
966 function nextSequenceValue( $seqName ) {
967 $safeseq = str_replace( "'", "''", $seqName );
968 $res = $this->query( "SELECT nextval('$safeseq')" );
969 $row = $this->fetchRow( $res );
970 $this->mInsertId
= $row[0];
971 return $this->mInsertId
;
975 * Return the current value of a sequence. Assumes it has been nextval'ed in this session.
977 function currentSequenceValue( $seqName ) {
978 $safeseq = str_replace( "'", "''", $seqName );
979 $res = $this->query( "SELECT currval('$safeseq')" );
980 $row = $this->fetchRow( $res );
986 * REPLACE query wrapper
987 * Postgres simulates this with a DELETE followed by INSERT
988 * $row is the row to insert, an associative array
989 * $uniqueIndexes is an array of indexes. Each element may be either a
990 * field name or an array of field names
992 * It may be more efficient to leave off unique indexes which are unlikely to collide.
993 * However if you do this, you run the risk of encountering errors which wouldn't have
996 function replace( $table, $uniqueIndexes, $rows, $fname = 'DatabasePostgres::replace' ) {
997 $table = $this->tableName( $table );
999 if ( count( $rows ) == 0 ) {
1004 if ( !is_array( reset( $rows ) ) ) {
1005 $rows = array( $rows );
1008 foreach( $rows as $row ) {
1009 # Delete rows which collide
1010 if ( $uniqueIndexes ) {
1011 $sql = "DELETE FROM $table WHERE ";
1013 foreach ( $uniqueIndexes as $index ) {
1020 if ( is_array( $index ) ) {
1022 foreach ( $index as $col ) {
1028 $sql .= $col.'=' . $this->addQuotes( $row[$col] );
1031 $sql .= $index.'=' . $this->addQuotes( $row[$index] );
1035 $this->query( $sql, $fname );
1038 # Now insert the row
1039 $sql = "INSERT INTO $table (" . $this->makeList( array_keys( $row ), LIST_NAMES
) .') VALUES (' .
1040 $this->makeList( $row, LIST_COMMA
) . ')';
1041 $this->query( $sql, $fname );
1045 # DELETE where the condition is a join
1046 function deleteJoin( $delTable, $joinTable, $delVar, $joinVar, $conds, $fname = 'DatabasePostgres::deleteJoin' ) {
1048 throw new DBUnexpectedError( $this, 'DatabasePostgres::deleteJoin() called with empty $conds' );
1051 $delTable = $this->tableName( $delTable );
1052 $joinTable = $this->tableName( $joinTable );
1053 $sql = "DELETE FROM $delTable WHERE $delVar IN (SELECT $joinVar FROM $joinTable ";
1054 if ( $conds != '*' ) {
1055 $sql .= 'WHERE ' . $this->makeList( $conds, LIST_AND
);
1059 $this->query( $sql, $fname );
1062 # Returns the size of a text field, or -1 for "unlimited"
1063 function textFieldSize( $table, $field ) {
1064 $table = $this->tableName( $table );
1065 $sql = "SELECT t.typname as ftype,a.atttypmod as size
1066 FROM pg_class c, pg_attribute a, pg_type t
1067 WHERE relname='$table' AND a.attrelid=c.oid AND
1068 a.atttypid=t.oid and a.attname='$field'";
1069 $res =$this->query( $sql );
1070 $row = $this->fetchObject( $res );
1071 if ( $row->ftype
== 'varchar' ) {
1072 $size = $row->size
- 4;
1079 function limitResult( $sql, $limit, $offset = false ) {
1080 return "$sql LIMIT $limit " . ( is_numeric( $offset ) ?
" OFFSET {$offset} " : '' );
1083 function wasDeadlock() {
1084 return $this->lastErrno() == '40P01';
1087 function duplicateTableStructure( $oldName, $newName, $temporary = false, $fname = 'DatabasePostgres::duplicateTableStructure' ) {
1088 return $this->query( 'CREATE ' . ( $temporary ?
'TEMPORARY ' : '' ) . " TABLE $newName (LIKE $oldName INCLUDING DEFAULTS)", $fname );
1091 function timestamp( $ts = 0 ) {
1092 return wfTimestamp( TS_POSTGRES
, $ts );
1096 * Return aggregated value function call
1098 function aggregateValue( $valuedata, $valuename = 'value' ) {
1102 function reportQueryError( $error, $errno, $sql, $fname, $tempIgnore = false ) {
1103 // Ignore errors during error handling to avoid infinite recursion
1104 $ignore = $this->ignoreErrors( true );
1105 $this->mErrorCount++
;
1107 if ( $ignore ||
$tempIgnore ) {
1108 wfDebug( "SQL ERROR (ignored): $error\n" );
1109 $this->ignoreErrors( $ignore );
1111 $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" .
1113 "Function: $fname\n" .
1114 "Error: $errno $error\n";
1115 throw new DBUnexpectedError( $this, $message );
1120 * @return string wikitext of a link to the server software's web site
1122 public static function getSoftwareLink() {
1123 return '[http://www.postgresql.org/ PostgreSQL]';
1127 * @return string Version information from the database
1129 function getServerVersion() {
1130 if ( !isset( $this->numeric_version
) ) {
1131 $versionInfo = pg_version( $this->mConn
);
1132 if ( version_compare( $versionInfo['client'], '7.4.0', 'lt' ) ) {
1133 // Old client, abort install
1134 $this->numeric_version
= '7.3 or earlier';
1135 } elseif ( isset( $versionInfo['server'] ) ) {
1137 $this->numeric_version
= $versionInfo['server'];
1139 // Bug 16937: broken pgsql extension from PHP<5.3
1140 $this->numeric_version
= pg_parameter_status( $this->mConn
, 'server_version' );
1143 return $this->numeric_version
;
1147 * Query whether a given relation exists (in the given schema, or the
1148 * default mw one if not given)
1150 function relationExists( $table, $types, $schema = false ) {
1151 global $wgDBmwschema;
1152 if ( !is_array( $types ) ) {
1153 $types = array( $types );
1156 $schema = $wgDBmwschema;
1158 $etable = $this->addQuotes( $table );
1159 $eschema = $this->addQuotes( $schema );
1160 $SQL = "SELECT 1 FROM pg_catalog.pg_class c, pg_catalog.pg_namespace n "
1161 . "WHERE c.relnamespace = n.oid AND c.relname = $etable AND n.nspname = $eschema "
1162 . "AND c.relkind IN ('" . implode( "','", $types ) . "')";
1163 $res = $this->query( $SQL );
1164 $count = $res ?
$res->numRows() : 0;
1165 return (bool)$count;
1169 * For backward compatibility, this function checks both tables and
1172 function tableExists( $table, $schema = false ) {
1173 return $this->relationExists( $table, array( 'r', 'v' ), $schema );
1176 function sequenceExists( $sequence, $schema = false ) {
1177 return $this->relationExists( $sequence, 'S', $schema );
1180 function triggerExists( $table, $trigger ) {
1181 global $wgDBmwschema;
1184 SELECT 1 FROM pg_class, pg_namespace, pg_trigger
1185 WHERE relnamespace=pg_namespace.oid AND relkind='r'
1186 AND tgrelid=pg_class.oid
1187 AND nspname=%s AND relname=%s AND tgname=%s
1189 $res = $this->query(
1192 $this->addQuotes( $wgDBmwschema ),
1193 $this->addQuotes( $table ),
1194 $this->addQuotes( $trigger )
1200 $rows = $res->numRows();
1204 function ruleExists( $table, $rule ) {
1205 global $wgDBmwschema;
1206 $exists = $this->selectField( 'pg_rules', 'rulename',
1208 'rulename' => $rule,
1209 'tablename' => $table,
1210 'schemaname' => $wgDBmwschema
1213 return $exists === $rule;
1216 function constraintExists( $table, $constraint ) {
1217 global $wgDBmwschema;
1218 $SQL = sprintf( "SELECT 1 FROM information_schema.table_constraints ".
1219 "WHERE constraint_schema = %s AND table_name = %s AND constraint_name = %s",
1220 $this->addQuotes( $wgDBmwschema ),
1221 $this->addQuotes( $table ),
1222 $this->addQuotes( $constraint )
1224 $res = $this->query( $SQL );
1228 $rows = $res->numRows();
1233 * Query whether a given schema exists. Returns the name of the owner
1235 function schemaExists( $schema ) {
1236 $eschema = str_replace( "'", "''", $schema );
1237 $SQL = "SELECT rolname FROM pg_catalog.pg_namespace n, pg_catalog.pg_roles r "
1238 ."WHERE n.nspowner=r.oid AND n.nspname = '$eschema'";
1239 $res = $this->query( $SQL );
1240 if ( $res && $res->numRows() ) {
1241 $row = $res->fetchObject();
1242 $owner = $row->rolname
;
1249 function fieldInfo( $table, $field ) {
1250 return PostgresField
::fromText( $this, $table, $field );
1254 * pg_field_type() wrapper
1256 function fieldType( $res, $index ) {
1257 if ( $res instanceof ResultWrapper
) {
1258 $res = $res->result
;
1260 return pg_field_type( $res, $index );
1263 /* Not even sure why this is used in the main codebase... */
1264 function limitResultForUpdate( $sql, $num ) {
1268 function encodeBlob( $b ) {
1269 return new Blob( pg_escape_bytea( $this->mConn
, $b ) );
1272 function decodeBlob( $b ) {
1273 if ( $b instanceof Blob
) {
1276 return pg_unescape_bytea( $b );
1279 function strencode( $s ) { # Should not be called by us
1280 return pg_escape_string( $this->mConn
, $s );
1283 function addQuotes( $s ) {
1284 if ( is_null( $s ) ) {
1286 } elseif ( is_bool( $s ) ) {
1287 return intval( $s );
1288 } elseif ( $s instanceof Blob
) {
1289 return "'" . $s->fetch( $s ) . "'";
1291 return "'" . pg_escape_string( $this->mConn
, $s ) . "'";
1295 * Postgres specific version of replaceVars.
1296 * Calls the parent version in Database.php
1300 * @param $ins String: SQL string, read from a stream (usually tables.sql)
1302 * @return string SQL string
1304 protected function replaceVars( $ins ) {
1305 $ins = parent
::replaceVars( $ins );
1307 if ( $this->numeric_version
>= 8.3 ) {
1308 // Thanks for not providing backwards-compatibility, 8.3
1309 $ins = preg_replace( "/to_tsvector\s*\(\s*'default'\s*,/", 'to_tsvector(', $ins );
1312 if ( $this->numeric_version
<= 8.1 ) { // Our minimum version
1313 $ins = str_replace( 'USING gin', 'USING gist', $ins );
1320 * Various select options
1324 * @param $options Array: an associative array of options to be turned into
1325 * an SQL query, valid keys are listed in the function.
1328 function makeSelectOptions( $options ) {
1329 $preLimitTail = $postLimitTail = '';
1330 $startOpts = $useIndex = '';
1332 $noKeyOptions = array();
1333 foreach ( $options as $key => $option ) {
1334 if ( is_numeric( $key ) ) {
1335 $noKeyOptions[$option] = true;
1339 if ( isset( $options['GROUP BY'] ) ) {
1340 $preLimitTail .= ' GROUP BY ' . $options['GROUP BY'];
1342 if ( isset( $options['HAVING'] ) ) {
1343 $preLimitTail .= " HAVING {$options['HAVING']}";
1345 if ( isset( $options['ORDER BY'] ) ) {
1346 $preLimitTail .= ' ORDER BY ' . $options['ORDER BY'];
1349 //if ( isset( $options['LIMIT'] ) ) {
1350 // $tailOpts .= $this->limitResult( '', $options['LIMIT'],
1351 // isset( $options['OFFSET'] ) ? $options['OFFSET']
1355 if ( isset( $noKeyOptions['FOR UPDATE'] ) ) {
1356 $postLimitTail .= ' FOR UPDATE';
1358 if ( isset( $noKeyOptions['LOCK IN SHARE MODE'] ) ) {
1359 $postLimitTail .= ' LOCK IN SHARE MODE';
1361 if ( isset( $noKeyOptions['DISTINCT'] ) ||
isset( $noKeyOptions['DISTINCTROW'] ) ) {
1362 $startOpts .= 'DISTINCT';
1365 return array( $startOpts, $useIndex, $preLimitTail, $postLimitTail );
1368 function setFakeMaster( $enabled = true ) {}
1370 function getDBname() {
1371 return $this->mDBname
;
1374 function getServer() {
1375 return $this->mServer
;
1378 function buildConcat( $stringList ) {
1379 return implode( ' || ', $stringList );
1382 public function getSearchEngine() {
1383 return 'SearchPostgres';
1385 } // end DatabasePostgres class