3 * This script is the IBM DB2 database abstraction layer
5 * See maintenance/ibm_db2/README for development notes and other specific information
8 * @author leo.petr+mediawiki@gmail.com
12 * This represents a column in a DB2 database
17 private $tablename = '';
19 private $nullable = false;
20 private $max_length = 0;
23 * Builder method for the class
24 * @param DatabaseIbm_db2 $db Database interface
25 * @param string $table table name
26 * @param string $field column name
27 * @return IBM_DB2Field
29 static function fromText($db, $table, $field) {
34 lcase(coltype) AS typname,
35 nulls AS attnotnull, length AS attlen
36 FROM sysibm.syscolumns
37 WHERE tbcreator=%s AND tbname=%s AND name=%s;
39 $res = $db->query(sprintf($q,
40 $db->addQuotes($wgDBmwschema),
41 $db->addQuotes($table),
42 $db->addQuotes($field)));
43 $row = $db->fetchObject($res);
46 $n = new IBM_DB2Field
;
47 $n->type
= $row->typname
;
48 $n->nullable
= ($row->attnotnull
== 'N');
50 $n->tablename
= $table;
51 $n->max_length
= $row->attlen
;
56 * @return string column name
58 function name() { return $this->name
; }
61 * @return string table name
63 function tableName() { return $this->tablename
; }
66 * @return string column type
68 function type() { return $this->type
; }
71 * @return bool true or false
73 function nullable() { return $this->nullable
; }
75 * How much can you fit in the column per row?
78 function maxLength() { return $this->max_length
; }
82 * Wrapper around binary large objects
88 public function __construct($data) {
92 public function getData() {
96 public function __toString()
103 * Primary database interface
106 class DatabaseIbm_db2
extends DatabaseBase
{
109 protected $mLastQuery = '';
110 protected $mPHPError = false;
112 protected $mServer, $mUser, $mPassword, $mConn = null, $mDBname;
113 protected $mOut, $mOpened = false;
115 protected $mFailFunction;
116 protected $mTablePrefix;
118 protected $mTrxLevel = 0;
119 protected $mErrorCount = 0;
120 protected $mLBInfo = array();
121 protected $mFakeSlaveLag = null, $mFakeMaster = false;
125 /// Server port for uncataloged connections
126 protected $mPort = NULL;
127 /// Whether connection is cataloged
128 protected $mCataloged = NULL;
129 /// Schema for tables, stored procedures, triggers
130 protected $mSchema = NULL;
131 /// Whether the schema has been applied in this session
132 protected $mSchemaSet = false;
133 /// Result of last query
134 protected $mLastResult = NULL;
135 /// Number of rows affected by last INSERT/UPDATE/DELETE
136 protected $mAffectedRows = NULL;
137 /// Number of rows returned by last SELECT
138 protected $mNumRows = NULL;
140 /// Connection config options - see constructor
141 public $mConnOptions = array();
142 /// Statement config options -- see constructor
143 public $mStmtOptions = array();
146 const CATALOGED
= "cataloged";
147 const UNCATALOGED
= "uncataloged";
148 const USE_GLOBAL
= "get from global";
150 const NONE_OPTION
= 0x00;
151 const CONN_OPTION
= 0x01;
152 const STMT_OPTION
= 0x02;
154 const REGULAR_MODE
= 'regular';
155 const INSTALL_MODE
= 'install';
157 // Whether this is regular operation or the initial installation
158 protected $mMode = self
::REGULAR_MODE
;
160 /// Last sequence value used for a primary key
161 protected $mInsertId = NULL;
164 * These can be safely inherited
166 * Getter/Setter: (18)
186 * Administrative: (8)
188 * installErrorHandler
189 * restoreErrorHandler
190 * connectionErrorHandler
191 * reportConnectionError
205 * Prepared Statement: 6
222 * tableNamesWithUseIndexOrJOIN
238 * These have been implemented
240 * Administrative: 7 / 7
243 * openCataloged [Done]
245 * newFromParams [Done]
246 * openUncataloged [Done]
247 * setup_database [Done]
249 * Getter/Setter: 13 / 13
250 * cascadingDeletes [Done]
251 * cleanupTriggers [Done]
253 * realTimestamps [Done]
254 * impliciGroupby [Done]
255 * implicitOrderby [Done]
256 * searchableIPs [Done]
257 * functionalIndexes [Done]
260 * getServerVersion [Done]
261 * getSoftwareLink [Done]
262 * getSearchEngine [Done]
264 * Database driver wrapper: 23 / 23
277 * affectedRows [Done]
290 * Slave/master: 2 / 2
291 * setFakeSlaveLag [Done]
292 * setFakeMaster [Done]
300 * textFieldSize [Done]
302 * Generation: 16 / 16
306 * makeSelectOptions [Done]
307 * estimateRowCount [Done]
308 * nextSequenceValue [Done]
309 * useIndexClause [Done]
312 * lowPriorityOption [Done]
314 * limitResultForUpdate [Done]
321 ######################################
322 # Getters and Setters
323 ######################################
326 * Returns true if this database supports (and uses) cascading deletes
328 function cascadingDeletes() {
333 * Returns true if this database supports (and uses) triggers (e.g. on the page table)
335 function cleanupTriggers() {
340 * Returns true if this database is strict about what can be put into an IP field.
341 * Specifically, it uses a NULL value instead of an empty string.
343 function strictIPs() {
348 * Returns true if this database uses timestamps rather than integers
350 function realTimestamps() {
355 * Returns true if this database does an implicit sort when doing GROUP BY
357 function implicitGroupby() {
362 * Returns true if this database does an implicit order by when the column has an index
363 * For example: SELECT page_title FROM page LIMIT 1
365 function implicitOrderby() {
370 * Returns true if this database can do a native search on IP columns
371 * e.g. this works as expected: .. WHERE rc_ip = '127.42.12.102/32';
373 function searchableIPs() {
378 * Returns true if this database can use functional indexes
380 function functionalIndexes() {
385 * Returns a unique string representing the wiki on the server
387 function getWikiID() {
388 if( $this->mSchema
) {
389 return "{$this->mDBname}-{$this->mSchema}";
391 return $this->mDBname
;
396 ######################################
398 ######################################
403 * @param string $server hostname of database server
404 * @param string $user username
405 * @param string $password
406 * @param string $dbName database name on the server
407 * @param function $failFunction (optional)
408 * @param integer $flags database behaviour flags (optional, unused)
410 public function DatabaseIbm_db2($server = false, $user = false, $password = false,
411 $dbName = false, $failFunction = false, $flags = 0,
412 $schema = self
::USE_GLOBAL
)
415 global $wgOut, $wgDBmwschema;
416 # Can't get a reference if it hasn't been set yet
417 if ( !isset( $wgOut ) ) {
420 $this->mOut
=& $wgOut;
421 $this->mFailFunction
= $failFunction;
422 $this->mFlags
= DBO_TRX |
$flags;
424 if ( $schema == self
::USE_GLOBAL
) {
425 $this->mSchema
= $wgDBmwschema;
428 $this->mSchema
= $schema;
431 // configure the connection and statement objects
432 $this->setDB2Option('db2_attr_case', 'DB2_CASE_LOWER', self
::CONN_OPTION | self
::STMT_OPTION
);
433 $this->setDB2Option('deferred_prepare', 'DB2_DEFERRED_PREPARE_ON', self
::STMT_OPTION
);
434 $this->setDB2Option('rowcount', 'DB2_ROWCOUNT_PREFETCH_ON', self
::STMT_OPTION
);
436 $this->open( $server, $user, $password, $dbName);
440 * Enables options only if the ibm_db2 extension version supports them
441 * @param string $name Name of the option in the options array
442 * @param string $const Name of the constant holding the right option value
443 * @param int $type Whether this is a Connection or Statement otion
445 private function setDB2Option($name, $const, $type) {
446 if (defined($const)) {
447 if ($type & self
::CONN_OPTION
) $this->mConnOptions
[$name] = constant($const);
448 if ($type & self
::STMT_OPTION
) $this->mStmtOptions
[$name] = constant($const);
451 $this->installPrint("$const is not defined. ibm_db2 version is likely too low.");
456 * Outputs debug information in the appropriate place
457 * @param string $string The relevant debug message
459 private function installPrint($string) {
461 if ($this->mMode
== self
::INSTALL_MODE
) {
462 print "<li>$string</li>";
468 * Opens a database connection and returns it
469 * Closes any existing connection
470 * @return a fresh connection
471 * @param string $server hostname
472 * @param string $user
473 * @param string $password
474 * @param string $dbName database name
476 public function open( $server, $user, $password, $dbName )
478 // Load the port number
479 global $wgDBport_db2, $wgDBcataloged;
480 wfProfileIn( __METHOD__
);
482 // Load IBM DB2 driver if missing
483 if (!@extension_loaded
('ibm_db2')) {
486 // Test for IBM DB2 support, to avoid suppressed fatal error
487 if ( !function_exists( 'db2_connect' ) ) {
488 $error = "DB2 functions missing, have you enabled the ibm_db2 extension for PHP?\n";
489 $this->installPrint($error);
490 $this->reportConnectionError($error);
493 if (!strlen($user)) { // Copied from Postgres
497 // Close existing connection
500 $this->mServer
= $server;
501 $this->mPort
= $port = $wgDBport_db2;
502 $this->mUser
= $user;
503 $this->mPassword
= $password;
504 $this->mDBname
= $dbName;
505 $this->mCataloged
= $cataloged = $wgDBcataloged;
507 if ( $cataloged == self
::CATALOGED
) {
508 $this->openCataloged($dbName, $user, $password);
510 elseif ( $cataloged == self
::UNCATALOGED
) {
511 $this->openUncataloged($dbName, $user, $password, $server, $port);
513 // Apply connection config
514 db2_set_option($this->mConn
, $this->mConnOptions
, 1);
515 // Not all MediaWiki code is transactional
516 // Rather, turn autocommit off in the begin function and turn on after a commit
517 db2_autocommit($this->mConn
, DB2_AUTOCOMMIT_ON
);
519 if ( $this->mConn
== false ) {
520 $this->installPrint( "DB connection error\n" );
521 $this->installPrint( "Server: $server, Database: $dbName, User: $user, Password: " . substr( $password, 0, 3 ) . "...\n" );
522 $this->installPrint( $this->lastError()."\n" );
526 $this->mOpened
= true;
527 $this->applySchema();
529 wfProfileOut( __METHOD__
);
534 * Opens a cataloged database connection, sets mConn
536 protected function openCataloged( $dbName, $user, $password )
538 @$this->mConn
= db2_connect($dbName, $user, $password);
542 * Opens an uncataloged database connection, sets mConn
544 protected function openUncataloged( $dbName, $user, $password, $server, $port )
546 $str = "DRIVER={IBM DB2 ODBC DRIVER};";
547 $str .= "DATABASE=$dbName;";
548 $str .= "HOSTNAME=$server;";
549 if ($port) $str .= "PORT=$port;";
550 $str .= "PROTOCOL=TCPIP;";
551 $str .= "UID=$user;";
552 $str .= "PWD=$password;";
554 @$this->mConn
= db2_connect($str, $user, $password);
558 * Closes a database connection, if it is open
559 * Returns success, true if already closed
561 public function close() {
562 $this->mOpened
= false;
563 if ( $this->mConn
) {
564 if ($this->trxLevel() > 0) {
567 return db2_close( $this->mConn
);
575 * Returns a fresh instance of this class
578 * @param string $server hostname of database server
579 * @param string $user username
580 * @param string $password
581 * @param string $dbName database name on the server
582 * @param function $failFunction (optional)
583 * @param integer $flags database behaviour flags (optional, unused)
585 static function newFromParams( $server, $user, $password, $dbName, $failFunction = false, $flags = 0)
587 return new DatabaseIbm_db2( $server, $user, $password, $dbName, $failFunction, $flags );
591 * Retrieves the most current database error
592 * Forces a database rollback
594 public function lastError() {
595 $connerr = db2_conn_errormsg();
600 $stmterr = db2_stmt_errormsg();
610 * Get the last error number
611 * Return 0 if no error
614 public function lastErrno() {
615 $connerr = db2_conn_error();
616 if ($connerr) return $connerr;
617 $stmterr = db2_stmt_error();
618 if ($stmterr) return $stmterr;
623 * Is a database connection open?
626 public function isOpen() { return $this->mOpened
; }
629 * The DBMS-dependent part of query()
630 * @param $sql String: SQL query.
631 * @return object Result object to feed to fetchObject, fetchRow, ...; or false on failure
635 public function doQuery( $sql ) {
636 //print "<li><pre>$sql</pre></li>";
637 // Switch into the correct namespace
638 $this->applySchema();
640 $ret = db2_exec( $this->mConn
, $sql, $this->mStmtOptions
);
645 $error = db2_stmt_errormsg();
646 throw new DBUnexpectedError($this, 'SQL error: ' . htmlspecialchars( $error ) );
648 $this->mLastResult
= $ret;
649 $this->mAffectedRows
= NULL; // Not calculated until asked for
654 * @return string Version information from the database
656 public function getServerVersion() {
657 $info = db2_server_info( $this->mConn
);
658 return $info->DBMS_VER
;
662 * Queries whether a given table exists
665 public function tableExists( $table ) {
666 $schema = $this->mSchema
;
668 SELECT
COUNT(*) FROM SYSIBM
.SYSTABLES ST
669 WHERE ST
.NAME
= '$table' AND ST
.CREATOR
= '$schema'
671 $res = $this->query( $sql );
672 if (!$res) return false;
674 // If the table exists, there should be one of it
675 @$row = $this->fetchRow($res);
677 if ($count == '1' or $count == 1) {
685 * Fetch the next row from the given result object, in object form.
686 * Fields can be retrieved with $row->fieldname, with fields acting like
689 * @param $res SQL result object as returned from Database::query(), etc.
690 * @return DB2 row object
691 * @throws DBUnexpectedError Thrown if the database returns an error
693 public function fetchObject( $res ) {
694 if ( $res instanceof ResultWrapper
) {
697 @$row = db2_fetch_object( $res );
698 if( $this->lastErrno() ) {
699 throw new DBUnexpectedError( $this, 'Error in fetchObject(): ' . htmlspecialchars( $this->lastError() ) );
705 * Fetch the next row from the given result object, in associative array
706 * form. Fields are retrieved with $row['fieldname'].
708 * @param $res SQL result object as returned from Database::query(), etc.
709 * @return DB2 row object
710 * @throws DBUnexpectedError Thrown if the database returns an error
712 public function fetchRow( $res ) {
713 if ( $res instanceof ResultWrapper
) {
716 @$row = db2_fetch_array( $res );
717 if ( $this->lastErrno() ) {
718 throw new DBUnexpectedError( $this, 'Error in fetchRow(): ' . htmlspecialchars( $this->lastError() ) );
724 * Override if introduced to base Database class
726 public function initial_setup() {
731 * Create tables, stored procedures, and so on
733 public function setup_database() {
734 // Timeout was being changed earlier due to mysterious crashes
735 // Changing it now may cause more problems than not changing it
736 //set_time_limit(240);
738 // TODO: switch to root login if available
740 // Switch into the correct namespace
741 $this->applySchema();
744 $res = $this->sourceFile( "../maintenance/ibm_db2/tables.sql" );
747 // TODO: update mediawiki_version table
749 // TODO: populate interwiki links
751 if ($this->lastError()) {
752 print "<li>Errors encountered during table creation -- rolled back</li>\n";
753 print "<li>Please install again</li>\n";
760 catch (MWException
$mwe)
762 print "<br><pre>$mwe</pre><br>";
768 * Doesn't escape numbers
769 * @param string s string to escape
770 * @return escaped string
772 public function addQuotes( $s ) {
773 //$this->installPrint("DB2::addQuotes($s)\n");
774 if ( is_null( $s ) ) {
776 } else if ($s instanceof Blob
) {
777 return "'".$s->fetch($s)."'";
778 } else if ($s instanceof IBM_DB2Blob
) {
779 return "'".$this->decodeBlob($s)."'";
781 $s = $this->strencode($s);
782 if ( is_numeric($s) ) {
791 * Verifies that a DB2 column/field type is numeric
792 * @return bool true if numeric
793 * @param string $type DB2 column type
795 public function is_numeric_type( $type ) {
796 switch (strtoupper($type)) {
811 * Alias for addQuotes()
812 * @param string s string to escape
813 * @return escaped string
815 public function strencode( $s ) {
816 // Bloody useless function
817 // Prepends backslashes to \x00, \n, \r, \, ', " and \x1a.
818 // But also necessary
819 $s = db2_escape_string($s);
820 // Wide characters are evil -- some of them look like '
821 $s = utf8_encode($s);
823 $from = array("\\\\", "\\'", '\\n', '\\t', '\\"', '\\r');
824 $to = array("\\", "''", "\n", "\t", '"', "\r");
825 $s = str_replace($from, $to, $s); // DB2 expects '', not \' escaping
830 * Switch into the database schema
832 protected function applySchema() {
833 if ( !($this->mSchemaSet
) ) {
834 $this->mSchemaSet
= true;
836 $this->doQuery("SET SCHEMA = $this->mSchema");
842 * Start a transaction (mandatory)
844 public function begin( $fname = 'DatabaseIbm_db2::begin' ) {
845 // turn off auto-commit
846 db2_autocommit($this->mConn
, DB2_AUTOCOMMIT_OFF
);
847 $this->mTrxLevel
= 1;
852 * Must have a preceding begin()
854 public function commit( $fname = 'DatabaseIbm_db2::commit' ) {
855 db2_commit($this->mConn
);
856 // turn auto-commit back on
857 db2_autocommit($this->mConn
, DB2_AUTOCOMMIT_ON
);
858 $this->mTrxLevel
= 0;
862 * Cancel a transaction
864 public function rollback( $fname = 'DatabaseIbm_db2::rollback' ) {
865 db2_rollback($this->mConn
);
866 // turn auto-commit back on
867 // not sure if this is appropriate
868 db2_autocommit($this->mConn
, DB2_AUTOCOMMIT_ON
);
869 $this->mTrxLevel
= 0;
873 * Makes an encoded list of strings from an array
875 * LIST_COMMA - comma separated, no field names
876 * LIST_AND - ANDed WHERE clause (without the WHERE)
877 * LIST_OR - ORed WHERE clause (without the WHERE)
878 * LIST_SET - comma separated with field names, like a SET clause
879 * LIST_NAMES - comma separated field names
881 public function makeList( $a, $mode = LIST_COMMA
) {
882 if ( !is_array( $a ) ) {
883 throw new DBUnexpectedError( $this, 'Database::makeList called with incorrect parameters' );
888 foreach ( $a as $field => $value ) {
890 if ( $mode == LIST_AND
) {
892 } elseif($mode == LIST_OR
) {
900 if ( ($mode == LIST_AND ||
$mode == LIST_OR
) && is_numeric( $field ) ) {
902 } elseif ( ($mode == LIST_SET
) && is_numeric( $field ) ) {
904 } elseif ( ($mode == LIST_AND ||
$mode == LIST_OR
) && is_array($value) ) {
905 if( count( $value ) == 0 ) {
906 throw new MWException( __METHOD__
.': empty input' );
907 } elseif( count( $value ) == 1 ) {
908 // Special-case single values, as IN isn't terribly efficient
909 // Don't necessarily assume the single key is 0; we don't
910 // enforce linear numeric ordering on other arrays here.
911 $value = array_values( $value );
912 $list .= $field." = ".$this->addQuotes( $value[0] );
914 $list .= $field." IN (".$this->makeList($value).") ";
916 } elseif( is_null($value) ) {
917 if ( $mode == LIST_AND ||
$mode == LIST_OR
) {
918 $list .= "$field IS ";
919 } elseif ( $mode == LIST_SET
) {
920 $list .= "$field = ";
924 if ( $mode == LIST_AND ||
$mode == LIST_OR ||
$mode == LIST_SET
) {
925 $list .= "$field = ";
927 if ( $mode == LIST_NAMES
) {
930 // Leo: Can't insert quoted numbers into numeric columns
931 // (?) Might cause other problems. May have to check column type before insertion.
932 else if ( is_numeric($value) ) {
936 $list .= $this->addQuotes( $value );
944 * Construct a LIMIT query with optional offset
945 * This is used for query pages
946 * $sql string SQL query we will append the limit too
947 * $limit integer the SQL limit
948 * $offset integer the SQL offset (default false)
950 public function limitResult($sql, $limit, $offset=false) {
951 if( !is_numeric($limit) ) {
952 throw new DBUnexpectedError( $this, "Invalid non-numeric limit passed to limitResult()\n" );
955 $this->installPrint("Offset parameter not supported in limitResult()\n");
957 // TODO implement proper offset handling
958 // idea: get all the rows between 0 and offset, advance cursor to offset
959 return "$sql FETCH FIRST $limit ROWS ONLY ";
963 * Handle reserved keyword replacement in table names
965 * @param $name Object
967 public function tableName( $name ) {
968 # Replace reserved words with better ones
973 // return 'pagecontent';
977 // we want maximum compatibility with MySQL schema
982 * Generates a timestamp in an insertable format
983 * @return string timestamp value
984 * @param timestamp $ts
986 public function timestamp( $ts=0 ) {
987 // TS_MW cannot be easily distinguished from an integer
988 return wfTimestamp(TS_DB2
,$ts);
992 * Return the next in a sequence, save the value for retrieval via insertId()
993 * @param string seqName Name of a defined sequence in the database
994 * @return next value in that sequence
996 public function nextSequenceValue( $seqName ) {
997 // Not using sequences in the primary schema to allow for easy third-party migration scripts
998 // Emulating MySQL behaviour of using NULL to signal that sequences aren't used
1000 $safeseq = preg_replace( "/'/", "''", $seqName );
1001 $res = $this->query( "VALUES NEXTVAL FOR $safeseq" );
1002 $row = $this->fetchRow( $res );
1003 $this->mInsertId = $row[0];
1004 $this->freeResult( $res );
1005 return $this->mInsertId;
1011 * This must be called after nextSequenceVal
1012 * @return Last sequence value used as a primary key
1014 public function insertId() {
1015 return $this->mInsertId
;
1019 * Updates the mInsertId property with the value of the last insert into a generated column
1020 * @param string $table Sanitized table name
1021 * @param mixed $primaryKey String name of the primary key or a bool if this call is a do-nothing
1022 * @param resource $stmt Prepared statement resource
1023 * of the SELECT primary_key FROM FINAL TABLE ( INSERT ... ) form
1025 private function calcInsertId($table, $primaryKey, $stmt) {
1027 $id_row = $this->fetchRow($stmt);
1028 $this->mInsertId
= $id_row[0];
1033 * INSERT wrapper, inserts an array into a table
1035 * $args may be a single associative array, or an array of these with numeric keys,
1036 * for multi-row insert
1038 * @param array $table String: Name of the table to insert to.
1039 * @param array $args Array: Items to insert into the table.
1040 * @param array $fname String: Name of the function, for profiling
1041 * @param mixed $options String or Array. Valid options: IGNORE
1043 * @return bool Success of insert operation. IGNORE always returns true.
1045 public function insert( $table, $args, $fname = 'DatabaseIbm_db2::insert', $options = array() ) {
1046 if ( !count( $args ) ) {
1049 // get database-specific table name (not used)
1050 $table = $this->tableName( $table );
1051 // format options as an array
1052 if ( !is_array( $options ) ) $options = array( $options );
1053 // format args as an array of arrays
1054 if ( !( isset( $args[0] ) && is_array( $args[0] ) ) ) {
1055 $args = array($args);
1057 // prevent insertion of NULL into primary key columns
1058 list($args, $primaryKeys) = $this->removeNullPrimaryKeys($table, $args);
1059 // if there's only one primary key
1060 // we'll be able to read its value after insertion
1061 $primaryKey = false;
1062 if (count($primaryKeys) == 1) {
1063 $primaryKey = $primaryKeys[0];
1067 $keys = array_keys( $args[0] );
1068 $key_count = count($keys);
1070 // If IGNORE is set, we use savepoints to emulate mysql's behavior
1071 $ignore = in_array( 'IGNORE', $options ) ?
'mw' : '';
1075 // If we are not in a transaction, we need to be for savepoint trickery
1077 if (! $this->mTrxLevel
) {
1082 $sql = "INSERT INTO $table (" . implode( ',', $keys ) . ') VALUES ';
1083 switch($key_count) {
1089 $sql .= '(?' . str_repeat(',?', $key_count-1) . ')';
1091 // add logic to read back the new primary key value
1093 $sql = "SELECT $primaryKey FROM FINAL TABLE($sql)";
1095 $stmt = $this->prepare($sql);
1097 // start a transaction/enter transaction mode
1102 foreach ( $args as $row ) {
1103 // insert each row into the database
1104 $res = $res & $this->execute($stmt, $row);
1105 // get the last inserted value into a generated column
1106 $this->calcInsertId($table, $primaryKey, $stmt);
1110 $olde = error_reporting( 0 );
1111 // For future use, we may want to track the number of actual inserts
1112 // Right now, insert (all writes) simply return true/false
1113 $numrowsinserted = 0;
1115 // always return true
1118 foreach ( $args as $row ) {
1119 $overhead = "SAVEPOINT $ignore ON ROLLBACK RETAIN CURSORS";
1120 db2_exec($this->mConn
, $overhead, $this->mStmtOptions
);
1122 $res2 = $this->execute($stmt, $row);
1123 // get the last inserted value into a generated column
1124 $this->calcInsertId($table, $primaryKey, $stmt);
1126 $errNum = $this->lastErrno();
1128 db2_exec( $this->mConn
, "ROLLBACK TO SAVEPOINT $ignore", $this->mStmtOptions
);
1131 db2_exec( $this->mConn
, "RELEASE SAVEPOINT $ignore", $this->mStmtOptions
);
1136 $olde = error_reporting( $olde );
1137 // Set the affected row count for the whole operation
1138 $this->mAffectedRows
= $numrowsinserted;
1140 // commit either way
1147 * Given a table name and a hash of columns with values
1148 * Removes primary key columns from the hash where the value is NULL
1150 * @param string $table Name of the table
1151 * @param array $args Array of hashes of column names with values
1152 * @return array Tuple containing filtered array of columns, array of primary keys
1154 private function removeNullPrimaryKeys($table, $args) {
1155 $schema = $this->mSchema
;
1156 // find out the primary keys
1157 $keyres = db2_primary_keys($this->mConn
, null, strtoupper($schema), strtoupper($table));
1159 for ($row = $this->fetchObject($keyres); $row != null; $row = $this->fetchRow($keyres)) {
1160 $keys[] = strtolower($row->column_name
);
1162 // remove primary keys
1163 foreach ($args as $ai => $row) {
1164 foreach ($keys as $ki => $key) {
1165 if ($row[$key] == NULL) {
1171 // return modified hash
1172 return array($args, $keys);
1176 * UPDATE wrapper, takes a condition array and a SET array
1178 * @param string $table The table to UPDATE
1179 * @param array $values An array of values to SET
1180 * @param array $conds An array of conditions (WHERE). Use '*' to update all rows.
1181 * @param string $fname The Class::Function calling this function
1183 * @param array $options An array of UPDATE options, can be one or
1184 * more of IGNORE, LOW_PRIORITY
1187 public function update( $table, $values, $conds, $fname = 'Database::update', $options = array() ) {
1188 $table = $this->tableName( $table );
1189 $opts = $this->makeUpdateOptions( $options );
1190 $sql = "UPDATE $opts $table SET " . $this->makeList( $values, LIST_SET
);
1191 if ( $conds != '*' ) {
1192 $sql .= " WHERE " . $this->makeList( $conds, LIST_AND
);
1194 return $this->query( $sql, $fname );
1198 * DELETE query wrapper
1200 * Use $conds == "*" to delete all rows
1202 public function delete( $table, $conds, $fname = 'Database::delete' ) {
1204 throw new DBUnexpectedError( $this, 'Database::delete() called with no conditions' );
1206 $table = $this->tableName( $table );
1207 $sql = "DELETE FROM $table";
1208 if ( $conds != '*' ) {
1209 $sql .= ' WHERE ' . $this->makeList( $conds, LIST_AND
);
1211 return $this->query( $sql, $fname );
1215 * Returns the number of rows affected by the last query or 0
1216 * @return int the number of rows affected by the last query
1218 public function affectedRows() {
1219 if ( !is_null( $this->mAffectedRows
) ) {
1220 // Forced result for simulated queries
1221 return $this->mAffectedRows
;
1223 if( empty( $this->mLastResult
) )
1225 return db2_num_rows( $this->mLastResult
);
1229 * Simulates REPLACE with a DELETE followed by INSERT
1230 * @param $table Object
1231 * @param array $uniqueIndexes array consisting of indexes and arrays of indexes
1232 * @param array $rows Rows to insert
1233 * @param string $fname Name of the function for profiling
1236 function replace( $table, $uniqueIndexes, $rows, $fname = 'DatabaseIbm_db2::replace' ) {
1237 $table = $this->tableName( $table );
1239 if (count($rows)==0) {
1244 if ( !is_array( reset( $rows ) ) ) {
1245 $rows = array( $rows );
1248 foreach( $rows as $row ) {
1249 # Delete rows which collide
1250 if ( $uniqueIndexes ) {
1251 $sql = "DELETE FROM $table WHERE ";
1253 foreach ( $uniqueIndexes as $index ) {
1260 if ( is_array( $index ) ) {
1262 foreach ( $index as $col ) {
1268 $sql .= $col.'=' . $this->addQuotes( $row[$col] );
1271 $sql .= $index.'=' . $this->addQuotes( $row[$index] );
1275 $this->query( $sql, $fname );
1278 # Now insert the row
1279 $sql = "INSERT INTO $table (" . $this->makeList( array_keys( $row ), LIST_NAMES
) .') VALUES (' .
1280 $this->makeList( $row, LIST_COMMA
) . ')';
1281 $this->query( $sql, $fname );
1286 * Returns the number of rows in the result set
1287 * Has to be called right after the corresponding select query
1288 * @param object $res result set
1289 * @return int number of rows
1291 public function numRows( $res ) {
1292 if ( $res instanceof ResultWrapper
) {
1293 $res = $res->result
;
1295 if ( $this->mNumRows
) {
1296 return $this->mNumRows
;
1304 * Moves the row pointer of the result set
1305 * @param object $res result set
1306 * @param int $row row number
1307 * @return success or failure
1309 public function dataSeek( $res, $row ) {
1310 if ( $res instanceof ResultWrapper
) {
1311 $res = $res->result
;
1313 return db2_fetch_row( $res, $row );
1317 # Fix notices in Block.php
1321 * Frees memory associated with a statement resource
1322 * @param object $res Statement resource to free
1323 * @return bool success or failure
1325 public function freeResult( $res ) {
1326 if ( $res instanceof ResultWrapper
) {
1327 $res = $res->result
;
1329 if ( !@db2_free_result
( $res ) ) {
1330 throw new DBUnexpectedError($this, "Unable to free DB2 result\n" );
1335 * Returns the number of columns in a resource
1336 * @param object $res Statement resource
1337 * @return Number of fields/columns in resource
1339 public function numFields( $res ) {
1340 if ( $res instanceof ResultWrapper
) {
1341 $res = $res->result
;
1343 return db2_num_fields( $res );
1347 * Returns the nth column name
1348 * @param object $res Statement resource
1349 * @param int $n Index of field or column
1350 * @return string name of nth column
1352 public function fieldName( $res, $n ) {
1353 if ( $res instanceof ResultWrapper
) {
1354 $res = $res->result
;
1356 return db2_field_name( $res, $n );
1362 * @param mixed $table Array or string, table name(s) (prefix auto-added)
1363 * @param mixed $vars Array or string, field name(s) to be retrieved
1364 * @param mixed $conds Array or string, condition(s) for WHERE
1365 * @param string $fname Calling function name (use __METHOD__) for logs/profiling
1366 * @param array $options Associative array of options (e.g. array('GROUP BY' => 'page_title')),
1367 * see Database::makeSelectOptions code for list of supported stuff
1368 * @param array $join_conds Associative array of table join conditions (optional)
1369 * (e.g. array( 'page' => array('LEFT JOIN','page_latest=rev_id') )
1370 * @return mixed Database result resource (feed to Database::fetchObject or whatever), or false on failure
1372 public function select( $table, $vars, $conds='', $fname = 'DatabaseIbm_db2::select', $options = array(), $join_conds = array() )
1374 $res = parent
::select( $table, $vars, $conds, $fname, $options, $join_conds );
1376 // We must adjust for offset
1377 if ( isset( $options['LIMIT'] ) ) {
1378 if ( isset ($options['OFFSET'] ) ) {
1379 $limit = $options['LIMIT'];
1380 $offset = $options['OFFSET'];
1385 // DB2 does not have a proper num_rows() function yet, so we must emulate it
1386 // DB2 9.5.3/9.5.4 and the corresponding ibm_db2 driver will introduce a working one
1389 // we want the count
1390 $vars2 = array('count(*) as num_rows');
1391 // respecting just the limit option
1392 $options2 = array();
1393 if ( isset( $options['LIMIT'] ) ) $options2['LIMIT'] = $options['LIMIT'];
1394 // but don't try to emulate for GROUP BY
1395 if ( isset( $options['GROUP BY'] ) ) return $res;
1397 $res2 = parent
::select( $table, $vars2, $conds, $fname, $options2, $join_conds );
1398 $obj = $this->fetchObject($res2);
1399 $this->mNumRows
= $obj->num_rows
;
1406 * Handles ordering, grouping, and having options ('GROUP BY' => colname)
1407 * Has limited support for per-column options (colnum => 'DISTINCT')
1411 * @param array $options an associative array of options to be turned into
1412 * an SQL query, valid keys are listed in the function.
1415 function makeSelectOptions( $options ) {
1416 $preLimitTail = $postLimitTail = '';
1419 $noKeyOptions = array();
1420 foreach ( $options as $key => $option ) {
1421 if ( is_numeric( $key ) ) {
1422 $noKeyOptions[$option] = true;
1426 if ( isset( $options['GROUP BY'] ) ) $preLimitTail .= " GROUP BY {$options['GROUP BY']}";
1427 if ( isset( $options['HAVING'] ) ) $preLimitTail .= " HAVING {$options['HAVING']}";
1428 if ( isset( $options['ORDER BY'] ) ) $preLimitTail .= " ORDER BY {$options['ORDER BY']}";
1430 if ( isset( $noKeyOptions['DISTINCT'] ) ||
isset( $noKeyOptions['DISTINCTROW'] ) ) $startOpts .= 'DISTINCT';
1432 return array( $startOpts, '', $preLimitTail, $postLimitTail );
1436 * Returns link to IBM DB2 free download
1437 * @return string wikitext of a link to the server software's web site
1439 public function getSoftwareLink() {
1440 return "[http://www.ibm.com/software/data/db2/express/?s_cmp=ECDDWW01&s_tact=MediaWiki IBM DB2]";
1444 * Get search engine class. All subclasses of this
1445 * need to implement this if they wish to use searching.
1449 public function getSearchEngine() {
1450 return "SearchIBM_DB2";
1454 * Did the last database access fail because of deadlock?
1457 public function wasDeadlock() {
1459 $err = $this->lastErrno();
1461 case '40001': // sql0911n, Deadlock or timeout, rollback
1462 case '57011': // sql0904n, Resource unavailable, no rollback
1463 case '57033': // sql0913n, Deadlock or timeout, no rollback
1464 $this->installPrint("In a deadlock because of SQLSTATE $err");
1471 * Ping the server and try to reconnect if it there is no connection
1472 * The connection may be closed and reopened while this happens
1473 * @return bool whether the connection exists
1475 public function ping() {
1476 // db2_ping() doesn't exist
1479 if ($this->mCataloged
== NULL) {
1482 else if ($this->mCataloged
) {
1483 $this->mConn
= $this->openCataloged($this->mDBName
, $this->mUser
, $this->mPassword
);
1485 else if (!$this->mCataloged
) {
1486 $this->mConn
= $this->openUncataloged($this->mDBName
, $this->mUser
, $this->mPassword
, $this->mServer
, $this->mPort
);
1490 ######################################
1491 # Unimplemented and not applicable
1492 ######################################
1498 public function getStatus( $which="%" ) { $this->installPrint('Not implemented for DB2: getStatus()'); return ''; }
1508 public function setFakeSlaveLag( $lag ) { $this->installPrint('Not implemented for DB2: setFakeSlaveLag()'); }
1513 public function setFakeMaster( $enabled = true ) { $this->installPrint('Not implemented for DB2: setFakeMaster()'); }
1516 * @return string $sql
1519 public function limitResultForUpdate($sql, $num) { $this->installPrint('Not implemented for DB2: limitResultForUpdate()'); return $sql; }
1522 * Only useful with fake prepare like in base Database class
1525 public function fillPreparedArg( $matches ) { $this->installPrint('Not useful for DB2: fillPreparedArg()'); return ''; }
1527 ######################################
1529 ######################################
1532 * Query whether a given column exists in the mediawiki schema
1533 * @param string $table name of the table
1534 * @param string $field name of the column
1535 * @param string $fname function name for logging and profiling
1537 public function fieldExists( $table, $field, $fname = 'DatabaseIbm_db2::fieldExists' ) {
1538 $table = $this->tableName( $table );
1539 $schema = $this->mSchema
;
1540 $etable = preg_replace("/'/", "''", $table);
1541 $eschema = preg_replace("/'/", "''", $schema);
1542 $ecol = preg_replace("/'/", "''", $field);
1544 SELECT 1 as fieldexists
1545 FROM sysibm.syscolumns sc
1546 WHERE sc.name='$ecol' AND sc.tbname='$etable' AND sc.tbcreator='$eschema'
1548 $res = $this->query( $sql, $fname );
1549 $count = $res ?
$this->numRows($res) : 0;
1551 $this->freeResult( $res );
1556 * Returns information about an index
1557 * If errors are explicitly ignored, returns NULL on failure
1558 * @param string $table table name
1559 * @param string $index index name
1561 * @return object query row in object form
1563 public function indexInfo( $table, $index, $fname = 'DatabaseIbm_db2::indexExists' ) {
1564 $table = $this->tableName( $table );
1566 SELECT name as indexname
1567 FROM sysibm.sysindexes si
1568 WHERE si.name='$index' AND si.tbname='$table' AND sc.tbcreator='$this->mSchema'
1570 $res = $this->query( $sql, $fname );
1574 $row = $this->fetchObject( $res );
1575 if ($row != NULL) return $row;
1580 * Returns an information object on a table column
1581 * @param string $table table name
1582 * @param string $field column name
1583 * @return IBM_DB2Field
1585 public function fieldInfo( $table, $field ) {
1586 return IBM_DB2Field
::fromText($this, $table, $field);
1590 * db2_field_type() wrapper
1591 * @param object $res Result of executed statement
1592 * @param mixed $index number or name of the column
1593 * @return string column type
1595 public function fieldType( $res, $index ) {
1596 if ( $res instanceof ResultWrapper
) {
1597 $res = $res->result
;
1599 return db2_field_type( $res, $index );
1603 * Verifies that an index was created as unique
1604 * @param string $table table name
1605 * @param string $index index name
1606 * @param string $fnam function name for profiling
1609 public function indexUnique ($table, $index, $fname = 'Database::indexUnique' ) {
1610 $table = $this->tableName( $table );
1612 SELECT si.name as indexname
1613 FROM sysibm.sysindexes si
1614 WHERE si.name='$index' AND si.tbname='$table' AND sc.tbcreator='$this->mSchema'
1615 AND si.uniquerule IN ('U', 'P')
1617 $res = $this->query( $sql, $fname );
1621 if ($this->fetchObject( $res )) {
1629 * Returns the size of a text field, or -1 for "unlimited"
1630 * @param string $table table name
1631 * @param string $field column name
1632 * @return int length or -1 for unlimited
1634 public function textFieldSize( $table, $field ) {
1635 $table = $this->tableName( $table );
1637 SELECT length as size
1638 FROM sysibm.syscolumns sc
1639 WHERE sc.name='$field' AND sc.tbname='$table' AND sc.tbcreator='$this->mSchema'
1641 $res = $this->query($sql);
1642 $row = $this->fetchObject($res);
1644 $this->freeResult( $res );
1649 * DELETE where the condition is a join
1650 * @param string $delTable deleting from this table
1651 * @param string $joinTable using data from this table
1652 * @param string $delVar variable in deleteable table
1653 * @param string $joinVar variable in data table
1654 * @param array $conds conditionals for join table
1655 * @param string $fname function name for profiling
1657 public function deleteJoin( $delTable, $joinTable, $delVar, $joinVar, $conds, $fname = "DatabaseIbm_db2::deleteJoin" ) {
1659 throw new DBUnexpectedError($this, 'Database::deleteJoin() called with empty $conds' );
1662 $delTable = $this->tableName( $delTable );
1663 $joinTable = $this->tableName( $joinTable );
1664 $sql = "DELETE FROM $delTable WHERE $delVar IN (SELECT $joinVar FROM $joinTable ";
1665 if ( $conds != '*' ) {
1666 $sql .= 'WHERE ' . $this->makeList( $conds, LIST_AND
);
1670 $this->query( $sql, $fname );
1674 * Description is left as an exercise for the reader
1675 * @param mixed $b data to be encoded
1676 * @return IBM_DB2Blob
1678 public function encodeBlob($b) {
1679 return new IBM_DB2Blob($b);
1683 * Description is left as an exercise for the reader
1684 * @param IBM_DB2Blob $b data to be decoded
1687 public function decodeBlob($b) {
1688 return $b->getData();
1692 * Convert into a list of string being concatenated
1693 * @param array $stringList strings that need to be joined together by the SQL engine
1694 * @return string joined by the concatenation operator
1696 public function buildConcat( $stringList ) {
1697 // || is equivalent to CONCAT
1698 // Sample query: VALUES 'foo' CONCAT 'bar' CONCAT 'baz'
1699 return implode( ' || ', $stringList );
1703 * Generates the SQL required to convert a DB2 timestamp into a Unix epoch
1704 * @param string $column name of timestamp column
1705 * @return string SQL code
1707 public function extractUnixEpoch( $column ) {
1709 // see SpecialAncientpages
1712 ######################################
1713 # Prepared statements
1714 ######################################
1717 * Intended to be compatible with the PEAR::DB wrapper functions.
1718 * http://pear.php.net/manual/en/package.database.db.intro-execute.php
1720 * ? = scalar value, quoted as necessary
1721 * ! = raw SQL bit (a function for instance)
1722 * & = filename; reads the file and inserts as a blob
1723 * (we don't use this though...)
1724 * @param string $sql SQL statement with appropriate markers
1725 * @return resource a prepared DB2 SQL statement
1727 public function prepare( $sql, $func = 'DB2::prepare' ) {
1728 $stmt = db2_prepare($this->mConn
, $sql, $this->mStmtOptions
);
1733 * Frees resources associated with a prepared statement
1734 * @return bool success or failure
1736 public function freePrepared( $prepared ) {
1737 return db2_free_stmt($prepared);
1741 * Execute a prepared query with the various arguments
1742 * @param string $prepared the prepared sql
1743 * @param mixed $args Either an array here, or put scalars as varargs
1744 * @return resource Results object
1746 public function execute( $prepared, $args = null ) {
1747 if( !is_array( $args ) ) {
1749 $args = func_get_args();
1750 array_shift( $args );
1752 $res = db2_execute($prepared, $args);
1757 * Prepare & execute an SQL statement, quoting and inserting arguments
1758 * in the appropriate places.
1759 * @param $query String
1762 public function safeQuery( $query, $args = null ) {
1763 // copied verbatim from Database.php
1764 $prepared = $this->prepare( $query, 'DB2::safeQuery' );
1765 if( !is_array( $args ) ) {
1767 $args = func_get_args();
1768 array_shift( $args );
1770 $retval = $this->execute( $prepared, $args );
1771 $this->freePrepared( $prepared );
1776 * For faking prepared SQL statements on DBs that don't support
1778 * @param resource $preparedQuery String: a 'preparable' SQL statement
1779 * @param array $args Array of arguments to fill it with
1780 * @return string executable statement
1782 public function fillPrepared( $preparedQuery, $args ) {
1784 $this->preparedArgs
=& $args;
1786 foreach ($args as $i => $arg) {
1787 db2_bind_param($preparedQuery, $i+
1, $args[$i]);
1790 return $preparedQuery;
1794 * Switches module between regular and install modes
1796 public function setMode($mode) {
1797 $old = $this->mMode
;
1798 $this->mMode
= $mode;
1803 * Bitwise negation of a column or value in SQL
1804 * Same as (~field) in C
1805 * @param string $field
1808 function bitNot($field) {
1809 //expecting bit-fields smaller than 4bytes
1810 return 'BITNOT('.$bitField.')';
1814 * Bitwise AND of two columns or values in SQL
1815 * Same as (fieldLeft & fieldRight) in C
1816 * @param string $fieldLeft
1817 * @param string $fieldRight
1820 function bitAnd($fieldLeft, $fieldRight) {
1821 return 'BITAND('.$fieldLeft.', '.$fieldRight.')';
1825 * Bitwise OR of two columns or values in SQL
1826 * Same as (fieldLeft | fieldRight) in C
1827 * @param string $fieldLeft
1828 * @param string $fieldRight
1831 function bitOr($fieldLeft, $fieldRight) {
1832 return 'BITOR('.$fieldLeft.', '.$fieldRight.')';