blob: 9a260a5ac47ffb6eed053ce3cfa5df67c233096e [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
Derek Allardd2df9bc2007-04-15 17:41:17 +00009 * @copyright Copyright (c) 2006, 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
33 /**
Derek Allard694b5b82007-12-18 15:58:03 +000034 * The syntax to count rows is slightly different across different
35 * database engines, so this string appears in each driver and is
36 * used for the count_all() and count_all_results() functions.
37 */
Derek Allard39b622d2008-01-16 21:10:09 +000038 var $_count_string = "SELECT COUNT(*) AS ";
Derek Allard6ddb5a12007-12-18 17:22:50 +000039 var $_random_keyword = ' RANDOM()'; // database specific random keyword
Derek Allard694b5b82007-12-18 15:58:03 +000040
41 /**
Derek Allardba0dd632007-03-07 12:10:58 +000042 * Non-persistent database connection
43 *
44 * @access private called by the base class
45 * @return resource
46 */
47 function db_connect()
48 {
49 $port = ($this->port == '') ? '' : " port=".$this->port;
50
51 return @pg_connect("host=".$this->hostname.$port." dbname=".$this->database." user=".$this->username." password=".$this->password);
52 }
53
54 // --------------------------------------------------------------------
55
56 /**
57 * Persistent database connection
58 *
59 * @access private called by the base class
60 * @return resource
61 */
62 function db_pconnect()
63 {
64 $port = ($this->port == '') ? '' : " port=".$this->port;
65
66 return @pg_pconnect("host=".$this->hostname.$port." dbname=".$this->database." user=".$this->username." password=".$this->password);
67 }
68
69 // --------------------------------------------------------------------
70
71 /**
72 * Select the database
73 *
74 * @access private called by the base class
75 * @return resource
76 */
77 function db_select()
78 {
79 // Not needed for Postgre so we'll return TRUE
80 return TRUE;
81 }
82
83 // --------------------------------------------------------------------
84
85 /**
Derek Allard39b622d2008-01-16 21:10:09 +000086 * Set client character set
87 *
88 * @access public
89 * @param string
90 * @param string
91 * @return resource
92 */
93 function db_set_charset($charset, $collation)
94 {
95 // TODO - add support if needed
96 return TRUE;
97 }
98
99 // --------------------------------------------------------------------
100
101 /**
Derek Allardba0dd632007-03-07 12:10:58 +0000102 * Version number query string
103 *
104 * @access public
105 * @return string
106 */
107 function _version()
108 {
109 return "SELECT version() AS ver";
110 }
111
112 // --------------------------------------------------------------------
113
114 /**
115 * Execute the query
116 *
117 * @access private called by the base class
118 * @param string an SQL query
119 * @return resource
120 */
121 function _execute($sql)
122 {
123 $sql = $this->_prep_query($sql);
124 return @pg_query($this->conn_id, $sql);
125 }
126
127 // --------------------------------------------------------------------
128
129 /**
130 * Prep the query
131 *
132 * If needed, each database adapter can prep the query string
133 *
134 * @access private called by execute()
135 * @param string an SQL query
136 * @return string
137 */
138 function _prep_query($sql)
139 {
140 return $sql;
141 }
142
143 // --------------------------------------------------------------------
144
145 /**
146 * Begin Transaction
147 *
148 * @access public
149 * @return bool
150 */
151 function trans_begin($test_mode = FALSE)
152 {
Derek Jones0b59f272008-05-13 04:22:33 +0000153 if ( ! $this->trans_enabled)
Derek Allardba0dd632007-03-07 12:10:58 +0000154 {
155 return TRUE;
156 }
157
158 // When transactions are nested we only begin/commit/rollback the outermost ones
159 if ($this->_trans_depth > 0)
160 {
161 return TRUE;
162 }
163
164 // Reset the transaction failure flag.
165 // If the $test_mode flag is set to TRUE transactions will be rolled back
166 // even if the queries produce a successful result.
167 $this->_trans_failure = ($test_mode === TRUE) ? TRUE : FALSE;
168
169 return @pg_exec($this->conn_id, "begin");
170 }
171
172 // --------------------------------------------------------------------
173
174 /**
175 * Commit Transaction
176 *
177 * @access public
178 * @return bool
179 */
180 function trans_commit()
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 return @pg_exec($this->conn_id, "commit");
194 }
195
196 // --------------------------------------------------------------------
197
198 /**
199 * Rollback Transaction
200 *
201 * @access public
202 * @return bool
203 */
204 function trans_rollback()
205 {
Derek Jones0b59f272008-05-13 04:22:33 +0000206 if ( ! $this->trans_enabled)
Derek Allardba0dd632007-03-07 12:10:58 +0000207 {
208 return TRUE;
209 }
210
211 // When transactions are nested we only begin/commit/rollback the outermost ones
212 if ($this->_trans_depth > 0)
213 {
214 return TRUE;
215 }
216
217 return @pg_exec($this->conn_id, "rollback");
218 }
219
220 // --------------------------------------------------------------------
221
222 /**
223 * Escape String
224 *
225 * @access public
226 * @param string
227 * @return string
228 */
229 function escape_str($str)
230 {
231 return pg_escape_string($str);
232 }
233
234 // --------------------------------------------------------------------
235
236 /**
237 * Affected Rows
238 *
239 * @access public
240 * @return integer
241 */
242 function affected_rows()
243 {
244 return @pg_affected_rows($this->result_id);
245 }
246
247 // --------------------------------------------------------------------
248
249 /**
250 * Insert ID
251 *
252 * @access public
253 * @return integer
254 */
255 function insert_id()
256 {
Derek Jonesf9a4e9e2007-07-12 13:56:21 +0000257 $v = $this->_version();
Derek Allardba0dd632007-03-07 12:10:58 +0000258 $v = $v['server'];
259
260 $table = func_num_args() > 0 ? func_get_arg(0) : null;
261 $column = func_num_args() > 1 ? func_get_arg(1) : null;
262
263 if ($table == null && $v >= '8.1')
264 {
265 $sql='SELECT LASTVAL() as ins_id';
266 }
267 elseif ($table != null && $column != null && $v >= '8.0')
268 {
269 $sql = sprintf("SELECT pg_get_serial_sequence('%s','%s') as seq", $table, $column);
270 $query = $this->query($sql);
271 $row = $query->row();
272 $sql = sprintf("SELECT CURRVAL('%s') as ins_id", $row->seq);
273 }
274 elseif ($table != null)
275 {
276 // seq_name passed in table parameter
277 $sql = sprintf("SELECT CURRVAL('%s') as ins_id", $table);
278 }
279 else
280 {
281 return pg_last_oid($this->result_id);
282 }
283 $query = $this->query($sql);
284 $row = $query->row();
285 return $row->ins_id;
286 }
287
288 // --------------------------------------------------------------------
289
290 /**
291 * "Count All" query
292 *
293 * Generates a platform-specific query string that counts all records in
294 * the specified database
295 *
296 * @access public
297 * @param string
298 * @return string
299 */
300 function count_all($table = '')
301 {
302 if ($table == '')
303 return '0';
Derek Allard694b5b82007-12-18 15:58:03 +0000304
Derek Allardf6cd45c2008-01-18 14:31:51 +0000305 $query = $this->query($this->_count_string . $this->_protect_identifiers('numrows'). " FROM " . $this->_protect_identifiers($this->dbprefix.$table));
Derek Allard694b5b82007-12-18 15:58:03 +0000306
Derek Allardba0dd632007-03-07 12:10:58 +0000307 if ($query->num_rows() == 0)
308 return '0';
309
310 $row = $query->row();
311 return $row->numrows;
312 }
313
314 // --------------------------------------------------------------------
315
316 /**
317 * Show table query
318 *
319 * Generates a platform-specific query string so that the table names can be fetched
320 *
321 * @access private
Derek Allard39b622d2008-01-16 21:10:09 +0000322 * @param boolean
Derek Allardba0dd632007-03-07 12:10:58 +0000323 * @return string
324 */
Derek Allard39b622d2008-01-16 21:10:09 +0000325 function _list_tables($prefix_limit = FALSE)
Derek Allardba0dd632007-03-07 12:10:58 +0000326 {
Derek Allard39b622d2008-01-16 21:10:09 +0000327 $sql = "SELECT table_name FROM information_schema.tables WHERE table_schema = 'public'";
328
329 if ($prefix_limit !== FALSE AND $this->dbprefix != '')
330 {
331 $sql .= " AND table_name LIKE '".$this->dbprefix."%'";
332 }
333
334 return $sql;
Derek Allardba0dd632007-03-07 12:10:58 +0000335 }
336
337 // --------------------------------------------------------------------
338
339 /**
340 * Show column query
341 *
342 * Generates a platform-specific query string so that the column names can be fetched
343 *
344 * @access public
345 * @param string the table name
346 * @return string
347 */
348 function _list_columns($table = '')
349 {
Derek Allard694b5b82007-12-18 15:58:03 +0000350 return "SELECT column_name FROM information_schema.columns WHERE table_name ='".$this->_escape_table($table)."'";
Derek Allardba0dd632007-03-07 12:10:58 +0000351 }
352
353 // --------------------------------------------------------------------
354
355 /**
356 * Field data query
357 *
358 * Generates a platform-specific query so that the column data can be retrieved
359 *
360 * @access public
361 * @param string the table name
362 * @return object
363 */
364 function _field_data($table)
365 {
366 return "SELECT * FROM ".$this->_escape_table($table)." LIMIT 1";
367 }
368
369 // --------------------------------------------------------------------
370
371 /**
372 * The error message string
373 *
374 * @access private
375 * @return string
376 */
377 function _error_message()
378 {
379 return pg_last_error($this->conn_id);
380 }
381
382 // --------------------------------------------------------------------
383
384 /**
385 * The error message number
386 *
387 * @access private
388 * @return integer
389 */
390 function _error_number()
391 {
392 return '';
393 }
394
395 // --------------------------------------------------------------------
396
397 /**
398 * Escape Table Name
399 *
400 * This function adds backticks if the table name has a period
401 * in it. Some DBs will get cranky unless periods are escaped.
402 *
403 * @access private
404 * @param string the table name
405 * @return string
406 */
407 function _escape_table($table)
408 {
Derek Allardc0743382008-02-11 05:54:44 +0000409 if (strpos($table, '.') !== FALSE)
Derek Allardba0dd632007-03-07 12:10:58 +0000410 {
Derek Allardc0743382008-02-11 05:54:44 +0000411 $table = '"' . str_replace('.', '"."', $table) . '"';
Derek Allardba0dd632007-03-07 12:10:58 +0000412 }
413
414 return $table;
415 }
416
417 // --------------------------------------------------------------------
418
419 /**
Derek Allard39b622d2008-01-16 21:10:09 +0000420 * Protect Identifiers
421 *
422 * This function adds backticks if appropriate based on db type
423 *
424 * @access private
425 * @param mixed the item to escape
426 * @param boolean only affect the first word
427 * @return mixed the item with backticks
428 */
429 function _protect_identifiers($item, $first_word_only = FALSE)
430 {
431 if (is_array($item))
432 {
433 $escaped_array = array();
434
435 foreach($item as $k=>$v)
436 {
437 $escaped_array[$this->_protect_identifiers($k)] = $this->_protect_identifiers($v, $first_word_only);
438 }
439
440 return $escaped_array;
441 }
442
443 // This function may get "item1 item2" as a string, and so
444 // we may need ""item1" "item2"" and not ""item1 item2""
Derek Allard61579382008-01-16 22:22:42 +0000445 if (ctype_alnum($item) === FALSE)
Derek Allard39b622d2008-01-16 21:10:09 +0000446 {
Derek Allard9b3e7b52008-02-04 23:20:34 +0000447 if (strpos($item, '.') !== FALSE)
448 {
449 $aliased_tables = implode(".",$this->ar_aliased_tables).'.';
450 $table_name = substr($item, 0, strpos($item, '.')+1);
451 $item = (strpos($aliased_tables, $table_name) !== FALSE) ? $item = $item : $this->dbprefix.$item;
452 }
453
Derek Allard39b622d2008-01-16 21:10:09 +0000454 // This function may get "field >= 1", and need it to return ""field" >= 1"
Derek Allard61579382008-01-16 22:22:42 +0000455 $lbound = ($first_word_only === TRUE) ? '' : '|\s|\(';
Derek Allard39b622d2008-01-16 21:10:09 +0000456
Derek Allard61579382008-01-16 22:22:42 +0000457 $item = preg_replace('/(^'.$lbound.')([\w\d\-\_]+?)(\s|\)|$)/iS', '$1"$2"$3', $item);
458 }
459 else
460 {
Derek Allard4acd7922008-01-26 19:33:59 +0000461 return "\"{$item}\"";
Derek Allard39b622d2008-01-16 21:10:09 +0000462 }
463
Derek Allard9a4d1da2008-02-25 14:18:38 +0000464 $exceptions = array('AS', '/', '-', '%', '+', '*', 'OR', 'IS');
Derek Allard39b622d2008-01-16 21:10:09 +0000465
466 foreach ($exceptions as $exception)
467 {
Derek Allard61579382008-01-16 22:22:42 +0000468
Derek Allard4acd7922008-01-26 19:33:59 +0000469 if (stristr($item, " \"{$exception}\" ") !== FALSE)
Derek Allard39b622d2008-01-16 21:10:09 +0000470 {
471 $item = preg_replace('/ "('.preg_quote($exception).')" /i', ' $1 ', $item);
472 }
473 }
Derek Allard39b622d2008-01-16 21:10:09 +0000474 return $item;
475 }
476
477 // --------------------------------------------------------------------
478
479 /**
Derek Jonesc6ad0232008-01-29 18:44:54 +0000480 * From Tables
481 *
482 * This function implicitly groups FROM tables so there is no confusion
483 * about operator precedence in harmony with SQL standards
484 *
485 * @access public
486 * @param type
487 * @return type
488 */
489 function _from_tables($tables)
490 {
Derek Jones0b59f272008-05-13 04:22:33 +0000491 if ( ! is_array($tables))
Derek Jonesc6ad0232008-01-29 18:44:54 +0000492 {
493 $tables = array($tables);
494 }
495
Derek Allard15648132008-02-10 21:46:18 +0000496 return implode(', ', $tables);
Derek Jonesc6ad0232008-01-29 18:44:54 +0000497 }
498
499 // --------------------------------------------------------------------
500
501 /**
Derek Allardba0dd632007-03-07 12:10:58 +0000502 * Insert statement
503 *
504 * Generates a platform-specific insert string from the supplied data
505 *
506 * @access public
507 * @param string the table name
508 * @param array the insert keys
509 * @param array the insert values
510 * @return string
511 */
512 function _insert($table, $keys, $values)
513 {
514 return "INSERT INTO ".$this->_escape_table($table)." (".implode(', ', $keys).") VALUES (".implode(', ', $values).")";
515 }
516
517 // --------------------------------------------------------------------
518
519 /**
520 * Update statement
521 *
522 * Generates a platform-specific update string from the supplied data
523 *
524 * @access public
525 * @param string the table name
526 * @param array the update data
527 * @param array the where clause
Derek Allard39b622d2008-01-16 21:10:09 +0000528 * @param array the orderby clause
529 * @param array the limit clause
Derek Allardba0dd632007-03-07 12:10:58 +0000530 * @return string
531 */
Derek Allard39b622d2008-01-16 21:10:09 +0000532 function _update($table, $values, $where, $orderby = array(), $limit = FALSE)
Derek Allardba0dd632007-03-07 12:10:58 +0000533 {
534 foreach($values as $key => $val)
535 {
536 $valstr[] = $key." = ".$val;
537 }
Derek Allardda6d2402007-12-19 14:49:29 +0000538
Derek Jones0b59f272008-05-13 04:22:33 +0000539 $limit = ( ! $limit) ? '' : ' LIMIT '.$limit;
Derek Allard39b622d2008-01-16 21:10:09 +0000540
541 $orderby = (count($orderby) >= 1)?' ORDER BY '.implode(", ", $orderby):'';
Derek Allardba0dd632007-03-07 12:10:58 +0000542
Derek Allard32cf7eb2008-02-05 16:03:50 +0000543 $sql = "UPDATE ".$this->_escape_table($table)." SET ".implode(', ', $valstr);
544 $sql .= ($where != '' AND count($where) >=1) ? " WHERE ".implode(" ", $where) : '';
545 $sql .= $orderby.$limit;
546
547 return $sql;
Derek Allard39b622d2008-01-16 21:10:09 +0000548 }
549
550
551 // --------------------------------------------------------------------
552
553 /**
554 * Truncate statement
555 *
556 * Generates a platform-specific truncate string from the supplied data
557 * If the database does not support the truncate() command
558 * This function maps to "DELETE FROM table"
559 *
560 * @access public
561 * @param string the table name
562 * @return string
563 */
564 function _truncate($table)
565 {
566 return "TRUNCATE ".$this->_escape_table($table);
Derek Allardba0dd632007-03-07 12:10:58 +0000567 }
568
569 // --------------------------------------------------------------------
570
571 /**
572 * Delete statement
573 *
574 * Generates a platform-specific delete string from the supplied data
575 *
576 * @access public
577 * @param string the table name
578 * @param array the where clause
Derek Allard39b622d2008-01-16 21:10:09 +0000579 * @param string the limit clause
Derek Allardba0dd632007-03-07 12:10:58 +0000580 * @return string
581 */
Derek Allard39b622d2008-01-16 21:10:09 +0000582 function _delete($table, $where = array(), $like = array(), $limit = FALSE)
Derek Allardba0dd632007-03-07 12:10:58 +0000583 {
Derek Allard39b622d2008-01-16 21:10:09 +0000584 $conditions = '';
585
Derek Jones0b59f272008-05-13 04:22:33 +0000586 if (count($where) > 0 OR count($like) > 0)
Derek Allard39b622d2008-01-16 21:10:09 +0000587 {
588 $conditions = "\nWHERE ";
589 $conditions .= implode("\n", $this->ar_where);
590
591 if (count($where) > 0 && count($like) > 0)
592 {
593 $conditions .= " AND ";
594 }
595 $conditions .= implode("\n", $like);
596 }
597
Derek Jones0b59f272008-05-13 04:22:33 +0000598 $limit = ( ! $limit) ? '' : ' LIMIT '.$limit;
Derek Allarde77d77c2007-12-19 15:01:55 +0000599
Derek Allard39b622d2008-01-16 21:10:09 +0000600 return "DELETE FROM ".$table.$conditions.$limit;
Derek Allardba0dd632007-03-07 12:10:58 +0000601 }
602
603 // --------------------------------------------------------------------
Derek Allardba0dd632007-03-07 12:10:58 +0000604 /**
605 * Limit string
606 *
607 * Generates a platform-specific LIMIT clause
608 *
609 * @access public
610 * @param string the sql query string
611 * @param integer the number of rows to limit the query to
612 * @param integer the offset value
613 * @return string
614 */
615 function _limit($sql, $limit, $offset)
616 {
617 $sql .= "LIMIT ".$limit;
618
619 if ($offset > 0)
620 {
621 $sql .= " OFFSET ".$offset;
622 }
623
624 return $sql;
625 }
626
627 // --------------------------------------------------------------------
628
629 /**
630 * Close DB Connection
631 *
632 * @access public
633 * @param resource
634 * @return void
635 */
636 function _close($conn_id)
637 {
638 @pg_close($conn_id);
639 }
640
641
642}
643
Derek Jones0b59f272008-05-13 04:22:33 +0000644
645/* End of file postgre_driver.php */
Derek Jonesa3ffbbb2008-05-11 18:18:29 +0000646/* Location: ./system/database/drivers/postgre/postgre_driver.php */