4 * This is the Postgres database abstraction layer.
6 * As it includes more generic version for DB functions,
7 * than MySQL ones, some of them should be moved to parent
13 private $name, $tablename, $type, $nullable, $max_length;
15 static function fromText($db, $table, $field) {
19 SELECT typname, attnotnull, attlen
20 FROM pg_class, pg_namespace, pg_attribute, pg_type
21 WHERE relnamespace=pg_namespace.oid
23 AND attrelid=pg_class.oid
24 AND atttypid=pg_type.oid
29 $res = $db->query(sprintf($q,
30 $db->addQuotes($wgDBmwschema),
31 $db->addQuotes($table),
32 $db->addQuotes($field)));
33 $row = $db->fetchObject($res);
36 $n = new PostgresField
;
37 $n->type
= $row->typname
;
38 $n->nullable
= ($row->attnotnull
== 'f');
40 $n->tablename
= $table;
41 $n->max_length
= $row->attlen
;
49 function tableName() {
50 return $this->tablename
;
58 return $this->nullable
;
61 function maxLength() {
62 return $this->max_length
;
66 class DatabasePostgres
extends Database
{
67 var $mInsertId = NULL;
68 var $mLastResult = NULL;
69 var $numeric_version = NULL;
71 function DatabasePostgres($server = false, $user = false, $password = false, $dbName = false,
72 $failFunction = false, $flags = 0 )
76 # Can't get a reference if it hasn't been set yet
77 if ( !isset( $wgOut ) ) {
80 $this->mOut
=& $wgOut;
81 $this->mFailFunction
= $failFunction;
82 $this->mFlags
= $flags;
83 $this->open( $server, $user, $password, $dbName);
87 function cascadingDeletes() {
90 function cleanupTriggers() {
93 function strictIPs() {
96 function realTimestamps() {
99 function implicitGroupby() {
102 function searchableIPs() {
106 static function newFromParams( $server, $user, $password, $dbName, $failFunction = false, $flags = 0)
108 return new DatabasePostgres( $server, $user, $password, $dbName, $failFunction, $flags );
112 * Usually aborts on failure
113 * If the failFunction is set to a non-zero integer, returns success
115 function open( $server, $user, $password, $dbName ) {
116 # Test for Postgres support, to avoid suppressed fatal error
117 if ( !function_exists( 'pg_connect' ) ) {
118 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" );
123 if (!strlen($user)) { ## e.g. the class is being loaded
128 $this->mServer
= $server;
130 $this->mUser
= $user;
131 $this->mPassword
= $password;
132 $this->mDBname
= $dbName;
135 if ($server!=false && $server!="") {
136 $hstring="host=$server ";
138 if ($port!=false && $port!="") {
139 $hstring .= "port=$port ";
143 error_reporting( E_ALL
);
144 @$this->mConn
= pg_connect("$hstring dbname=$dbName user=$user password=$password");
146 if ( $this->mConn
== false ) {
147 wfDebug( "DB connection error\n" );
148 wfDebug( "Server: $server, Database: $dbName, User: $user, Password: " . substr( $password, 0, 3 ) . "...\n" );
149 wfDebug( $this->lastError()."\n" );
153 $this->mOpened
= true;
154 ## If this is the initial connection, setup the schema stuff and possibly create the user
155 if (defined('MEDIAWIKI_INSTALL')) {
156 global $wgDBname, $wgDBuser, $wgDBpassword, $wgDBsuperuser, $wgDBmwschema,
159 print "<li>Checking the version of Postgres...";
160 $version = $this->getServerVersion();
162 if ($this->numeric_version
< $PGMINVER) {
163 print "<b>FAILED</b>. Required version is $PGMINVER. You have $this->numeric_version ($version)</li>\n";
166 print "version $this->numeric_version is OK.</li>\n";
168 $safeuser = $this->quote_ident($wgDBuser);
169 ## Are we connecting as a superuser for the first time?
170 if ($wgDBsuperuser) {
171 ## Are we really a superuser? Check out our rights
173 CASE WHEN usesuper IS TRUE THEN
174 CASE WHEN usecreatedb IS TRUE THEN 3 ELSE 1 END
175 ELSE CASE WHEN usecreatedb IS TRUE THEN 2 ELSE 0 END
177 FROM pg_catalog.pg_user WHERE usename = " . $this->addQuotes($wgDBsuperuser);
178 $rows = $this->numRows($res = $this->doQuery($SQL));
180 print "<li>ERROR: Could not read permissions for user \"$wgDBsuperuser\"</li>\n";
183 $perms = pg_fetch_result($res, 0, 0);
185 $SQL = "SELECT 1 FROM pg_catalog.pg_user WHERE usename = " . $this->addQuotes($wgDBuser);
186 $rows = $this->numRows($this->doQuery($SQL));
188 print "<li>User \"$wgDBuser\" already exists, skipping account creation.</li>";
191 if ($perms != 1 and $perms != 3) {
192 print "<li>ERROR: the user \"$wgDBsuperuser\" cannot create other users. ";
193 print 'Please use a different Postgres user.</li>';
196 print "<li>Creating user <b>$wgDBuser</b>...";
197 $safepass = $this->addQuotes($wgDBpassword);
198 $SQL = "CREATE USER $safeuser NOCREATEDB PASSWORD $safepass";
199 $this->doQuery($SQL);
202 ## User now exists, check out the database
203 if ($dbName != $wgDBname) {
204 $SQL = "SELECT 1 FROM pg_catalog.pg_database WHERE datname = " . $this->addQuotes($wgDBname);
205 $rows = $this->numRows($this->doQuery($SQL));
207 print "<li>Database \"$wgDBname\" already exists, skipping database creation.</li>";
211 print "<li>ERROR: the user \"$wgDBsuperuser\" cannot create databases. ";
212 print 'Please use a different Postgres user.</li>';
215 print "<li>Creating database <b>$wgDBname</b>...";
216 $safename = $this->quote_ident($wgDBname);
217 $SQL = "CREATE DATABASE $safename OWNER $safeuser ";
218 $this->doQuery($SQL);
220 ## Hopefully tsearch2 and plpgsql are in template1...
223 ## Reconnect to check out tsearch2 rights for this user
224 print "<li>Connecting to \"$wgDBname\" as superuser \"$wgDBsuperuser\" to check rights...";
225 @$this->mConn
= pg_connect("$hstring dbname=$wgDBname user=$user password=$password");
226 if ( $this->mConn
== false ) {
227 print "<b>FAILED TO CONNECT!</b></li>";
234 print "<li>Checking that tsearch2 is installed in the database \"$wgDBname\"...";
235 if (! $this->tableExists("pg_ts_cfg", $wgDBts2schema)) {
236 print "<b>FAILED</b>. tsearch2 must be installed in the database \"$wgDBname\".";
237 print "Please see <a href='http://www.devx.com/opensource/Article/21674/0/page/2'>this article</a>";
238 print " for instructions or ask on #postgresql on irc.freenode.net</li>\n";
242 print "<li>Ensuring that user \"$wgDBuser\" has select rights on the tsearch2 tables...";
243 foreach (array('cfg','cfgmap','dict','parser') as $table) {
244 $SQL = "GRANT SELECT ON pg_ts_$table TO $safeuser";
245 $this->doQuery($SQL);
250 ## Setup the schema for this user if needed
251 $result = $this->schemaExists($wgDBmwschema);
252 $safeschema = $this->quote_ident($wgDBmwschema);
254 print "<li>Creating schema <b>$wgDBmwschema</b> ...";
255 $result = $this->doQuery("CREATE SCHEMA $safeschema AUTHORIZATION $safeuser");
257 print "<b>FAILED</b>.</li>\n";
263 print "<li>Schema already exists, explicitly granting rights...\n";
264 $safeschema2 = $this->addQuotes($wgDBmwschema);
265 $SQL = "SELECT 'GRANT ALL ON '||pg_catalog.quote_ident(relname)||' TO $safeuser;'\n".
266 "FROM pg_catalog.pg_class p, pg_catalog.pg_namespace n\n".
267 "WHERE relnamespace = n.oid AND n.nspname = $safeschema2\n".
268 "AND p.relkind IN ('r','S','v')\n";
270 $SQL .= "SELECT 'GRANT ALL ON FUNCTION '||pg_catalog.quote_ident(proname)||'('||\n".
271 "pg_catalog.oidvectortypes(p.proargtypes)||') TO $safeuser;'\n".
272 "FROM pg_catalog.pg_proc p, pg_catalog.pg_namespace n\n".
273 "WHERE p.pronamespace = n.oid AND n.nspname = $safeschema2";
274 $res = $this->doQuery($SQL);
276 print "<b>FAILED</b>. Could not set rights for the user.</li>\n";
279 $this->doQuery("SET search_path = $safeschema");
280 $rows = $this->numRows($res);
283 $this->doQuery(pg_fetch_result($res, $rows, 0));
289 return true; ## Reconnect as regular user
293 if (!defined('POSTGRES_SEARCHPATH')) {
295 ## Do we have the basic tsearch2 table?
296 print "<li>Checking for tsearch2 in the schema \"$wgDBts2schema\"...";
297 if (! $this->tableExists("pg_ts_dict", $wgDBts2schema)) {
298 print "<b>FAILED</b>. Make sure tsearch2 is installed. See <a href=";
299 print "'http://www.devx.com/opensource/Article/21674/0/page/2'>this article</a>";
300 print " for instructions.</li>\n";
305 ## Does this user have the rights to the tsearch2 tables?
306 $ctype = pg_fetch_result($this->doQuery("SHOW lc_ctype"),0,0);
307 print "<li>Checking tsearch2 permissions...";
308 ## Let's check all four, just to be safe
309 error_reporting( 0 );
310 $ts2tables = array('cfg','cfgmap','dict','parser');
311 foreach ( $ts2tables AS $tname ) {
312 $SQL = "SELECT count(*) FROM $wgDBts2schema.pg_ts_$tname";
313 $res = $this->doQuery($SQL);
315 print "<b>FAILED</b> to access pg_ts_$tname. Make sure that the user ".
316 "\"$wgDBuser\" has SELECT access to all four tsearch2 tables</li>\n";
320 $SQL = "SELECT ts_name FROM $wgDBts2schema.pg_ts_cfg WHERE locale = '$ctype'";
321 $SQL .= " ORDER BY CASE WHEN ts_name <> 'default' THEN 1 ELSE 0 END";
322 $res = $this->doQuery($SQL);
323 error_reporting( E_ALL
);
325 print "<b>FAILED</b>. Could not determine the tsearch2 locale information</li>\n";
330 ## Will the current locale work? Can we force it to?
331 print "<li>Verifying tsearch2 locale with $ctype...";
332 $rows = $this->numRows($res);
335 print "<b>not found</b></li>\n";
336 print "<li>Attempting to set default tsearch2 locale to \"$ctype\"...";
340 $tsname = pg_fetch_result($res, 0, 0);
341 if ($tsname != 'default') {
342 print "<b>not set to default ($tsname)</b>";
343 print "<li>Attempting to change tsearch2 default locale to \"$ctype\"...";
348 $SQL = "UPDATE $wgDBts2schema.pg_ts_cfg SET locale = '$ctype' WHERE ts_name = 'default'";
349 $res = $this->doQuery($SQL);
351 print "<b>FAILED</b>. ";
352 print "Please make sure that the locale in pg_ts_cfg for \"default\" is set to \"$ctype\"</li>\n";
358 ## Final test: try out a simple tsearch2 query
359 $SQL = "SELECT $wgDBts2schema.to_tsvector('default','MediaWiki tsearch2 testing')";
360 $res = $this->doQuery($SQL);
362 print "<b>FAILED</b>. Specifically, \"$SQL\" did not work.</li>";
367 ## Do we have plpgsql installed?
368 print "<li>Checking for Pl/Pgsql ...";
369 $SQL = "SELECT 1 FROM pg_catalog.pg_language WHERE lanname = 'plpgsql'";
370 $rows = $this->numRows($this->doQuery($SQL));
372 // plpgsql is not installed, but if we have a pg_pltemplate table, we should be able to create it
373 print "not installed. Attempting to install Pl/Pgsql ...";
374 $SQL = "SELECT 1 FROM pg_catalog.pg_class c JOIN pg_catalog.pg_namespace n ON (n.oid = c.relnamespace) ".
375 "WHERE relname = 'pg_pltemplate' AND nspname='pg_catalog'";
376 $rows = $this->numRows($this->doQuery($SQL));
378 $result = $this->doQuery("CREATE LANGUAGE plpgsql");
380 print "<b>FAILED</b>. You need to install the language plpgsql in the database <tt>$wgDBname</tt></li>";
385 print "<b>FAILED</b>. You need to install the language plpgsql in the database <tt>$wgDBname</tt></li>";
391 ## Does the schema already exist? Who owns it?
392 $result = $this->schemaExists($wgDBmwschema);
394 print "<li>Creating schema <b>$wgDBmwschema</b> ...";
395 error_reporting( 0 );
396 $result = $this->doQuery("CREATE SCHEMA $wgDBmwschema");
397 error_reporting( E_ALL
);
399 print "<b>FAILED</b>. The user \"$wgDBuser\" must be able to access the schema. ".
400 "You can try making them the owner of the database, or try creating the schema with a ".
401 "different user, and then grant access to the \"$wgDBuser\" user.</li>\n";
406 else if ($result != $user) {
407 print "<li>Schema \"$wgDBmwschema\" exists but is not owned by \"$user\". Not ideal.</li>\n";
410 print "<li>Schema \"$wgDBmwschema\" exists and is owned by \"$user\". Excellent.</li>\n";
413 ## Fix up the search paths if needed
414 print "<li>Setting the search path for user \"$user\" ...";
415 $path = $this->quote_ident($wgDBmwschema);
416 if ($wgDBts2schema !== $wgDBmwschema)
417 $path .= ", ". $this->quote_ident($wgDBts2schema);
418 if ($wgDBmwschema !== 'public' and $wgDBts2schema !== 'public')
420 $SQL = "ALTER USER $safeuser SET search_path = $path";
421 $result = pg_query($this->mConn
, $SQL);
423 print "<b>FAILED</b>.</li>\n";
427 ## Set for the rest of this session
428 $SQL = "SET search_path = $path";
429 $result = pg_query($this->mConn
, $SQL);
431 print "<li>Failed to set search_path</li>\n";
434 define( "POSTGRES_SEARCHPATH", $path );
437 global $wgCommandLineMode;
438 ## If called from the command-line (e.g. importDump), only show errors
439 if ($wgCommandLineMode) {
440 $this->doQuery("SET client_min_messages = 'ERROR'");
447 * Closes a database connection, if it is open
448 * Returns success, true if already closed
451 $this->mOpened
= false;
452 if ( $this->mConn
) {
453 return pg_close( $this->mConn
);
459 function doQuery( $sql ) {
460 return $this->mLastResult
=pg_query( $this->mConn
, $sql);
463 function queryIgnore( $sql, $fname = '' ) {
464 return $this->query( $sql, $fname, true );
467 function freeResult( $res ) {
468 if ( !@pg_free_result
( $res ) ) {
469 throw new DBUnexpectedError($this, "Unable to free Postgres result\n" );
473 function fetchObject( $res ) {
474 @$row = pg_fetch_object( $res );
475 # FIXME: HACK HACK HACK HACK debug
478 # hashar : not sure if the following test really trigger if the object
480 if( pg_last_error($this->mConn
) ) {
481 throw new DBUnexpectedError($this, 'SQL error: ' . htmlspecialchars( pg_last_error($this->mConn
) ) );
486 function fetchRow( $res ) {
487 @$row = pg_fetch_array( $res );
488 if( pg_last_error($this->mConn
) ) {
489 throw new DBUnexpectedError($this, 'SQL error: ' . htmlspecialchars( pg_last_error($this->mConn
) ) );
494 function numRows( $res ) {
495 @$n = pg_num_rows( $res );
496 if( pg_last_error($this->mConn
) ) {
497 throw new DBUnexpectedError($this, 'SQL error: ' . htmlspecialchars( pg_last_error($this->mConn
) ) );
501 function numFields( $res ) { return pg_num_fields( $res ); }
502 function fieldName( $res, $n ) { return pg_field_name( $res, $n ); }
505 * This must be called after nextSequenceVal
507 function insertId() {
508 return $this->mInsertId
;
511 function dataSeek( $res, $row ) { return pg_result_seek( $res, $row ); }
512 function lastError() {
513 if ( $this->mConn
) {
514 return pg_last_error();
517 return "No database connection";
520 function lastErrno() {
521 return pg_last_error() ?
1 : 0;
524 function affectedRows() {
525 return pg_affected_rows( $this->mLastResult
);
529 * Returns information about an index
530 * If errors are explicitly ignored, returns NULL on failure
532 function indexInfo( $table, $index, $fname = 'Database::indexExists' ) {
533 $sql = "SELECT indexname FROM pg_indexes WHERE tablename='$table'";
534 $res = $this->query( $sql, $fname );
539 while ( $row = $this->fetchObject( $res ) ) {
540 if ( $row->indexname
== $index ) {
543 // BUG: !!!! This code needs to be synced up with database.php
550 function indexUnique ($table, $index, $fname = 'Database::indexUnique' ) {
551 $sql = "SELECT indexname FROM pg_indexes WHERE tablename='{$table}'".
552 " AND indexdef LIKE 'CREATE UNIQUE%({$index})'";
553 $res = $this->query( $sql, $fname );
556 while ($row = $this->fetchObject( $res ))
562 function insert( $table, $a, $fname = 'Database::insert', $options = array() ) {
563 # Postgres doesn't support options
564 # We have a go at faking one of them
565 # TODO: DELAYED, LOW_PRIORITY
567 if ( !is_array($options))
568 $options = array($options);
570 if ( in_array( 'IGNORE', $options ) )
571 $oldIgnore = $this->ignoreErrors( true );
573 # IGNORE is performed using single-row inserts, ignoring errors in each
574 # FIXME: need some way to distiguish between key collision and other types of error
575 $oldIgnore = $this->ignoreErrors( true );
576 if ( !is_array( reset( $a ) ) ) {
579 foreach ( $a as $row ) {
580 parent
::insert( $table, $row, $fname, array() );
582 $this->ignoreErrors( $oldIgnore );
585 if ( in_array( 'IGNORE', $options ) )
586 $this->ignoreErrors( $oldIgnore );
591 function tableName( $name ) {
592 # Replace reserved words with better ones
597 return 'pagecontent';
604 * Return the next in a sequence, save the value for retrieval via insertId()
606 function nextSequenceValue( $seqName ) {
607 $safeseq = preg_replace( "/'/", "''", $seqName );
608 $res = $this->query( "SELECT nextval('$safeseq')" );
609 $row = $this->fetchRow( $res );
610 $this->mInsertId
= $row[0];
611 $this->freeResult( $res );
612 return $this->mInsertId
;
616 * Postgres does not have a "USE INDEX" clause, so return an empty string
618 function useIndexClause( $index ) {
622 # REPLACE query wrapper
623 # Postgres simulates this with a DELETE followed by INSERT
624 # $row is the row to insert, an associative array
625 # $uniqueIndexes is an array of indexes. Each element may be either a
626 # field name or an array of field names
628 # It may be more efficient to leave off unique indexes which are unlikely to collide.
629 # However if you do this, you run the risk of encountering errors which wouldn't have
631 function replace( $table, $uniqueIndexes, $rows, $fname = 'Database::replace' ) {
632 $table = $this->tableName( $table );
634 if (count($rows)==0) {
639 if ( !is_array( reset( $rows ) ) ) {
640 $rows = array( $rows );
643 foreach( $rows as $row ) {
644 # Delete rows which collide
645 if ( $uniqueIndexes ) {
646 $sql = "DELETE FROM $table WHERE ";
648 foreach ( $uniqueIndexes as $index ) {
655 if ( is_array( $index ) ) {
657 foreach ( $index as $col ) {
663 $sql .= $col.'=' . $this->addQuotes( $row[$col] );
666 $sql .= $index.'=' . $this->addQuotes( $row[$index] );
670 $this->query( $sql, $fname );
674 $sql = "INSERT INTO $table (" . $this->makeList( array_keys( $row ), LIST_NAMES
) .') VALUES (' .
675 $this->makeList( $row, LIST_COMMA
) . ')';
676 $this->query( $sql, $fname );
680 # DELETE where the condition is a join
681 function deleteJoin( $delTable, $joinTable, $delVar, $joinVar, $conds, $fname = "Database::deleteJoin" ) {
683 throw new DBUnexpectedError($this, 'Database::deleteJoin() called with empty $conds' );
686 $delTable = $this->tableName( $delTable );
687 $joinTable = $this->tableName( $joinTable );
688 $sql = "DELETE FROM $delTable WHERE $delVar IN (SELECT $joinVar FROM $joinTable ";
689 if ( $conds != '*' ) {
690 $sql .= 'WHERE ' . $this->makeList( $conds, LIST_AND
);
694 $this->query( $sql, $fname );
697 # Returns the size of a text field, or -1 for "unlimited"
698 function textFieldSize( $table, $field ) {
699 $table = $this->tableName( $table );
700 $sql = "SELECT t.typname as ftype,a.atttypmod as size
701 FROM pg_class c, pg_attribute a, pg_type t
702 WHERE relname='$table' AND a.attrelid=c.oid AND
703 a.atttypid=t.oid and a.attname='$field'";
704 $res =$this->query($sql);
705 $row=$this->fetchObject($res);
706 if ($row->ftype
=="varchar") {
711 $this->freeResult( $res );
715 function lowPriorityOption() {
719 function limitResult($sql, $limit,$offset=false) {
720 return "$sql LIMIT $limit ".(is_numeric($offset)?
" OFFSET {$offset} ":"");
724 * Returns an SQL expression for a simple conditional.
725 * Uses CASE on Postgres
727 * @param string $cond SQL expression which will result in a boolean value
728 * @param string $trueVal SQL expression to return if true
729 * @param string $falseVal SQL expression to return if false
730 * @return string SQL fragment
732 function conditional( $cond, $trueVal, $falseVal ) {
733 return " (CASE WHEN $cond THEN $trueVal ELSE $falseVal END) ";
736 function wasDeadlock() {
737 return $this->lastErrno() == '40P01';
740 function timestamp( $ts=0 ) {
741 return wfTimestamp(TS_POSTGRES
,$ts);
745 * Return aggregated value function call
747 function aggregateValue ($valuedata,$valuename='value') {
752 function reportQueryError( $error, $errno, $sql, $fname, $tempIgnore = false ) {
753 # Ignore errors during error handling to avoid infinite recursion
754 $ignore = $this->ignoreErrors( true );
755 ++
$this->mErrorCount
;
757 if ($ignore ||
$tempIgnore) {
758 wfDebug("SQL ERROR (ignored): $error\n");
759 $this->ignoreErrors( $ignore );
762 $message = "A database error has occurred\n" .
764 "Function: $fname\n" .
765 "Error: $errno $error\n";
766 throw new DBUnexpectedError($this, $message);
771 * @return string wikitext of a link to the server software's web site
773 function getSoftwareLink() {
774 return "[http://www.postgresql.org/ PostgreSQL]";
778 * @return string Version information from the database
780 function getServerVersion() {
781 $version = pg_fetch_result($this->doQuery("SELECT version()"),0,0);
783 if (!preg_match('/PostgreSQL (\d+\.\d+)(\S+)/', $version, $thisver)) {
784 die("Could not determine the numeric version from $version!");
786 $this->numeric_version
= $thisver[1];
792 * Query whether a given relation exists (in the given schema, or the
793 * default mw one if not given)
795 function relationExists( $table, $types, $schema = false ) {
796 global $wgDBmwschema;
797 if (!is_array($types))
798 $types = array($types);
800 $schema = $wgDBmwschema;
801 $etable = $this->addQuotes($table);
802 $eschema = $this->addQuotes($schema);
803 $SQL = "SELECT 1 FROM pg_catalog.pg_class c, pg_catalog.pg_namespace n "
804 . "WHERE c.relnamespace = n.oid AND c.relname = $etable AND n.nspname = $eschema "
805 . "AND c.relkind IN ('" . implode("','", $types) . "')";
806 $res = $this->query( $SQL );
807 $count = $res ?
pg_num_rows($res) : 0;
809 $this->freeResult( $res );
814 * For backward compatibility, this function checks both tables and
817 function tableExists ($table, $schema = false) {
818 return $this->relationExists($table, array('r', 'v'), $schema);
821 function sequenceExists ($sequence, $schema = false) {
822 return $this->relationExists($sequence, 'S', $schema);
825 function triggerExists($table, $trigger) {
826 global $wgDBmwschema;
829 SELECT 1 FROM pg_class, pg_namespace, pg_trigger
830 WHERE relnamespace=pg_namespace.oid AND relkind='r'
831 AND tgrelid=pg_class.oid
832 AND nspname=%s AND relname=%s AND tgname=%s
834 $res = $this->query(sprintf($q,
835 $this->addQuotes($wgDBmwschema),
836 $this->addQuotes($table),
837 $this->addQuotes($trigger)));
838 $row = $this->fetchRow($res);
840 $this->freeResult($res);
844 function ruleExists($table, $rule) {
845 global $wgDBmwschema;
846 $exists = $this->selectField("pg_rules", "rulename",
847 array( "rulename" => $rule,
848 "tablename" => $table,
849 "schemaname" => $wgDBmwschema));
850 return $exists === $rule;
854 * Query whether a given schema exists. Returns the name of the owner
856 function schemaExists( $schema ) {
857 $eschema = preg_replace("/'/", "''", $schema);
858 $SQL = "SELECT rolname FROM pg_catalog.pg_namespace n, pg_catalog.pg_roles r "
859 ."WHERE n.nspowner=r.oid AND n.nspname = '$eschema'";
860 $res = $this->query( $SQL );
861 $owner = $res ?
pg_num_rows($res) ?
pg_fetch_result($res, 0, 0) : false : false;
863 $this->freeResult($res);
868 * Query whether a given column exists in the mediawiki schema
870 function fieldExists( $table, $field, $fname = 'DatabasePostgres::fieldExists' ) {
871 global $wgDBmwschema;
872 $etable = preg_replace("/'/", "''", $table);
873 $eschema = preg_replace("/'/", "''", $wgDBmwschema);
874 $ecol = preg_replace("/'/", "''", $field);
875 $SQL = "SELECT 1 FROM pg_catalog.pg_class c, pg_catalog.pg_namespace n, pg_catalog.pg_attribute a "
876 . "WHERE c.relnamespace = n.oid AND c.relname = '$etable' AND n.nspname = '$eschema' "
877 . "AND a.attrelid = c.oid AND a.attname = '$ecol'";
878 $res = $this->query( $SQL, $fname );
879 $count = $res ?
pg_num_rows($res) : 0;
881 $this->freeResult( $res );
885 function fieldInfo( $table, $field ) {
886 return PostgresField
::fromText($this, $table, $field);
889 function begin( $fname = 'DatabasePostgres::begin' ) {
890 $this->query( 'BEGIN', $fname );
891 $this->mTrxLevel
= 1;
893 function immediateCommit( $fname = 'DatabasePostgres::immediateCommit' ) {
896 function commit( $fname = 'DatabasePostgres::commit' ) {
897 $this->query( 'COMMIT', $fname );
898 $this->mTrxLevel
= 0;
901 /* Not even sure why this is used in the main codebase... */
902 function limitResultForUpdate($sql, $num) {
906 function setup_database() {
907 global $wgVersion, $wgDBmwschema, $wgDBts2schema, $wgDBport, $wgDBuser;
909 ## Make sure that we can write to the correct schema
910 ## If not, Postgres will happily and silently go to the next search_path item
911 $ctest = "mw_test_table";
912 if ($this->tableExists($ctest, $wgDBmwschema)) {
913 $this->doQuery("DROP TABLE $wgDBmwschema.$ctest");
915 $SQL = "CREATE TABLE $wgDBmwschema.$ctest(a int)";
916 error_reporting( 0 );
917 $res = $this->doQuery($SQL);
918 error_reporting( E_ALL
);
920 print "<b>FAILED</b>. Make sure that the user \"$wgDBuser\" can write to the schema \"$wgDBmwschema\"</li>\n";
923 $this->doQuery("DROP TABLE $wgDBmwschema.mw_test_table");
925 dbsource( "../maintenance/postgres/tables.sql", $this);
927 ## Version-specific stuff
928 if ($this->numeric_version
== 8.1) {
929 $this->doQuery("CREATE INDEX ts2_page_text ON pagecontent USING gist(textvector)");
930 $this->doQuery("CREATE INDEX ts2_page_title ON page USING gist(titlevector)");
933 $this->doQuery("CREATE INDEX ts2_page_text ON pagecontent USING gin(textvector)");
934 $this->doQuery("CREATE INDEX ts2_page_title ON page USING gin(titlevector)");
937 ## Update version information
938 $mwv = $this->addQuotes($wgVersion);
939 $pgv = $this->addQuotes($this->getServerVersion());
940 $pgu = $this->addQuotes($this->mUser
);
941 $mws = $this->addQuotes($wgDBmwschema);
942 $tss = $this->addQuotes($wgDBts2schema);
943 $pgp = $this->addQuotes($wgDBport);
944 $dbn = $this->addQuotes($this->mDBname
);
945 $ctype = pg_fetch_result($this->doQuery("SHOW lc_ctype"),0,0);
947 $SQL = "UPDATE mediawiki_version SET mw_version=$mwv, pg_version=$pgv, pg_user=$pgu, ".
948 "mw_schema = $mws, ts2_schema = $tss, pg_port=$pgp, pg_dbname=$dbn, ".
950 "WHERE type = 'Creation'";
953 ## Avoid the non-standard "REPLACE INTO" syntax
954 $f = fopen( "../maintenance/interwiki.sql", 'r' );
956 dieout( "<li>Could not find the interwiki.sql file");
958 ## We simply assume it is already empty as we have just created it
959 $SQL = "INSERT INTO interwiki(iw_prefix,iw_url,iw_local) VALUES ";
960 while ( ! feof( $f ) ) {
961 $line = fgets($f,1024);
963 if (!preg_match('/^\s*(\(.+?),(\d)\)/', $line, $matches)) {
966 $this->query("$SQL $matches[1],$matches[2])");
968 print " (table interwiki successfully populated)...\n";
970 $this->doQuery("COMMIT");
973 function encodeBlob($b) {
974 return array('bytea',pg_escape_bytea($b));
976 function decodeBlob($b) {
977 return pg_unescape_bytea( $b );
980 function strencode( $s ) { ## Should not be called by us
981 return pg_escape_string( $s );
984 function addQuotes( $s ) {
985 if ( is_null( $s ) ) {
987 } else if (is_array( $s )) { ## Assume it is bytea data
990 return "'" . pg_escape_string($s) . "'";
991 // Unreachable: return "E'" . pg_escape_string($s) . "'";
994 function quote_ident( $s ) {
995 return '"' . preg_replace( '/"/', '""', $s) . '"';
998 /* For now, does nothing */
999 function selectDB( $db ) {
1004 * Returns an optional USE INDEX clause to go after the table, and a
1005 * string to go at the end of the query
1009 * @param array $options an associative array of options to be turned into
1010 * an SQL query, valid keys are listed in the function.
1013 function makeSelectOptions( $options ) {
1014 $preLimitTail = $postLimitTail = '';
1017 $noKeyOptions = array();
1018 foreach ( $options as $key => $option ) {
1019 if ( is_numeric( $key ) ) {
1020 $noKeyOptions[$option] = true;
1024 if ( isset( $options['GROUP BY'] ) ) $preLimitTail .= " GROUP BY " . $options['GROUP BY'];
1025 if ( isset( $options['ORDER BY'] ) ) $preLimitTail .= " ORDER BY " . $options['ORDER BY'];
1027 //if (isset($options['LIMIT'])) {
1028 // $tailOpts .= $this->limitResult('', $options['LIMIT'],
1029 // isset($options['OFFSET']) ? $options['OFFSET']
1033 if ( isset( $noKeyOptions['FOR UPDATE'] ) ) $postLimitTail .= ' FOR UPDATE';
1034 if ( isset( $noKeyOptions['LOCK IN SHARE MODE'] ) ) $postLimitTail .= ' LOCK IN SHARE MODE';
1035 if ( isset( $noKeyOptions['DISTINCT'] ) && isset( $noKeyOptions['DISTINCTROW'] ) ) $startOpts .= 'DISTINCT';
1037 if ( isset( $options['USE INDEX'] ) && ! is_array( $options['USE INDEX'] ) ) {
1038 $useIndex = $this->useIndexClause( $options['USE INDEX'] );
1043 return array( $startOpts, $useIndex, $preLimitTail, $postLimitTail );
1046 public function setTimeout( $timeout ) {
1051 wfDebug( "Function ping() not written for DatabasePostgres.php yet");
1056 } // end DatabasePostgres class