blob: 55f6502800bc285a30404584dbfbc102786f9a0b [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
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 {
Rick Ellisff734012008-09-30 20:38:12 +000095 // @todo - add support if needed
Derek Allard39b622d2008-01-16 21:10:09 +000096 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 }
Rick Ellis52dc8ca2008-09-30 19:53:52 +0000394 // --------------------------------------------------------------------
395
396 /**
397 * Escape Column Name
398 *
399 * This function adds backticks around supplied column name
400 *
401 * @access private
402 * @param string the column name
403 * @return string
404 */
405 function _escape_column($column)
406 {
407 // Probably not necessary with Postgres so we simply return the value
408 return $column;
409 }
410
Derek Allardba0dd632007-03-07 12:10:58 +0000411 // --------------------------------------------------------------------
412
413 /**
414 * Escape Table Name
415 *
416 * This function adds backticks if the table name has a period
417 * in it. Some DBs will get cranky unless periods are escaped.
418 *
419 * @access private
420 * @param string the table name
421 * @return string
422 */
423 function _escape_table($table)
424 {
Derek Allardc0743382008-02-11 05:54:44 +0000425 if (strpos($table, '.') !== FALSE)
Derek Allardba0dd632007-03-07 12:10:58 +0000426 {
Derek Allardc0743382008-02-11 05:54:44 +0000427 $table = '"' . str_replace('.', '"."', $table) . '"';
Derek Allardba0dd632007-03-07 12:10:58 +0000428 }
429
430 return $table;
431 }
432
433 // --------------------------------------------------------------------
434
435 /**
Derek Allard39b622d2008-01-16 21:10:09 +0000436 * Protect Identifiers
437 *
438 * This function adds backticks if appropriate based on db type
439 *
440 * @access private
441 * @param mixed the item to escape
442 * @param boolean only affect the first word
443 * @return mixed the item with backticks
444 */
445 function _protect_identifiers($item, $first_word_only = FALSE)
446 {
447 if (is_array($item))
448 {
449 $escaped_array = array();
450
451 foreach($item as $k=>$v)
452 {
453 $escaped_array[$this->_protect_identifiers($k)] = $this->_protect_identifiers($v, $first_word_only);
454 }
455
456 return $escaped_array;
457 }
458
459 // This function may get "item1 item2" as a string, and so
460 // we may need ""item1" "item2"" and not ""item1 item2""
Derek Allard61579382008-01-16 22:22:42 +0000461 if (ctype_alnum($item) === FALSE)
Derek Allard39b622d2008-01-16 21:10:09 +0000462 {
Derek Allard9b3e7b52008-02-04 23:20:34 +0000463 if (strpos($item, '.') !== FALSE)
464 {
465 $aliased_tables = implode(".",$this->ar_aliased_tables).'.';
466 $table_name = substr($item, 0, strpos($item, '.')+1);
467 $item = (strpos($aliased_tables, $table_name) !== FALSE) ? $item = $item : $this->dbprefix.$item;
468 }
469
Derek Allard39b622d2008-01-16 21:10:09 +0000470 // This function may get "field >= 1", and need it to return ""field" >= 1"
Derek Allard61579382008-01-16 22:22:42 +0000471 $lbound = ($first_word_only === TRUE) ? '' : '|\s|\(';
Derek Allard39b622d2008-01-16 21:10:09 +0000472
Derek Allard61579382008-01-16 22:22:42 +0000473 $item = preg_replace('/(^'.$lbound.')([\w\d\-\_]+?)(\s|\)|$)/iS', '$1"$2"$3', $item);
474 }
475 else
476 {
Derek Allard4acd7922008-01-26 19:33:59 +0000477 return "\"{$item}\"";
Derek Allard39b622d2008-01-16 21:10:09 +0000478 }
479
Derek Allard9a4d1da2008-02-25 14:18:38 +0000480 $exceptions = array('AS', '/', '-', '%', '+', '*', 'OR', 'IS');
Derek Allard39b622d2008-01-16 21:10:09 +0000481
482 foreach ($exceptions as $exception)
483 {
Derek Allard61579382008-01-16 22:22:42 +0000484
Derek Allard4acd7922008-01-26 19:33:59 +0000485 if (stristr($item, " \"{$exception}\" ") !== FALSE)
Derek Allard39b622d2008-01-16 21:10:09 +0000486 {
487 $item = preg_replace('/ "('.preg_quote($exception).')" /i', ' $1 ', $item);
488 }
489 }
Derek Allard39b622d2008-01-16 21:10:09 +0000490 return $item;
491 }
492
493 // --------------------------------------------------------------------
494
495 /**
Derek Jonesc6ad0232008-01-29 18:44:54 +0000496 * From Tables
497 *
498 * This function implicitly groups FROM tables so there is no confusion
499 * about operator precedence in harmony with SQL standards
500 *
501 * @access public
502 * @param type
503 * @return type
504 */
505 function _from_tables($tables)
506 {
Derek Jones0b59f272008-05-13 04:22:33 +0000507 if ( ! is_array($tables))
Derek Jonesc6ad0232008-01-29 18:44:54 +0000508 {
509 $tables = array($tables);
510 }
511
Derek Allard15648132008-02-10 21:46:18 +0000512 return implode(', ', $tables);
Derek Jonesc6ad0232008-01-29 18:44:54 +0000513 }
514
515 // --------------------------------------------------------------------
516
517 /**
Derek Allardba0dd632007-03-07 12:10:58 +0000518 * Insert statement
519 *
520 * Generates a platform-specific insert string from the supplied data
521 *
522 * @access public
523 * @param string the table name
524 * @param array the insert keys
525 * @param array the insert values
526 * @return string
527 */
528 function _insert($table, $keys, $values)
529 {
530 return "INSERT INTO ".$this->_escape_table($table)." (".implode(', ', $keys).") VALUES (".implode(', ', $values).")";
531 }
532
533 // --------------------------------------------------------------------
534
535 /**
536 * Update statement
537 *
538 * Generates a platform-specific update string from the supplied data
539 *
540 * @access public
541 * @param string the table name
542 * @param array the update data
543 * @param array the where clause
Derek Allard39b622d2008-01-16 21:10:09 +0000544 * @param array the orderby clause
545 * @param array the limit clause
Derek Allardba0dd632007-03-07 12:10:58 +0000546 * @return string
547 */
Derek Allard39b622d2008-01-16 21:10:09 +0000548 function _update($table, $values, $where, $orderby = array(), $limit = FALSE)
Derek Allardba0dd632007-03-07 12:10:58 +0000549 {
550 foreach($values as $key => $val)
551 {
552 $valstr[] = $key." = ".$val;
553 }
Derek Allardda6d2402007-12-19 14:49:29 +0000554
Derek Jones0b59f272008-05-13 04:22:33 +0000555 $limit = ( ! $limit) ? '' : ' LIMIT '.$limit;
Derek Allard39b622d2008-01-16 21:10:09 +0000556
557 $orderby = (count($orderby) >= 1)?' ORDER BY '.implode(", ", $orderby):'';
Derek Allardba0dd632007-03-07 12:10:58 +0000558
Derek Allard32cf7eb2008-02-05 16:03:50 +0000559 $sql = "UPDATE ".$this->_escape_table($table)." SET ".implode(', ', $valstr);
560 $sql .= ($where != '' AND count($where) >=1) ? " WHERE ".implode(" ", $where) : '';
561 $sql .= $orderby.$limit;
562
563 return $sql;
Derek Allard39b622d2008-01-16 21:10:09 +0000564 }
565
566
567 // --------------------------------------------------------------------
568
569 /**
570 * Truncate statement
571 *
572 * Generates a platform-specific truncate string from the supplied data
573 * If the database does not support the truncate() command
574 * This function maps to "DELETE FROM table"
575 *
576 * @access public
577 * @param string the table name
578 * @return string
579 */
580 function _truncate($table)
581 {
582 return "TRUNCATE ".$this->_escape_table($table);
Derek Allardba0dd632007-03-07 12:10:58 +0000583 }
584
585 // --------------------------------------------------------------------
586
587 /**
588 * Delete statement
589 *
590 * Generates a platform-specific delete string from the supplied data
591 *
592 * @access public
593 * @param string the table name
594 * @param array the where clause
Derek Allard39b622d2008-01-16 21:10:09 +0000595 * @param string the limit clause
Derek Allardba0dd632007-03-07 12:10:58 +0000596 * @return string
597 */
Derek Allard39b622d2008-01-16 21:10:09 +0000598 function _delete($table, $where = array(), $like = array(), $limit = FALSE)
Derek Allardba0dd632007-03-07 12:10:58 +0000599 {
Derek Allard39b622d2008-01-16 21:10:09 +0000600 $conditions = '';
601
Derek Jones0b59f272008-05-13 04:22:33 +0000602 if (count($where) > 0 OR count($like) > 0)
Derek Allard39b622d2008-01-16 21:10:09 +0000603 {
604 $conditions = "\nWHERE ";
605 $conditions .= implode("\n", $this->ar_where);
606
607 if (count($where) > 0 && count($like) > 0)
608 {
609 $conditions .= " AND ";
610 }
611 $conditions .= implode("\n", $like);
612 }
613
Derek Jones0b59f272008-05-13 04:22:33 +0000614 $limit = ( ! $limit) ? '' : ' LIMIT '.$limit;
Derek Allarde77d77c2007-12-19 15:01:55 +0000615
Derek Allard39b622d2008-01-16 21:10:09 +0000616 return "DELETE FROM ".$table.$conditions.$limit;
Derek Allardba0dd632007-03-07 12:10:58 +0000617 }
618
619 // --------------------------------------------------------------------
Derek Allardba0dd632007-03-07 12:10:58 +0000620 /**
621 * Limit string
622 *
623 * Generates a platform-specific LIMIT clause
624 *
625 * @access public
626 * @param string the sql query string
627 * @param integer the number of rows to limit the query to
628 * @param integer the offset value
629 * @return string
630 */
631 function _limit($sql, $limit, $offset)
632 {
633 $sql .= "LIMIT ".$limit;
634
635 if ($offset > 0)
636 {
637 $sql .= " OFFSET ".$offset;
638 }
639
640 return $sql;
641 }
642
643 // --------------------------------------------------------------------
644
645 /**
646 * Close DB Connection
647 *
648 * @access public
649 * @param resource
650 * @return void
651 */
652 function _close($conn_id)
653 {
654 @pg_close($conn_id);
655 }
656
657
658}
659
Derek Jones0b59f272008-05-13 04:22:33 +0000660
661/* End of file postgre_driver.php */
Derek Jonesa3ffbbb2008-05-11 18:18:29 +0000662/* Location: ./system/database/drivers/postgre/postgre_driver.php */