test SQL for our QueryPages objects
[mediawiki.git] / includes / db / DatabasePostgres.php
blobd991680fe9cbe684cd7b6de714e1d1f4acadad90
1 <?php
2 /**
3 * This is the Postgres database abstraction layer.
5 * @file
6 * @ingroup Database
7 */
9 class PostgresField implements Field {
10 private $name, $tablename, $type, $nullable, $max_length, $deferred, $deferrable, $conname;
12 /**
13 * @param $db DatabaseBase
14 * @param $table
15 * @param $field
16 * @return null|PostgresField
18 static function fromText( $db, $table, $field ) {
19 global $wgDBmwschema;
21 $q = <<<SQL
22 SELECT
23 attnotnull, attlen, COALESCE(conname, '') AS conname,
24 COALESCE(condeferred, 'f') AS deferred,
25 COALESCE(condeferrable, 'f') AS deferrable,
26 CASE WHEN typname = 'int2' THEN 'smallint'
27 WHEN typname = 'int4' THEN 'integer'
28 WHEN typname = 'int8' THEN 'bigint'
29 WHEN typname = 'bpchar' THEN 'char'
30 ELSE typname END AS typname
31 FROM pg_class c
32 JOIN pg_namespace n ON (n.oid = c.relnamespace)
33 JOIN pg_attribute a ON (a.attrelid = c.oid)
34 JOIN pg_type t ON (t.oid = a.atttypid)
35 LEFT JOIN pg_constraint o ON (o.conrelid = c.oid AND a.attnum = ANY(o.conkey) AND o.contype = 'f')
36 WHERE relkind = 'r'
37 AND nspname=%s
38 AND relname=%s
39 AND attname=%s;
40 SQL;
42 $table = $db->tableName( $table, 'raw' );
43 $res = $db->query(
44 sprintf( $q,
45 $db->addQuotes( $wgDBmwschema ),
46 $db->addQuotes( $table ),
47 $db->addQuotes( $field )
50 $row = $db->fetchObject( $res );
51 if ( !$row ) {
52 return null;
54 $n = new PostgresField;
55 $n->type = $row->typname;
56 $n->nullable = ( $row->attnotnull == 'f' );
57 $n->name = $field;
58 $n->tablename = $table;
59 $n->max_length = $row->attlen;
60 $n->deferrable = ( $row->deferrable == 't' );
61 $n->deferred = ( $row->deferred == 't' );
62 $n->conname = $row->conname;
63 return $n;
66 function name() {
67 return $this->name;
70 function tableName() {
71 return $this->tablename;
74 function type() {
75 return $this->type;
78 function isNullable() {
79 return $this->nullable;
82 function maxLength() {
83 return $this->max_length;
86 function is_deferrable() {
87 return $this->deferrable;
90 function is_deferred() {
91 return $this->deferred;
94 function conname() {
95 return $this->conname;
101 * @ingroup Database
103 class DatabasePostgres extends DatabaseBase {
104 var $mInsertId = null;
105 var $mLastResult = null;
106 var $numeric_version = null;
107 var $mAffectedRows = null;
109 function getType() {
110 return 'postgres';
113 function cascadingDeletes() {
114 return true;
116 function cleanupTriggers() {
117 return true;
119 function strictIPs() {
120 return true;
122 function realTimestamps() {
123 return true;
125 function implicitGroupby() {
126 return false;
128 function implicitOrderby() {
129 return false;
131 function searchableIPs() {
132 return true;
134 function functionalIndexes() {
135 return true;
138 function hasConstraint( $name ) {
139 global $wgDBmwschema;
140 $SQL = "SELECT 1 FROM pg_catalog.pg_constraint c, pg_catalog.pg_namespace n WHERE c.connamespace = n.oid AND conname = '" .
141 pg_escape_string( $this->mConn, $name ) . "' AND n.nspname = '" . pg_escape_string( $this->mConn, $wgDBmwschema ) ."'";
142 $res = $this->doQuery( $SQL );
143 return $this->numRows( $res );
147 * Usually aborts on failure
149 function open( $server, $user, $password, $dbName ) {
150 # Test for Postgres support, to avoid suppressed fatal error
151 if ( !function_exists( 'pg_connect' ) ) {
152 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" );
155 global $wgDBport;
157 if ( !strlen( $user ) ) { # e.g. the class is being loaded
158 return;
161 $this->close();
162 $this->mServer = $server;
163 $port = $wgDBport;
164 $this->mUser = $user;
165 $this->mPassword = $password;
166 $this->mDBname = $dbName;
168 $connectVars = array(
169 'dbname' => $dbName,
170 'user' => $user,
171 'password' => $password
173 if ( $server != false && $server != '' ) {
174 $connectVars['host'] = $server;
176 if ( $port != false && $port != '' ) {
177 $connectVars['port'] = $port;
179 $connectString = $this->makeConnectionString( $connectVars, PGSQL_CONNECT_FORCE_NEW );
181 $this->installErrorHandler();
182 $this->mConn = pg_connect( $connectString );
183 $phpError = $this->restoreErrorHandler();
185 if ( !$this->mConn ) {
186 wfDebug( "DB connection error\n" );
187 wfDebug( "Server: $server, Database: $dbName, User: $user, Password: " . substr( $password, 0, 3 ) . "...\n" );
188 wfDebug( $this->lastError() . "\n" );
189 throw new DBConnectionError( $this, str_replace( "\n", ' ', $phpError ) );
192 $this->mOpened = true;
194 global $wgCommandLineMode;
195 # If called from the command-line (e.g. importDump), only show errors
196 if ( $wgCommandLineMode ) {
197 $this->doQuery( "SET client_min_messages = 'ERROR'" );
200 $this->query( "SET client_encoding='UTF8'", __METHOD__ );
201 $this->query( "SET datestyle = 'ISO, YMD'", __METHOD__ );
202 $this->query( "SET timezone = 'GMT'", __METHOD__ );
203 $this->query( "SET standard_conforming_strings = on", __METHOD__ );
205 global $wgDBmwschema;
206 if ( $this->schemaExists( $wgDBmwschema ) ) {
207 $safeschema = $this->addIdentifierQuotes( $wgDBmwschema );
208 $this->doQuery( "SET search_path = $safeschema" );
209 } else {
210 $this->doQuery( "SET search_path = public" );
213 return $this->mConn;
217 * Postgres doesn't support selectDB in the same way MySQL does. So if the
218 * DB name doesn't match the open connection, open a new one
219 * @return
221 function selectDB( $db ) {
222 if ( $this->mDBname !== $db ) {
223 return (bool)$this->open( $this->mServer, $this->mUser, $this->mPassword, $db );
224 } else {
225 return true;
229 function makeConnectionString( $vars ) {
230 $s = '';
231 foreach ( $vars as $name => $value ) {
232 $s .= "$name='" . str_replace( "'", "\\'", $value ) . "' ";
234 return $s;
238 * Closes a database connection, if it is open
239 * Returns success, true if already closed
241 function close() {
242 $this->mOpened = false;
243 if ( $this->mConn ) {
244 return pg_close( $this->mConn );
245 } else {
246 return true;
250 protected function doQuery( $sql ) {
251 if ( function_exists( 'mb_convert_encoding' ) ) {
252 $sql = mb_convert_encoding( $sql, 'UTF-8' );
254 $this->mLastResult = pg_query( $this->mConn, $sql );
255 $this->mAffectedRows = null; // use pg_affected_rows(mLastResult)
256 return $this->mLastResult;
259 function queryIgnore( $sql, $fname = 'DatabasePostgres::queryIgnore' ) {
260 return $this->query( $sql, $fname, true );
263 function freeResult( $res ) {
264 if ( $res instanceof ResultWrapper ) {
265 $res = $res->result;
267 wfSuppressWarnings();
268 $ok = pg_free_result( $res );
269 wfRestoreWarnings();
270 if ( !$ok ) {
271 throw new DBUnexpectedError( $this, "Unable to free Postgres result\n" );
275 function fetchObject( $res ) {
276 if ( $res instanceof ResultWrapper ) {
277 $res = $res->result;
279 wfSuppressWarnings();
280 $row = pg_fetch_object( $res );
281 wfRestoreWarnings();
282 # @todo FIXME: HACK HACK HACK HACK debug
284 # @todo hashar: not sure if the following test really trigger if the object
285 # fetching failed.
286 if( pg_last_error( $this->mConn ) ) {
287 throw new DBUnexpectedError( $this, 'SQL error: ' . htmlspecialchars( pg_last_error( $this->mConn ) ) );
289 return $row;
292 function fetchRow( $res ) {
293 if ( $res instanceof ResultWrapper ) {
294 $res = $res->result;
296 wfSuppressWarnings();
297 $row = pg_fetch_array( $res );
298 wfRestoreWarnings();
299 if( pg_last_error( $this->mConn ) ) {
300 throw new DBUnexpectedError( $this, 'SQL error: ' . htmlspecialchars( pg_last_error( $this->mConn ) ) );
302 return $row;
305 function numRows( $res ) {
306 if ( $res instanceof ResultWrapper ) {
307 $res = $res->result;
309 wfSuppressWarnings();
310 $n = pg_num_rows( $res );
311 wfRestoreWarnings();
312 if( pg_last_error( $this->mConn ) ) {
313 throw new DBUnexpectedError( $this, 'SQL error: ' . htmlspecialchars( pg_last_error( $this->mConn ) ) );
315 return $n;
318 function numFields( $res ) {
319 if ( $res instanceof ResultWrapper ) {
320 $res = $res->result;
322 return pg_num_fields( $res );
325 function fieldName( $res, $n ) {
326 if ( $res instanceof ResultWrapper ) {
327 $res = $res->result;
329 return pg_field_name( $res, $n );
333 * This must be called after nextSequenceVal
335 function insertId() {
336 return $this->mInsertId;
339 function dataSeek( $res, $row ) {
340 if ( $res instanceof ResultWrapper ) {
341 $res = $res->result;
343 return pg_result_seek( $res, $row );
346 function lastError() {
347 if ( $this->mConn ) {
348 return pg_last_error();
349 } else {
350 return 'No database connection';
353 function lastErrno() {
354 return pg_last_error() ? 1 : 0;
357 function affectedRows() {
358 if ( !is_null( $this->mAffectedRows ) ) {
359 // Forced result for simulated queries
360 return $this->mAffectedRows;
362 if( empty( $this->mLastResult ) ) {
363 return 0;
365 return pg_affected_rows( $this->mLastResult );
369 * Estimate rows in dataset
370 * Returns estimated count, based on EXPLAIN output
371 * This is not necessarily an accurate estimate, so use sparingly
372 * Returns -1 if count cannot be found
373 * Takes same arguments as Database::select()
375 function estimateRowCount( $table, $vars = '*', $conds='', $fname = 'DatabasePostgres::estimateRowCount', $options = array() ) {
376 $options['EXPLAIN'] = true;
377 $res = $this->select( $table, $vars, $conds, $fname, $options );
378 $rows = -1;
379 if ( $res ) {
380 $row = $this->fetchRow( $res );
381 $count = array();
382 if( preg_match( '/rows=(\d+)/', $row[0], $count ) ) {
383 $rows = $count[1];
386 return $rows;
390 * Returns information about an index
391 * If errors are explicitly ignored, returns NULL on failure
393 function indexInfo( $table, $index, $fname = 'DatabasePostgres::indexInfo' ) {
394 $sql = "SELECT indexname FROM pg_indexes WHERE tablename='$table'";
395 $res = $this->query( $sql, $fname );
396 if ( !$res ) {
397 return null;
399 foreach ( $res as $row ) {
400 if ( $row->indexname == $this->indexName( $index ) ) {
401 return $row;
404 return false;
407 function indexUnique( $table, $index, $fname = 'DatabasePostgres::indexUnique' ) {
408 $sql = "SELECT indexname FROM pg_indexes WHERE tablename='{$table}'".
409 " AND indexdef LIKE 'CREATE UNIQUE%(" .
410 $this->strencode( $this->indexName( $index ) ) .
411 ")'";
412 $res = $this->query( $sql, $fname );
413 if ( !$res ) {
414 return null;
416 foreach ( $res as $row ) {
417 return true;
419 return false;
423 * INSERT wrapper, inserts an array into a table
425 * $args may be a single associative array, or an array of these with numeric keys,
426 * for multi-row insert (Postgres version 8.2 and above only).
428 * @param $table String: Name of the table to insert to.
429 * @param $args Array: Items to insert into the table.
430 * @param $fname String: Name of the function, for profiling
431 * @param $options String or Array. Valid options: IGNORE
433 * @return bool Success of insert operation. IGNORE always returns true.
435 function insert( $table, $args, $fname = 'DatabasePostgres::insert', $options = array() ) {
436 if ( !count( $args ) ) {
437 return true;
440 $table = $this->tableName( $table );
441 if (! isset( $this->numeric_version ) ) {
442 $this->getServerVersion();
445 if ( !is_array( $options ) ) {
446 $options = array( $options );
449 if ( isset( $args[0] ) && is_array( $args[0] ) ) {
450 $multi = true;
451 $keys = array_keys( $args[0] );
452 } else {
453 $multi = false;
454 $keys = array_keys( $args );
457 // If IGNORE is set, we use savepoints to emulate mysql's behavior
458 $ignore = in_array( 'IGNORE', $options ) ? 'mw' : '';
460 // If we are not in a transaction, we need to be for savepoint trickery
461 $didbegin = 0;
462 if ( $ignore ) {
463 if ( !$this->mTrxLevel ) {
464 $this->begin();
465 $didbegin = 1;
467 $olde = error_reporting( 0 );
468 // For future use, we may want to track the number of actual inserts
469 // Right now, insert (all writes) simply return true/false
470 $numrowsinserted = 0;
473 $sql = "INSERT INTO $table (" . implode( ',', $keys ) . ') VALUES ';
475 if ( $multi ) {
476 if ( $this->numeric_version >= 8.2 && !$ignore ) {
477 $first = true;
478 foreach ( $args as $row ) {
479 if ( $first ) {
480 $first = false;
481 } else {
482 $sql .= ',';
484 $sql .= '(' . $this->makeList( $row ) . ')';
486 $res = (bool)$this->query( $sql, $fname, $ignore );
487 } else {
488 $res = true;
489 $origsql = $sql;
490 foreach ( $args as $row ) {
491 $tempsql = $origsql;
492 $tempsql .= '(' . $this->makeList( $row ) . ')';
494 if ( $ignore ) {
495 pg_query( $this->mConn, "SAVEPOINT $ignore" );
498 $tempres = (bool)$this->query( $tempsql, $fname, $ignore );
500 if ( $ignore ) {
501 $bar = pg_last_error();
502 if ( $bar != false ) {
503 pg_query( $this->mConn, "ROLLBACK TO $ignore" );
504 } else {
505 pg_query( $this->mConn, "RELEASE $ignore" );
506 $numrowsinserted++;
510 // If any of them fail, we fail overall for this function call
511 // Note that this will be ignored if IGNORE is set
512 if ( !$tempres ) {
513 $res = false;
517 } else {
518 // Not multi, just a lone insert
519 if ( $ignore ) {
520 pg_query($this->mConn, "SAVEPOINT $ignore");
523 $sql .= '(' . $this->makeList( $args ) . ')';
524 $res = (bool)$this->query( $sql, $fname, $ignore );
525 if ( $ignore ) {
526 $bar = pg_last_error();
527 if ( $bar != false ) {
528 pg_query( $this->mConn, "ROLLBACK TO $ignore" );
529 } else {
530 pg_query( $this->mConn, "RELEASE $ignore" );
531 $numrowsinserted++;
535 if ( $ignore ) {
536 $olde = error_reporting( $olde );
537 if ( $didbegin ) {
538 $this->commit();
541 // Set the affected row count for the whole operation
542 $this->mAffectedRows = $numrowsinserted;
544 // IGNORE always returns true
545 return true;
548 return $res;
552 * INSERT SELECT wrapper
553 * $varMap must be an associative array of the form array( 'dest1' => 'source1', ...)
554 * Source items may be literals rather then field names, but strings should be quoted with Database::addQuotes()
555 * $conds may be "*" to copy the whole table
556 * srcTable may be an array of tables.
557 * @todo FIXME: Implement this a little better (seperate select/insert)?
559 function insertSelect( $destTable, $srcTable, $varMap, $conds, $fname = 'DatabasePostgres::insertSelect',
560 $insertOptions = array(), $selectOptions = array() )
562 $destTable = $this->tableName( $destTable );
564 // If IGNORE is set, we use savepoints to emulate mysql's behavior
565 $ignore = in_array( 'IGNORE', $insertOptions ) ? 'mw' : '';
567 if( is_array( $insertOptions ) ) {
568 $insertOptions = implode( ' ', $insertOptions ); // FIXME: This is unused
570 if( !is_array( $selectOptions ) ) {
571 $selectOptions = array( $selectOptions );
573 list( $startOpts, $useIndex, $tailOpts ) = $this->makeSelectOptions( $selectOptions );
574 if( is_array( $srcTable ) ) {
575 $srcTable = implode( ',', array_map( array( &$this, 'tableName' ), $srcTable ) );
576 } else {
577 $srcTable = $this->tableName( $srcTable );
580 // If we are not in a transaction, we need to be for savepoint trickery
581 $didbegin = 0;
582 if ( $ignore ) {
583 if( !$this->mTrxLevel ) {
584 $this->begin();
585 $didbegin = 1;
587 $olde = error_reporting( 0 );
588 $numrowsinserted = 0;
589 pg_query( $this->mConn, "SAVEPOINT $ignore");
592 $sql = "INSERT INTO $destTable (" . implode( ',', array_keys( $varMap ) ) . ')' .
593 " SELECT $startOpts " . implode( ',', $varMap ) .
594 " FROM $srcTable $useIndex";
596 if ( $conds != '*' ) {
597 $sql .= ' WHERE ' . $this->makeList( $conds, LIST_AND );
600 $sql .= " $tailOpts";
602 $res = (bool)$this->query( $sql, $fname, $ignore );
603 if( $ignore ) {
604 $bar = pg_last_error();
605 if( $bar != false ) {
606 pg_query( $this->mConn, "ROLLBACK TO $ignore" );
607 } else {
608 pg_query( $this->mConn, "RELEASE $ignore" );
609 $numrowsinserted++;
611 $olde = error_reporting( $olde );
612 if( $didbegin ) {
613 $this->commit();
616 // Set the affected row count for the whole operation
617 $this->mAffectedRows = $numrowsinserted;
619 // IGNORE always returns true
620 return true;
623 return $res;
626 function tableName( $name, $format = 'quoted' ) {
627 # Replace reserved words with better ones
628 switch( $name ) {
629 case 'user':
630 return 'mwuser';
631 case 'text':
632 return 'pagecontent';
633 default:
634 return parent::tableName( $name, $format );
639 * Return the next in a sequence, save the value for retrieval via insertId()
641 function nextSequenceValue( $seqName ) {
642 $safeseq = str_replace( "'", "''", $seqName );
643 $res = $this->query( "SELECT nextval('$safeseq')" );
644 $row = $this->fetchRow( $res );
645 $this->mInsertId = $row[0];
646 return $this->mInsertId;
650 * Return the current value of a sequence. Assumes it has been nextval'ed in this session.
652 function currentSequenceValue( $seqName ) {
653 $safeseq = str_replace( "'", "''", $seqName );
654 $res = $this->query( "SELECT currval('$safeseq')" );
655 $row = $this->fetchRow( $res );
656 $currval = $row[0];
657 return $currval;
660 # Returns the size of a text field, or -1 for "unlimited"
661 function textFieldSize( $table, $field ) {
662 $table = $this->tableName( $table );
663 $sql = "SELECT t.typname as ftype,a.atttypmod as size
664 FROM pg_class c, pg_attribute a, pg_type t
665 WHERE relname='$table' AND a.attrelid=c.oid AND
666 a.atttypid=t.oid and a.attname='$field'";
667 $res =$this->query( $sql );
668 $row = $this->fetchObject( $res );
669 if ( $row->ftype == 'varchar' ) {
670 $size = $row->size - 4;
671 } else {
672 $size = $row->size;
674 return $size;
677 function limitResult( $sql, $limit, $offset = false ) {
678 return "$sql LIMIT $limit " . ( is_numeric( $offset ) ? " OFFSET {$offset} " : '' );
681 function wasDeadlock() {
682 return $this->lastErrno() == '40P01';
685 function duplicateTableStructure( $oldName, $newName, $temporary = false, $fname = 'DatabasePostgres::duplicateTableStructure' ) {
686 $newName = $this->addIdentifierQuotes( $newName );
687 $oldName = $this->addIdentifierQuotes( $oldName );
688 return $this->query( 'CREATE ' . ( $temporary ? 'TEMPORARY ' : '' ) . " TABLE $newName (LIKE $oldName INCLUDING DEFAULTS)", $fname );
691 function listTables( $prefix = null, $fname = 'DatabasePostgres::listTables' ) {
692 global $wgDBmwschema;
693 $eschema = $this->addQuotes( $wgDBmwschema );
694 $result = $this->query( "SELECT tablename FROM pg_tables WHERE schemaname = $eschema", $fname );
696 $endArray = array();
698 foreach( $result as $table ) {
699 $vars = get_object_vars($table);
700 $table = array_pop( $vars );
701 if( !$prefix || strpos( $table, $prefix ) === 0 ) {
702 $endArray[] = $table;
706 return $endArray;
709 function timestamp( $ts = 0 ) {
710 return wfTimestamp( TS_POSTGRES, $ts );
714 * Return aggregated value function call
716 function aggregateValue( $valuedata, $valuename = 'value' ) {
717 return $valuedata;
721 * @return string wikitext of a link to the server software's web site
723 public static function getSoftwareLink() {
724 return '[http://www.postgresql.org/ PostgreSQL]';
728 * @return string Version information from the database
730 function getServerVersion() {
731 if ( !isset( $this->numeric_version ) ) {
732 $versionInfo = pg_version( $this->mConn );
733 if ( version_compare( $versionInfo['client'], '7.4.0', 'lt' ) ) {
734 // Old client, abort install
735 $this->numeric_version = '7.3 or earlier';
736 } elseif ( isset( $versionInfo['server'] ) ) {
737 // Normal client
738 $this->numeric_version = $versionInfo['server'];
739 } else {
740 // Bug 16937: broken pgsql extension from PHP<5.3
741 $this->numeric_version = pg_parameter_status( $this->mConn, 'server_version' );
744 return $this->numeric_version;
748 * Query whether a given relation exists (in the given schema, or the
749 * default mw one if not given)
751 function relationExists( $table, $types, $schema = false ) {
752 global $wgDBmwschema;
753 if ( !is_array( $types ) ) {
754 $types = array( $types );
756 if ( !$schema ) {
757 $schema = $wgDBmwschema;
759 $table = $this->tableName( $table, 'raw' );
760 $etable = $this->addQuotes( $table );
761 $eschema = $this->addQuotes( $schema );
762 $SQL = "SELECT 1 FROM pg_catalog.pg_class c, pg_catalog.pg_namespace n "
763 . "WHERE c.relnamespace = n.oid AND c.relname = $etable AND n.nspname = $eschema "
764 . "AND c.relkind IN ('" . implode( "','", $types ) . "')";
765 $res = $this->query( $SQL );
766 $count = $res ? $res->numRows() : 0;
767 return (bool)$count;
771 * For backward compatibility, this function checks both tables and
772 * views.
774 function tableExists( $table, $schema = false ) {
775 return $this->relationExists( $table, array( 'r', 'v' ), $schema );
778 function sequenceExists( $sequence, $schema = false ) {
779 return $this->relationExists( $sequence, 'S', $schema );
782 function triggerExists( $table, $trigger ) {
783 global $wgDBmwschema;
785 $q = <<<SQL
786 SELECT 1 FROM pg_class, pg_namespace, pg_trigger
787 WHERE relnamespace=pg_namespace.oid AND relkind='r'
788 AND tgrelid=pg_class.oid
789 AND nspname=%s AND relname=%s AND tgname=%s
790 SQL;
791 $res = $this->query(
792 sprintf(
794 $this->addQuotes( $wgDBmwschema ),
795 $this->addQuotes( $table ),
796 $this->addQuotes( $trigger )
799 if ( !$res ) {
800 return null;
802 $rows = $res->numRows();
803 return $rows;
806 function ruleExists( $table, $rule ) {
807 global $wgDBmwschema;
808 $exists = $this->selectField( 'pg_rules', 'rulename',
809 array(
810 'rulename' => $rule,
811 'tablename' => $table,
812 'schemaname' => $wgDBmwschema
815 return $exists === $rule;
818 function constraintExists( $table, $constraint ) {
819 global $wgDBmwschema;
820 $SQL = sprintf( "SELECT 1 FROM information_schema.table_constraints ".
821 "WHERE constraint_schema = %s AND table_name = %s AND constraint_name = %s",
822 $this->addQuotes( $wgDBmwschema ),
823 $this->addQuotes( $table ),
824 $this->addQuotes( $constraint )
826 $res = $this->query( $SQL );
827 if ( !$res ) {
828 return null;
830 $rows = $res->numRows();
831 return $rows;
835 * Query whether a given schema exists. Returns true if it does, false if it doesn't.
837 function schemaExists( $schema ) {
838 $exists = $this->selectField( '"pg_catalog"."pg_namespace"', 1,
839 array( 'nspname' => $schema ), __METHOD__ );
840 return (bool)$exists;
844 * Returns true if a given role (i.e. user) exists, false otherwise.
846 function roleExists( $roleName ) {
847 $exists = $this->selectField( '"pg_catalog"."pg_roles"', 1,
848 array( 'rolname' => $roleName ), __METHOD__ );
849 return (bool)$exists;
852 function fieldInfo( $table, $field ) {
853 return PostgresField::fromText( $this, $table, $field );
857 * pg_field_type() wrapper
859 function fieldType( $res, $index ) {
860 if ( $res instanceof ResultWrapper ) {
861 $res = $res->result;
863 return pg_field_type( $res, $index );
866 /* Not even sure why this is used in the main codebase... */
867 function limitResultForUpdate( $sql, $num ) {
868 return $sql;
872 * @param $b
873 * @return Blob
875 function encodeBlob( $b ) {
876 return new Blob( pg_escape_bytea( $this->mConn, $b ) );
879 function decodeBlob( $b ) {
880 if ( $b instanceof Blob ) {
881 $b = $b->fetch();
883 return pg_unescape_bytea( $b );
886 function strencode( $s ) { # Should not be called by us
887 return pg_escape_string( $this->mConn, $s );
891 * @param $s null|bool|Blob
892 * @return int|string
894 function addQuotes( $s ) {
895 if ( is_null( $s ) ) {
896 return 'NULL';
897 } elseif ( is_bool( $s ) ) {
898 return intval( $s );
899 } elseif ( $s instanceof Blob ) {
900 return "'" . $s->fetch( $s ) . "'";
902 return "'" . pg_escape_string( $this->mConn, $s ) . "'";
906 * Postgres specific version of replaceVars.
907 * Calls the parent version in Database.php
909 * @private
911 * @param $ins String: SQL string, read from a stream (usually tables.sql)
913 * @return string SQL string
915 protected function replaceVars( $ins ) {
916 $ins = parent::replaceVars( $ins );
918 if ( $this->numeric_version >= 8.3 ) {
919 // Thanks for not providing backwards-compatibility, 8.3
920 $ins = preg_replace( "/to_tsvector\s*\(\s*'default'\s*,/", 'to_tsvector(', $ins );
923 if ( $this->numeric_version <= 8.1 ) { // Our minimum version
924 $ins = str_replace( 'USING gin', 'USING gist', $ins );
927 return $ins;
931 * Various select options
933 * @private
935 * @param $options Array: an associative array of options to be turned into
936 * an SQL query, valid keys are listed in the function.
937 * @return array
939 function makeSelectOptions( $options ) {
940 $preLimitTail = $postLimitTail = '';
941 $startOpts = $useIndex = '';
943 $noKeyOptions = array();
944 foreach ( $options as $key => $option ) {
945 if ( is_numeric( $key ) ) {
946 $noKeyOptions[$option] = true;
950 if ( isset( $options['GROUP BY'] ) ) {
951 $gb = is_array( $options['GROUP BY'] )
952 ? implode( ',', $options['GROUP BY'] )
953 : $options['GROUP BY'];
954 $preLimitTail .= " GROUP BY {$gb}";
957 if ( isset( $options['HAVING'] ) ) {
958 $preLimitTail .= " HAVING {$options['HAVING']}";
961 if ( isset( $options['ORDER BY'] ) ) {
962 $ob = is_array( $options['ORDER BY'] )
963 ? implode( ',', $options['ORDER BY'] )
964 : $options['ORDER BY'];
965 $preLimitTail .= " ORDER BY {$ob}";
968 //if ( isset( $options['LIMIT'] ) ) {
969 // $tailOpts .= $this->limitResult( '', $options['LIMIT'],
970 // isset( $options['OFFSET'] ) ? $options['OFFSET']
971 // : false );
974 if ( isset( $noKeyOptions['FOR UPDATE'] ) ) {
975 $postLimitTail .= ' FOR UPDATE';
977 if ( isset( $noKeyOptions['LOCK IN SHARE MODE'] ) ) {
978 $postLimitTail .= ' LOCK IN SHARE MODE';
980 if ( isset( $noKeyOptions['DISTINCT'] ) || isset( $noKeyOptions['DISTINCTROW'] ) ) {
981 $startOpts .= 'DISTINCT';
984 return array( $startOpts, $useIndex, $preLimitTail, $postLimitTail );
987 function setFakeMaster( $enabled = true ) {}
989 function getDBname() {
990 return $this->mDBname;
993 function getServer() {
994 return $this->mServer;
997 function buildConcat( $stringList ) {
998 return implode( ' || ', $stringList );
1001 public function getSearchEngine() {
1002 return 'SearchPostgres';
1004 } // end DatabasePostgres class