blob: 68622a22b3418644994ebb440c3508084dd1d90d [file] [log] [blame]
Derek Jones0b59f272008-05-13 04:22:33 +00001<?php if ( ! defined('BASEPATH')) exit('No direct script access allowed');
Derek Allardba0dd632007-03-07 12:10:58 +00002/**
Derek Allardd2df9bc2007-04-15 17:41:17 +00003 * CodeIgniter
Derek Allardba0dd632007-03-07 12:10:58 +00004 *
5 * An open source application development framework for PHP 4.3.2 or newer
6 *
7 * @package CodeIgniter
Derek Allard3d879d52008-01-18 19:41:32 +00008 * @author ExpressionEngine Dev Team
Rick Ellis9ba2bf22008-09-12 23:34:39 +00009 * @copyright Copyright (c) 2008, EllisLab, Inc.
Derek Jones7a9193a2008-01-21 18:39:20 +000010 * @license http://codeigniter.com/user_guide/license.html
11 * @link http://codeigniter.com
Derek Allardba0dd632007-03-07 12:10:58 +000012 * @since Version 1.0
13 * @filesource
14 */
15
16// ------------------------------------------------------------------------
17
18/**
19 * Postgre Database Adapter Class
20 *
21 * Note: _DB is an extender class that the app controller
22 * creates dynamically based on whether the active record
23 * class is being used or not.
24 *
25 * @package CodeIgniter
26 * @subpackage Drivers
27 * @category Database
Derek Allard3d879d52008-01-18 19:41:32 +000028 * @author ExpressionEngine Dev Team
Derek Jones7a9193a2008-01-21 18:39:20 +000029 * @link http://codeigniter.com/user_guide/database/
Derek Allardba0dd632007-03-07 12:10:58 +000030 */
31class CI_DB_postgre_driver extends CI_DB {
32
Rick Ellis5aa8c602008-10-07 01:24:07 +000033 var $dbdriver = 'postgre';
Rick Ellis605a07a2008-10-17 04:07:54 +000034
35 var $_escape_char = '"';
Rick Ellis5aa8c602008-10-07 01:24:07 +000036
Derek Allardba0dd632007-03-07 12:10:58 +000037 /**
Derek Allard694b5b82007-12-18 15:58:03 +000038 * The syntax to count rows is slightly different across different
39 * database engines, so this string appears in each driver and is
40 * used for the count_all() and count_all_results() functions.
41 */
Derek Allard39b622d2008-01-16 21:10:09 +000042 var $_count_string = "SELECT COUNT(*) AS ";
Derek Allard6ddb5a12007-12-18 17:22:50 +000043 var $_random_keyword = ' RANDOM()'; // database specific random keyword
Derek Allard694b5b82007-12-18 15:58:03 +000044
45 /**
Rick Ellisb6ba6a32008-10-07 00:44:41 +000046 * Connection String
47 *
48 * @access private
49 * @return string
50 */
51 function _connect_string()
52 {
53 $components = array(
54 'hostname' => 'host',
55 'port' => 'port',
56 'database' => 'dbname',
57 'username' => 'user',
58 'password' => 'password'
59 );
60
61 $connect_string = "";
62 foreach ($components as $key => $val)
63 {
64 if (isset($this->$key) && $this->$key != '')
65 {
66 $connect_string .= " $val=".$this->$key;
67 }
68 }
69 return trim($connect_string);
70 }
71
72 // --------------------------------------------------------------------
73
74 /**
Derek Allardba0dd632007-03-07 12:10:58 +000075 * Non-persistent database connection
76 *
77 * @access private called by the base class
78 * @return resource
79 */
80 function db_connect()
Rick Ellisb6ba6a32008-10-07 00:44:41 +000081 {
82 return @pg_connect($this->_connect_string());
Derek Allardba0dd632007-03-07 12:10:58 +000083 }
84
85 // --------------------------------------------------------------------
86
87 /**
88 * Persistent database connection
89 *
90 * @access private called by the base class
91 * @return resource
92 */
93 function db_pconnect()
94 {
Rick Ellisb6ba6a32008-10-07 00:44:41 +000095 return @pg_pconnect($this->_connect_string());
Derek Allardba0dd632007-03-07 12:10:58 +000096 }
97
98 // --------------------------------------------------------------------
99
100 /**
101 * Select the database
102 *
103 * @access private called by the base class
104 * @return resource
105 */
106 function db_select()
107 {
108 // Not needed for Postgre so we'll return TRUE
109 return TRUE;
110 }
111
112 // --------------------------------------------------------------------
113
114 /**
Derek Allard39b622d2008-01-16 21:10:09 +0000115 * Set client character set
116 *
117 * @access public
118 * @param string
119 * @param string
120 * @return resource
121 */
122 function db_set_charset($charset, $collation)
123 {
Rick Ellisff734012008-09-30 20:38:12 +0000124 // @todo - add support if needed
Derek Allard39b622d2008-01-16 21:10:09 +0000125 return TRUE;
126 }
127
128 // --------------------------------------------------------------------
129
130 /**
Derek Allardba0dd632007-03-07 12:10:58 +0000131 * Version number query string
132 *
133 * @access public
134 * @return string
135 */
136 function _version()
137 {
138 return "SELECT version() AS ver";
139 }
140
141 // --------------------------------------------------------------------
142
143 /**
144 * Execute the query
145 *
146 * @access private called by the base class
147 * @param string an SQL query
148 * @return resource
149 */
150 function _execute($sql)
151 {
152 $sql = $this->_prep_query($sql);
153 return @pg_query($this->conn_id, $sql);
154 }
155
156 // --------------------------------------------------------------------
157
158 /**
159 * Prep the query
160 *
161 * If needed, each database adapter can prep the query string
162 *
163 * @access private called by execute()
164 * @param string an SQL query
165 * @return string
166 */
167 function _prep_query($sql)
168 {
169 return $sql;
170 }
171
172 // --------------------------------------------------------------------
173
174 /**
175 * Begin Transaction
176 *
177 * @access public
178 * @return bool
179 */
180 function trans_begin($test_mode = FALSE)
181 {
Derek Jones0b59f272008-05-13 04:22:33 +0000182 if ( ! $this->trans_enabled)
Derek Allardba0dd632007-03-07 12:10:58 +0000183 {
184 return TRUE;
185 }
186
187 // When transactions are nested we only begin/commit/rollback the outermost ones
188 if ($this->_trans_depth > 0)
189 {
190 return TRUE;
191 }
192
193 // Reset the transaction failure flag.
194 // If the $test_mode flag is set to TRUE transactions will be rolled back
195 // even if the queries produce a successful result.
196 $this->_trans_failure = ($test_mode === TRUE) ? TRUE : FALSE;
197
198 return @pg_exec($this->conn_id, "begin");
199 }
200
201 // --------------------------------------------------------------------
202
203 /**
204 * Commit Transaction
205 *
206 * @access public
207 * @return bool
208 */
209 function trans_commit()
210 {
Derek Jones0b59f272008-05-13 04:22:33 +0000211 if ( ! $this->trans_enabled)
Derek Allardba0dd632007-03-07 12:10:58 +0000212 {
213 return TRUE;
214 }
215
216 // When transactions are nested we only begin/commit/rollback the outermost ones
217 if ($this->_trans_depth > 0)
218 {
219 return TRUE;
220 }
221
222 return @pg_exec($this->conn_id, "commit");
223 }
224
225 // --------------------------------------------------------------------
226
227 /**
228 * Rollback Transaction
229 *
230 * @access public
231 * @return bool
232 */
233 function trans_rollback()
234 {
Derek Jones0b59f272008-05-13 04:22:33 +0000235 if ( ! $this->trans_enabled)
Derek Allardba0dd632007-03-07 12:10:58 +0000236 {
237 return TRUE;
238 }
239
240 // When transactions are nested we only begin/commit/rollback the outermost ones
241 if ($this->_trans_depth > 0)
242 {
243 return TRUE;
244 }
245
246 return @pg_exec($this->conn_id, "rollback");
247 }
248
249 // --------------------------------------------------------------------
250
251 /**
252 * Escape String
253 *
254 * @access public
255 * @param string
256 * @return string
257 */
258 function escape_str($str)
259 {
260 return pg_escape_string($str);
261 }
262
263 // --------------------------------------------------------------------
264
265 /**
266 * Affected Rows
267 *
268 * @access public
269 * @return integer
270 */
271 function affected_rows()
272 {
273 return @pg_affected_rows($this->result_id);
274 }
275
276 // --------------------------------------------------------------------
277
278 /**
279 * Insert ID
280 *
281 * @access public
282 * @return integer
283 */
284 function insert_id()
285 {
Derek Jonesf9a4e9e2007-07-12 13:56:21 +0000286 $v = $this->_version();
Derek Allardba0dd632007-03-07 12:10:58 +0000287 $v = $v['server'];
288
289 $table = func_num_args() > 0 ? func_get_arg(0) : null;
290 $column = func_num_args() > 1 ? func_get_arg(1) : null;
291
292 if ($table == null && $v >= '8.1')
293 {
294 $sql='SELECT LASTVAL() as ins_id';
295 }
296 elseif ($table != null && $column != null && $v >= '8.0')
297 {
298 $sql = sprintf("SELECT pg_get_serial_sequence('%s','%s') as seq", $table, $column);
299 $query = $this->query($sql);
300 $row = $query->row();
301 $sql = sprintf("SELECT CURRVAL('%s') as ins_id", $row->seq);
302 }
303 elseif ($table != null)
304 {
305 // seq_name passed in table parameter
306 $sql = sprintf("SELECT CURRVAL('%s') as ins_id", $table);
307 }
308 else
309 {
310 return pg_last_oid($this->result_id);
311 }
312 $query = $this->query($sql);
313 $row = $query->row();
314 return $row->ins_id;
315 }
316
317 // --------------------------------------------------------------------
318
319 /**
320 * "Count All" query
321 *
322 * Generates a platform-specific query string that counts all records in
323 * the specified database
324 *
325 * @access public
326 * @param string
327 * @return string
328 */
329 function count_all($table = '')
330 {
331 if ($table == '')
332 return '0';
Derek Allard694b5b82007-12-18 15:58:03 +0000333
Rick Ellis605a07a2008-10-17 04:07:54 +0000334 $query = $this->query($this->_count_string . $this->_protect_identifiers('numrows'). " FROM " . $this->_protect_identifiers($table, TRUE, NULL, FALSE));
Derek Allard694b5b82007-12-18 15:58:03 +0000335
Derek Allardba0dd632007-03-07 12:10:58 +0000336 if ($query->num_rows() == 0)
337 return '0';
338
339 $row = $query->row();
340 return $row->numrows;
341 }
342
343 // --------------------------------------------------------------------
344
345 /**
346 * Show table query
347 *
348 * Generates a platform-specific query string so that the table names can be fetched
349 *
350 * @access private
Derek Allard39b622d2008-01-16 21:10:09 +0000351 * @param boolean
Derek Allardba0dd632007-03-07 12:10:58 +0000352 * @return string
353 */
Derek Allard39b622d2008-01-16 21:10:09 +0000354 function _list_tables($prefix_limit = FALSE)
Derek Allardba0dd632007-03-07 12:10:58 +0000355 {
Derek Allard39b622d2008-01-16 21:10:09 +0000356 $sql = "SELECT table_name FROM information_schema.tables WHERE table_schema = 'public'";
357
358 if ($prefix_limit !== FALSE AND $this->dbprefix != '')
359 {
360 $sql .= " AND table_name LIKE '".$this->dbprefix."%'";
361 }
362
363 return $sql;
Derek Allardba0dd632007-03-07 12:10:58 +0000364 }
365
366 // --------------------------------------------------------------------
367
368 /**
369 * Show column query
370 *
371 * Generates a platform-specific query string so that the column names can be fetched
372 *
373 * @access public
374 * @param string the table name
375 * @return string
376 */
377 function _list_columns($table = '')
378 {
Rick Ellis605a07a2008-10-17 04:07:54 +0000379 return "SELECT column_name FROM information_schema.columns WHERE table_name ='".$table."'";
Derek Allardba0dd632007-03-07 12:10:58 +0000380 }
381
382 // --------------------------------------------------------------------
383
384 /**
385 * Field data query
386 *
387 * Generates a platform-specific query so that the column data can be retrieved
388 *
389 * @access public
390 * @param string the table name
391 * @return object
392 */
393 function _field_data($table)
394 {
Rick Ellis605a07a2008-10-17 04:07:54 +0000395 return "SELECT * FROM ".$table." LIMIT 1";
Derek Allardba0dd632007-03-07 12:10:58 +0000396 }
397
398 // --------------------------------------------------------------------
399
400 /**
401 * The error message string
402 *
403 * @access private
404 * @return string
405 */
406 function _error_message()
407 {
408 return pg_last_error($this->conn_id);
409 }
410
411 // --------------------------------------------------------------------
412
413 /**
414 * The error message number
415 *
416 * @access private
417 * @return integer
418 */
419 function _error_number()
420 {
421 return '';
422 }
Rick Ellis52dc8ca2008-09-30 19:53:52 +0000423
Derek Allardba0dd632007-03-07 12:10:58 +0000424 // --------------------------------------------------------------------
425
426 /**
Rick Ellis605a07a2008-10-17 04:07:54 +0000427 * Escape the SQL Identifiers
Derek Allardba0dd632007-03-07 12:10:58 +0000428 *
Rick Ellis605a07a2008-10-17 04:07:54 +0000429 * This function escapes column and table names
Derek Allardba0dd632007-03-07 12:10:58 +0000430 *
431 * @access private
Rick Ellis605a07a2008-10-17 04:07:54 +0000432 * @param string
Derek Allardba0dd632007-03-07 12:10:58 +0000433 * @return string
434 */
Rick Ellis605a07a2008-10-17 04:07:54 +0000435 function _escape_identifiers($item)
Derek Allardba0dd632007-03-07 12:10:58 +0000436 {
Rick Ellis605a07a2008-10-17 04:07:54 +0000437 if ($this->_escape_char == '')
Derek Allardba0dd632007-03-07 12:10:58 +0000438 {
Rick Ellis605a07a2008-10-17 04:07:54 +0000439 return $item;
Derek Allardba0dd632007-03-07 12:10:58 +0000440 }
Rick Ellisa0e86292008-10-26 22:46:55 +0000441
442 foreach ($this->_reserved_identifiers as $id)
443 {
444 if (strpos($item, '.'.$id) !== FALSE)
445 {
446 $str = $this->_escape_char. str_replace('.', $this->_escape_char.'.', $item);
447
448 // remove duplicates if the user already included the escape
449 return preg_replace('/['.$this->_escape_char.']+/', $this->_escape_char, $str);
450 }
451 }
Derek Allardba0dd632007-03-07 12:10:58 +0000452
Rick Ellis605a07a2008-10-17 04:07:54 +0000453 if (strpos($item, '.') !== FALSE)
Derek Allard39b622d2008-01-16 21:10:09 +0000454 {
Rick Ellis605a07a2008-10-17 04:07:54 +0000455 $str = $this->_escape_char.str_replace('.', $this->_escape_char.'.'.$this->_escape_char, $item).$this->_escape_char;
Derek Allard61579382008-01-16 22:22:42 +0000456 }
457 else
458 {
Rick Ellis605a07a2008-10-17 04:07:54 +0000459 $str = $this->_escape_char.$item.$this->_escape_char;
Derek Allard39b622d2008-01-16 21:10:09 +0000460 }
Derek Allard39b622d2008-01-16 21:10:09 +0000461
Rick Ellis605a07a2008-10-17 04:07:54 +0000462 // remove duplicates if the user already included the escape
463 return preg_replace('/['.$this->_escape_char.']+/', $this->_escape_char, $str);
Derek Allard39b622d2008-01-16 21:10:09 +0000464 }
465
466 // --------------------------------------------------------------------
467
468 /**
Derek Jonesc6ad0232008-01-29 18:44:54 +0000469 * From Tables
470 *
471 * This function implicitly groups FROM tables so there is no confusion
472 * about operator precedence in harmony with SQL standards
473 *
474 * @access public
475 * @param type
476 * @return type
477 */
478 function _from_tables($tables)
479 {
Derek Jones0b59f272008-05-13 04:22:33 +0000480 if ( ! is_array($tables))
Derek Jonesc6ad0232008-01-29 18:44:54 +0000481 {
482 $tables = array($tables);
483 }
484
Derek Allard15648132008-02-10 21:46:18 +0000485 return implode(', ', $tables);
Derek Jonesc6ad0232008-01-29 18:44:54 +0000486 }
487
488 // --------------------------------------------------------------------
489
490 /**
Derek Allardba0dd632007-03-07 12:10:58 +0000491 * Insert statement
492 *
493 * Generates a platform-specific insert string from the supplied data
494 *
495 * @access public
496 * @param string the table name
497 * @param array the insert keys
498 * @param array the insert values
499 * @return string
500 */
501 function _insert($table, $keys, $values)
502 {
Rick Ellis605a07a2008-10-17 04:07:54 +0000503 return "INSERT INTO ".$table." (".implode(', ', $keys).") VALUES (".implode(', ', $values).")";
Derek Allardba0dd632007-03-07 12:10:58 +0000504 }
505
506 // --------------------------------------------------------------------
507
508 /**
509 * Update statement
510 *
511 * Generates a platform-specific update string from the supplied data
512 *
513 * @access public
514 * @param string the table name
515 * @param array the update data
516 * @param array the where clause
Derek Allard39b622d2008-01-16 21:10:09 +0000517 * @param array the orderby clause
518 * @param array the limit clause
Derek Allardba0dd632007-03-07 12:10:58 +0000519 * @return string
520 */
Derek Allard39b622d2008-01-16 21:10:09 +0000521 function _update($table, $values, $where, $orderby = array(), $limit = FALSE)
Derek Allardba0dd632007-03-07 12:10:58 +0000522 {
523 foreach($values as $key => $val)
524 {
525 $valstr[] = $key." = ".$val;
526 }
Derek Allardda6d2402007-12-19 14:49:29 +0000527
Derek Jones0b59f272008-05-13 04:22:33 +0000528 $limit = ( ! $limit) ? '' : ' LIMIT '.$limit;
Derek Allard39b622d2008-01-16 21:10:09 +0000529
530 $orderby = (count($orderby) >= 1)?' ORDER BY '.implode(", ", $orderby):'';
Derek Allardba0dd632007-03-07 12:10:58 +0000531
Rick Ellis605a07a2008-10-17 04:07:54 +0000532 $sql = "UPDATE ".$table." SET ".implode(', ', $valstr);
533
Derek Allard32cf7eb2008-02-05 16:03:50 +0000534 $sql .= ($where != '' AND count($where) >=1) ? " WHERE ".implode(" ", $where) : '';
Rick Ellis605a07a2008-10-17 04:07:54 +0000535
Derek Allard32cf7eb2008-02-05 16:03:50 +0000536 $sql .= $orderby.$limit;
537
538 return $sql;
Derek Allard39b622d2008-01-16 21:10:09 +0000539 }
540
Derek Allard39b622d2008-01-16 21:10:09 +0000541 // --------------------------------------------------------------------
542
543 /**
544 * Truncate statement
545 *
546 * Generates a platform-specific truncate string from the supplied data
547 * If the database does not support the truncate() command
548 * This function maps to "DELETE FROM table"
549 *
550 * @access public
551 * @param string the table name
552 * @return string
553 */
554 function _truncate($table)
555 {
Rick Ellis605a07a2008-10-17 04:07:54 +0000556 return "TRUNCATE ".$table;
Derek Allardba0dd632007-03-07 12:10:58 +0000557 }
558
559 // --------------------------------------------------------------------
560
561 /**
562 * Delete statement
563 *
564 * Generates a platform-specific delete string from the supplied data
565 *
566 * @access public
567 * @param string the table name
568 * @param array the where clause
Derek Allard39b622d2008-01-16 21:10:09 +0000569 * @param string the limit clause
Derek Allardba0dd632007-03-07 12:10:58 +0000570 * @return string
571 */
Derek Allard39b622d2008-01-16 21:10:09 +0000572 function _delete($table, $where = array(), $like = array(), $limit = FALSE)
Derek Allardba0dd632007-03-07 12:10:58 +0000573 {
Derek Allard39b622d2008-01-16 21:10:09 +0000574 $conditions = '';
575
Derek Jones0b59f272008-05-13 04:22:33 +0000576 if (count($where) > 0 OR count($like) > 0)
Derek Allard39b622d2008-01-16 21:10:09 +0000577 {
578 $conditions = "\nWHERE ";
579 $conditions .= implode("\n", $this->ar_where);
580
581 if (count($where) > 0 && count($like) > 0)
582 {
583 $conditions .= " AND ";
584 }
585 $conditions .= implode("\n", $like);
586 }
587
Derek Jones0b59f272008-05-13 04:22:33 +0000588 $limit = ( ! $limit) ? '' : ' LIMIT '.$limit;
Derek Allarde77d77c2007-12-19 15:01:55 +0000589
Derek Allard39b622d2008-01-16 21:10:09 +0000590 return "DELETE FROM ".$table.$conditions.$limit;
Derek Allardba0dd632007-03-07 12:10:58 +0000591 }
592
593 // --------------------------------------------------------------------
Derek Allardba0dd632007-03-07 12:10:58 +0000594 /**
595 * Limit string
596 *
597 * Generates a platform-specific LIMIT clause
598 *
599 * @access public
600 * @param string the sql query string
601 * @param integer the number of rows to limit the query to
602 * @param integer the offset value
603 * @return string
604 */
605 function _limit($sql, $limit, $offset)
606 {
607 $sql .= "LIMIT ".$limit;
608
609 if ($offset > 0)
610 {
611 $sql .= " OFFSET ".$offset;
612 }
613
614 return $sql;
615 }
616
617 // --------------------------------------------------------------------
618
619 /**
620 * Close DB Connection
621 *
622 * @access public
623 * @param resource
624 * @return void
625 */
626 function _close($conn_id)
627 {
628 @pg_close($conn_id);
629 }
630
631
632}
633
Derek Jones0b59f272008-05-13 04:22:33 +0000634
635/* End of file postgre_driver.php */
Derek Jonesa3ffbbb2008-05-11 18:18:29 +0000636/* Location: ./system/database/drivers/postgre/postgre_driver.php */