blob: b6c4eb7eac87590779fc9cb9cb298890513ac3f6 [file] [log] [blame]
admin046000b2006-09-24 18:12:07 +00001<?php if (!defined('BASEPATH')) exit('No direct script access allowed');
2/**
3 * Code Igniter
4 *
5 * An open source application development framework for PHP 4.3.2 or newer
6 *
7 * @package CodeIgniter
8 * @author Rick Ellis
9 * @copyright Copyright (c) 2006, pMachine, Inc.
10 * @license http://www.codeignitor.com/user_guide/license.html
11 * @link http://www.codeigniter.com
12 * @since Version 1.0
13 * @filesource
14 */
15
16// ------------------------------------------------------------------------
17
18/**
19 * MySQL 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
28 * @author Rick Ellis
29 * @link http://www.codeigniter.com/user_guide/database/
30 */
31class CI_DB_mysql_driver extends CI_DB {
32
33 /**
34 * Whether to use the MySQL "delete hack" which allows the number
35 * of affected rows to be shown. Uses a preg_replace when enabled,
36 * adding a bit more processing to all queries.
37 */
38 var $delete_hack = TRUE;
39
40 /**
41 * Non-persistent database connection
42 *
43 * @access private called by the base class
44 * @return resource
45 */
46 function db_connect()
47 {
48 return mysql_connect($this->hostname, $this->username, $this->password, TRUE);
49 }
50
51 // --------------------------------------------------------------------
52
53 /**
54 * Persistent database connection
55 *
56 * @access private called by the base class
57 * @return resource
58 */
59 function db_pconnect()
60 {
61 return mysql_pconnect($this->hostname, $this->username, $this->password);
62 }
63
64 // --------------------------------------------------------------------
65
66 /**
67 * Select the database
68 *
69 * @access private called by the base class
70 * @return resource
71 */
72 function db_select()
73 {
74 return @mysql_select_db($this->database, $this->conn_id);
75 }
admin9cd4e8e2006-09-25 23:26:25 +000076
77 // --------------------------------------------------------------------
78
79 /**
80 * Version number query string
81 *
82 * @access public
83 * @return string
84 */
85 function _version()
86 {
87 return "SELECT version() AS ver";
88 }
89
admin046000b2006-09-24 18:12:07 +000090 // --------------------------------------------------------------------
91
92 /**
93 * Execute the query
94 *
95 * @access private called by the base class
96 * @param string an SQL query
97 * @return resource
98 */
99 function _execute($sql)
100 {
101 $sql = $this->_prep_query($sql);
102 return @mysql_query($sql, $this->conn_id);
103 }
104
105 // --------------------------------------------------------------------
106
107 /**
108 * Prep the query
109 *
110 * If needed, each database adapter can prep the query string
111 *
112 * @access private called by execute()
113 * @param string an SQL query
114 * @return string
115 */
116 function _prep_query($sql)
117 {
118 // "DELETE FROM TABLE" returns 0 affected rows This hack modifies
119 // the query so that it returns the number of affected rows
120 if ($this->delete_hack === TRUE)
121 {
122 if (preg_match('/^\s*DELETE\s+FROM\s+(\S+)\s*$/i', $sql))
123 {
124 $sql = preg_replace("/^\s*DELETE\s+FROM\s+(\S+)\s*$/", "DELETE FROM \\1 WHERE 1=1", $sql);
125 }
126 }
127
128 return $sql;
129 }
130
131 // --------------------------------------------------------------------
132
133 /**
134 * Begin Transaction
135 *
136 * @access public
137 * @return bool
138 */
139 function trans_begin($test_mode = FALSE)
140 {
141 if ( ! $this->trans_enabled)
142 {
143 return TRUE;
144 }
145
146 // When transactions are nested we only begin/commit/rollback the outermost ones
147 if ($this->_trans_depth > 0)
148 {
149 return TRUE;
150 }
151
152 // Reset the transaction failure flag.
153 // If the $test_mode flag is set to TRUE transactions will be rolled back
154 // even if the queries produce a successful result.
155 $this->_trans_failure = ($test_mode === TRUE) ? TRUE : FALSE;
156
157 $this->simple_query('SET AUTOCOMMIT=0');
158 $this->simple_query('START TRANSACTION'); // can also be BEGIN or BEGIN WORK
159 return TRUE;
160 }
161
162 // --------------------------------------------------------------------
163
164 /**
165 * Commit Transaction
166 *
167 * @access public
168 * @return bool
169 */
170 function trans_commit()
171 {
172 if ( ! $this->trans_enabled)
173 {
174 return TRUE;
175 }
176
177 // When transactions are nested we only begin/commit/rollback the outermost ones
178 if ($this->_trans_depth > 0)
179 {
180 return TRUE;
181 }
182
183 $this->simple_query('COMMIT');
184 $this->simple_query('SET AUTOCOMMIT=1');
185 return TRUE;
186 }
187
188 // --------------------------------------------------------------------
189
190 /**
191 * Rollback Transaction
192 *
193 * @access public
194 * @return bool
195 */
196 function trans_rollback()
197 {
198 if ( ! $this->trans_enabled)
199 {
200 return TRUE;
201 }
202
203 // When transactions are nested we only begin/commit/rollback the outermost ones
204 if ($this->_trans_depth > 0)
205 {
206 return TRUE;
207 }
208
209 $this->simple_query('ROLLBACK');
210 $this->simple_query('SET AUTOCOMMIT=1');
211 return TRUE;
212 }
213
214 // --------------------------------------------------------------------
215
216 /**
217 * Escape String
218 *
219 * @access public
220 * @param string
221 * @return string
222 */
223 function escape_str($str)
224 {
225 return mysql_real_escape_string($str);
226 }
227
228 // --------------------------------------------------------------------
229
230 /**
231 * Affected Rows
232 *
233 * @access public
234 * @return integer
235 */
236 function affected_rows()
237 {
238 return @mysql_affected_rows($this->conn_id);
239 }
240
241 // --------------------------------------------------------------------
242
243 /**
244 * Insert ID
245 *
246 * @access public
247 * @return integer
248 */
249 function insert_id()
250 {
251 return @mysql_insert_id($this->conn_id);
252 }
253
254 // --------------------------------------------------------------------
255
256 /**
257 * "Count All" query
258 *
259 * Generates a platform-specific query string that counts all records in
260 * the specified database
261 *
262 * @access public
263 * @param string
264 * @return string
265 */
266 function count_all($table = '')
267 {
268 if ($table == '')
269 return '0';
270
271 $query = $this->query("SELECT COUNT(*) AS numrows FROM `".$this->dbprefix.$table."`");
272
273 if ($query->num_rows() == 0)
274 return '0';
275
276 $row = $query->row();
277 return $row->numrows;
278 }
279
280 // --------------------------------------------------------------------
281
282 /**
admin9cd4e8e2006-09-25 23:26:25 +0000283 * Show columnn query
284 *
285 * Generates a platform-specific query string so that the column names can be fetched
286 *
287 * @access public
288 * @param string the table name
289 * @return string
290 */
291 function _list_columns($table = '')
292 {
293 return "SHOW COLUMNS FROM ".$this->_escape_table($table);
294 }
295
296 // --------------------------------------------------------------------
297
298 /**
299 * Field data query
300 *
301 * Generates a platform-specific query so that the column data can be retrieved
302 *
303 * @access public
304 * @param string the table name
305 * @return object
306 */
307 function _field_data($table)
308 {
309 return "SELECT * FROM ".$this->_escape_table($table)." LIMIT 1";
310 }
311
312 // --------------------------------------------------------------------
313
314 /**
admin046000b2006-09-24 18:12:07 +0000315 * The error message string
316 *
adminbb1d4392006-09-24 20:14:38 +0000317 * @access private
admin046000b2006-09-24 18:12:07 +0000318 * @return string
319 */
adminbb1d4392006-09-24 20:14:38 +0000320 function _error_message()
admin046000b2006-09-24 18:12:07 +0000321 {
322 return mysql_error($this->conn_id);
323 }
324
325 // --------------------------------------------------------------------
326
327 /**
328 * The error message number
329 *
adminbb1d4392006-09-24 20:14:38 +0000330 * @access private
admin046000b2006-09-24 18:12:07 +0000331 * @return integer
332 */
adminbb1d4392006-09-24 20:14:38 +0000333 function _error_number()
admin046000b2006-09-24 18:12:07 +0000334 {
335 return mysql_errno($this->conn_id);
336 }
337
338 // --------------------------------------------------------------------
339
340 /**
341 * Escape Table Name
342 *
343 * This function adds backticks if the table name has a period
344 * in it. Some DBs will get cranky unless periods are escaped
345 *
adminbb1d4392006-09-24 20:14:38 +0000346 * @access private
admin046000b2006-09-24 18:12:07 +0000347 * @param string the table name
348 * @return string
349 */
adminbb1d4392006-09-24 20:14:38 +0000350 function _escape_table($table)
admin046000b2006-09-24 18:12:07 +0000351 {
352 if (stristr($table, '.'))
353 {
354 $table = preg_replace("/\./", "`.`", $table);
355 }
356
357 return $table;
358 }
adminbb1d4392006-09-24 20:14:38 +0000359
admin046000b2006-09-24 18:12:07 +0000360 // --------------------------------------------------------------------
361
362 /**
363 * Insert statement
364 *
365 * Generates a platform-specific insert string from the supplied data
366 *
367 * @access public
368 * @param string the table name
369 * @param array the insert keys
370 * @param array the insert values
371 * @return string
372 */
373 function _insert($table, $keys, $values)
374 {
adminbb1d4392006-09-24 20:14:38 +0000375 return "INSERT INTO ".$this->_escape_table($table)." (".implode(', ', $keys).") VALUES (".implode(', ', $values).")";
admin046000b2006-09-24 18:12:07 +0000376 }
377
378 // --------------------------------------------------------------------
379
380 /**
381 * Update statement
382 *
383 * Generates a platform-specific update string from the supplied data
384 *
385 * @access public
386 * @param string the table name
387 * @param array the update data
388 * @param array the where clause
389 * @return string
390 */
391 function _update($table, $values, $where)
392 {
393 foreach($values as $key => $val)
394 {
395 $valstr[] = $key." = ".$val;
396 }
397
adminbb1d4392006-09-24 20:14:38 +0000398 return "UPDATE ".$this->_escape_table($table)." SET ".implode(', ', $valstr)." WHERE ".implode(" ", $where);
admin046000b2006-09-24 18:12:07 +0000399 }
400
401 // --------------------------------------------------------------------
402
403 /**
404 * Delete statement
405 *
406 * Generates a platform-specific delete string from the supplied data
407 *
408 * @access public
409 * @param string the table name
410 * @param array the where clause
411 * @return string
412 */
413 function _delete($table, $where)
414 {
adminbb1d4392006-09-24 20:14:38 +0000415 return "DELETE FROM ".$this->_escape_table($table)." WHERE ".implode(" ", $where);
admin046000b2006-09-24 18:12:07 +0000416 }
adminbb1d4392006-09-24 20:14:38 +0000417
418 // --------------------------------------------------------------------
419
420 /**
421 * Limit string
422 *
423 * Generates a platform-specific LIMIT clause
424 *
425 * @access public
426 * @param string the sql query string
427 * @param integer the number of rows to limit the query to
428 * @param integer the offset value
429 * @return string
430 */
431 function _limit($sql, $limit, $offset)
432 {
433 if ($offset == 0)
434 {
435 $offset = '';
436 }
437 else
438 {
439 $offset .= ", ";
440 }
441
442 return $sql."LIMIT ".$offset.$limit;
443 }
444
445 // --------------------------------------------------------------------
446
447 /**
448 * Close DB Connection
449 *
450 * @access public
451 * @param resource
452 * @return void
453 */
454 function _close($conn_id)
455 {
456 mysql_close($conn_id);
457 }
admin046000b2006-09-24 18:12:07 +0000458
admin046000b2006-09-24 18:12:07 +0000459}
460
461?>