b7b33ab8c548df37c686a609232f5c82179a2f4d
[moodle.git] / lib / dml / moodle_database.php
1 <?php
3 // This file is part of Moodle - http://moodle.org/
4 //
5 // Moodle is free software: you can redistribute it and/or modify
6 // it under the terms of the GNU General Public License as published by
7 // the Free Software Foundation, either version 3 of the License, or
8 // (at your option) any later version.
9 //
10 // Moodle is distributed in the hope that it will be useful,
11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13 // GNU General Public License for more details.
14 //
15 // You should have received a copy of the GNU General Public License
16 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
19 /**
20  * Abstract database driver class.
21  *
22  * @package    core
23  * @subpackage dml
24  * @copyright  2008 Petr Skoda (http://skodak.org)
25  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
26  */
28 defined('MOODLE_INTERNAL') || die();
30 require_once($CFG->libdir.'/dml/database_column_info.php');
31 require_once($CFG->libdir.'/dml/moodle_recordset.php');
32 require_once($CFG->libdir.'/dml/moodle_transaction.php');
34 /// GLOBAL CONSTANTS /////////////////////////////////////////////////////////
36 /** Bitmask, indicates :name type parameters are supported by db backend. */
37 define('SQL_PARAMS_NAMED', 1);
39 /** Bitmask, indicates ? type parameters are supported by db backend. */
40 define('SQL_PARAMS_QM', 2);
42 /** Bitmask, indicates $1, $2, ... type parameters are supported by db backend. */
43 define('SQL_PARAMS_DOLLAR', 4);
46 /** Normal select query, reading only */
47 define('SQL_QUERY_SELECT', 1);
49 /** Insert select query, writing */
50 define('SQL_QUERY_INSERT', 2);
52 /** Update select query, writing */
53 define('SQL_QUERY_UPDATE', 3);
55 /** Query changing db structure, writing */
56 define('SQL_QUERY_STRUCTURE', 4);
58 /** Auxiliary query done by driver, setting connection config, getting table info, etc. */
59 define('SQL_QUERY_AUX', 5);
61 /**
62  * Abstract class representing moodle database interface.
63  */
64 abstract class moodle_database {
66     /** @var database_manager db manager which allows db structure modifications */
67     protected $database_manager;
68     /** @var moodle_temptables temptables manager to provide cross-db support for temp tables */
69     protected $temptables;
70     /** @var array cache of column info */
71     protected $columns = array(); // I wish we had a shared memory cache for this :-(
72     /** @var array cache of table info */
73     protected $tables  = null;
75     // db connection options
76     /** @var string db host name */
77     protected $dbhost;
78     /** @var string db host user */
79     protected $dbuser;
80     /** @var string db host password */
81     protected $dbpass;
82     /** @var string db name */
83     protected $dbname;
84     /** @var string table prefix */
85     protected $prefix;
87     /** @var array Database or driver specific options, such as sockets or TCPIP db connections */
88     protected $dboptions;
90     /** @var bool true means non-moodle external database used.*/
91     protected $external;
93     /** @var int The database reads (performance counter).*/
94     protected $reads = 0;
95     /** @var int The database writes (performance counter).*/
96     protected $writes = 0;
98     /** @var int Debug level */
99     protected $debug  = 0;
101     /** @var string last query sql */
102     protected $last_sql;
103     /** @var array last query parameters */
104     protected $last_params;
105     /** @var int last query type */
106     protected $last_type;
107     /** @var string last extra info */
108     protected $last_extrainfo;
109     /** @var float last time in seconds with millisecond precision */
110     protected $last_time;
111     /** @var bool flag indicating logging of query in progress, prevents infinite loops */
112     private $loggingquery = false;
114     /** @var bool true if db used for db sessions */
115     protected $used_for_db_sessions = false;
117     /** @var array open transactions */
118     private $transactions = array();
119     /** @var bool force rollback of all current transactions */
120     private $force_rollback = false;
122     /** @var int internal temporary variable */
123     private $fix_sql_params_i;
125     /**
126      * Constructor - instantiates the database, specifying if it's external (connect to other systems) or no (Moodle DB)
127      *              note this has effect to decide if prefix checks must be performed or no
128      * @param bool true means external database used
129      */
130     public function __construct($external=false) {
131         $this->external  = $external;
132     }
134     /**
135      * Destructor - cleans up and flushes everything needed.
136      */
137     public function __destruct() {
138         $this->dispose();
139     }
141     /**
142      * Detects if all needed PHP stuff installed.
143      * Note: can be used before connect()
144      * @return mixed true if ok, string if something
145      */
146     public abstract function driver_installed();
148     /**
149      * Returns database table prefix
150      * Note: can be used before connect()
151      * @return string database table prefix
152      */
153     public function get_prefix() {
154         return $this->prefix;
155     }
157     /**
158      * Loads and returns a database instance with the specified type and library.
159      * @param string $type database type of the driver (mysql, postgres7, mssql, etc)
160      * @param string $library database library of the driver (adodb, pdo, native, etc)
161      * @return moodle_database driver object or null if error
162      */
163     public static function get_driver_instance($type, $library) {
164         global $CFG;
166         $classname = $type.'_'.$library.'_moodle_database';
167         $libfile   = "$CFG->libdir/dml/$classname.php";
169         if (!file_exists($libfile)) {
170             return null;
171         }
173         require_once($libfile);
174         return new $classname();
175     }
177     /**
178      * Returns database family type - describes SQL dialect
179      * Note: can be used before connect()
180      * @return string db family name (mysql, postgres, mssql, oracle, etc.)
181      */
182     public abstract function get_dbfamily();
184     /**
185      * Returns more specific database driver type
186      * Note: can be used before connect()
187      * @return string db type mysql, mysqli, postgres7
188      */
189     protected abstract function get_dbtype();
191     /**
192      * Returns general database library name
193      * Note: can be used before connect()
194      * @return string db type pdo, native
195      */
196     protected abstract function get_dblibrary();
198     /**
199      * Returns localised database type name
200      * Note: can be used before connect()
201      * @return string
202      */
203     public abstract function get_name();
205     /**
206      * Returns localised database configuration help.
207      * Note: can be used before connect()
208      * @return string
209      */
210     public abstract function get_configuration_help();
212     /**
213      * Returns localised database description
214      * Note: can be used before connect()
215      * @return string
216      */
217     public abstract function get_configuration_hints();
219     /**
220      * Returns db related part of config.php
221      * @return object
222      */
223     public function export_dbconfig() {
224         $cfg = new stdClass();
225         $cfg->dbtype    = $this->get_dbtype();
226         $cfg->dblibrary = $this->get_dblibrary();
227         $cfg->dbhost    = $this->dbhost;
228         $cfg->dbname    = $this->dbname;
229         $cfg->dbuser    = $this->dbuser;
230         $cfg->dbpass    = $this->dbpass;
231         $cfg->prefix    = $this->prefix;
232         if ($this->dboptions) {
233             $cfg->dboptions = $this->dboptions;
234         }
236         return $cfg;
237     }
239     /**
240      * Diagnose database and tables, this function is used
241      * to verify database and driver settings, db engine types, etc.
242      *
243      * @return string null means everything ok, string means problem found.
244      */
245     public function diagnose() {
246         return null;
247     }
249     /**
250      * Connect to db
251      * Must be called before other methods.
252      * @param string $dbhost
253      * @param string $dbuser
254      * @param string $dbpass
255      * @param string $dbname
256      * @param mixed $prefix string means moodle db prefix, false used for external databases where prefix not used
257      * @param array $dboptions driver specific options
258      * @return bool true
259      * @throws dml_connection_exception if error
260      */
261     public abstract function connect($dbhost, $dbuser, $dbpass, $dbname, $prefix, array $dboptions=null);
263     /**
264      * Store various database settings
265      * @param string $dbhost
266      * @param string $dbuser
267      * @param string $dbpass
268      * @param string $dbname
269      * @param mixed $prefix string means moodle db prefix, false used for external databases where prefix not used
270      * @param array $dboptions driver specific options
271      * @return void
272      */
273     protected function store_settings($dbhost, $dbuser, $dbpass, $dbname, $prefix, array $dboptions=null) {
274         $this->dbhost    = $dbhost;
275         $this->dbuser    = $dbuser;
276         $this->dbpass    = $dbpass;
277         $this->dbname    = $dbname;
278         $this->prefix    = $prefix;
279         $this->dboptions = (array)$dboptions;
280     }
282     /**
283      * Attempt to create the database
284      * @param string $dbhost
285      * @param string $dbuser
286      * @param string $dbpass
287      * @param string $dbname
288      *
289      * @return bool success
290      */
291     public function create_database($dbhost, $dbuser, $dbpass, $dbname, array $dboptions=null) {
292         return false;
293     }
295     /**
296      * Close database connection and release all resources
297      * and memory (especially circular memory references).
298      * Do NOT use connect() again, create a new instance if needed.
299      * @return void
300      */
301     public function dispose() {
302         if ($this->transactions) {
303             // this should not happen, it usually indicates wrong catching of exceptions,
304             // because all transactions should be finished manually or in default exception handler.
305             // unfortunately we can not access global $CFG any more and can not print debug,
306             // the diagnostic info should be printed in footer instead
307             $lowesttransaction = end($this->transactions);
308             $backtrace = $lowesttransaction->get_backtrace();
310             error_log('Potential coding error - active database transaction detected when disposing database:'."\n".format_backtrace($backtrace, true));
311             $this->force_transaction_rollback();
312         }
313         if ($this->used_for_db_sessions) {
314             // this is needed because we need to save session to db before closing it
315             session_get_instance()->write_close();
316             $this->used_for_db_sessions = false;
317         }
318         if ($this->temptables) {
319             $this->temptables->dispose();
320             $this->temptables = null;
321         }
322         if ($this->database_manager) {
323             $this->database_manager->dispose();
324             $this->database_manager = null;
325         }
326         $this->columns = array();
327         $this->tables  = null;
328     }
330     /**
331      * Called before each db query.
332      * @param string $sql
333      * @param array array of parameters
334      * @param int $type type of query
335      * @param mixed $extrainfo driver specific extra information
336      * @return void
337      */
338     protected function query_start($sql, array $params=null, $type, $extrainfo=null) {
339         if ($this->loggingquery) {
340             return;
341         }
342         $this->last_sql       = $sql;
343         $this->last_params    = $params;
344         $this->last_type      = $type;
345         $this->last_extrainfo = $extrainfo;
346         $this->last_time      = microtime(true);
348         switch ($type) {
349             case SQL_QUERY_SELECT:
350             case SQL_QUERY_AUX:
351                 $this->reads++;
352                 break;
353             case SQL_QUERY_INSERT:
354             case SQL_QUERY_UPDATE:
355             case SQL_QUERY_STRUCTURE:
356                 $this->writes++;
357         }
359         $this->print_debug($sql, $params);
360     }
362     /**
363      * Called immediately after each db query.
364      * @param mixed db specific result
365      * @return void
366      */
367     protected function query_end($result) {
368         if ($this->loggingquery) {
369             return;
370         }
371         if ($result !== false) {
372             $this->query_log();
373             // free memory
374             $this->last_sql    = null;
375             $this->last_params = null;
376             return;
377         }
379         // remember current info, log queries may alter it
380         $type   = $this->last_type;
381         $sql    = $this->last_sql;
382         $params = $this->last_params;
383         $time   = microtime(true) - $this->last_time;
384         $error  = $this->get_last_error();
386         $this->query_log($error);
388         switch ($type) {
389             case SQL_QUERY_SELECT:
390             case SQL_QUERY_AUX:
391                 throw new dml_read_exception($error, $sql, $params);
392             case SQL_QUERY_INSERT:
393             case SQL_QUERY_UPDATE:
394                 throw new dml_write_exception($error, $sql, $params);
395             case SQL_QUERY_STRUCTURE:
396                 $this->get_manager(); // includes ddl exceptions classes ;-)
397                 throw new ddl_change_structure_exception($error, $sql);
398         }
399     }
401     /**
402      * Log last database query if requested
403      * @param mixed string error or false if not error
404      * @return void
405      */
406     public function query_log($error=false) {
407         $logall    = !empty($this->dboptions['logall']);
408         $logslow   = !empty($this->dboptions['logslow']) ? $this->dboptions['logslow'] : false;
409         $logerrors = !empty($this->dboptions['logerrors']);
410         $iserror   = ($error !== false);
412         $time = microtime(true) - $this->last_time;
414         if ($logall or ($logslow and ($logslow < ($time+0.00001))) or ($iserror and $logerrors)) {
415             $this->loggingquery = true;
416             try {
417                 $backtrace = debug_backtrace();
418                 if ($backtrace) {
419                     //remove query_log()
420                     array_shift($backtrace);
421                 }
422                 if ($backtrace) {
423                     //remove query_end()
424                     array_shift($backtrace);
425                 }
426                 $log = new object();
427                 $log->qtype      = $this->last_type;
428                 $log->sqltext    = $this->last_sql;
429                 $log->sqlparams  = var_export((array)$this->last_params, true);
430                 $log->error      = (int)$iserror;
431                 $log->info       = $iserror ? $error : null;
432                 $log->backtrace  = format_backtrace($backtrace, true);
433                 $log->exectime   = $time;
434                 $log->timelogged = time();
435                 $this->insert_record('log_queries', $log);
436             } catch (Exception $ignored) {
437             }
438             $this->loggingquery = false;
439         }
440     }
442     /**
443      * Returns database server info array
444      * @return array
445      */
446     public abstract function get_server_info();
448     /**
449      * Returns supported query parameter types
450      * @return int bitmask
451      */
452     protected abstract function allowed_param_types();
454     /**
455      * Returns last error reported by database engine.
456      * @return string error message
457      */
458     public abstract function get_last_error();
460     /**
461      * Print sql debug info
462      * @param string $sql query which caused problems
463      * @param array $params optional query parameters
464      * @param mixed $obj optional library specific object
465      * @return void
466      */
467     protected function print_debug($sql, array $params=null, $obj=null) {
468         if (!$this->get_debug()) {
469             return;
470         }
471         if (CLI_SCRIPT) {
472             echo "--------------------------------\n";
473             echo $sql."\n";
474             if (!is_null($params)) {
475                 echo "[".var_export($params, true)."]\n";
476             }
477             echo "--------------------------------\n";
478         } else {
479             echo "<hr />\n";
480             echo s($sql)."\n";
481             if (!is_null($params)) {
482                 echo "[".s(var_export($params, true))."]\n";
483             }
484             echo "<hr />\n";
485         }
486     }
488     /**
489      * Returns SQL WHERE conditions.
490      *
491      * @param array conditions - must not contain numeric indexes
492      * @return array sql part and params
493      */
494     protected function where_clause(array $conditions=null) {
495         $allowed_types = $this->allowed_param_types();
496         if (empty($conditions)) {
497             return array('', array());
498         }
499         $where = array();
500         $params = array();
501         foreach ($conditions as $key=>$value) {
502             if (is_int($key)) {
503                 throw new dml_exception('invalidnumkey');
504             }
505             if (is_null($value)) {
506                 $where[] = "$key IS NULL";
507             } else {
508                 if ($allowed_types & SQL_PARAMS_NAMED) {
509                     $normkey = trim(preg_replace('/[^a-zA-Z0-9-_]/', '_', $key), '-_'); // Need to normalize key names
510                     $where[] = "$key = :$normkey";                                      // because they can contain, originally,
511                     $params[$normkey] = $value;                                         // spaces and other forbidden chars when
512                 } else {                                                                // using sql_xxx() functions and friends.
513                     $where[] = "$key = ?";
514                     $params[] = $value;
515                 }
516             }
517         }
518         $where = implode(" AND ", $where);
519         return array($where, $params);
520     }
522     /**
523      * Returns SQL WHERE conditions for the ..._list methods.
524      *
525      * @param string $field the name of a field.
526      * @param array $values the values field might take.
527      * @return array sql part and params
528      */
529     protected function where_clause_list($field, array $values) {
530         $params = array();
531         $select = array();
532         $values = (array)$values;
533         foreach ($values as $value) {
534             if (is_bool($value)) {
535                 $value = (int)$value;
536             }
537             if (is_null($value)) {
538                 $select[] = "$field IS NULL";
539             } else {
540                 $select[] = "$field = ?";
541                 $params[] = $value;
542             }
543         }
544         $select = implode(" OR ", $select);
545         return array($select, $params);
546     }
548     /**
549      * Constructs IN() or = sql fragment
550      * @param mixed $items single or array of values
551      * @param int $type bound param type SQL_PARAMS_QM or SQL_PARAMS_NAMED
552      * @param string named param placeholder start
553      * @param bool true means equal, false not equal
554      * @return array - $sql and $params
555      */
556     public function get_in_or_equal($items, $type=SQL_PARAMS_QM, $start='param0000', $equal=true) {
557         if (is_array($items) and empty($items)) {
558             throw new coding_exception('moodle_database::get_in_or_equal() does not accept empty arrays');
559         }
560         if ($type == SQL_PARAMS_QM) {
561             if (!is_array($items) or count($items) == 1) {
562                 $sql = $equal ? '= ?' : '<> ?';
563                 $items = (array)$items;
564                 $params = array_values($items);
565             } else {
566                 if ($equal) {
567                     $sql = 'IN ('.implode(',', array_fill(0, count($items), '?')).')';
568                 } else {
569                     $sql = 'NOT IN ('.implode(',', array_fill(0, count($items), '?')).')';
570                 }
571                 $params = array_values($items);
572             }
574         } else if ($type == SQL_PARAMS_NAMED) {
575             if (!is_array($items)){
576                 $sql = $equal ? "= :$start" : "<> :$start";
577                 $params = array($start=>$items);
578             } else if (count($items) == 1) {
579                 $sql = $equal ? "= :$start" : "<> :$start";
580                 $item = reset($items);
581                 $params = array($start=>$item);
582             } else {
583                 $params = array();
584                 $sql = array();
585                 foreach ($items as $item) {
586                     $params[$start] = $item;
587                     $sql[] = ':'.$start++;
588                 }
589                 if ($equal) {
590                     $sql = 'IN ('.implode(',', $sql).')';
591                 } else {
592                     $sql = 'NOT IN ('.implode(',', $sql).')';
593                 }
594             }
596         } else {
597             throw new dml_exception('typenotimplement');
598         }
599         return array($sql, $params);
600     }
602     /**
603      * Converts short table name {tablename} to real table name
604      * @param string sql
605      * @return string sql
606      */
607     protected function fix_table_names($sql) {
608         return preg_replace('/\{([a-z][a-z0-9_]*)\}/', $this->prefix.'$1', $sql);
609     }
611     /** Internal function */
612     private function _fix_sql_params_dollar_callback($match) {
613         $this->fix_sql_params_i++;
614         return "\$".$this->fix_sql_params_i;
615     }
617     /**
618      * Normalizes sql query parameters and verifies parameters.
619      * @param string $sql query or part of it
620      * @param array $params query parameters
621      * @return array (sql, params, type of params)
622      */
623     public function fix_sql_params($sql, array $params=null) {
624         $params = (array)$params; // mke null array if needed
625         $allowed_types = $this->allowed_param_types();
627         // convert table names
628         $sql = $this->fix_table_names($sql);
630         // NICOLAS C: Fixed regexp for negative backwards lookahead of double colons. Thanks for Sam Marshall's help
631         $named_count = preg_match_all('/(?<!:):[a-z][a-z0-9_]*/', $sql, $named_matches); // :: used in pgsql casts
632         $dollar_count = preg_match_all('/\$[1-9][0-9]*/', $sql, $dollar_matches);
633         $q_count     = substr_count($sql, '?');
635         $count = 0;
637         if ($named_count) {
638             $type = SQL_PARAMS_NAMED;
639             $count = $named_count;
641         }
642         if ($dollar_count) {
643             if ($count) {
644                 throw new dml_exception('mixedtypesqlparam');
645             }
646             $type = SQL_PARAMS_DOLLAR;
647             $count = $dollar_count;
649         }
650         if ($q_count) {
651             if ($count) {
652                 throw new dml_exception('mixedtypesqlparam');
653             }
654             $type = SQL_PARAMS_QM;
655             $count = $q_count;
657         }
659         if (!$count) {
660              // ignore params
661             if ($allowed_types & SQL_PARAMS_NAMED) {
662                 return array($sql, array(), SQL_PARAMS_NAMED);
663             } else if ($allowed_types & SQL_PARAMS_QM) {
664                 return array($sql, array(), SQL_PARAMS_QM);
665             } else {
666                 return array($sql, array(), SQL_PARAMS_DOLLAR);
667             }
668         }
670         if ($count > count($params)) {
671             $a = new stdClass;
672             $a->expected = $count;
673             $a->actual = count($params);
674             throw new dml_exception('invalidqueryparam', $a);
675         }
677         $target_type = $allowed_types;
679         if ($type & $allowed_types) { // bitwise AND
680             if ($count == count($params)) {
681                 if ($type == SQL_PARAMS_QM) {
682                     return array($sql, array_values($params), SQL_PARAMS_QM); // 0-based array required
683                 } else {
684                     //better do the validation of names below
685                 }
686             }
687             // needs some fixing or validation - there might be more params than needed
688             $target_type = $type;
689         }
691         if ($type == SQL_PARAMS_NAMED) {
692             $finalparams = array();
693             foreach ($named_matches[0] as $key) {
694                 $key = trim($key, ':');
695                 if (!array_key_exists($key, $params)) {
696                     throw new dml_exception('missingkeyinsql', $key, '');
697                 }
698                 $finalparams[$key] = $params[$key];
699             }
700             if ($count != count($finalparams)) {
701                 throw new dml_exception('duplicateparaminsql');
702             }
704             if ($target_type & SQL_PARAMS_QM) {
705                 $sql = preg_replace('/(?<!:):[a-z][a-z0-9_]*/', '?', $sql);
706                 return array($sql, array_values($finalparams), SQL_PARAMS_QM); // 0-based required
707             } else if ($target_type & SQL_PARAMS_NAMED) {
708                 return array($sql, $finalparams, SQL_PARAMS_NAMED);
709             } else {  // $type & SQL_PARAMS_DOLLAR
710                 //lambda-style functions eat memory - we use globals instead :-(
711                 $this->fix_sql_params_i = 0;
712                 $sql = preg_replace_callback('/(?<!:):[a-z][a-z0-9_]*/', array($this, '_fix_sql_params_dollar_callback'), $sql);
713                 return array($sql, array_values($finalparams), SQL_PARAMS_DOLLAR); // 0-based required
714             }
716         } else if ($type == SQL_PARAMS_DOLLAR) {
717             if ($target_type & SQL_PARAMS_DOLLAR) {
718                 return array($sql, array_values($params), SQL_PARAMS_DOLLAR); // 0-based required
719             } else if ($target_type & SQL_PARAMS_QM) {
720                 $sql = preg_replace('/\$[0-9]+/', '?', $sql);
721                 return array($sql, array_values($params), SQL_PARAMS_QM); // 0-based required
722             } else { //$target_type & SQL_PARAMS_NAMED
723                 $sql = preg_replace('/\$([0-9]+)/', ':param\\1', $sql);
724                 $finalparams = array();
725                 foreach ($params as $key=>$param) {
726                     $key++;
727                     $finalparams['param'.$key] = $param;
728                 }
729                 return array($sql, $finalparams, SQL_PARAMS_NAMED);
730             }
732         } else { // $type == SQL_PARAMS_QM
733             if (count($params) != $count) {
734                 $params = array_slice($params, 0, $count);
735             }
737             if ($target_type & SQL_PARAMS_QM) {
738                 return array($sql, array_values($params), SQL_PARAMS_QM); // 0-based required
739             } else if ($target_type & SQL_PARAMS_NAMED) {
740                 $finalparams = array();
741                 $pname = 'param0';
742                 $parts = explode('?', $sql);
743                 $sql = array_shift($parts);
744                 foreach ($parts as $part) {
745                     $param = array_shift($params);
746                     $pname++;
747                     $sql .= ':'.$pname.$part;
748                     $finalparams[$pname] = $param;
749                 }
750                 return array($sql, $finalparams, SQL_PARAMS_NAMED);
751             } else {  // $type & SQL_PARAMS_DOLLAR
752                 //lambda-style functions eat memory - we use globals instead :-(
753                 $this->fix_sql_params_i = 0;
754                 $sql = preg_replace_callback('/\?/', array($this, '_fix_sql_params_dollar_callback'), $sql);
755                 return array($sql, array_values($params), SQL_PARAMS_DOLLAR); // 0-based required
756             }
757         }
758     }
760     /**
761      * Return tables in database WITHOUT current prefix
762      * @return array of table names in lowercase and without prefix
763      */
764     public abstract function get_tables($usecache=true);
766     /**
767      * Return table indexes - everything lowercased
768      * @return array of arrays
769      */
770     public abstract function get_indexes($table);
772     /**
773      * Returns datailed information about columns in table. This information is cached internally.
774      * @param string $table name
775      * @param bool $usecache
776      * @return array array of database_column_info objects indexed with column names
777      */
778     public abstract function get_columns($table, $usecache=true);
780     /**
781      * Normalise values based in RDBMS dependencies (booleans, LOBs...)
782      *
783      * @param database_column_info $column column metadata corresponding with the value we are going to normalise
784      * @param mixed $value value we are going to normalise
785      * @return mixed the normalised value
786      */
787     protected abstract function normalise_value($column, $value);
789     /**
790      * Reset internal column details cache
791      * @param string $table - empty means all, or one if name of table given
792      * @return void
793      */
794     public function reset_caches() {
795         $this->columns = array();
796         $this->tables  = null;
797     }
799     /**
800      * Returns sql generator used for db manipulation.
801      * Used mostly in upgrade.php scripts.
802      * @return object database_manager instance
803      */
804     public function get_manager() {
805         global $CFG;
807         if (!$this->database_manager) {
808             require_once($CFG->libdir.'/ddllib.php');
810             $classname = $this->get_dbfamily().'_sql_generator';
811             require_once("$CFG->libdir/ddl/$classname.php");
812             $generator = new $classname($this, $this->temptables);
814             $this->database_manager = new database_manager($this, $generator);
815         }
816         return $this->database_manager;
817     }
819     /**
820      * Attempt to change db encoding toUTF-8 if possible
821      * @return bool success
822      */
823     public function change_db_encoding() {
824         return false;
825     }
827     /**
828      * Is db in unicode mode?
829      * @return bool
830      */
831     public function setup_is_unicodedb() {
832         return true;
833     }
835     /**
836      * Enable/disable very detailed debugging
837      * @param bool $state
838      */
839     public function set_debug($state) {
840         $this->debug = $state;
841     }
843     /**
844      * Returns debug status
845      * @return bool $state
846      */
847     public function get_debug() {
848         return $this->debug;
849     }
851     /**
852      * Enable/disable detailed sql logging
853      * @param bool $state
854      */
855     public function set_logging($state) {
856         // adodb sql logging shares one table without prefix per db - this is no longer acceptable :-(
857         // we must create one table shared by all drivers
858     }
860     /**
861      * Do NOT use in code, to be used by database_manager only!
862      * @param string $sql query
863      * @return bool true
864      * @throws dml_exception if error
865      */
866     public abstract function change_database_structure($sql);
868     /**
869      * Execute general sql query. Should be used only when no other method suitable.
870      * Do NOT use this to make changes in db structure, use database_manager::execute_sql() instead!
871      * @param string $sql query
872      * @param array $params query parameters
873      * @return bool true
874      * @throws dml_exception if error
875      */
876     public abstract function execute($sql, array $params=null);
878     /**
879      * Get a number of records as a moodle_recordset where all the given conditions met.
880      *
881      * Selects records from the table $table.
882      *
883      * If specified, only records meeting $conditions.
884      *
885      * If specified, the results will be sorted as specified by $sort. This
886      * is added to the SQL as "ORDER BY $sort". Example values of $sort
887      * might be "time ASC" or "time DESC".
888      *
889      * If $fields is specified, only those fields are returned.
890      *
891      * Since this method is a little less readable, use of it should be restricted to
892      * code where it's possible there might be large datasets being returned.  For known
893      * small datasets use get_records - it leads to simpler code.
894      *
895      * If you only want some of the records, specify $limitfrom and $limitnum.
896      * The query will skip the first $limitfrom records (according to the sort
897      * order) and then return the next $limitnum records. If either of $limitfrom
898      * or $limitnum is specified, both must be present.
899      *
900      * The return value is a moodle_recordset
901      * if the query succeeds. If an error occurs, false is returned.
902      *
903      * @param string $table the table to query.
904      * @param array $conditions optional array $fieldname=>requestedvalue with AND in between
905      * @param string $sort an order to sort the results in (optional, a valid SQL ORDER BY parameter).
906      * @param string $fields a comma separated list of fields to return (optional, by default all fields are returned).
907      * @param int $limitfrom return a subset of records, starting at this point (optional, required if $limitnum is set).
908      * @param int $limitnum return a subset comprising this many records (optional, required if $limitfrom is set).
909      * @return moodle_recordset instance
910      * @throws dml_exception if error
911      */
912     public function get_recordset($table, array $conditions=null, $sort='', $fields='*', $limitfrom=0, $limitnum=0) {
913         list($select, $params) = $this->where_clause($conditions);
914         return $this->get_recordset_select($table, $select, $params, $sort, $fields, $limitfrom, $limitnum);
915     }
917     /**
918      * Get a number of records as a moodle_recordset where one field match one list of values.
919      *
920      * Only records where $field takes one of the values $values are returned.
921      * $values must be an array of values.
922      *
923      * Other arguments and the return type as for @see function get_recordset.
924      *
925      * @param string $table the table to query.
926      * @param string $field a field to check (optional).
927      * @param array $values array of values the field must have
928      * @param string $sort an order to sort the results in (optional, a valid SQL ORDER BY parameter).
929      * @param string $fields a comma separated list of fields to return (optional, by default all fields are returned).
930      * @param int $limitfrom return a subset of records, starting at this point (optional, required if $limitnum is set).
931      * @param int $limitnum return a subset comprising this many records (optional, required if $limitfrom is set).
932      * @return moodle_recordset instance
933      * @throws dml_exception if error
934      */
935     public function get_recordset_list($table, $field, array $values, $sort='', $fields='*', $limitfrom=0, $limitnum=0) {
936         list($select, $params) = $this->where_clause_list($field, $values);
937         if (empty($select)) {
938             $select = '? = ?'; /// Fake condition, won't return rows ever. MDL-17645
939             $params = array(1, 2);
940         }
941         return $this->get_recordset_select($table, $select, $params, $sort, $fields, $limitfrom, $limitnum);
942     }
944     /**
945      * Get a number of records as a moodle_recordset which match a particular WHERE clause.
946      *
947      * If given, $select is used as the SELECT parameter in the SQL query,
948      * otherwise all records from the table are returned.
949      *
950      * Other arguments and the return type as for @see function get_recordset.
951      *
952      * @param string $table the table to query.
953      * @param string $select A fragment of SQL to be used in a where clause in the SQL call.
954      * @param array $params array of sql parameters
955      * @param string $sort an order to sort the results in (optional, a valid SQL ORDER BY parameter).
956      * @param string $fields a comma separated list of fields to return (optional, by default all fields are returned).
957      * @param int $limitfrom return a subset of records, starting at this point (optional, required if $limitnum is set).
958      * @param int $limitnum return a subset comprising this many records (optional, required if $limitfrom is set).
959      * @return moodle_recordset instance
960      * @throws dml_exception if error
961      */
962     public function get_recordset_select($table, $select, array $params=null, $sort='', $fields='*', $limitfrom=0, $limitnum=0) {
963         $sql = "SELECT $fields FROM {".$table."}";
964         if ($select) {
965             $sql .= " WHERE $select";
966         }
967         if ($sort) {
968             $sql .= " ORDER BY $sort";
969         }
970         return $this->get_recordset_sql($sql, $params, $limitfrom, $limitnum);
971     }
973     /**
974      * Get a number of records as a moodle_recordset using a SQL statement.
975      *
976      * Since this method is a little less readable, use of it should be restricted to
977      * code where it's possible there might be large datasets being returned.  For known
978      * small datasets use get_records_sql - it leads to simpler code.
979      *
980      * The return type is as for @see function get_recordset.
981      *
982      * @param string $sql the SQL select query to execute.
983      * @param array $params array of sql parameters
984      * @param int $limitfrom return a subset of records, starting at this point (optional, required if $limitnum is set).
985      * @param int $limitnum return a subset comprising this many records (optional, required if $limitfrom is set).
986      * @return moodle_recordset instance
987      * @throws dml_exception if error
988      */
989     public abstract function get_recordset_sql($sql, array $params=null, $limitfrom=0, $limitnum=0);
991     /**
992      * Get a number of records as an array of objects where all the given conditions met.
993      *
994      * If the query succeeds and returns at least one record, the
995      * return value is an array of objects, one object for each
996      * record found. The array key is the value from the first
997      * column of the result set. The object associated with that key
998      * has a member variable for each column of the results.
999      *
1000      * @param string $table the table to query.
1001      * @param array $conditions optional array $fieldname=>requestedvalue with AND in between
1002      * @param string $sort an order to sort the results in (optional, a valid SQL ORDER BY parameter).
1003      * @param string $fields a comma separated list of fields to return (optional, by default
1004      *   all fields are returned). The first field will be used as key for the
1005      *   array so must be a unique field such as 'id'.
1006      * @param int $limitfrom return a subset of records, starting at this point (optional, required if $limitnum is set).
1007      * @param int $limitnum return a subset comprising this many records (optional, required if $limitfrom is set).
1008      * @return array of objects indexed by first column
1009      * @throws dml_exception if error
1010      */
1011     public function get_records($table, array $conditions=null, $sort='', $fields='*', $limitfrom=0, $limitnum=0) {
1012         list($select, $params) = $this->where_clause($conditions);
1013         return $this->get_records_select($table, $select, $params, $sort, $fields, $limitfrom, $limitnum);
1014     }
1016     /**
1017      * Get a number of records as an array of objects where one field match one list of values.
1018      *
1019      * Return value as for @see function get_records.
1020      *
1021      * @param string $table The database table to be checked against.
1022      * @param string $field The field to search
1023      * @param string $values array of values
1024      * @param string $sort Sort order (as valid SQL sort parameter)
1025      * @param string $fields A comma separated list of fields to be returned from the chosen table. If specified,
1026      *   the first field should be a unique one such as 'id' since it will be used as a key in the associative
1027      *   array.
1028      * @return array of objects indexed by first column
1029      * @throws dml_exception if error
1030      */
1031     public function get_records_list($table, $field, array $values, $sort='', $fields='*', $limitfrom=0, $limitnum=0) {
1032         list($select, $params) = $this->where_clause_list($field, $values);
1033         if (empty($select)) {
1034             // nothing to return
1035             return array();
1036         }
1037         return $this->get_records_select($table, $select, $params, $sort, $fields, $limitfrom, $limitnum);
1038     }
1040     /**
1041      * Get a number of records as an array of objects which match a particular WHERE clause.
1042      *
1043      * Return value as for @see function get_records.
1044      *
1045      * @param string $table the table to query.
1046      * @param string $select A fragment of SQL to be used in a where clause in the SQL call.
1047      * @param array $params array of sql parameters
1048      * @param string $sort an order to sort the results in (optional, a valid SQL ORDER BY parameter).
1049      * @param string $fields a comma separated list of fields to return
1050      *   (optional, by default all fields are returned). The first field will be used as key for the
1051      *   array so must be a unique field such as 'id'.
1052      * @param int $limitfrom return a subset of records, starting at this point (optional, required if $limitnum is set).
1053      * @param int $limitnum return a subset comprising this many records (optional, required if $limitfrom is set).
1054      * @return array of objects indexed by first column
1055      * @throws dml_exception if error
1056      */
1057     public function get_records_select($table, $select, array $params=null, $sort='', $fields='*', $limitfrom=0, $limitnum=0) {
1058         if ($select) {
1059             $select = "WHERE $select";
1060         }
1061         if ($sort) {
1062             $sort = " ORDER BY $sort";
1063         }
1064         return $this->get_records_sql("SELECT $fields FROM {" . $table . "} $select $sort", $params, $limitfrom, $limitnum);
1065     }
1067     /**
1068      * Get a number of records as an array of objects using a SQL statement.
1069      *
1070      * Return value as for @see function get_records.
1071      *
1072      * @param string $sql the SQL select query to execute. The first column of this SELECT statement
1073      *   must be a unique value (usually the 'id' field), as it will be used as the key of the
1074      *   returned array.
1075      * @param array $params array of sql parameters
1076      * @param int $limitfrom return a subset of records, starting at this point (optional, required if $limitnum is set).
1077      * @param int $limitnum return a subset comprising this many records (optional, required if $limitfrom is set).
1078      * @return array of objects indexed by first column
1079      * @throws dml_exception if error
1080      */
1081     public abstract function get_records_sql($sql, array $params=null, $limitfrom=0, $limitnum=0);
1083     /**
1084      * Get the first two columns from a number of records as an associative array where all the given conditions met.
1085      *
1086      * Arguments as for @see function get_recordset.
1087      *
1088      * If no errors occur the return value
1089      * is an associative whose keys come from the first field of each record,
1090      * and whose values are the corresponding second fields.
1091      * False is returned if an error occurs.
1092      *
1093      * @param string $table the table to query.
1094      * @param array $conditions optional array $fieldname=>requestedvalue with AND in between
1095      * @param string $sort an order to sort the results in (optional, a valid SQL ORDER BY parameter).
1096      * @param string $fields a comma separated list of fields to return - the number of fields should be 2!
1097      * @param int $limitfrom return a subset of records, starting at this point (optional, required if $limitnum is set).
1098      * @param int $limitnum return a subset comprising this many records (optional, required if $limitfrom is set).
1099      * @return array an associative array
1100      * @throws dml_exception if error
1101      */
1102     public function get_records_menu($table, array $conditions=null, $sort='', $fields='*', $limitfrom=0, $limitnum=0) {
1103         $menu = array();
1104         if ($records = $this->get_records($table, $conditions, $sort, $fields, $limitfrom, $limitnum)) {
1105             foreach ($records as $record) {
1106                 $record = (array)$record;
1107                 $key   = array_shift($record);
1108                 $value = array_shift($record);
1109                 $menu[$key] = $value;
1110             }
1111         }
1112         return $menu;
1113     }
1115     /**
1116      * Get the first two columns from a number of records as an associative array which match a particular WHERE clause.
1117      *
1118      * Arguments as for @see function get_recordset_select.
1119      * Return value as for @see function get_records_menu.
1120      *
1121      * @param string $table The database table to be checked against.
1122      * @param string $select A fragment of SQL to be used in a where clause in the SQL call.
1123      * @param array $params array of sql parameters
1124      * @param string $sort Sort order (optional) - a valid SQL order parameter
1125      * @param string $fields A comma separated list of fields to be returned from the chosen table - the number of fields should be 2!
1126      * @param int $limitfrom return a subset of records, starting at this point (optional, required if $limitnum is set).
1127      * @param int $limitnum return a subset comprising this many records (optional, required if $limitfrom is set).
1128      * @return array an associative array
1129      * @throws dml_exception if error
1130      */
1131     public function get_records_select_menu($table, $select, array $params=null, $sort='', $fields='*', $limitfrom=0, $limitnum=0) {
1132         $menu = array();
1133         if ($records = $this->get_records_select($table, $select, $params, $sort, $fields, $limitfrom, $limitnum)) {
1134             foreach ($records as $record) {
1135                 $record = (array)$record;
1136                 $key   = array_shift($record);
1137                 $value = array_shift($record);
1138                 $menu[$key] = $value;
1139             }
1140         }
1141         return $menu;
1142     }
1144     /**
1145      * Get the first two columns from a number of records as an associative array using a SQL statement.
1146      *
1147      * Arguments as for @see function get_recordset_sql.
1148      * Return value as for @see function get_records_menu.
1149      *
1150      * @param string $sql The SQL string you wish to be executed.
1151      * @param array $params array of sql parameters
1152      * @param int $limitfrom return a subset of records, starting at this point (optional, required if $limitnum is set).
1153      * @param int $limitnum return a subset comprising this many records (optional, required if $limitfrom is set).
1154      * @return array an associative array
1155      * @throws dml_exception if error
1156      */
1157     public function get_records_sql_menu($sql, array $params=null, $limitfrom=0, $limitnum=0) {
1158         $menu = array();
1159         if ($records = $this->get_records_sql($sql, $params, $limitfrom, $limitnum)) {
1160             foreach ($records as $record) {
1161                 $record = (array)$record;
1162                 $key   = array_shift($record);
1163                 $value = array_shift($record);
1164                 $menu[$key] = $value;
1165             }
1166         }
1167         return $menu;
1168     }
1170     /**
1171      * Get a single database record as an object where all the given conditions met.
1172      *
1173      * @param string $table The table to select from.
1174      * @param array $conditions optional array $fieldname=>requestedvalue with AND in between
1175      * @param string $fields A comma separated list of fields to be returned from the chosen table.
1176      * @param int $strictness IGNORE_MISSING means compatible mode, false returned if record not found, debug message if more found;
1177      *                        IGNORE_MULTIPLE means return first, ignore multiple records found(not recommended);
1178      *                        MUST_EXIST means throw exception if no record or multiple records found
1179      * @return mixed a fieldset object containing the first matching record, false or exception if error not found depending on mode
1180      * @throws dml_exception if error
1181      */
1182     public function get_record($table, array $conditions, $fields='*', $strictness=IGNORE_MISSING) {
1183         list($select, $params) = $this->where_clause($conditions);
1184         return $this->get_record_select($table, $select, $params, $fields, $strictness);
1185     }
1187     /**
1188      * Get a single database record as an object which match a particular WHERE clause.
1189      *
1190      * @param string $table The database table to be checked against.
1191      * @param string $select A fragment of SQL to be used in a where clause in the SQL call.
1192      * @param array $params array of sql parameters
1193      * @param int $strictness IGNORE_MISSING means compatible mode, false returned if record not found, debug message if more found;
1194      *                        IGNORE_MULTIPLE means return first, ignore multiple records found(not recommended);
1195      *                        MUST_EXIST means throw exception if no record or multiple records found
1196      * @return mixed a fieldset object containing the first matching record, false or exception if error not found depending on mode
1197      * @throws dml_exception if error
1198      */
1199     public function get_record_select($table, $select, array $params=null, $fields='*', $strictness=IGNORE_MISSING) {
1200         if ($select) {
1201             $select = "WHERE $select";
1202         }
1203         try {
1204             return $this->get_record_sql("SELECT $fields FROM {" . $table . "} $select", $params, $strictness);
1205         } catch (dml_missing_record_exception $e) {
1206             // create new exception which will contain correct table name
1207             throw new dml_missing_record_exception($table, $e->sql, $e->params);
1208         }
1209     }
1211     /**
1212      * Get a single database record as an object using a SQL statement.
1213      *
1214      * The SQL statement should normally only return one record.
1215      * It is recommended to use get_records_sql() if more matches possible!
1216      *
1217      * @param string $sql The SQL string you wish to be executed, should normally only return one record.
1218      * @param array $params array of sql parameters
1219      * @param int $strictness IGNORE_MISSING means compatible mode, false returned if record not found, debug message if more found;
1220      *                        IGNORE_MULTIPLE means return first, ignore multiple records found(not recommended);
1221      *                        MUST_EXIST means throw exception if no record or multiple records found
1222      * @return mixed a fieldset object containing the first matching record, false or exception if error not found depending on mode
1223      * @throws dml_exception if error
1224      */
1225     public function get_record_sql($sql, array $params=null, $strictness=IGNORE_MISSING) {
1226         $strictness = (int)$strictness; // we support true/false for BC reasons too
1227         if ($strictness == IGNORE_MULTIPLE) {
1228             $count = 1;
1229         } else {
1230             $count = 0;
1231         }
1232         if (!$records = $this->get_records_sql($sql, $params, 0, $count)) {
1233             // not found
1234             if ($strictness == MUST_EXIST) {
1235                 throw new dml_missing_record_exception('', $sql, $params);
1236             }
1237             return false;
1238         }
1240         if (count($records) > 1) {
1241             if ($strictness == MUST_EXIST) {
1242                 throw new dml_multiple_records_exception($sql, $params);
1243             }
1244             debugging('Error: mdb->get_record() found more than one record!');
1245         }
1247         $return = reset($records);
1248         return $return;
1249     }
1251     /**
1252      * Get a single field value from a table record where all the given conditions met.
1253      *
1254      * @param string $table the table to query.
1255      * @param string $return the field to return the value of.
1256      * @param array $conditions optional array $fieldname=>requestedvalue with AND in between
1257      * @param int $strictness IGNORE_MISSING means compatible mode, false returned if record not found, debug message if more found;
1258      *                        IGNORE_MULTIPLE means return first, ignore multiple records found(not recommended);
1259      *                        MUST_EXIST means throw exception if no record or multiple records found
1260      * @return mixed the specified value false if not found
1261      * @throws dml_exception if error
1262      */
1263     public function get_field($table, $return, array $conditions, $strictness=IGNORE_MISSING) {
1264         list($select, $params) = $this->where_clause($conditions);
1265         return $this->get_field_select($table, $return, $select, $params, $strictness);
1266     }
1268     /**
1269      * Get a single field value from a table record which match a particular WHERE clause.
1270      *
1271      * @param string $table the table to query.
1272      * @param string $return the field to return the value of.
1273      * @param string $select A fragment of SQL to be used in a where clause returning one row with one column
1274      * @param array $params array of sql parameters
1275      * @param int $strictness IGNORE_MISSING means compatible mode, false returned if record not found, debug message if more found;
1276      *                        IGNORE_MULTIPLE means return first, ignore multiple records found(not recommended);
1277      *                        MUST_EXIST means throw exception if no record or multiple records found
1278      * @return mixed the specified value false if not found
1279      * @throws dml_exception if error
1280      */
1281     public function get_field_select($table, $return, $select, array $params=null, $strictness=IGNORE_MISSING) {
1282         if ($select) {
1283             $select = "WHERE $select";
1284         }
1285         try {
1286             return $this->get_field_sql("SELECT $return FROM {" . $table . "} $select", $params, $strictness);
1287         } catch (dml_missing_record_exception $e) {
1288             // create new exception which will contain correct table name
1289             throw new dml_missing_record_exception($table, $e->sql, $e->params);
1290         }
1291     }
1293     /**
1294      * Get a single field value (first field) using a SQL statement.
1295      *
1296      * @param string $table the table to query.
1297      * @param string $return the field to return the value of.
1298      * @param string $sql The SQL query returning one row with one column
1299      * @param array $params array of sql parameters
1300      * @param int $strictness IGNORE_MISSING means compatible mode, false returned if record not found, debug message if more found;
1301      *                        IGNORE_MULTIPLE means return first, ignore multiple records found(not recommended);
1302      *                        MUST_EXIST means throw exception if no record or multiple records found
1303      * @return mixed the specified value false if not found
1304      * @throws dml_exception if error
1305      */
1306     public function get_field_sql($sql, array $params=null, $strictness=IGNORE_MISSING) {
1307         if (!$record = $this->get_record_sql($sql, $params, $strictness)) {
1308             return false;
1309         }
1311         $record = (array)$record;
1312         return reset($record); // first column
1313     }
1315     /**
1316      * Selects records and return values of chosen field as an array which match a particular WHERE clause.
1317      *
1318      * @param string $table the table to query.
1319      * @param string $return the field we are intered in
1320      * @param string $select A fragment of SQL to be used in a where clause in the SQL call.
1321      * @param array $params array of sql parameters
1322      * @return array of values
1323      * @throws dml_exception if error
1324      */
1325     public function get_fieldset_select($table, $return, $select, array $params=null) {
1326         if ($select) {
1327             $select = "WHERE $select";
1328         }
1329         return $this->get_fieldset_sql("SELECT $return FROM {" . $table . "} $select", $params);
1330     }
1332     /**
1333      * Selects records and return values (first field) as an array using a SQL statement.
1334      *
1335      * @param string $sql The SQL query
1336      * @param array $params array of sql parameters
1337      * @return array of values
1338      * @throws dml_exception if error
1339      */
1340     public abstract function get_fieldset_sql($sql, array $params=null);
1342     /**
1343      * Insert new record into database, as fast as possible, no safety checks, lobs not supported.
1344      * @param string $table name
1345      * @param mixed $params data record as object or array
1346      * @param bool $returnit return it of inserted record
1347      * @param bool $bulk true means repeated inserts expected
1348      * @param bool $customsequence true if 'id' included in $params, disables $returnid
1349      * @return bool|int true or new id
1350      * @throws dml_exception if error
1351      */
1352     public abstract function insert_record_raw($table, $params, $returnid=true, $bulk=false, $customsequence=false);
1354     /**
1355      * Insert a record into a table and return the "id" field if required.
1356      *
1357      * Some conversions and safety checks are carried out. Lobs are supported.
1358      * If the return ID isn't required, then this just reports success as true/false.
1359      * $data is an object containing needed data
1360      * @param string $table The database table to be inserted into
1361      * @param object $data A data object with values for one or more fields in the record
1362      * @param bool $returnid Should the id of the newly created record entry be returned? If this option is not requested then true/false is returned.
1363      * @return bool|int true or new id
1364      * @throws dml_exception if error
1365      */
1366     public abstract function insert_record($table, $dataobject, $returnid=true, $bulk=false);
1368     /**
1369      * Import a record into a table, id field is required.
1370      * Safety checks are NOT carried out. Lobs are supported.
1371      *
1372      * @param string $table name of database table to be inserted into
1373      * @param object $dataobject A data object with values for one or more fields in the record
1374      * @return bool true
1375      * @throws dml_exception if error
1376      */
1377     public abstract function import_record($table, $dataobject);
1379     /**
1380      * Update record in database, as fast as possible, no safety checks, lobs not supported.
1381      * @param string $table name
1382      * @param mixed $params data record as object or array
1383      * @param bool true means repeated updates expected
1384      * @return bool true
1385      * @throws dml_exception if error
1386      */
1387     public abstract function update_record_raw($table, $params, $bulk=false);
1389     /**
1390      * Update a record in a table
1391      *
1392      * $dataobject is an object containing needed data
1393      * Relies on $dataobject having a variable "id" to
1394      * specify the record to update
1395      *
1396      * @param string $table The database table to be checked against.
1397      * @param object $dataobject An object with contents equal to fieldname=>fieldvalue. Must have an entry for 'id' to map to the table specified.
1398      * @param bool true means repeated updates expected
1399      * @return bool true
1400      * @throws dml_exception if error
1401      */
1402     public abstract function update_record($table, $dataobject, $bulk=false);
1405     /**
1406      * Set a single field in every table record where all the given conditions met.
1407      *
1408      * @param string $table The database table to be checked against.
1409      * @param string $newfield the field to set.
1410      * @param string $newvalue the value to set the field to.
1411      * @param array $conditions optional array $fieldname=>requestedvalue with AND in between
1412      * @return bool true
1413      * @throws dml_exception if error
1414      */
1415     public function set_field($table, $newfield, $newvalue, array $conditions=null) {
1416         list($select, $params) = $this->where_clause($conditions);
1417         return $this->set_field_select($table, $newfield, $newvalue, $select, $params);
1418     }
1420     /**
1421      * Set a single field in every table record which match a particular WHERE clause.
1422      *
1423      * @param string $table The database table to be checked against.
1424      * @param string $newfield the field to set.
1425      * @param string $newvalue the value to set the field to.
1426      * @param string $select A fragment of SQL to be used in a where clause in the SQL call.
1427      * @param array $params array of sql parameters
1428      * @return bool true
1429      * @throws dml_exception if error
1430      */
1431     public abstract function set_field_select($table, $newfield, $newvalue, $select, array $params=null);
1434     /**
1435      * Count the records in a table where all the given conditions met.
1436      *
1437      * @param string $table The table to query.
1438      * @param array $conditions optional array $fieldname=>requestedvalue with AND in between
1439      * @return int The count of records returned from the specified criteria.
1440      * @throws dml_exception if error
1441      */
1442     public function count_records($table, array $conditions=null) {
1443         list($select, $params) = $this->where_clause($conditions);
1444         return $this->count_records_select($table, $select, $params);
1445     }
1447     /**
1448      * Count the records in a table which match a particular WHERE clause.
1449      *
1450      * @param string $table The database table to be checked against.
1451      * @param string $select A fragment of SQL to be used in a WHERE clause in the SQL call.
1452      * @param array $params array of sql parameters
1453      * @param string $countitem The count string to be used in the SQL call. Default is COUNT('x').
1454      * @return int The count of records returned from the specified criteria.
1455      * @throws dml_exception if error
1456      */
1457     public function count_records_select($table, $select, array $params=null, $countitem="COUNT('x')") {
1458         if ($select) {
1459             $select = "WHERE $select";
1460         }
1461         return $this->count_records_sql("SELECT $countitem FROM {" . $table . "} $select", $params);
1462     }
1464     /**
1465      * Get the result of a SQL SELECT COUNT(...) query.
1466      *
1467      * Given a query that counts rows, return that count. (In fact,
1468      * given any query, return the first field of the first record
1469      * returned. However, this method should only be used for the
1470      * intended purpose.) If an error occurs, 0 is returned.
1471      *
1472      * @param string $sql The SQL string you wish to be executed.
1473      * @param array $params array of sql parameters
1474      * @return int the count
1475      * @throws dml_exception if error
1476      */
1477     public function count_records_sql($sql, array $params=null) {
1478         if ($count = $this->get_field_sql($sql, $params)) {
1479             return $count;
1480         } else {
1481             return 0;
1482         }
1483     }
1485     /**
1486      * Test whether a record exists in a table where all the given conditions met.
1487      *
1488      * The record to test is specified by giving up to three fields that must
1489      * equal the corresponding values.
1490      *
1491      * @param string $table The table to check.
1492      * @param array $conditions optional array $fieldname=>requestedvalue with AND in between
1493      * @return bool true if a matching record exists, else false.
1494      * @throws dml_exception if error
1495      */
1496     public function record_exists($table, array $conditions) {
1497         list($select, $params) = $this->where_clause($conditions);
1498         return $this->record_exists_select($table, $select, $params);
1499     }
1501     /**
1502      * Test whether any records exists in a table which match a particular WHERE clause.
1503      *
1504      * @param string $table The database table to be checked against.
1505      * @param string $select A fragment of SQL to be used in a WHERE clause in the SQL call.
1506      * @param array $params array of sql parameters
1507      * @return bool true if a matching record exists, else false.
1508      * @throws dml_exception if error
1509      */
1510     public function record_exists_select($table, $select, array $params=null) {
1511         if ($select) {
1512             $select = "WHERE $select";
1513         }
1514         return $this->record_exists_sql("SELECT 'x' FROM {" . $table . "} $select", $params);
1515     }
1517     /**
1518      * Test whether a SQL SELECT statement returns any records.
1519      *
1520      * This function returns true if the SQL statement executes
1521      * without any errors and returns at least one record.
1522      *
1523      * @param string $sql The SQL statement to execute.
1524      * @param array $params array of sql parameters
1525      * @return bool true if the SQL executes without errors and returns at least one record.
1526      * @throws dml_exception if error
1527      */
1528     public function record_exists_sql($sql, array $params=null) {
1529         if ($mrs = $this->get_recordset_sql($sql, $params, 0, 1)) {
1530             $return = $mrs->valid();
1531             $mrs->close();
1532             return $return;
1533         }
1534         return false;
1535     }
1537     /**
1538      * Delete the records from a table where all the given conditions met.
1539      * If conditions not specified, table is truncated.
1540      *
1541      * @param string $table the table to delete from.
1542      * @param array $conditions optional array $fieldname=>requestedvalue with AND in between
1543      * @return bool true.
1544      * @throws dml_exception if error
1545      */
1546     public function delete_records($table, array $conditions=null) {
1547         if (is_null($conditions)) {
1548             return $this->execute("TRUNCATE TABLE {".$table."}");
1549         }
1550         list($select, $params) = $this->where_clause($conditions);
1551         return $this->delete_records_select($table, $select, $params);
1552     }
1554     /**
1555      * Delete the records from a table where one field match one list of values.
1556      *
1557      * @param string $table the table to delete from.
1558      * @param string $field The field to search
1559      * @param array $values array of values
1560      * @return bool true.
1561      * @throws dml_exception if error
1562      */
1563     public function delete_records_list($table, $field, array $values) {
1564         list($select, $params) = $this->where_clause_list($field, $values);
1565         if (empty($select)) {
1566             // nothing to delete
1567             return true;
1568         }
1569         return $this->delete_records_select($table, $select, $params);
1570     }
1572     /**
1573      * Delete one or more records from a table which match a particular WHERE clause.
1574      *
1575      * @param string $table The database table to be checked against.
1576      * @param string $select A fragment of SQL to be used in a where clause in the SQL call (used to define the selection criteria).
1577      * @param array $params array of sql parameters
1578      * @return bool true.
1579      * @throws dml_exception if error
1580      */
1581     public abstract function delete_records_select($table, $select, array $params=null);
1585 /// sql constructs
1586     /**
1587      * Returns the FROM clause required by some DBs in all SELECT statements.
1588      *
1589      * To be used in queries not having FROM clause to provide cross_db
1590      * Most DBs don't need it, hence the default is ''
1591      * @return string
1592      */
1593     public function sql_null_from_clause() {
1594         return '';
1595     }
1597     /**
1598      * Returns the SQL text to be used in order to perform one bitwise AND operation
1599      * between 2 integers.
1600      *
1601      * NOTE: The SQL result is a number and can not be used directly in
1602      *       SQL condition, please compare it to some number to get a bool!!
1603      *
1604      * @param int $int1 first integer in the operation
1605      * @param int $int2 second integer in the operation
1606      * @return string the piece of SQL code to be used in your statement
1607      */
1608     public function sql_bitand($int1, $int2) {
1609         return '((' . $int1 . ') & (' . $int2 . '))';
1610     }
1612     /**
1613      * Returns the SQL text to be used in order to perform one bitwise NOT operation
1614      * with 1 integer.
1615      *
1616      * @param int $int1 integer in the operation
1617      * @return string the piece of SQL code to be used in your statement.
1618      */
1619     public function sql_bitnot($int1) {
1620         return '(~(' . $int1 . '))';
1621     }
1623     /**
1624      * Returns the SQL text to be used in order to perform one bitwise OR operation
1625      * between 2 integers.
1626      *
1627      * NOTE: The SQL result is a number and can not be used directly in
1628      *       SQL condition, please compare it to some number to get a bool!!
1629      *
1630      * @param int $int1 first integer in the operation
1631      * @param int $int2 second integer in the operation
1632      * @return string the piece of SQL code to be used in your statement.
1633      */
1634     public function sql_bitor($int1, $int2) {
1635         return '((' . $int1 . ') | (' . $int2 . '))';
1636     }
1638     /**
1639      * Returns the SQL text to be used in order to perform one bitwise XOR operation
1640      * between 2 integers.
1641      *
1642      * NOTE: The SQL result is a number and can not be used directly in
1643      *       SQL condition, please compare it to some number to get a bool!!
1644      *
1645      * @param int $int1 first integer in the operation
1646      * @param int $int2 second integer in the operation
1647      * @return string the piece of SQL code to be used in your statement.
1648      */
1649     public function sql_bitxor($int1, $int2) {
1650         return '((' . $int1 . ') ^ (' . $int2 . '))';
1651     }
1653     /**
1654      * Returns the SQL text to be used in order to perform module '%'
1655      * operation - remainder after division
1656      *
1657      * @param int $int1 first integer in the operation
1658      * @param int $int2 second integer in the operation
1659      * @return string the piece of SQL code to be used in your statement.
1660      */
1661     public function sql_modulo($int1, $int2) {
1662         return '((' . $int1 . ') % (' . $int2 . '))';
1663     }
1665     /**
1666      * Returns the correct CEIL expression applied to fieldname.
1667      *
1668      * @param string $fieldname the field (or expression) we are going to ceil
1669      * @return string the piece of SQL code to be used in your ceiling statement
1670      * Most DB use CEIL(), hence it's the default.
1671      */
1672     public function sql_ceil($fieldname) {
1673         return ' CEIL(' . $fieldname . ')';
1674     }
1676     /**
1677      * Returns the SQL to be used in order to CAST one CHAR column to INTEGER.
1678      *
1679      * Be aware that the CHAR column you're trying to cast contains really
1680      * int values or the RDBMS will throw an error!
1681      *
1682      * @param string $fieldname the name of the field to be casted
1683      * @param bool $text to specify if the original column is one TEXT (CLOB) column (true). Defaults to false.
1684      * @return string the piece of SQL code to be used in your statement.
1685      */
1686     public function sql_cast_char2int($fieldname, $text=false) {
1687         return ' ' . $fieldname . ' ';
1688     }
1690     /**
1691      * Returns the SQL to be used in order to CAST one CHAR column to REAL number.
1692      *
1693      * Be aware that the CHAR column you're trying to cast contains really
1694      * numbers or the RDBMS will throw an error!
1695      *
1696      * @param string $fieldname the name of the field to be casted
1697      * @param bool $text to specify if the original column is one TEXT (CLOB) column (true). Defaults to false.
1698      * @return string the piece of SQL code to be used in your statement.
1699      */
1700     public function sql_cast_char2real($fieldname, $text=false) {
1701         return ' ' . $fieldname . ' ';
1702     }
1704     /**
1705      * Returns the SQL to be used in order to an UNSIGNED INTEGER column to SIGNED.
1706      *
1707      * (Only MySQL needs this. MySQL things that 1 * -1 = 18446744073709551615
1708      * if the 1 comes from an unsigned column).
1709      *
1710      * @param string $fieldname the name of the field to be cast
1711      * @return string the piece of SQL code to be used in your statement.
1712      */
1713     public function sql_cast_2signed($fieldname) {
1714         return ' ' . $fieldname . ' ';
1715     }
1717     /**
1718      * Returns the SQL text to be used to compare one TEXT (clob) column with
1719      * one varchar column, because some RDBMS doesn't support such direct
1720      * comparisons.
1721      *
1722      * @param string $fieldname the name of the TEXT field we need to order by
1723      * @param int $numchars of chars to use for the ordering (defaults to 32)
1724      * @return string the piece of SQL code to be used in your statement.
1725      */
1726     public function sql_compare_text($fieldname, $numchars=32) {
1727         return $this->sql_order_by_text($fieldname, $numchars);
1728     }
1730     /**
1731      * Returns the proper SQL to do LIKE in a case-insensitive way.
1732      *
1733      * Note the LIKE are case sensitive for Oracle. Oracle 10g is required to use
1734      * the case insensitive search using regexp_like() or NLS_COMP=LINGUISTIC :-(
1735      * See http://docs.moodle.org/en/XMLDB_Problems#Case-insensitive_searches
1736      *
1737      * @return string
1738      */
1739     public function sql_ilike() {
1740         return 'LIKE';
1741     }
1743     /**
1744      * Returns the proper SQL to do CONCAT between the elements passed
1745      * Can take many parameters
1746      *
1747      * This function accepts variable number of string parameters.
1748      *
1749      * @return string
1750      */
1751     public abstract function sql_concat();
1753     /**
1754      * Returns the proper SQL to do CONCAT between the elements passed
1755      * with a given separator
1756      *
1757      * @param string $separator
1758      * @param array  $elements
1759      * @return string
1760      */
1761     public abstract function sql_concat_join($separator="' '", $elements=array());
1763     /**
1764      * Returns the proper SQL (for the dbms in use) to concatenate $firstname and $lastname
1765      * TODO: Does this really need to be here? Eloy 20070727.
1766      * TODO: we definitely do not! (skodak)
1767      *
1768      * @param string $first User's first name
1769      * @param string $last User's last name
1770      * @return string
1771      */
1772     function sql_fullname($first='firstname', $last='lastname') {
1773         return $this->sql_concat($first, "' '", $last);
1774     }
1776     /**
1777      * Returns the SQL text to be used to order by one TEXT (clob) column, because
1778      * some RDBMS doesn't support direct ordering of such fields.
1779      *
1780      * Note that the use or queries being ordered by TEXT columns must be minimised,
1781      * because it's really slooooooow.
1782      *
1783      * @param string $fieldname the name of the TEXT field we need to order by
1784      * @param string $numchars of chars to use for the ordering (defaults to 32)
1785      * @return string the piece of SQL code to be used in your statement.
1786      */
1787     public function sql_order_by_text($fieldname, $numchars=32) {
1788         return $fieldname;
1789     }
1791     /**
1792      * Returns the SQL text to be used to calculate the length in characters of one expression.
1793      * @param string $fieldname or expression to calculate its length in characters.
1794      * @return string the piece of SQL code to be used in the statement.
1795      */
1796     public function sql_length($fieldname) {
1797         return ' LENGTH(' . $fieldname . ')';
1798     }
1800     /**
1801      * Returns the proper substr() SQL text used to extract substrings from DB
1802      * NOTE: this was originally returning only function name
1803      *
1804      * @param string $expr some string field, no aggregates
1805      * @param mixed $start integer or expression evaluating to int (1 based value; first char has index 1)
1806      * @param mixed $length optional integer or expression evaluating to int
1807      * @return string sql fragment
1808      */
1809     public function sql_substr($expr, $start, $length=false) {
1810         if (count(func_get_args()) < 2) {
1811             throw new coding_exception('moodle_database::sql_substr() requires at least two parameters', 'Originally this function was only returning name of SQL substring function, it now requires all parameters.');
1812         }
1813         if ($length === false) {
1814             return "SUBSTR($expr, $start)";
1815         } else {
1816             return "SUBSTR($expr, $start, $length)";
1817         }
1818     }
1820     /**
1821      * Returns the SQL for returning searching one string for the location of another.
1822      * Note, there is no guarantee which order $needle, $haystack will be in
1823      * the resulting SQL, so when using this method, and both arguments contain
1824      * placeholders, you should use named placeholders.
1825      * @param string $needle the SQL expression that will be searched for.
1826      * @param string $haystack the SQL expression that will be searched in.
1827      * @return string the required SQL
1828      */
1829     public function sql_position($needle, $haystack) {
1830         // Implementation using standard SQL.
1831         return "POSITION(($needle) IN ($haystack))";
1832     }
1834     /**
1835      * Returns the empty string char used by every supported DB. To be used when
1836      * we are searching for that values in our queries. Only Oracle uses this
1837      * for now (will be out, once we migrate to proper NULLs if that days arrives)
1838      * @return string
1839      */
1840     function sql_empty() {
1841         return '';
1842     }
1844     /**
1845      * Returns the proper SQL to know if one field is empty.
1846      *
1847      * Note that the function behavior strongly relies on the
1848      * parameters passed describing the field so, please,  be accurate
1849      * when specifying them.
1850      *
1851      * Also, note that this function is not suitable to look for
1852      * fields having NULL contents at all. It's all for empty values!
1853      *
1854      * This function should be applied in all the places where conditions of
1855      * the type:
1856      *
1857      *     ... AND fieldname = '';
1858      *
1859      * are being used. Final result should be:
1860      *
1861      *     ... AND ' . sql_isempty('tablename', 'fieldname', true/false, true/false);
1862      *
1863      * (see parameters description below)
1864      *
1865      * @param string $tablename name of the table (without prefix). Not used for now but can be
1866      *                          necessary in the future if we want to use some introspection using
1867      *                          meta information against the DB. /// TODO ///
1868      * @param string $fieldname name of the field we are going to check
1869      * @param boolean $nullablefield to specify if the field us nullable (true) or no (false) in the DB
1870      * @param boolean $textfield to specify if it is a text (also called clob) field (true) or a varchar one (false)
1871      * @return string the sql code to be added to check for empty values
1872      */
1873     public function sql_isempty($tablename, $fieldname, $nullablefield, $textfield) {
1874         return " ($fieldname = '') ";
1875     }
1877     /**
1878      * Returns the proper SQL to know if one field is not empty.
1879      *
1880      * Note that the function behavior strongly relies on the
1881      * parameters passed describing the field so, please,  be accurate
1882      * when specifying them.
1883      *
1884      * This function should be applied in all the places where conditions of
1885      * the type:
1886      *
1887      *     ... AND fieldname != '';
1888      *
1889      * are being used. Final result should be:
1890      *
1891      *     ... AND ' . sql_isnotempty('tablename', 'fieldname', true/false, true/false);
1892      *
1893      * (see parameters description below)
1894      *
1895      * @param string $tablename name of the table (without prefix). Not used for now but can be
1896      *                          necessary in the future if we want to use some introspection using
1897      *                          meta information against the DB. /// TODO ///
1898      * @param string $fieldname name of the field we are going to check
1899      * @param boolean $nullablefield to specify if the field us nullable (true) or no (false) in the DB
1900      * @param boolean $textfield to specify if it is a text (also called clob) field (true) or a varchar one (false)
1901      * @return string the sql code to be added to check for non empty values
1902      */
1903     public function sql_isnotempty($tablename, $fieldname, $nullablefield, $textfield) {
1904         return ' ( NOT ' . $this->sql_isempty($tablename, $fieldname, $nullablefield, $textfield) . ') ';
1905     }
1907     /**
1908      * Does this driver suppoer regex syntax when searching
1909      * @return bool
1910      */
1911     public function sql_regex_supported() {
1912         return false;
1913     }
1915     /**
1916      * Return regex positive or negative match sql
1917      * @param bool $positivematch
1918      * @return string or empty if not supported
1919      */
1920     public function sql_regex($positivematch=true) {
1921         return '';
1922     }
1924 /// transactions
1926     /**
1927      * Are transactions supported?
1928      * It is not responsible to run productions servers
1929      * on databases without transaction support ;-)
1930      *
1931      * Override in driver if needed.
1932      *
1933      * @return bool
1934      */
1935     protected function transactions_supported() {
1936         // protected for now, this might be changed to public if really necessary
1937         return true;
1938     }
1940     /**
1941      * Returns true if transaction in progress
1942      * @return bool
1943      */
1944     public function is_transaction_started() {
1945         return !empty($this->transactions);
1946     }
1948     /**
1949      * Throws exception if transaction in progress.
1950      * This test does not force rollback of active transactions.
1951      * @return void
1952      */
1953     public function transactions_forbidden() {
1954         if ($this->is_transaction_started()) {
1955             throw new dml_transaction_exception('This code can not be excecuted in transaction');
1956         }
1957     }
1959     /**
1960      * On DBs that support it, switch to transaction mode and begin a transaction
1961      * you'll need to ensure you call allow_commit() on the returned object
1962      * or your changes *will* be lost.
1963      *
1964      * this is _very_ useful for massive updates
1965      *
1966      * Delegated database transactions can be nested, but only one actual database
1967      * transaction is used for the outer-most delegated transaction. This method
1968      * returns a transaction object which you should keep until the end of the
1969      * delegated transaction. The actual database transaction will
1970      * only be committed if all the nested delegated transactions commit
1971      * successfully. If any part of the transaction rolls back then the whole
1972      * thing is rolled back.
1973      *
1974      * @return moodle_transaction
1975      */
1976     public function start_delegated_transaction() {
1977         $transaction = new moodle_transaction($this);
1978         $this->transactions[] = $transaction;
1979         if (count($this->transactions) == 1) {
1980             $this->begin_transaction();
1981         }
1982         return $transaction;
1983     }
1985     /**
1986      * Driver specific start of real database transaction,
1987      * this can not be used directly in code.
1988      * @return void
1989      */
1990     protected abstract function begin_transaction();
1992     /**
1993      * Indicates delegated transaction finished successfully.
1994      * The real database transaction is committed only if
1995      * all delegated transactions committed.
1996      * @return void
1997      */
1998     public function commit_delegated_transaction(moodle_transaction $transaction) {
1999         if ($transaction->is_disposed()) {
2000             throw new dml_transaction_exception('Transactions already disposed', $transaction);
2001         }
2002         // mark as disposed so that it can not be used again
2003         $transaction->dispose();
2005         if (empty($this->transactions)) {
2006             throw new dml_transaction_exception('Transaction not started', $transaction);
2007         }
2009         if ($this->force_rollback) {
2010             throw new dml_transaction_exception('Tried to commit transaction after lower level rollback', $transaction);
2011         }
2013         if ($transaction !== $this->transactions[count($this->transactions) - 1]) {
2014             // one incorrect commit at any level rollbacks everything
2015             $this->force_rollback = true;
2016             throw new dml_transaction_exception('Invalid transaction commit attempt', $transaction);
2017         }
2019         if (count($this->transactions) == 1) {
2020             // only commit the top most level
2021             $this->commit_transaction();
2022         }
2023         array_pop($this->transactions);
2024     }
2026     /**
2027      * Driver specific commit of real database transaction,
2028      * this can not be used directly in code.
2029      * @return void
2030      */
2031     protected abstract function commit_transaction();
2033     /**
2034      * Call when delegated transaction failed, this rolls back
2035      * all delegated transactions up to the top most level.
2036      *
2037      * In many cases you do not need to call this method manually,
2038      * because all open delegated transactions are rolled back
2039      * automatically if exceptions not caught.
2040      *
2041      * @param moodle_transaction $transaction
2042      * @param Exception $e exception that caused the problem
2043      * @return void - does not return, exception is rethrown
2044      */
2045     public function rollback_delegated_transaction(moodle_transaction $transaction, Exception $e) {
2046         if ($transaction->is_disposed()) {
2047             throw new dml_transaction_exception('Transactions already disposed', $transaction);
2048         }
2049         // mark as disposed so that it can not be used again
2050         $transaction->dispose();
2052         // one rollback at any level rollbacks everything
2053         $this->force_rollback = true;
2055         if (empty($this->transactions) or $transaction !== $this->transactions[count($this->transactions) - 1]) {
2056             // this may or may not be a coding problem, better just rethrow the exception,
2057             // because we do not want to loose the original $e
2058             throw $e;
2059         }
2061         if (count($this->transactions) == 1) {
2062             // only rollback the top most level
2063             $this->rollback_transaction();
2064         }
2065         array_pop($this->transactions);
2066         if (empty($this->transactions)) {
2067             // finally top most level rolled back
2068             $this->force_rollback = false;
2069         }
2070         throw $e;
2071     }
2073     /**
2074      * Driver specific abort of real database transaction,
2075      * this can not be used directly in code.
2076      * @return void
2077      */
2078     protected abstract function rollback_transaction();
2080     /**
2081      * Force rollback of all delegated transaction.
2082      * Does not trow any exceptions and does not log anything.
2083      *
2084      * This method should be used only from default exception handlers and other
2085      * core code.
2086      *
2087      * @return void
2088      */
2089     public function force_transaction_rollback() {
2090         if ($this->transactions) {
2091             try {
2092                 $this->rollback_transaction();
2093             } catch (dml_exception $e) {
2094                 // ignore any sql errors here, the connection might be broken
2095             }
2096         }
2098         // now enable transactions again
2099         $this->transactions = array(); // unfortunately all unfinished exceptions are kept in memory
2100         $this->force_rollback = false;
2101     }
2103 /// session locking
2104     /**
2105      * Is session lock supported in this driver?
2106      * @return bool
2107      */
2108     public function session_lock_supported() {
2109         return false;
2110     }
2112     /**
2113      * Obtain session lock
2114      * @param int $rowid id of the row with session record
2115      * @return bool success
2116      */
2117     public function get_session_lock($rowid) {
2118         $this->used_for_db_sessions = true;
2119     }
2121     /**
2122      * Release session lock
2123      * @param int $rowid id of the row with session record
2124      * @return bool success
2125      */
2126     public function release_session_lock($rowid) {
2127     }
2129 /// performance and logging
2130     /**
2131      * Returns number of reads done by this database
2132      * @return int
2133      */
2134     public function perf_get_reads() {
2135         return $this->reads;
2136     }
2138     /**
2139      * Returns number of writes done by this database
2140      * @return int
2141      */
2142     public function perf_get_writes() {
2143         return $this->writes;
2144     }
2146     /**
2147      * Returns number of queries done by this database
2148      * @return int
2149      */
2150     public function perf_get_queries() {
2151         return $this->writes + $this->reads;
2152     }