2 if(!defined('sugarEntry') || !sugarEntry) die('Not A Valid Entry Point');
3 /*********************************************************************************
4 * SugarCRM Community Edition is a customer relationship management program developed by
5 * SugarCRM, Inc. Copyright (C) 2004-2012 SugarCRM Inc.
7 * This program is free software; you can redistribute it and/or modify it under
8 * the terms of the GNU Affero General Public License version 3 as published by the
9 * Free Software Foundation with the addition of the following permission added
10 * to Section 15 as permitted in Section 7(a): FOR ANY PART OF THE COVERED WORK
11 * IN WHICH THE COPYRIGHT IS OWNED BY SUGARCRM, SUGARCRM DISCLAIMS THE WARRANTY
12 * OF NON INFRINGEMENT OF THIRD PARTY RIGHTS.
14 * This program is distributed in the hope that it will be useful, but WITHOUT
15 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
16 * FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more
19 * You should have received a copy of the GNU Affero General Public License along with
20 * this program; if not, see http://www.gnu.org/licenses or write to the Free
21 * Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
24 * You can contact SugarCRM, Inc. headquarters at 10050 North Wolfe Road,
25 * SW2-130, Cupertino, CA 95014, USA. or at email address contact@sugarcrm.com.
27 * The interactive user interfaces in modified source and object code versions
28 * of this program must display Appropriate Legal Notices, as required under
29 * Section 5 of the GNU Affero General Public License version 3.
31 * In accordance with Section 7(b) of the GNU Affero General Public License version 3,
32 * these Appropriate Legal Notices must retain the display of the "Powered by
33 * SugarCRM" logo. If the display of the logo is not reasonably feasible for
34 * technical reasons, the Appropriate Legal Notices must display the words
35 * "Powered by SugarCRM".
36 ********************************************************************************/
38 /*********************************************************************************
40 * Description: This file handles the Data base functionality for the application.
41 * It acts as the DB abstraction layer for the application. It depends on helper classes
42 * which generate the necessary SQL. This sql is then passed to PEAR DB classes.
43 * The helper class is chosen in DBManagerFactory, which is driven by 'db_type' in 'dbconfig' under config.php.
45 * All the functions in this class will work with any bean which implements the meta interface.
46 * The passed bean is passed to helper class which uses these functions to generate correct sql.
48 * The meta interface has the following functions:
49 * getTableName() Returns table name of the object.
50 * getFieldDefinitions() Returns a collection of field definitions in order.
51 * getFieldDefintion(name) Return field definition for the field.
52 * getFieldValue(name) Returns the value of the field identified by name.
53 * If the field is not set, the function will return boolean FALSE.
54 * getPrimaryFieldDefinition() Returns the field definition for primary key
56 * The field definition is an array with the following keys:
58 * name This represents name of the field. This is a required field.
59 * type This represents type of the field. This is a required field and valid values are:
73 * length This is used only when the type is varchar and denotes the length of the string.
74 * The max value is 255.
75 * enumvals This is a list of valid values for an enum separated by "|".
76 * It is used only if the type is �enum�;
77 * required This field dictates whether it is a required value.
78 * The default value is �FALSE�.
79 * isPrimary This field identifies the primary key of the table.
80 * If none of the fields have this flag set to �TRUE�,
81 * the first field definition is assume to be the primary key.
82 * Default value for this field is �FALSE�.
83 * default This field sets the default value for the field definition.
86 * Portions created by SugarCRM are Copyright (C) SugarCRM, Inc.
87 * All Rights Reserved.
88 * Contributor(s): ______________________________________..
89 ********************************************************************************/
92 * Base database driver implementation
95 abstract class DBManager
101 public $database = null;
104 * Indicates whether we should die when we get an error from the DB
106 protected $dieOnError = false;
109 * Indicates whether we should html encode the results from a query by default
111 protected $encode = true;
114 * Records the execution time of the last query
116 protected $query_time = 0;
119 * Last error message from the DB backend
121 protected $last_error = false;
124 * Registry of available result sets
126 protected $lastResult;
129 * Current query count
131 private static $queryCount = 0;
134 * Query threshold limit
136 private static $queryLimit = 0;
139 * Array of prepared statements and their correspoding parsed tokens
141 protected $preparedTokens = array();
159 protected static $table_descriptions = array();
165 protected static $index_descriptions = array();
168 * Maximum length of identifiers
172 protected $maxNameLengths = array(
181 * Higher priority drivers override lower priority ones
184 public $priority = 0;
187 * Driver name label, for install
198 protected $type_map = array();
201 * Type classification into:
209 protected $type_class = array(
218 'datetime' => 'date',
219 'datetimecombo' => 'date',
223 'currency' => 'float',
224 'decimal' => 'float',
225 'decimal2' => 'float',
229 * Capabilities this DB supports. Supported list:
230 * affected_rows Can report query affected rows for UPDATE/DELETE
231 * implement getAffectedRowCount()
232 * select_rows Can report row count for SELECT
233 * implement getRowCount()
234 * case_sensitive Supports case-sensitive text columns
235 * fulltext Supports fulltext search indexes
236 * inline_keys Supports defining keys together with the table
237 * auto_increment_sequence Autoincrement support implemented as sequence
238 * limit_subquery Supports LIMIT clauses in subqueries
239 * create_user Can create users for Sugar
240 * create_db Can create databases
241 * collation Supports setting collations
242 * disable_keys Supports temporarily disabling keys (for upgrades, etc.)
246 * fix:expandDatabase - needs expandDatabase fix, see expandDatabase.php
247 * TODO: verify if we need these cases
249 protected $capabilities = array();
255 protected $options = array();
260 public function __construct()
262 $this->timedate = TimeDate::getInstance();
263 $this->log = $GLOBALS['log'];
264 $this->helper = $this; // compatibility
268 * Wrapper for those trying to access the private and protected class members directly
269 * @param string $p var name
272 public function __get($p)
274 $this->log->info('Call to DBManager::$'.$p.' is deprecated');
279 * Returns the current database handle
282 public function getDatabase()
284 $this->checkConnection();
285 return $this->database;
289 * Returns this instance's DBHelper
290 * Actually now returns $this
294 public function getHelper()
300 * Checks for error happening in the database
302 * @param string $msg message to prepend to the error message
303 * @param bool $dieOnError true if we want to die immediately on error
304 * @return bool True if there was an error
306 public function checkError($msg = '', $dieOnError = false)
308 if (empty($this->database)) {
309 $this->registerError("$msg: Database Is Not Connected", $dieOnError);
313 $dberror = $this->lastDbError();
314 if($dberror === false) {
315 $this->last_error = false;
318 $this->registerError($msg, $dberror, $dieOnError);
323 * Register database error
324 * If die-on-error flag is set, logs the message and dies,
325 * otherwise sets last_error to the message
326 * @param string $userMessage Message from function user
327 * @param string $message Message from SQL driver
328 * @param bool $dieOnError
330 protected function registerError($userMessage, $message, $dieOnError = false)
332 if(!empty($message)) {
333 if(!empty($userMessage)) {
334 $message = "$userMessage: $message";
336 if(empty($message)) {
337 $message = "Database error";
339 $this->log->fatal($message);
340 if ($dieOnError || $this->dieOnError) {
341 if(isset($GLOBALS['app_strings']['ERR_DB_FAIL'])) {
342 sugar_die($GLOBALS['app_strings']['ERR_DB_FAIL']);
344 sugar_die("Database error. Please check sugarcrm.log for details.");
347 $this->last_error = $message;
353 * Return DB error message for the last query executed
354 * @return string Last error message
356 public function lastError()
358 return $this->last_error;
362 * This method is called by every method that runs a query.
363 * If slow query dumping is turned on and the query time is beyond
364 * the time limit, we will log the query. This function may do
365 * additional reporting or log in a different area in the future.
367 * @param string $query query to log
368 * @return boolean true if the query was logged, false otherwise
370 protected function dump_slow_queries($query)
372 global $sugar_config;
374 $do_the_dump = isset($sugar_config['dump_slow_queries'])
375 ? $sugar_config['dump_slow_queries'] : false;
376 $slow_query_time_msec = isset($sugar_config['slow_query_time_msec'])
377 ? $sugar_config['slow_query_time_msec'] : 5000;
380 if($slow_query_time_msec < ($this->query_time * 1000)) {
381 // Then log both the query and the query time
382 $this->log->fatal('Slow Query (time:'.$this->query_time."\n".$query);
390 * Scans order by to ensure that any field being ordered by is.
392 * It will throw a warning error to the log file - fatal if slow query logging is enabled
394 * @param string $sql query to be run
395 * @param bool $object_name optional, object to look up indices in
396 * @return bool true if an index is found false otherwise
398 protected function checkQuery($sql, $object_name = false)
401 preg_match_all("'.* FROM ([^ ]*).* ORDER BY (.*)'is", $sql, $match);
403 if (!empty($match[1][0]))
404 $table = $match[1][0];
408 if (!empty($object_name) && !empty($GLOBALS['dictionary'][$object_name]))
409 $indices = $GLOBALS['dictionary'][$object_name]['indices'];
411 if (empty($indices)) {
412 foreach ( $GLOBALS['dictionary'] as $current ) {
413 if ($current['table'] == $table){
414 $indices = $current['indices'];
419 if (empty($indices)) {
420 $this->log->warn('CHECK QUERY: Could not find index definitions for table ' . $table);
423 if (!empty($match[2][0])) {
424 $orderBys = explode(' ', $match[2][0]);
425 foreach ($orderBys as $orderBy){
426 $orderBy = trim($orderBy);
429 $orderBy = strtolower($orderBy);
430 if ($orderBy == 'asc' || $orderBy == 'desc')
433 $orderBy = str_replace(array($table . '.', ','), '', $orderBy);
435 foreach ($indices as $index)
436 if (empty($index['db']) || $index['db'] == $this->dbType)
437 foreach ($index['fields'] as $field)
438 if ($field == $orderBy)
441 $warning = 'Missing Index For Order By Table: ' . $table . ' Order By:' . $orderBy ;
442 if (!empty($GLOBALS['sugar_config']['dump_slow_queries']))
443 $this->log->fatal('CHECK QUERY:' .$warning);
445 $this->log->warn('CHECK QUERY:' .$warning);
452 * Returns the time the last query took to execute
456 public function getQueryTime()
458 return $this->query_time;
462 * Checks the current connection; if it is not connected then reconnect
464 public function checkConnection()
466 $this->last_error = '';
467 if (!isset($this->database))
472 * Sets the dieOnError value
476 public function setDieOnError($value)
478 $this->dieOnError = $value;
482 * Implements a generic insert for any bean.
484 * @param SugarBean $bean SugarBean instance
485 * @return bool query result
488 public function insert(SugarBean $bean)
490 $sql = $this->insertSQL($bean);
491 $tablename = $bean->getTableName();
492 $msg = "Error inserting into table: $tablename:";
493 return $this->query($sql,true,$msg);
497 * Insert data into table by parameter definition
498 * @param string $table Table name
499 * @param array $field_defs Definitions in vardef-like format
500 * @param array $data Key/value to insert
501 * @param array $field_map Fields map from SugarBean
502 * @param bool $execute Execute or return query?
503 * @return bool query result
505 public function insertParams($table, $field_defs, $data, $field_map = null, $execute = true)
508 foreach ($field_defs as $field => $fieldDef)
510 if (isset($fieldDef['source']) && $fieldDef['source'] != 'db') continue;
511 //custom fields handle there save seperatley
512 if(!empty($field_map) && !empty($field_map[$field]['custom_type'])) continue;
514 if(isset($data[$field])) {
515 // clean the incoming value..
516 $val = from_html($data[$field]);
518 if(isset($fieldDef['default']) && strlen($fieldDef['default']) > 0) {
519 $val = $fieldDef['default'];
525 //handle auto increment values here - we may have to do something like nextval for oracle
526 if (!empty($fieldDef['auto_increment'])) {
527 $auto = $this->getAutoIncrementSQL($table, $fieldDef['name']);
529 $values[$field] = $auto;
531 } elseif ($fieldDef['name'] == 'deleted') {
532 $values['deleted'] = (int)$val;
534 // need to do some thing about types of values
535 if(!is_null($val) || !empty($fieldDef['required'])) {
536 $values[$field] = $this->massageValue($val, $fieldDef);
542 return $execute?true:''; // no columns set
544 // get the entire sql
545 $query = "INSERT INTO $table (".implode(",", array_keys($values)).")
546 VALUES (".implode(",", $values).")";
547 return $execute?$this->query($query):$query;
551 * Implements a generic update for any bean
553 * @param SugarBean $bean Sugarbean instance
554 * @param array $where values with the keys as names of fields.
555 * If we want to pass multiple values for a name, pass it as an array
556 * If where is not passed, it defaults to id of table
557 * @return bool query result
560 public function update(SugarBean $bean, array $where = array())
562 $sql = $this->updateSQL($bean, $where);
563 $tablename = $bean->getTableName();
564 $msg = "Error updating table: $tablename:";
565 return $this->query($sql,true,$msg);
569 * Implements a generic delete for any bean identified by id
571 * @param SugarBean $bean Sugarbean instance
572 * @param array $where values with the keys as names of fields.
573 * If we want to pass multiple values for a name, pass it as an array
574 * If where is not passed, it defaults to id of table
575 * @return bool query result
577 public function delete(SugarBean $bean, array $where = array())
579 $sql = $this->deleteSQL($bean, $where);
580 $tableName = $bean->getTableName();
581 $msg = "Error deleting from table: ".$tableName. ":";
582 return $this->query($sql,true,$msg);
586 * Implements a generic retrieve for any bean identified by id
588 * If we want to pass multiple values for a name, pass it as an array
589 * If where is not passed, it defaults to id of table
591 * @param SugarBean $bean Sugarbean instance
592 * @param array $where values with the keys as names of fields.
593 * @return resource result from the query
595 public function retrieve(SugarBean $bean, array $where = array())
597 $sql = $this->retrieveSQL($bean, $where);
598 $tableName = $bean->getTableName();
599 $msg = "Error retriving values from table:".$tableName. ":";
600 return $this->query($sql,true,$msg);
604 * Implements a generic retrieve for a collection of beans.
606 * These beans will be joined in the sql by the key attribute of field defs.
607 * Currently, this function does support outer joins.
609 * @param array $beans Sugarbean instance(s)
610 * @param array $cols columns to be returned with the keys as names of bean as identified by
611 * get_class of bean. Values of this array is the array of fieldDefs to be returned for a bean.
612 * If an empty array is passed, all columns are selected.
613 * @param array $where values with the keys as names of bean as identified by get_class of bean
614 * Each value at the first level is an array of values for that bean identified by name of fields.
615 * If we want to pass multiple values for a name, pass it as an array
616 * If where is not passed, all the rows will be returned.
619 public function retrieveView(array $beans, array $cols = array(), array $where = array())
621 $sql = $this->retrieveViewSQL($beans, $cols, $where);
622 $msg = "Error retriving values from View Collection:";
623 return $this->query($sql,true,$msg);
628 * Implements creation of a db table for a bean.
630 * NOTE: does not handle out-of-table constraints, use createConstraintSQL for that
631 * @param SugarBean $bean Sugarbean instance
633 public function createTable(SugarBean $bean)
635 $sql = $this->createTableSQL($bean);
636 $tablename = $bean->getTableName();
637 $msg = "Error creating table: $tablename:";
638 $this->query($sql,true,$msg);
639 if(!$this->supports("inline_keys")) {
640 // handle constraints and indices
641 $indicesArr = $this->createConstraintSql($bean);
642 if (count($indicesArr) > 0)
643 foreach ($indicesArr as $indexSql)
644 $this->query($indexSql, true, $msg);
649 * returns SQL to create constraints or indices
651 * @param SugarBean $bean SugarBean instance
652 * @return array list of SQL statements
654 protected function createConstraintSql(SugarBean $bean)
656 return $this->getConstraintSql($bean->getIndices(), $bean->getTableName());
660 * Implements creation of a db table
662 * @param string $tablename
663 * @param array $fieldDefs Field definitions, in vardef format
664 * @param array $indices Index definitions, in vardef format
665 * @param string $engine Engine parameter, used for MySQL engine so far
666 * @todo: refactor engine param to be more generic
667 * @return bool success value
669 public function createTableParams($tablename, $fieldDefs, $indices, $engine = null)
671 if (!empty($fieldDefs)) {
672 $sql = $this->createTableSQLParams($tablename, $fieldDefs, $indices, $engine);
675 $msg = "Error creating table: $tablename";
676 $res = ($res and $this->query($sql,true,$msg));
678 if(!$this->supports("inline_keys")) {
679 // handle constraints and indices
680 $indicesArr = $this->getConstraintSql($indices, $tablename);
681 if (count($indicesArr) > 0)
682 foreach ($indicesArr as $indexSql)
683 $res = ($res and $this->query($indexSql, true, "Error creating indexes"));
691 * Implements repair of a db table for a bean.
693 * @param SugarBean $bean SugarBean instance
694 * @param bool $execute true if we want the action to take place, false if we just want the sql returned
695 * @return string SQL statement or empty string, depending upon $execute
697 public function repairTable(SugarBean $bean, $execute = true)
699 $indices = $bean->getIndices();
700 $fielddefs = $bean->getFieldDefinitions();
701 $tablename = $bean->getTableName();
703 //Clean the indexes to prevent duplicate definitions
704 $new_index = array();
705 foreach($indices as $ind_def){
706 $new_index[$ind_def['name']] = $ind_def;
708 //jc: added this for beans that do not actually have a table, namely
709 //ForecastOpportunities
710 if($tablename == 'does_not_exist' || $tablename == '')
715 if (isset($dictionary[$bean->getObjectName()]['engine']) && !empty($dictionary[$bean->getObjectName()]['engine']) )
716 $engine = $dictionary[$bean->getObjectName()]['engine'];
718 return $this->repairTableParams($tablename, $fielddefs,$new_index,$execute,$engine);
722 * Can this field be null?
723 * Auto-increment and ID fields can not be null
724 * @param array $vardef
727 protected function isNullable($vardef)
730 if(isset($vardef['isnull']) && (strtolower($vardef['isnull']) == 'false' || $vardef['isnull'] === false)
731 && !empty($vardef['required'])) {
732 /* required + is_null=false => not null */
735 if(empty($vardef['auto_increment']) && (empty($vardef['type']) || $vardef['type'] != 'id')
736 && (empty($vardef['dbType']) || $vardef['dbType'] != 'id')
737 && (empty($vardef['name']) || ($vardef['name'] != 'id' && $vardef['name'] != 'deleted'))
746 * Builds the SQL commands that repair a table structure
748 * @param string $tablename
749 * @param array $fielddefs Field definitions, in vardef format
750 * @param array $indices Index definitions, in vardef format
751 * @param bool $execute optional, true if we want the queries executed instead of returned
752 * @param string $engine optional, MySQL engine
753 * @todo: refactor engine param to be more generic
756 public function repairTableParams($tablename, $fielddefs, $indices, $execute = true, $engine = null)
758 //jc: had a bug when running the repair if the tablename is blank the repair will
759 //fail when it tries to create a repair table
760 if ($tablename == '' || empty($fielddefs))
763 //if the table does not exist create it and we are done
764 $sql = "/* Table : $tablename */\n";
765 if (!$this->tableExists($tablename)) {
766 $createtablesql = $this->createTableSQLParams($tablename,$fielddefs,$indices,$engine);
767 if($execute && $createtablesql){
768 $this->createTableParams($tablename,$fielddefs,$indices,$engine);
771 $sql .= "/* MISSING TABLE: {$tablename} */\n";
772 $sql .= $createtablesql . "\n";
776 $compareFieldDefs = $this->get_columns($tablename);
777 $compareIndices = $this->get_indices($tablename);
779 $take_action = false;
781 // do column comparisions
782 $sql .= "/*COLUMNS*/\n";
783 foreach ($fielddefs as $name => $value) {
784 if (isset($value['source']) && $value['source'] != 'db')
787 // Bug #42406. Skipping breaked vardef without type or name
788 if (isset($value['name']) == false || $value['name'] == false)
790 $sql .= "/* NAME IS MISSING IN VARDEF $tablename::$name */\n";
793 else if (isset($value['type']) == false || $value['type'] == false)
795 $sql .= "/* TYPE IS MISSING IN VARDEF $tablename::$name */\n";
799 $name = strtolower($value['name']);
800 // add or fix the field defs per what the DB is expected to give us back
801 $this->massageFieldDef($value,$tablename);
803 $ignorerequired=false;
805 //Do not track requiredness in the DB, auto_increment, ID,
806 // and deleted fields are always required in the DB, so don't force those
807 if ($this->isNullable($value)) {
808 $value['required'] = false;
810 //Should match the conditions in DBManager::oneColumnSQLRep for DB required fields, type='id' fields will sometimes
812 //come into this function as 'type' = 'char', 'dbType' = 'id' without required set in $value. Assume they are correct and leave them alone.
813 else if (($name == 'id' || $value['type'] == 'id' || (isset($value['dbType']) && $value['dbType'] == 'id'))
814 && (!isset($value['required']) && isset($compareFieldDefs[$name]['required'])))
816 $value['required'] = $compareFieldDefs[$name]['required'];
819 if ( !isset($compareFieldDefs[$name]) ) {
820 // ok we need this field lets create it
821 $sql .= "/*MISSING IN DATABASE - $name - ROW*/\n";
822 $sql .= $this->addColumnSQL($tablename, $value) . "\n";
824 $this->addColumn($tablename, $value);
826 } elseif ( !$this->compareVarDefs($compareFieldDefs[$name],$value)) {
827 //fields are different lets alter it
828 $sql .= "/*MISMATCH WITH DATABASE - $name - ROW ";
829 foreach($compareFieldDefs[$name] as $rKey => $rValue) {
830 $sql .= "[$rKey] => '$rValue' ";
833 $sql .= "/* VARDEF - $name - ROW";
834 foreach($value as $rKey => $rValue) {
835 $sql .= "[$rKey] => '$rValue' ";
839 //jc: oracle will complain if you try to execute a statement that sets a column to (not) null
840 //when it is already (not) null
841 if ( isset($value['isnull']) && isset($compareFieldDefs[$name]['isnull']) &&
842 $value['isnull'] === $compareFieldDefs[$name]['isnull']) {
843 unset($value['required']);
844 $ignorerequired=true;
847 //dwheeler: Once a column has been defined as null, we cannot try to force it back to !null
848 if ((isset($value['required']) && ($value['required'] === true || $value['required'] == 'true' || $value['required'] === 1))
849 && (empty($compareFieldDefs[$name]['required']) || $compareFieldDefs[$name]['required'] != 'true'))
851 $ignorerequired = true;
853 $altersql = $this->alterColumnSQL($tablename, $value,$ignorerequired);
854 if(is_array($altersql)) {
855 $altersql = join("\n", $altersql);
857 $sql .= $altersql . "\n";
859 $this->alterColumn($tablename, $value, $ignorerequired);
865 // do index comparisions
866 $sql .= "/* INDEXES */\n";
867 $correctedIndexs = array();
869 $compareIndices_case_insensitive = array();
871 // do indicies comparisons case-insensitive
872 foreach($compareIndices as $k => $value){
873 $value['name'] = strtolower($value['name']);
874 $compareIndices_case_insensitive[strtolower($k)] = $value;
876 $compareIndices = $compareIndices_case_insensitive;
877 unset($compareIndices_case_insensitive);
879 foreach ($indices as $value) {
880 if (isset($value['source']) && $value['source'] != 'db')
884 $validDBName = $this->getValidDBName($value['name'], true, 'index', true);
885 if (isset($compareIndices[$validDBName])) {
886 $value['name'] = $validDBName;
888 $name = strtolower($value['name']);
890 //Don't attempt to fix the same index twice in one pass;
891 if (isset($correctedIndexs[$name]))
894 //don't bother checking primary nothing we can do about them
895 if (isset($value['type']) && $value['type'] == 'primary')
898 //database helpers do not know how to handle full text indices
899 if ($value['type']=='fulltext')
902 if ( in_array($value['type'],array('alternate_key','foreign')) )
903 $value['type'] = 'index';
905 if ( !isset($compareIndices[$name]) ) {
906 //First check if an index exists that doens't match our name, if so, try to rename it
908 foreach ($compareIndices as $ex_name => $ex_value) {
909 if($this->compareVarDefs($ex_value, $value, true)) {
915 $sql .= "/*MISSNAMED INDEX IN DATABASE - $name - $ex_name */\n";
916 $rename = $this->renameIndexDefs($ex_value, $value, $tablename);
918 $this->query($rename, true, "Cannot rename index");
920 $sql .= is_array($rename)?join("\n", $rename). "\n":$rename."\n";
923 // ok we need this field lets create it
924 $sql .= "/*MISSING INDEX IN DATABASE - $name -{$value['type']} ROW */\n";
925 $sql .= $this->addIndexes($tablename,array($value), $execute) . "\n";
928 $correctedIndexs[$name] = true;
929 } elseif ( !$this->compareVarDefs($compareIndices[$name],$value) ) {
930 // fields are different lets alter it
931 $sql .= "/*INDEX MISMATCH WITH DATABASE - $name - ROW ";
932 foreach ($compareIndices[$name] as $n1 => $t1) {
934 if ( $n1 == 'fields' )
935 foreach($t1 as $rKey => $rValue)
936 $sql .= "[$rKey] => '$rValue' ";
941 $sql .= "/* VARDEF - $name - ROW";
942 foreach ($value as $n1 => $t1) {
944 if ( $n1 == 'fields' )
945 foreach ($t1 as $rKey => $rValue)
946 $sql .= "[$rKey] => '$rValue' ";
951 $sql .= $this->modifyIndexes($tablename,array($value), $execute) . "\n";
953 $correctedIndexs[$name] = true;
957 return ($take_action === true) ? $sql : '';
961 * Compares two vardefs
963 * @param array $fielddef1 This is from the database
964 * @param array $fielddef2 This is from the vardef
965 * @param bool $ignoreName Ignore name-only differences?
966 * @return bool true if they match, false if they don't
968 public function compareVarDefs($fielddef1, $fielddef2, $ignoreName = false)
970 foreach ( $fielddef1 as $key => $value ) {
971 if ( $key == 'name' && ( strtolower($fielddef1[$key]) == strtolower($fielddef2[$key]) || $ignoreName) )
973 if ( isset($fielddef2[$key]) && $fielddef1[$key] == $fielddef2[$key] )
975 //Ignore len if its not set in the vardef
976 if ($key == 'len' && empty($fielddef2[$key]))
985 * Compare a field in two tables
987 * @param string $name field name
988 * @param string $table1
989 * @param string $table2
990 * @return array array with keys 'msg','table1','table2'
992 public function compareFieldInTables($name, $table1, $table2)
994 $row1 = $this->describeField($name, $table1);
995 $row2 = $this->describeField($name, $table2);
996 $returnArray = array(
1002 $ignore_filter = array('Key'=>1);
1005 // Exists on table1 but not table2
1006 $returnArray['msg'] = 'not_exists_table2';
1009 if (sizeof($row1) != sizeof($row2)) {
1010 $returnArray['msg'] = 'no_match';
1013 $returnArray['msg'] = 'match';
1014 foreach($row1 as $key => $value){
1015 //ignore keys when checking we will check them when we do the index check
1016 if( !isset($ignore_filter[$key]) && (!isset($row2[$key]) || $row1[$key] !== $row2[$key])){
1017 $returnArray['msg'] = 'no_match';
1024 $returnArray['msg'] = 'not_exists_table1';
1027 return $returnArray;
1031 // * Compare an index in two different tables
1033 // * @param string $name index name
1034 // * @param string $table1
1035 // * @param string $table2
1036 // * @return array array with keys 'msg','table1','table2'
1038 // public function compareIndexInTables($name, $table1, $table2)
1040 // $row1 = $this->describeIndex($name, $table1);
1041 // $row2 = $this->describeIndex($name, $table2);
1042 // $returnArray = array(
1043 // 'table1' => $row1,
1044 // 'table2' => $row2,
1045 // 'msg' => 'error',
1047 // $ignore_filter = array('Table'=>1, 'Seq_in_index'=>1,'Cardinality'=>1, 'Sub_part'=>1, 'Packed'=>1, 'Comment'=>1);
1051 // //Exists on table1 but not table2
1052 // $returnArray['msg'] = 'not_exists_table2';
1055 // if (sizeof($row1) != sizeof($row2)) {
1056 // $returnArray['msg'] = 'no_match';
1059 // $returnArray['msg'] = 'match';
1060 // foreach ($row1 as $fname => $fvalue) {
1061 // if (!isset($row2[$fname])) {
1062 // $returnArray['msg'] = 'no_match';
1064 // if(!isset($ignore_filter[$fname]) && $row1[$fname] != $row2[$fname]){
1065 // $returnArray['msg'] = 'no_match';
1071 // $returnArray['msg'] = 'not_exists_table1';
1074 // return $returnArray;
1079 * Creates an index identified by name on the given fields.
1081 * @param SugarBean $bean SugarBean instance
1082 * @param array $fieldDefs Field definitions, in vardef format
1083 * @param string $name index name
1084 * @param bool $unique optional, true if we want to create an unique index
1085 * @return bool query result
1087 public function createIndex(SugarBean $bean, $fieldDefs, $name, $unique = true)
1089 $sql = $this->createIndexSQL($bean, $fieldDefs, $name, $unique);
1090 $tablename = $bean->getTableName();
1091 $msg = "Error creating index $name on table: $tablename:";
1092 return $this->query($sql,true,$msg);
1096 * returns a SQL query that creates the indices as defined in metadata
1097 * @param array $indices Assoc array with index definitions from vardefs
1098 * @param string $table Focus table
1099 * @return array Array of SQL queries to generate indices
1101 public function getConstraintSql($indices, $table)
1103 if (!$this->isFieldArray($indices))
1104 $indices = array($indices);
1108 foreach ($indices as $index) {
1109 if(!empty($index['db']) && $index['db'] != $this->dbType)
1111 if (isset($index['source']) && $index['source'] != 'db')
1114 $sql = $this->add_drop_constraint($table, $index);
1125 * Adds a new indexes
1127 * @param string $tablename
1128 * @param array $indexes indexes to add
1129 * @param bool $execute true if we want to execute the returned sql statement
1130 * @return string SQL statement
1132 public function addIndexes($tablename, $indexes, $execute = true)
1134 $alters = $this->getConstraintSql($indexes, $tablename);
1136 foreach($alters as $sql) {
1137 $this->query($sql, true, "Error adding index: ");
1140 if(!empty($alters)) {
1141 $sql = join(";\n", $alters).";\n";
1151 * @param string $tablename
1152 * @param array $indexes indexes to drop
1153 * @param bool $execute true if we want to execute the returned sql statement
1154 * @return string SQL statement
1156 public function dropIndexes($tablename, $indexes, $execute = true)
1159 foreach ($indexes as $index) {
1160 $name =$index['name'];
1161 $sqls[$name] = $this->add_drop_constraint($tablename,$index,true);
1163 if (!empty($sqls) && $execute) {
1164 foreach($sqls as $name => $sql) {
1165 unset(self::$index_descriptions[$tablename][$name]);
1170 return join(";\n",$sqls).";";
1179 * @param string $tablename
1180 * @param array $indexes indexes to modify
1181 * @param bool $execute true if we want to execute the returned sql statement
1182 * @return string SQL statement
1184 public function modifyIndexes($tablename, $indexes, $execute = true)
1186 return $this->dropIndexes($tablename, $indexes, $execute)."\n".
1187 $this->addIndexes($tablename, $indexes, $execute);
1191 * Adds a column to table identified by field def.
1193 * @param string $tablename
1194 * @param array $fieldDefs
1195 * @return bool query result
1197 public function addColumn($tablename, $fieldDefs)
1199 $sql = $this->addColumnSQL($tablename, $fieldDefs);
1200 if ($this->isFieldArray($fieldDefs)){
1202 foreach ($fieldDefs as $fieldDef)
1203 $columns[] = $fieldDef['name'];
1204 $columns = implode(",", $columns);
1207 $columns = $fieldDefs['name'];
1209 $msg = "Error adding column(s) $columns on table: $tablename:";
1210 return $this->query($sql,true,$msg);
1214 * Alters old column identified by oldFieldDef to new fieldDef.
1216 * @param string $tablename
1217 * @param array $newFieldDef
1218 * @param bool $ignoreRequired optional, true if we are ignoring this being a required field
1219 * @return bool query result
1221 public function alterColumn($tablename, $newFieldDef, $ignoreRequired = false)
1223 $sql = $this->alterColumnSQL($tablename, $newFieldDef,$ignoreRequired);
1224 if ($this->isFieldArray($newFieldDef)){
1226 foreach ($newFieldDef as $fieldDef) {
1227 $columns[] = $fieldDef['name'];
1229 $columns = implode(",", $columns);
1232 $columns = $newFieldDef['name'];
1235 $msg = "Error altering column(s) $columns on table: $tablename:";
1236 $res = $this->query($sql,true,$msg);
1238 $this->getTableDescription($tablename, true); // reload table description after altering
1244 * Drops the table associated with a bean
1246 * @param SugarBean $bean SugarBean instance
1247 * @return bool query result
1249 public function dropTable(SugarBean $bean)
1251 return $this->dropTableName($bean->getTableName());
1255 * Drops the table by name
1257 * @param string $name Table name
1258 * @return bool query result
1260 public function dropTableName($name)
1262 $sql = $this->dropTableNameSQL($name);
1263 return $this->query($sql,true,"Error dropping table $name:");
1267 * Deletes a column identified by fieldDef.
1269 * @param SugarBean $bean SugarBean containing the field
1270 * @param array $fieldDefs Vardef definition of the field
1271 * @return bool query result
1273 public function deleteColumn(SugarBean $bean, $fieldDefs)
1275 $tablename = $bean->getTableName();
1276 $sql = $this->dropColumnSQL($tablename, $fieldDefs);
1277 $msg = "Error deleting column(s) on table: $tablename:";
1278 return $this->query($sql,true,$msg);
1282 * Generate a set of Insert statements based on the bean given
1286 * @param SugarBean $bean the bean from which table we will generate insert stmts
1287 * @param string $select_query the query which will give us the set of objects we want to place into our insert statement
1288 * @param int $start the first row to query
1289 * @param int $count the number of rows to query
1290 * @param string $table the table to query from
1291 * @param bool $is_related_query
1292 * @return string SQL insert statement
1294 public function generateInsertSQL(SugarBean $bean, $select_query, $start, $count = -1, $table, $is_related_query = false)
1296 $this->log->info('call to DBManager::generateInsertSQL() is deprecated');
1297 global $sugar_config;
1300 $count_query = $bean->create_list_count_query($select_query);
1301 if(!empty($count_query))
1303 // We have a count query. Run it and get the results.
1304 $result = $this->query($count_query, true, "Error running count query for $this->object_name List: ");
1305 $assoc = $this->fetchByAssoc($result);
1306 if(!empty($assoc['c']))
1308 $rows_found = $assoc['c'];
1312 $count = $sugar_config['list_max_entries_per_page'];
1314 $next_offset = $start + $count;
1316 $result = $this->limitQuery($select_query, $start, $count);
1318 $sql = "INSERT INTO ".$table;
1319 $custom_sql = "INSERT INTO ".$table."_cstm";
1321 // get field definitions
1322 $fields = $bean->getFieldDefinitions();
1323 $custom_fields = array();
1325 if($bean->hasCustomFields()){
1326 foreach ($fields as $fieldDef){
1327 if($fieldDef['source'] == 'custom_fields'){
1328 $custom_fields[$fieldDef['name']] = $fieldDef['name'];
1331 if(!empty($custom_fields)){
1332 $custom_fields['id_c'] = 'id_c';
1333 $id_field = array('name' => 'id_c', 'custom_type' => 'id',);
1334 $fields[] = $id_field;
1338 // get column names and values
1339 $row_array = array();
1341 $cstm_row_array = array();
1342 $cstm_columns = array();
1343 $built_columns = false;
1344 while(($row = $this->fetchByAssoc($result)) != null)
1347 $cstm_values = array();
1348 if(!$is_related_query){
1349 foreach ($fields as $fieldDef)
1351 if(isset($fieldDef['source']) && $fieldDef['source'] != 'db' && $fieldDef['source'] != 'custom_fields') continue;
1352 $val = $row[$fieldDef['name']];
1354 //handle auto increment values here only need to do this on insert not create
1355 if ($fieldDef['name'] == 'deleted'){
1356 $values['deleted'] = $val;
1357 if(!$built_columns){
1358 $columns[] = 'deleted';
1363 $type = $fieldDef['type'];
1364 if(!empty($fieldDef['custom_type'])){
1365 $type = $fieldDef['custom_type'];
1367 // need to do some thing about types of values
1368 if($this->dbType == 'mysql' && $val == '' && ($type == 'datetime' || $type == 'date' || $type == 'int' || $type == 'currency' || $type == 'decimal')){
1369 if(!empty($custom_fields[$fieldDef['name']]))
1370 $cstm_values[$fieldDef['name']] = 'null';
1372 $values[$fieldDef['name']] = 'null';
1374 if(isset($type) && $type=='int') {
1375 if(!empty($custom_fields[$fieldDef['name']]))
1376 $cstm_values[$fieldDef['name']] = $GLOBALS['db']->quote(from_html($val));
1378 $values[$fieldDef['name']] = $GLOBALS['db']->quote(from_html($val));
1380 if(!empty($custom_fields[$fieldDef['name']]))
1381 $cstm_values[$fieldDef['name']] = "'".$GLOBALS['db']->quote(from_html($val))."'";
1383 $values[$fieldDef['name']] = "'".$GLOBALS['db']->quote(from_html($val))."'";
1386 if(!$built_columns){
1387 if(!empty($custom_fields[$fieldDef['name']]))
1388 $cstm_columns[] = $fieldDef['name'];
1390 $columns[] = $fieldDef['name'];
1396 foreach ($row as $key=>$val)
1398 if($key != 'orc_row'){
1399 $values[$key] = "'$val'";
1400 if(!$built_columns){
1406 $built_columns = true;
1407 if(!empty($values)){
1408 $row_array[] = $values;
1410 if(!empty($cstm_values) && !empty($cstm_values['id_c']) && (strlen($cstm_values['id_c']) > 7)){
1411 $cstm_row_array[] = $cstm_values;
1415 //if (sizeof ($values) == 0) return ""; // no columns set
1417 // get the entire sql
1418 $sql .= "(".implode(",", $columns).") ";
1420 for($i = 0; $i < count($row_array); $i++){
1421 $sql .= " (".implode(",", $row_array[$i]).")";
1422 if($i < (count($row_array) - 1)){
1427 // get the entire sql
1428 $custom_sql .= "(".implode(",", $cstm_columns).") ";
1429 $custom_sql .= "VALUES";
1431 for($i = 0; $i < count($cstm_row_array); $i++){
1432 $custom_sql .= " (".implode(",", $cstm_row_array[$i]).")";
1433 if($i < (count($cstm_row_array) - 1)){
1434 $custom_sql .= ", ";
1437 return array('data' => $sql, 'cstm_sql' => $custom_sql, /*'result_count' => $row_count, */ 'total_count' => $rows_found, 'next_offset' => $next_offset);
1442 * Disconnects all instances
1444 public function disconnectAll()
1446 DBManagerFactory::disconnectAll();
1450 * This function sets the query threshold limit
1452 * @param int $limit value of query threshold limit
1454 public static function setQueryLimit($limit)
1456 //reset the queryCount
1457 self::$queryCount = 0;
1458 self::$queryLimit = $limit;
1462 * Returns the static queryCount value
1464 * @return int value of the queryCount static variable
1466 public static function getQueryCount()
1468 return self::$queryCount;
1473 * Resets the queryCount value to 0
1476 public static function resetQueryCount()
1478 self::$queryCount = 0;
1482 * This function increments the global $sql_queries variable
1484 public function countQuery()
1486 if (self::$queryLimit != 0 && ++self::$queryCount > self::$queryLimit
1487 &&(empty($GLOBALS['current_user']) || !is_admin($GLOBALS['current_user']))) {
1488 require_once('include/resource/ResourceManager.php');
1489 $resourceManager = ResourceManager::getInstance();
1490 $resourceManager->notifyObservers('ERR_QUERY_LIMIT');
1495 * Pre-process string for quoting
1497 * @param string $string
1500 protected function quoteInternal($string)
1502 return from_html($string);
1506 * Return string properly quoted with ''
1507 * @param string $string
1510 public function quoted($string)
1512 return "'".$this->quote($string)."'";
1516 * Quote value according to type
1517 * Numerics aren't quoted
1518 * Dates are converted and quoted
1519 * Rest is just quoted
1520 * @param string $type
1521 * @param string $value
1522 * @return string Quoted value
1524 public function quoteType($type, $value)
1526 if($type == 'date') {
1527 return $this->convert($this->quoted($value), "date");
1529 if($type == 'time') {
1530 return $this->convert($this->quoted($value), "time");
1532 if(isset($this->type_class[$type]) && $this->type_class[$type] == "date") {
1533 return $this->convert($this->quoted($value), "datetime");
1535 if($this->isNumericType($type)) {
1536 return 0+$value; // ensure it's numeric
1539 return $this->quoted($value);
1543 * Quote the strings of the passed in array
1545 * The array must only contain strings
1547 * @param array $array
1548 * @return array Quoted strings
1550 public function arrayQuote(array &$array)
1552 foreach($array as &$val) {
1553 $val = $this->quote($val);
1559 * Frees out previous results
1561 * @param resource|bool $result optional, pass if you want to free a single result instead of all results
1563 protected function freeResult($result = false)
1566 $this->freeDbResult($result);
1568 if($this->lastResult) {
1569 $this->freeDbResult($this->lastResult);
1570 $this->lastResult = null;
1576 * Check if query has LIMIT clause
1577 * Relevant for now only for Mysql
1578 * @param string $sql
1581 protected function hasLimit($sql)
1587 * Runs a query and returns a single row containing single value
1589 * @param string $sql SQL Statement to execute
1590 * @param bool $dieOnError True if we want to call die if the query returns errors
1591 * @param string $msg Message to log if error occurs
1592 * @return array single value from the query
1594 public function getOne($sql, $dieOnError = false, $msg = '')
1596 $this->log->info("Get One: |$sql|");
1597 if(!$this->hasLimit($sql)) {
1598 $queryresult = $this->limitQuery($sql, 0, 1, $dieOnError, $msg);
1600 // support old code that passes LIMIT to sql
1601 // works only for mysql, so do not rely on this
1602 $queryresult = $this->query($sql, $dieOnError, $msg);
1604 $this->checkError($msg.' Get One Failed:' . $sql, $dieOnError);
1605 if (!$queryresult) return false;
1606 $row = $this->fetchByAssoc($queryresult);
1608 return array_shift($row);
1614 * Runs a query and returns a single row
1616 * @param string $sql SQL Statement to execute
1617 * @param bool $dieOnError True if we want to call die if the query returns errors
1618 * @param string $msg Message to log if error occurs
1619 * @param bool $suppress Message to log if error occurs
1620 * @return array single row from the query
1622 public function fetchOne($sql, $dieOnError = false, $msg = '', $suppress = false)
1624 $this->log->info("Fetch One: |$sql|");
1625 $this->checkConnection();
1626 $queryresult = $this->query($sql, $dieOnError, $msg);
1627 $this->checkError($msg.' Fetch One Failed:' . $sql, $dieOnError);
1629 if (!$queryresult) return false;
1631 $row = $this->fetchByAssoc($queryresult);
1632 if ( !$row ) return false;
1634 $this->freeResult($queryresult);
1639 * Returns the number of rows affected by the last query
1641 * See also affected_rows capability, will return 0 unless the DB supports it
1642 * @param resource $result query result resource
1645 public function getAffectedRowCount($result)
1651 * Returns the number of rows returned by the result
1653 * This function can't be reliably implemented on most DB, do not use it.
1656 * @param resource $result
1659 public function getRowCount($result)
1665 * Get table description
1666 * @param string $tablename
1667 * @param bool $reload true means load from DB, false allows using cache
1668 * @return array Vardef-format table description
1671 public function getTableDescription($tablename, $reload = false)
1673 if($reload || empty(self::$table_descriptions[$tablename])) {
1674 self::$table_descriptions[$tablename] = $this->get_columns($tablename);
1676 return self::$table_descriptions[$tablename];
1680 * Returns the field description for a given field in table
1682 * @param string $name
1683 * @param string $tablename
1686 protected function describeField($name, $tablename)
1688 $table = $this->getTableDescription($tablename);
1689 if(!empty($table) && isset($table[$name]))
1690 return $table[$name];
1692 $table = $this->getTableDescription($tablename, true);
1694 if(isset($table[$name]))
1695 return $table[$name];
1701 * Returns the index description for a given index in table
1703 * @param string $name
1704 * @param string $tablename
1707 protected function describeIndex($name, $tablename)
1709 if(isset(self::$index_descriptions[$tablename]) && isset(self::$index_descriptions[$tablename]) && isset(self::$index_descriptions[$tablename][$name])){
1710 return self::$index_descriptions[$tablename][$name];
1713 self::$index_descriptions[$tablename] = $this->get_indices($tablename);
1715 if(isset(self::$index_descriptions[$tablename][$name])){
1716 return self::$index_descriptions[$tablename][$name];
1723 * Truncates a string to a given length
1725 * @param string $string
1726 * @param int $len length to trim to
1730 public function truncate($string, $len)
1732 if ( is_numeric($len) && $len > 0)
1734 $string = mb_substr($string,0,(int) $len, "UTF-8");
1740 * Returns the database string needed for concatinating multiple database strings together
1742 * @param string $table table name of the database fields to concat
1743 * @param array $fields fields in the table to concat together
1744 * @param string $space Separator between strings, default is single space
1747 public function concat($table, array $fields, $space = ' ')
1749 if(empty($fields)) return '';
1751 $space = $this->quoted($space);
1752 foreach ( $fields as $field ) {
1753 if(!empty($elems)) $elems[] = $space;
1754 $elems[] = $this->convert("$table.$field", 'IFNULL', array("''"));
1756 $first = array_shift($elems);
1757 return "LTRIM(RTRIM(".$this->convert($first, 'CONCAT', $elems)."))";
1761 * Given a sql stmt attempt to parse it into the sql and the tokens. Then return the index of this prepared statement
1762 * Tokens can come in the following forms:
1763 * ? - a scalar which will be quoted
1764 * ! - a literal which will not be quoted
1765 * & - binary data to read from a file
1767 * @param string $sql The sql to parse
1768 * @return int index of the prepared statement to be used with execute
1770 public function prepareQuery($sql)
1772 //parse out the tokens
1773 $tokens = preg_split('/((?<!\\\)[&?!])/', $sql, -1, PREG_SPLIT_DELIM_CAPTURE);
1775 //maintain a count of the actual tokens for quick reference in execute
1779 foreach ($tokens as $key => $val) {
1789 //escape any special characters
1790 $tokens[$key] = preg_replace('/\\\([&?!])/', "\\1", $val);
1791 $sqlStr .= $tokens[$key];
1796 $this->preparedTokens[] = array('tokens' => $tokens, 'tokenCount' => $count, 'sqlString' => $sqlStr);
1797 end($this->preparedTokens);
1798 return key($this->preparedTokens);
1802 * Takes a prepared stmt index and the data to replace and creates the query and runs it.
1804 * @param int $stmt The index of the prepared statement from preparedTokens
1805 * @param array $data The array of data to replace the tokens with.
1806 * @return resource result set or false on error
1808 public function executePreparedQuery($stmt, $data = array())
1810 if(!empty($this->preparedTokens[$stmt])){
1811 if(!is_array($data)){
1812 $data = array($data);
1815 $pTokens = $this->preparedTokens[$stmt];
1817 //ensure that the number of data elements matches the number of replacement tokens
1818 //we found in prepare().
1819 if(count($data) != $pTokens['tokenCount']){
1820 //error the data count did not match the token count
1826 $tokens = $pTokens['tokens'];
1827 foreach ($tokens as $val) {
1830 $query .= $this->quote($data[$dataIndex++]);
1833 $filename = $data[$dataIndex++];
1834 $query .= file_get_contents($filename);
1837 $query .= $data[$dataIndex++];
1844 return $this->query($query);
1851 * Run both prepare and execute without the client having to run both individually.
1853 * @param string $sql The sql to parse
1854 * @param array $data The array of data to replace the tokens with.
1855 * @return resource result set or false on error
1857 public function pQuery($sql, $data = array())
1859 $stmt = $this->prepareQuery($sql);
1860 return $this->executePreparedQuery($stmt, $data);
1863 /********************** SQL FUNCTIONS ****************************/
1865 * Generates sql for create table statement for a bean.
1867 * NOTE: does not handle out-of-table constraints, use createConstraintSQL for that
1868 * @param SugarBean $bean SugarBean instance
1869 * @return string SQL Create Table statement
1871 public function createTableSQL(SugarBean $bean)
1873 $tablename = $bean->getTableName();
1874 $fieldDefs = $bean->getFieldDefinitions();
1875 $indices = $bean->getIndices();
1876 return $this->createTableSQLParams($tablename, $fieldDefs, $indices);
1880 * Generates SQL for insert statement.
1882 * @param SugarBean $bean SugarBean instance
1883 * @return string SQL Create Table statement
1885 public function insertSQL(SugarBean $bean)
1887 // get column names and values
1888 $sql = $this->insertParams($bean->getTableName(), $bean->getFieldDefinitions(), get_object_vars($bean),
1889 isset($bean->field_name_map)?$bean->field_name_map:null, false);
1894 * Generates SQL for update statement.
1896 * @param SugarBean $bean SugarBean instance
1897 * @param array $where Optional, where conditions in an array
1898 * @return string SQL Create Table statement
1900 public function updateSQL(SugarBean $bean, array $where = array())
1902 $primaryField = $bean->getPrimaryFieldDefinition();
1904 $fields = $bean->getFieldDefinitions();
1905 // get column names and values
1906 foreach ($fields as $field => $fieldDef) {
1907 if (isset($fieldDef['source']) && $fieldDef['source'] != 'db') continue;
1908 // Do not write out the id field on the update statement.
1909 // We are not allowed to change ids.
1910 if ($fieldDef['name'] == $primaryField['name']) continue;
1912 // If the field is an auto_increment field, then we shouldn't be setting it. This was added
1913 // specially for Bugs and Cases which have a number associated with them.
1914 if (!empty($bean->field_name_map[$field]['auto_increment'])) continue;
1916 //custom fields handle their save seperatley
1917 if(isset($bean->field_name_map) && !empty($bean->field_name_map[$field]['custom_type'])) continue;
1919 // no need to clear deleted since we only update not deleted records anyway
1920 if($fieldDef['name'] == 'deleted' && empty($bean->deleted)) continue;
1922 if(isset($bean->$field)) {
1923 $val = from_html($bean->$field);
1928 if(!empty($fieldDef['type']) && $fieldDef['type'] == 'bool'){
1929 $val = $bean->getFieldValue($field);
1932 if(strlen($val) == 0) {
1933 if(isset($fieldDef['default']) && strlen($fieldDef['default']) > 0) {
1934 $val = $fieldDef['default'];
1940 if(!empty($val) && !empty($fieldDef['len']) && strlen($val) > $fieldDef['len']) {
1941 $val = $this->truncate($val, $fieldDef['len']);
1944 if(!is_null($val) || !empty($fieldDef['required'])) {
1945 $columns[] = "{$fieldDef['name']}=".$this->massageValue($val, $fieldDef);
1946 } elseif($this->isNullable($fieldDef)) {
1947 $columns[] = "{$fieldDef['name']}=NULL";
1949 $columns[] = "{$fieldDef['name']}=".$this->emptyValue($fieldDef['type']);
1953 if ( sizeof($columns) == 0 )
1954 return ""; // no columns set
1956 // build where clause
1957 $where = $this->getWhereClause($bean, $this->updateWhereArray($bean, $where));
1958 if(isset($fields['deleted'])) {
1959 $where .= " AND deleted=0";
1962 return "UPDATE ".$bean->getTableName()."
1963 SET ".implode(",", $columns)."
1968 * This method returns a where array so that it has id entry if
1969 * where is not an array or is empty
1971 * @param SugarBean $bean SugarBean instance
1972 * @param array $where Optional, where conditions in an array
1975 protected function updateWhereArray(SugarBean $bean, array $where = array())
1977 if (count($where) == 0) {
1978 $fieldDef = $bean->getPrimaryFieldDefinition();
1979 $primaryColumn = $fieldDef['name'];
1981 $val = $bean->getFieldValue($fieldDef['name']);
1983 $where[$primaryColumn] = $val;
1991 * Returns a where clause without the 'where' key word
1993 * The clause returned does not have an 'and' at the beginning and the columns
1994 * are joined by 'and'.
1996 * @param string $table table name
1997 * @param array $whereArray Optional, where conditions in an array
2000 protected function getColumnWhereClause($table, array $whereArray = array())
2003 foreach ($whereArray as $name => $val) {
2005 if (is_array($val)) {
2008 foreach ($val as $tval){
2009 $temp[] = $this->quoted($tval);
2011 $val = implode(",", $temp);
2014 $val = $this->quoted($val);
2017 $where[] = " $table.$name $op $val";
2021 return implode(" AND ", $where);
2027 * This method returns a complete where clause built from the
2028 * where values specified.
2030 * @param SugarBean $bean SugarBean that describes the table
2031 * @param array $whereArray Optional, where conditions in an array
2034 protected function getWhereClause(SugarBean $bean, array $whereArray=array())
2036 return " WHERE " . $this->getColumnWhereClause($bean->getTableName(), $whereArray);
2040 * Outputs a correct string for the sql statement according to value
2043 * @param array $fieldDef field definition
2046 public function massageValue($val, $fieldDef)
2048 $type = $this->getFieldType($fieldDef);
2050 if(isset($this->type_class[$type])) {
2051 // handle some known types
2052 switch($this->type_class[$type]) {
2055 if (!empty($fieldDef['required']) && $val == ''){
2056 if (isset($fieldDef['default'])){
2057 return $fieldDef['default'];
2061 return intval($val);
2064 if (!empty($fieldDef['required']) && $val == false){
2065 if (isset($fieldDef['default'])){
2066 return $fieldDef['default'];
2072 if (!empty($fieldDef['required']) && $val == ''){
2073 if (isset($fieldDef['default'])){
2074 return $fieldDef['default'];
2078 return floatval($val);
2081 // empty date can't be '', so convert it to either NULL or empty date value
2083 if (!empty($fieldDef['required'])) {
2084 if (isset($fieldDef['default'])) {
2085 return $fieldDef['default'];
2087 return $this->emptyValue($type);
2094 if(!empty($val) && !empty($fieldDef['len']) && strlen($val) > $fieldDef['len']) {
2095 $val = $this->truncate($val, $fieldDef['len']);
2099 if ( is_null($val) ) {
2100 if(!empty($fieldDef['required'])) {
2101 if (isset($fieldDef['default'])){
2102 return $fieldDef['default'];
2104 return $this->emptyValue($type);
2109 if($type == "datetimecombo") {
2112 return $this->convert($this->quoted($val), $type);
2116 * Massages the field defintions to fill in anything else the DB backend may add
2118 * @param array $fieldDef
2119 * @param string $tablename
2122 public function massageFieldDef(&$fieldDef, $tablename)
2124 if ( !isset($fieldDef['dbType']) ) {
2125 if ( isset($fieldDef['dbtype']) )
2126 $fieldDef['dbType'] = $fieldDef['dbtype'];
2128 $fieldDef['dbType'] = $fieldDef['type'];
2130 $type = $this->getColumnType($fieldDef['dbType'],$fieldDef['name'],$tablename);
2132 preg_match_all('/(\w+)(?:\(([0-9]+,?[0-9]*)\)|)/i', $type, $matches);
2133 if ( isset($matches[1][0]) )
2134 $fieldDef['type'] = $matches[1][0];
2135 if ( isset($matches[2][0]) && empty($fieldDef['len']) )
2136 $fieldDef['len'] = $matches[2][0];
2137 if ( !empty($fieldDef['precision']) && is_numeric($fieldDef['precision']) && !strstr($fieldDef['len'],',') )
2138 $fieldDef['len'] .= ",{$fieldDef['precision']}";
2139 if (!empty($fieldDef['required']) || ($fieldDef['name'] == 'id' && !isset($fieldDef['required'])) ) {
2140 $fieldDef['required'] = 'true';
2145 * Take an SQL statement and produce a list of fields used in that select
2146 * @param string $selectStatement
2149 public function getSelectFieldsFromQuery($selectStatement)
2151 $selectStatement = trim($selectStatement);
2152 if (strtoupper(substr($selectStatement, 0, 6)) == "SELECT")
2153 $selectStatement = trim(substr($selectStatement, 6));
2155 //Due to sql functions existing in many selects, we can't use php explode
2159 $strLen = strlen($selectStatement);
2160 for($i = 0; $i < $strLen; $i++)
2162 $char = $selectStatement[$i];
2164 if ($char == "," && $level == 0)
2166 $field = $this->getFieldNameFromSelect(trim($selectField));
2167 $fields[$field] = $selectField;
2170 else if ($char == "("){
2172 $selectField .= $char;
2174 else if($char == ")"){
2176 $selectField .= $char;
2180 $selectField .= $char;
2184 $fields[$this->getFieldNameFromSelect($selectField)] = $selectField;
2189 * returns the field name used in a select
2190 * @param string $string SELECT query
2193 protected function getFieldNameFromSelect($string)
2195 if(strncasecmp($string, "DISTINCT ", 9) == 0) {
2196 $string = substr($string, 9);
2198 if (stripos($string, " as ") !== false)
2199 //"as" used for an alias
2200 return trim(substr($string, strripos($string, " as ") + 4));
2201 else if (strrpos($string, " ") != 0)
2202 //Space used as a delimeter for an alias
2203 return trim(substr($string, strrpos($string, " ")));
2204 else if (strpos($string, ".") !== false)
2205 //No alias, but a table.field format was used
2206 return substr($string, strpos($string, ".") + 1);
2208 //Give up and assume the whole thing is the field name
2213 * Generates SQL for delete statement identified by id.
2215 * @param SugarBean $bean SugarBean instance
2216 * @param array $where where conditions in an array
2217 * @return string SQL Update Statement
2219 public function deleteSQL(SugarBean $bean, array $where)
2221 $where = $this->getWhereClause($bean, $this->updateWhereArray($bean, $where));
2222 return "UPDATE ".$bean->getTableName()." SET deleted=1 $where";
2226 * Generates SQL for select statement for any bean identified by id.
2228 * @param SugarBean $bean SugarBean instance
2229 * @param array $where where conditions in an array
2230 * @return string SQL Select Statement
2232 public function retrieveSQL(SugarBean $bean, array $where)
2234 $where = $this->getWhereClause($bean, $this->updateWhereArray($bean, $where));
2235 return "SELECT * FROM ".$bean->getTableName()." $where AND deleted=0";
2239 * This method implements a generic sql for a collection of beans.
2241 * Currently, this function does not support outer joins.
2243 * @param array $beans Array of values returned by get_class method as the keys and a bean as
2244 * the value for that key. These beans will be joined in the sql by the key
2245 * attribute of field defs.
2246 * @param array $cols Optional, columns to be returned with the keys as names of bean
2247 * as identified by get_class of bean. Values of this array is the array of fieldDefs
2248 * to be returned for a bean. If an empty array is passed, all columns are selected.
2249 * @param array $whereClause Optional, values with the keys as names of bean as identified
2250 * by get_class of bean. Each value at the first level is an array of values for that
2251 * bean identified by name of fields. If we want to pass multiple values for a name,
2252 * pass it as an array. If where is not passed, all the rows will be returned.
2254 * @return string SQL Select Statement
2256 public function retrieveViewSQL(array $beans, array $cols = array(), array $whereClause = array())
2258 $relations = array(); // stores relations between tables as they are discovered
2259 $where = $select = array();
2260 foreach ($beans as $beanID => $bean) {
2261 $tableName = $bean->getTableName();
2262 $beanTables[$beanID] = $tableName;
2265 $tables[$table] = $tableName;
2266 $aliases[$tableName][] = $table;
2268 // build part of select for this table
2269 if (is_array($cols[$beanID]))
2270 foreach ($cols[$beanID] as $def) $select[] = $table.".".$def['name'];
2272 // build part of where clause
2273 if (is_array($whereClause[$beanID])){
2274 $where[] = $this->getColumnWhereClause($table, $whereClause[$beanID]);
2276 // initialize so that it can be used properly in form clause generation
2277 $table_used_in_from[$table] = false;
2279 $indices = $bean->getIndices();
2280 foreach ($indices as $index){
2281 if ($index['type'] == 'foreign') {
2282 $relationship[$table][] = array('foreignTable'=> $index['foreignTable']
2283 ,'foreignColumn'=>$index['foreignField']
2284 ,'localColumn'=> $index['fields']
2288 $where[] = " $table.deleted = 0";
2291 // join these clauses
2292 $select = !empty($select) ? implode(",", $select) : "*";
2293 $where = implode(" AND ", $where);
2295 // generate the from clause. Use relations array to generate outer joins
2296 // all the rest of the tables will be used as a simple from
2297 // relations table define relations between table1 and table2 through column on table 1
2298 // table2 is assumed to joing through primaty key called id
2300 $from = ''; $table_used_in_from = array();
2301 foreach ($relations as $table1 => $rightsidearray){
2302 if ($table_used_in_from[$table1]) continue; // table has been joined
2304 $from .= $separator." ".$table1;
2305 $table_used_in_from[$table1] = true;
2306 foreach ($rightsidearray as $tablearray){
2307 $table2 = $tablearray['foreignTable']; // get foreign table
2308 $tableAlias = $aliases[$table2]; // get a list of aliases fo thtis table
2309 foreach ($tableAlias as $table2) {
2310 //choose first alias that does not match
2311 // we are doing this because of self joins.
2312 // in case of self joins, the same table will bave many aliases.
2313 if ($table2 != $table1) break;
2316 $col = $tablearray['foreingColumn'];
2317 $name = $tablearray['localColumn'];
2318 $from .= " LEFT JOIN $table on ($table1.$name = $table2.$col)";
2319 $table_used_in_from[$table2] = true;
2324 return "SELECT $select FROM $from WHERE $where";
2328 * Generates SQL for create index statement for a bean.
2330 * @param SugarBean $bean SugarBean instance
2331 * @param array $fields fields used in the index
2332 * @param string $name index name
2333 * @param bool $unique Optional, set to true if this is an unique index
2334 * @return string SQL Select Statement
2336 public function createIndexSQL(SugarBean $bean, array $fields, $name, $unique = true)
2338 $unique = ($unique) ? "unique" : "";
2339 $tablename = $bean->getTableName();
2342 foreach ($fields as $fieldDef)
2343 $columns[] = $fieldDef['name'];
2345 if (empty($columns))
2348 $columns = implode(",", $columns);
2350 return "CREATE $unique INDEX $name ON $tablename ($columns)";
2354 * Returns the type of the variable in the field
2356 * @param array $fieldDef Vardef-format field def
2359 public function getFieldType($fieldDef)
2361 // get the type for db type. if that is not set,
2362 // get it from type. This is done so that
2363 // we do not have change a lot of existing code
2364 // and add dbtype where type is being used for some special
2365 // purposes like referring to foreign table etc.
2366 if(!empty($fieldDef['dbType']))
2367 return $fieldDef['dbType'];
2368 if(!empty($fieldDef['dbtype']))
2369 return $fieldDef['dbtype'];
2370 if (!empty($fieldDef['type']))
2371 return $fieldDef['type'];
2372 if (!empty($fieldDef['Type']))
2373 return $fieldDef['Type'];
2374 if (!empty($fieldDef['data_type']))
2375 return $fieldDef['data_type'];
2381 * retrieves the different components from the passed column type as it is used in the type mapping and vardefs
2382 * type format: <baseType>[(<len>[,<scale>])]
2383 * @param string $type Column type
2384 * @return array|bool array containing the different components of the passed in type or false in case the type contains illegal characters
2386 public function getTypeParts($type) {
2387 if(preg_match("((?'type'\w+)\s*(?'arg'\((?'len'\w+)\s*(,\s*(?'scale'\d+))*\))*)", $type, $matches))
2389 $return = array(); // Not returning matches array as such as we don't want to expose the regex make up on the interface
2390 $return['baseType'] = $matches['type'];
2391 if( isset($matches['arg'])) {
2392 $return['arg'] = $matches['arg'];
2394 if( isset($matches['len'])) {
2395 $return['len'] = $matches['len'];
2397 if( isset($matches['scale'])) {
2398 $return['scale'] = $matches['scale'];
2407 * Returns the defintion for a single column
2409 * @param array $fieldDef Vardef-format field def
2410 * @param bool $ignoreRequired Optional, true if we should ignore this being a required field
2411 * @param string $table Optional, table name
2412 * @param bool $return_as_array Optional, true if we should return the result as an array instead of sql
2413 * @return string or array if $return_as_array is true
2415 protected function oneColumnSQLRep($fieldDef, $ignoreRequired = false, $table = '', $return_as_array = false)
2417 $name = $fieldDef['name'];
2418 $type = $this->getFieldType($fieldDef);
2419 $colType = $this->getColumnType($type);
2421 if($parts = $this->getTypeParts($colType))
2423 $colBaseType = $parts['baseType'];
2424 $defLen = isset($parts['len']) ? $parts['len'] : '255'; // Use the mappings length (precision) as default if it exists
2427 if(!empty($fieldDef['len'])) {
2428 if (in_array($colBaseType, array( 'nvarchar', 'nchar', 'varchar', 'varchar2', 'char',
2429 'clob', 'blob', 'text'))) {
2430 $colType = "$colBaseType(${fieldDef['len']})";
2431 } elseif(($colBaseType == 'decimal' || $colBaseType == 'float')){
2432 if(!empty($fieldDef['precision']) && is_numeric($fieldDef['precision']))
2433 if(strpos($fieldDef['len'],',') === false){
2434 $colType = $colBaseType . "(".$fieldDef['len'].",".$fieldDef['precision'].")";
2436 $colType = $colBaseType . "(".$fieldDef['len'].")";
2439 $colType = $colBaseType . "(".$fieldDef['len'].")";
2442 if (in_array($colBaseType, array( 'nvarchar', 'nchar', 'varchar', 'varchar2', 'char'))) {
2443 $colType = "$colBaseType($defLen)";
2447 if (isset($fieldDef['default']) && strlen($fieldDef['default']) > 0)
2448 $default = " DEFAULT ".$this->quoted($fieldDef['default']);
2449 elseif (!isset($default) && $type == 'bool')
2450 $default = " DEFAULT 0 ";
2451 elseif (!isset($default))
2454 $auto_increment = '';
2455 if(!empty($fieldDef['auto_increment']) && $fieldDef['auto_increment'])
2456 $auto_increment = $this->setAutoIncrement($table , $fieldDef['name']);
2458 $required = 'NULL'; // MySQL defaults to NULL, SQL Server defaults to NOT NULL -- must specify
2459 //Starting in 6.0, only ID and auto_increment fields will be NOT NULL in the DB.
2460 if ((empty($fieldDef['isnull']) || strtolower($fieldDef['isnull']) == 'false') &&
2461 (!empty($auto_increment) || $name == 'id' || ($fieldDef['type'] == 'id' && !empty($fieldDef['required'])))) {
2462 $required = "NOT NULL";
2464 // If the field is marked both required & isnull=>false - alwqys make it not null
2465 // Use this to ensure primary key fields never defined as null
2466 if(isset($fieldDef['isnull']) && (strtolower($fieldDef['isnull']) == 'false' || $fieldDef['isnull'] === false)
2467 && !empty($fieldDef['required'])) {
2468 $required = "NOT NULL";
2470 if ($ignoreRequired)
2473 if ( $return_as_array ) {
2476 'colType' => $colType,
2477 'colBaseType' => $colBaseType, // Adding base type for easier processing in derived classes
2478 'default' => $default,
2479 'required' => $required,
2480 'auto_increment' => $auto_increment,
2481 'full' => "$name $colType $default $required $auto_increment",
2484 return "$name $colType $default $required $auto_increment";
2489 * Returns SQL defintions for all columns in a table
2491 * @param array $fieldDefs Vardef-format field def
2492 * @param bool $ignoreRequired Optional, true if we should ignor this being a required field
2493 * @param string $tablename Optional, table name
2494 * @return string SQL column definitions
2496 protected function columnSQLRep($fieldDefs, $ignoreRequired = false, $tablename)
2500 if ($this->isFieldArray($fieldDefs)) {
2501 foreach ($fieldDefs as $fieldDef) {
2502 if(!isset($fieldDef['source']) || $fieldDef['source'] == 'db') {
2503 $columns[] = $this->oneColumnSQLRep($fieldDef,false, $tablename);
2506 $columns = implode(",", $columns);
2509 $columns = $this->oneColumnSQLRep($fieldDefs,$ignoreRequired, $tablename);
2516 * Returns the next value for an auto increment
2518 * @param string $table Table name
2519 * @param string $field_name Field name
2522 public function getAutoIncrement($table, $field_name)
2528 * Returns the sql for the next value in a sequence
2530 * @param string $table Table name
2531 * @param string $field_name Field name
2534 public function getAutoIncrementSQL($table, $field_name)
2540 * Either creates an auto increment through queries or returns sql for auto increment
2541 * that can be appended to the end of column defination (mysql)
2543 * @param string $table Table name
2544 * @param string $field_name Field name
2547 protected function setAutoIncrement($table, $field_name)
2549 $this->deleteAutoIncrement($table, $field_name);
2554 * Sets the next auto-increment value of a column to a specific value.
2556 * @param string $table Table name
2557 * @param string $field_name Field name
2558 * @param int $start_value Starting autoincrement value
2562 public function setAutoIncrementStart($table, $field_name, $start_value)
2568 * Deletes an auto increment
2570 * @param string $table tablename
2571 * @param string $field_name
2573 public function deleteAutoIncrement($table, $field_name)
2579 * This method generates sql for adding a column to table identified by field def.
2581 * @param string $tablename
2582 * @param array $fieldDefs
2583 * @return string SQL statement
2585 public function addColumnSQL($tablename, $fieldDefs)
2587 return $this->changeColumnSQL($tablename, $fieldDefs, 'add');
2591 * This method genrates sql for altering old column identified by oldFieldDef to new fieldDef.
2593 * @param string $tablename
2594 * @param array $newFieldDefs
2595 * @param bool $ignorerequired Optional, true if we should ignor this being a required field
2596 * @return string|array SQL statement(s)
2598 public function alterColumnSQL($tablename, $newFieldDefs, $ignorerequired = false)
2600 return $this->changeColumnSQL($tablename, $newFieldDefs, 'modify', $ignorerequired);
2604 * Generates SQL for dropping a table.
2606 * @param SugarBean $bean Sugarbean instance
2607 * @return string SQL statement
2609 public function dropTableSQL(SugarBean $bean)
2611 return $this->dropTableNameSQL($bean->getTableName());
2615 * Generates SQL for dropping a table.
2617 * @param string $name table name
2618 * @return string SQL statement
2620 public function dropTableNameSQL($name)
2622 return "DROP TABLE ".$name;
2626 * Generates SQL for truncating a table.
2627 * @param string $name table name
2630 public function truncateTableSQL($name)
2632 return "TRUNCATE $name";
2636 * This method generates sql that deletes a column identified by fieldDef.
2638 * @param SugarBean $bean Sugarbean instance
2639 * @param array $fieldDefs
2640 * @return string SQL statement
2642 public function deleteColumnSQL(SugarBean $bean, $fieldDefs)
2644 return $this->dropColumnSQL($bean->getTableName(), $fieldDefs);
2648 * This method generates sql that drops a column identified by fieldDef.
2649 * Designed to work like the other addColumnSQL() and alterColumnSQL() functions
2651 * @param string $tablename
2652 * @param array $fieldDefs
2653 * @return string SQL statement
2655 public function dropColumnSQL($tablename, $fieldDefs)
2657 return $this->changeColumnSQL($tablename, $fieldDefs, 'drop');
2661 * Return a version of $proposed that can be used as a column name in any of our supported databases
2662 * Practically this means no longer than 25 characters as the smallest identifier length for our supported DBs is 30 chars for Oracle plus we add on at least four characters in some places (for indicies for example)
2663 * @param string|array $name Proposed name for the column
2664 * @param bool|string $ensureUnique Ensure the name is unique
2665 * @param string $type Name type (table, column)
2666 * @param bool $force Force new name
2667 * @return string|array Valid column name trimmed to right length and with invalid characters removed
2669 public function getValidDBName($name, $ensureUnique = false, $type = 'column', $force = false)
2671 if(is_array($name)) {
2673 foreach($name as $field) {
2674 $result[] = $this->getValidDBName($field, $ensureUnique, $type);
2678 if(strchr($name, ".")) {
2679 // this is a compound name with dots, handle separately
2680 $parts = explode(".", $name);
2681 if(count($parts) > 2) {
2682 // some weird name, cut to table.name
2683 array_splice($parts, 0, count($parts)-2);
2684 $parts = $this->getValidDBName($parts, $ensureUnique, $type, $force);
2685 return join(".", $parts);
2688 // first strip any invalid characters - all but word chars (which is alphanumeric and _)
2689 $name = preg_replace( '/[^\w]+/i', '', $name ) ;
2690 $len = strlen( $name ) ;
2691 $maxLen = empty($this->maxNameLengths[$type]) ? $this->maxNameLengths[$type]['column'] : $this->maxNameLengths[$type];
2692 if ($len <= $maxLen && !$force) {
2693 return strtolower($name);
2695 if ($ensureUnique) {
2696 $md5str = md5($name);
2697 $tail = substr ( $name, -11) ;
2698 $temp = substr($md5str , strlen($md5str)-4 );
2699 $result = substr( $name, 0, 10) . $temp . $tail ;
2701 $result = substr( $name, 0, 11) . substr( $name, 11 - $maxLen);
2704 return strtolower( $result ) ;
2709 * Returns the valid type for a column given the type in fieldDef
2711 * @param string $type field type
2712 * @return string valid type for the given field
2714 public function getColumnType($type)
2716 return isset($this->type_map[$type])?$this->type_map[$type]:$type;
2720 * Checks to see if passed array is truely an array of defitions
2722 * Such an array may have type as a key but it will point to an array
2723 * for a true array of definitions an to a col type for a definition only
2725 * @param mixed $defArray
2728 public function isFieldArray($defArray)
2730 if ( !is_array($defArray) )
2733 if ( isset($defArray['type']) ){
2734 // type key exists. May be an array of defs or a simple definition
2735 return is_array($defArray['type']); // type is not an array => definition else array
2738 // type does not exist. Must be array of definitions
2743 * returns true if the type can be mapped to a valid column type
2745 * @param string $type
2748 protected function validColumnType($type)
2750 $type = $this->getColumnType($type);
2751 return !empty($type);
2755 * Generate query for audit table
2756 * @param SugarBean $bean SugarBean that was changed
2757 * @param array $changes List of changes, contains 'before' and 'after'
2758 * @return string Audit table INSERT query
2760 protected function auditSQL(SugarBean $bean, $changes)
2762 global $current_user;
2763 $sql = "INSERT INTO ".$bean->get_audit_table_name();
2764 //get field defs for the audit table.
2765 require('metadata/audit_templateMetaData.php');
2766 $fieldDefs = $dictionary['audit']['fields'];
2769 $values['id'] = $this->massageValue(create_guid(), $fieldDefs['id']);
2770 $values['parent_id']= $this->massageValue($bean->id, $fieldDefs['parent_id']);
2771 $values['field_name']= $this->massageValue($changes['field_name'], $fieldDefs['field_name']);
2772 $values['data_type'] = $this->massageValue($changes['data_type'], $fieldDefs['data_type']);
2773 if ($changes['data_type']=='text') {
2774 $bean->fetched_row[$changes['field_name']]=$changes['after'];;
2775 $values['before_value_text'] = $this->massageValue($changes['before'], $fieldDefs['before_value_text']);
2776 $values['after_value_text'] = $this->massageValue($changes['after'], $fieldDefs['after_value_text']);
2778 $bean->fetched_row[$changes['field_name']]=$changes['after'];;
2779 $values['before_value_string'] = $this->massageValue($changes['before'], $fieldDefs['before_value_string']);
2780 $values['after_value_string'] = $this->massageValue($changes['after'], $fieldDefs['after_value_string']);
2782 $values['date_created'] = $this->massageValue(TimeDate::getInstance()->nowDb(), $fieldDefs['date_created'] );
2783 $values['created_by'] = $this->massageValue($current_user->id, $fieldDefs['created_by']);
2785 $sql .= "(".implode(",", array_keys($values)).") ";
2786 $sql .= "VALUES(".implode(",", $values).")";
2791 * Saves changes to module's audit table
2793 * @param SugarBean $bean Sugarbean instance that was changed
2794 * @param array $changes List of changes, contains 'before' and 'after'
2795 * @return bool query result
2798 public function save_audit_records(SugarBean $bean, $changes)
2800 return $this->query($this->auditSQL($bean, $changes));
2804 * Uses the audit enabled fields array to find fields whose value has changed.
2805 * The before and after values are stored in the bean.
2806 * Uses $bean->fetched_row to compare
2808 * @param SugarBean $bean Sugarbean instance that was changed
2811 public function getDataChanges(SugarBean &$bean)
2813 $changed_values=array();
2814 $audit_fields=$bean->getAuditEnabledFieldDefinitions();
2816 if (is_array($audit_fields) and count($audit_fields) > 0) {
2817 foreach ($audit_fields as $field=>$properties) {
2818 if (!empty($bean->fetched_row) && array_key_exists($field, $bean->fetched_row)) {
2819 $before_value=$bean->fetched_row[$field];
2820 $after_value=$bean->$field;
2821 if (isset($properties['type'])) {
2822 $field_type=$properties['type'];
2824 if (isset($properties['dbType']))
2825 $field_type=$properties['dbType'];
2826 else if(isset($properties['data_type']))
2827 $field_type=$properties['data_type'];
2829 $field_type=$properties['dbtype'];
2832 //Because of bug #25078(sqlserver haven't 'date' type, trim extra "00:00:00" when insert into *_cstm table).
2833 // so when we read the audit datetime field from sqlserver, we have to replace the extra "00:00:00" again.
2834 if(!empty($field_type) && $field_type == 'date'){
2835 $before_value = $this->fromConvert($before_value , $field_type);
2837 //if the type and values match, do nothing.
2838 if (!($this->_emptyValue($before_value,$field_type) && $this->_emptyValue($after_value,$field_type))) {
2839 if (trim($before_value) !== trim($after_value)) {
2840 // Bug #42475: Don't directly compare numeric values, instead do the subtract and see if the comparison comes out to be "close enough", it is necessary for floating point numbers.
2841 // Manual merge of fix 95727f2eed44852f1b6bce9a9eccbe065fe6249f from DBHelper
2842 // This fix also fixes Bug #44624 in a more generic way and therefore eliminates the need for fix 0a55125b281c4bee87eb347709af462715f33d2d in DBHelper
2843 if (!($this->isNumericType($field_type) &&
2845 2*((trim($before_value)+0)-(trim($after_value)+0))/((trim($before_value)+0)+(trim($after_value)+0)) // Using relative difference so that it also works for other numerical types besides currencies
2846 )<0.0000000001)) { // Smaller than 10E-10
2847 if (!($this->isBooleanType($field_type) && ($this->_getBooleanValue($before_value)== $this->_getBooleanValue($after_value)))) {
2848 $changed_values[$field]=array('field_name'=>$field,
2849 'data_type'=>$field_type,
2850 'before'=>$before_value,
2851 'after'=>$after_value);
2859 return $changed_values;
2866 public function full_text_indexing_setup()
2868 // Most DBs have nothing to setup, so provide default empty function
2872 * Quotes a string for storing in the database
2874 * Return value will be not surrounded by quotes
2876 * @param string $string
2879 public function escape_quote($string)
2881 return $this->quote($string);
2885 * Quotes a string for storing in the database
2887 * Return value will be not surrounded by quotes
2889 * @param string $string
2892 public function quoteFormEmail($string)
2894 return $this->quote($string);
2898 * Renames an index using fields definition
2900 * @param array $old_definition
2901 * @param array $new_definition
2902 * @param string $table_name
2903 * @return string SQL statement
2905 public function renameIndexDefs($old_definition, $new_definition, $table_name)
2907 return array($this->add_drop_constraint($table_name,$old_definition,true),
2908 $this->add_drop_constraint($table_name,$new_definition), false);
2912 * Check if type is boolean
2913 * @param string $type
2916 public function isBooleanType($type)
2918 return 'bool' == $type;
2922 * Get truth value for boolean type
2923 * Allows 'off' to mean false, along with all 'empty' values
2927 protected function _getBooleanValue($val)
2929 //need to put the === sign here otherwise true == 'non empty string'
2930 if (empty($val) or $val==='off')
2937 * Check if type is a number
2938 * @param string $type
2941 public function isNumericType($type)
2943 if(isset($this->type_class[$type]) && ($this->type_class[$type] == 'int' || $this->type_class[$type] == 'float')) {
2950 * Check if the value is empty value for this type
2951 * @param mixed $val Value
2952 * @param string $type Type (one of vardef types)
2953 * @return bool true if the value if empty
2955 protected function _emptyValue($val, $type)
2960 if($this->emptyValue($type) == $val) {
2975 if ($val == '0000-00-00')
2987 * Does this type represent text (i.e., non-varchar) value?
2988 * @param string $type
2991 public function isTextType($type)
2997 * Check if this DB supports certain capability
2998 * See $this->capabilities for the list
2999 * @param string $cap
3002 public function supports($cap)
3004 return !empty($this->capabilities[$cap]);
3008 * Create ORDER BY clause for ENUM type field
3009 * @param string $order_by Field name
3010 * @param array $values Possible enum value
3011 * @param string $order_dir Order direction, ASC or DESC
3014 public function orderByEnum($order_by, $values, $order_dir)
3017 $order_by_arr = array();
3018 foreach ($values as $key => $value) {
3020 $order_by_arr[] = "WHEN ($order_by='' OR $order_by IS NULL) THEN $i";
3022 $order_by_arr[] = "WHEN $order_by=".$this->quoted($key)." THEN $i";
3026 return "CASE ".implode("\n", $order_by_arr)." ELSE $i END $order_dir\n";
3030 * Return representation of an empty value depending on type
3031 * The value is fully quoted, converted, etc.
3032 * @param string $type
3033 * @return mixed Empty value
3035 public function emptyValue($type)
3037 if(isset($this->type_class[$type]) && ($this->type_class[$type] == 'bool' || $this->type_class[$type] == 'int' || $this->type_class[$type] == 'float')) {
3045 * List of available collation settings
3049 public function getDefaultCollation()
3055 * List of available collation settings
3059 public function getCollationList()
3065 * Returns the number of columns in a table
3067 * @param string $table_name
3070 public function number_of_columns($table_name)
3072 $table = $this->getTableDescription($table_name);
3073 return count($table);
3077 * Return limit query based on given query
3078 * @param string $sql
3081 * @param bool $dieOnError
3082 * @param string $msg
3083 * @return resource|bool query result
3084 * @see DBManager::limitQuery()
3086 public function limitQuerySql($sql, $start, $count, $dieOnError=false, $msg='')
3088 return $this->limitQuery($sql,$start,$count,$dieOnError,$msg,false);
3092 * Return current time in format fit for insertion into DB (with quotes)
3095 public function now()
3097 return $this->convert($this->quoted(TimeDate::getInstance()->nowDb()), "datetime");
3101 * Check if connecting user has certain privilege
3102 * @param string $privilege
3103 * @return bool Privilege allowed?
3105 public function checkPrivilege($privilege)
3107 switch($privilege) {
3108 case "CREATE TABLE":
3109 $this->query("CREATE TABLE temp (id varchar(36))");
3112 $sql = $this->dropTableNameSQL("temp");
3116 $this->query("INSERT INTO temp (id) VALUES ('abcdef0123456789abcdef0123456789abcd')");
3119 $this->query("UPDATE temp SET id = '100000000000000000000000000000000000' WHERE id = 'abcdef0123456789abcdef0123456789abcd'");
3122 return $this->getOne('SELECT id FROM temp WHERE id=\'100000000000000000000000000000000000\'', false);
3124 $this->query("DELETE FROM temp WHERE id = '100000000000000000000000000000000000'");
3127 $test = array("test" => array("name" => "test", "type" => "varchar", "len" => 50));
3128 $sql = $this->changeColumnSQL("temp", $test, "add");
3131 case "CHANGE COLUMN":
3132 $test = array("test" => array("name" => "test", "type" => "varchar", "len" => 100));
3133 $sql = $this->changeColumnSQL("temp", $test, "modify");
3137 $test = array("test" => array("name" => "test", "type" => "varchar", "len" => 100));
3138 $sql = $this->changeColumnSQL("temp", $test, "drop");
3144 if($this->checkError("Checking privileges")) {
3151 * Check if the query is a select query
3152 * @param string $query
3153 * @return bool Is query SELECT?
3155 protected function isSelect($query)
3157 $query = trim($query);
3158 $select_check = strpos(strtolower($query), strtolower("SELECT"));
3159 //Checks to see if there is union select which is valid
3160 $select_check2 = strpos(strtolower($query), strtolower("(SELECT"));
3161 if($select_check==0 || $select_check2==0){
3162 //Returning false means query is ok!
3169 * Parse fulltext search query with mysql syntax:
3170 * terms quoted by ""
3171 * + means the term must be included
3172 * - means the term must be excluded
3173 * * or % at the end means wildcard
3174 * @param string $query
3175 * @return array of 3 elements - query terms, mandatory terms and excluded terms
3177 public function parseFulltextQuery($query)
3179 /* split on space or comma, double quotes with \ for escape */
3180 if(strpbrk($query, " ,")) {
3181 // ("([^"]*?)"|[^" ,]+)((, )+)?
3182 // '/([^" ,]+|".*?[^\\\\]")(,|\s)\s*/'
3183 if(!preg_match_all('/("([^"]*?)"|[^"\s,]+)((,\s)+)?/', $query, $m)) {
3188 $qterms = array($query);
3190 $terms = $must_terms = $not_terms = array();
3191 foreach($qterms as $item) {
3192 if($item[0] == '"') {
3193 $item = trim($item, '"');
3195 if($item[0] == '+') {
3196 if (strlen($item) > 1) {
3197 $must_terms[] = substr($item, 1);
3201 if($item[0] == '-') {
3202 if (strlen($item) > 1) {
3203 $not_terms[] = substr($item, 1);
3209 return array($terms, $must_terms, $not_terms);
3212 // Methods to check respective queries
3213 protected $standardQueries = array(
3214 'ALTER TABLE' => 'verifyAlterTable',
3215 'DROP TABLE' => 'verifyDropTable',
3216 'CREATE TABLE' => 'verifyCreateTable',
3217 'INSERT INTO' => 'verifyInsertInto',
3218 'UPDATE' => 'verifyUpdate',
3219 'DELETE FROM' => 'verifyDeleteFrom',
3224 * Extract table name from a query
3225 * @param string $query SQL query
3228 protected function extractTableName($query)
3230 $query = preg_replace('/[^A-Za-z0-9_\s]/', "", $query);
3231 $query = trim(str_replace(array_keys($this->standardQueries), '', $query));
3233 $firstSpc = strpos($query, " ");
3234 $end = ($firstSpc > 0) ? $firstSpc : strlen($query);
3235 $table = substr($query, 0, $end);
3241 * Verify SQl statement using per-DB verification function
3242 * provided the function exists
3243 * @param string $query Query to verify
3244 * @param array $skipTables List of blacklisted tables that aren't checked
3247 public function verifySQLStatement($query, $skipTables)
3249 $query = trim($query);
3250 foreach($this->standardQueries as $qstart => $check) {
3251 if(strncasecmp($qstart, $query, strlen($qstart)) == 0) {
3252 if(is_callable(array($this, $check))) {
3253 $table = $this->extractTableName($query);
3254 if(!in_array($table, $skipTables)) {
3255 return call_user_func(array($this, $check), $table, $query);
3257 $this->log->debug("Skipping table $table as blacklisted");
3260 $this->log->debug("No verification for $qstart on {$this->dbType}");
3269 * Tests an CREATE TABLE query
3270 * @param string $table The table name to get DDL
3271 * @param string $query The query to test.
3272 * @return string Non-empty if error found
3274 protected function verifyCreateTable($table, $query)
3276 $this->log->debug('verifying CREATE statement...');
3278 // rewrite DDL with _temp name
3279 $this->log->debug('testing query: ['.$query.']');
3280 $tempname = $table."__uw_temp";
3281 $tempTableQuery = str_replace("CREATE TABLE {$table}", "CREATE TABLE $tempname", $query);
3283 if(strpos($tempTableQuery, '__uw_temp') === false) {
3284 return 'Could not use a temp table to test query!';
3287 $this->query($tempTableQuery, false, "Preflight Failed for: {$query}");
3289 $error = $this->lastError(); // empty on no-errors
3290 if(!empty($error)) {
3294 // check if table exists
3295 $this->log->debug('testing for table: '.$table);
3296 if(!$this->tableExists($tempname)) {
3297 return "Failed to create temp table!";
3300 $this->dropTableName($tempname);
3305 * Execute multiple queries one after another
3306 * @param array $sqls Queries
3307 * @param bool $dieOnError Die on error, passed to query()
3308 * @param string $msg Error message, passed to query()
3309 * @param bool $suppress Supress errors, passed to query()
3310 * @return resource|bool result set or success/failure bool
3312 public function queryArray(array $sqls, $dieOnError = false, $msg = '', $suppress = false)
3315 foreach($sqls as $sql) {
3316 if(!($last = $this->query($sql, $dieOnError, $msg, $suppress))) {
3324 * Fetches the next row in the query result into an associative array
3326 * @param resource $result
3327 * @param bool $encode Need to HTML-encode the result?
3328 * @return array returns false if there are no more rows available to fetch
3330 public function fetchByAssoc($result, $encode = true)
3332 if (empty($result)) return false;
3334 if(is_int($encode) && func_num_args() == 3) {
3335 // old API: $result, $rowNum, $encode
3336 $GLOBALS['log']->deprecated("Using row number in fetchByAssoc is not portable and no longer supported. Please fix your code.");
3337 $encode = func_get_arg(2);
3339 $row = $this->fetchRow($result);
3340 if (!empty($row) && $encode && $this->encode) {
3341 return array_map('to_html', $row);
3348 * Get DB driver name used for install/upgrade scripts
3351 public function getScriptName()
3353 // Usually the same name as dbType
3354 return $this->dbType;
3358 * Set database options
3359 * Options are usually db-dependant and derive from $config['dbconfigoption']
3360 * @param array $options
3363 public function setOptions($options)
3365 $this->options = $options;
3373 public function getOptions()
3375 return $this->options;
3379 * Get DB option by name
3380 * @param string $option Option name
3381 * @return mixed Option value or null if doesn't exist
3383 public function getOption($option)
3385 if(isset($this->options[$option])) {
3386 return $this->options[$option];
3392 * Commits pending changes to the database when the driver is setup to support transactions.
3393 * Note that the default implementation is applicable for transaction-less or auto commit scenarios.
3395 * @return bool true if commit succeeded, false if it failed
3397 public function commit()
3399 $this->log->info("DBManager.commit() stub");
3404 * Rollsback pending changes to the database when the driver is setup to support transactions.
3405 * Note that the default implementation is applicable for transaction-less or auto commit scenarios.
3406 * Since rollbacks cannot be done, this implementation always returns false.
3408 * @return bool true if rollback succeeded, false if it failed
3410 public function rollback()
3412 $this->log->info("DBManager.rollback() stub");
3417 * Check if this DB name is valid
3419 * @param string $name
3422 public function isDatabaseNameValid($name)
3424 // Generic case - no slashes, no dots
3425 return preg_match('#[/.\\\\]#', $name)==0;
3429 * Check special requirements for DB installation.
3431 * If everything is OK, return true.
3432 * If something's wrong, return array of error code and parameters
3435 public function canInstall()
3442 * Code run on new database before installing
3444 public function preInstall()
3450 * Code run on new database after installing
3452 public function postInstall()
3457 * Disable keys on the table
3459 * @param string $tableName
3461 public function disableKeys($tableName)
3466 * Re-enable keys on the table
3468 * @param string $tableName
3470 public function enableKeys($tableName)
3475 * Quote string in DB-specific manner
3476 * @param string $string
3479 abstract public function quote($string);
3482 * Use when you need to convert a database string to a different value; this function does it in a
3483 * database-backend aware way
3484 * Supported conversions:
3485 * today return current date
3486 * left Take substring from the left
3487 * date_format Format date as string, supports %Y-%m-%d, %Y-%m, %Y
3488 * time_format Format time as string
3489 * date Convert date string to datetime value
3490 * time Convert time string to datetime value
3491 * datetime Convert datetime string to datetime value
3492 * ifnull If var is null, use default value
3493 * concat Concatenate strings
3494 * quarter Quarter number of the date
3495 * length Length of string
3496 * month Month number of the date
3497 * add_date Add specified interval to a date
3498 * add_time Add time interval to a date
3499 * text2char Convert text field to varchar
3501 * @param string $string database string to convert
3502 * @param string $type type of conversion to do
3503 * @param array $additional_parameters optional, additional parameters to pass to the db function
3506 abstract public function convert($string, $type, array $additional_parameters = array());
3509 * Converts from Database data to app data
3518 * @param string $string database string to convert
3519 * @param string $type type of conversion to do
3522 abstract public function fromConvert($string, $type);
3525 * Parses and runs queries
3527 * @param string $sql SQL Statement to execute
3528 * @param bool $dieOnError True if we want to call die if the query returns errors
3529 * @param string $msg Message to log if error occurs
3530 * @param bool $suppress Flag to suppress all error output unless in debug logging mode.
3531 * @param bool $keepResult Keep query result in the object?
3532 * @return resource|bool result set or success/failure bool
3534 abstract public function query($sql, $dieOnError = false, $msg = '', $suppress = false, $keepResult = false);
3537 * Runs a limit query: one where we specify where to start getting records and how many to get
3539 * @param string $sql SELECT query
3540 * @param int $start Starting row
3541 * @param int $count How many rows
3542 * @param boolean $dieOnError True if we want to call die if the query returns errors
3543 * @param string $msg Message to log if error occurs
3544 * @param bool $execute Execute or return SQL?
3545 * @return resource query result
3547 abstract function limitQuery($sql, $start, $count, $dieOnError = false, $msg = '', $execute = true);
3551 * Free Database result
3552 * @param resource $dbResult
3554 abstract protected function freeDbResult($dbResult);
3557 * Rename column in the DB
3558 * @param string $tablename
3559 * @param string $column
3560 * @param string $newname
3562 abstract function renameColumnSQL($tablename, $column, $newname);
3565 * Returns definitions of all indies for passed table.
3567 * return will is a multi-dimensional array that
3568 * categorizes the index definition by types, unique, primary and index.
3572 * 'index1'=> array (
3573 * 'name' => 'index1',
3574 * 'type' => 'primary',
3575 * 'fields' => array('field1','field2')
3580 * This format is similar to how indicies are defined in vardef file.
3582 * @param string $tablename
3585 abstract public function get_indices($tablename);
3588 * Returns definitions of all indies for passed table.
3590 * return will is a multi-dimensional array that
3591 * categorizes the index definition by types, unique, primary and index.
3595 * 'field1'=> array (
3596 * 'name' => 'field1',
3597 * 'type' => 'varchar',
3603 * This format is similar to how indicies are defined in vardef file.
3605 * @param string $tablename
3608 abstract public function get_columns($tablename);
3611 * Generates alter constraint statement given a table name and vardef definition.
3613 * Supports both adding and droping a constraint.
3615 * @param string $table tablename
3616 * @param array $definition field definition
3617 * @param bool $drop true if we are dropping the constraint, false if we are adding it
3618 * @return string SQL statement
3620 abstract public function add_drop_constraint($table, $definition, $drop = false);
3623 * Returns the description of fields based on the result
3625 * @param resource $result
3626 * @param boolean $make_lower_case
3627 * @return array field array
3629 abstract public function getFieldsArray($result, $make_lower_case = false);
3632 * Returns an array of tables for this database
3634 * @return array|false an array of with table names, false if no tables found
3636 abstract public function getTablesArray();
3639 * Return's the version of the database
3643 abstract public function version();
3646 * Checks if a table with the name $tableName exists
3647 * and returns true if it does or false otherwise
3649 * @param string $tableName
3652 abstract public function tableExists($tableName);
3655 * Fetches the next row in the query result into an associative array
3657 * @param resource $result
3658 * @return array returns false if there are no more rows available to fetch
3660 abstract public function fetchRow($result);
3663 * Connects to the database backend
3665 * Takes in the database settings and opens a database connection based on those
3666 * will open either a persistent or non-persistent connection.
3667 * If a persistent connection is desired but not available it will defualt to non-persistent
3669 * configOptions must include
3670 * db_host_name - server ip
3671 * db_user_name - database user name
3672 * db_password - database password
3674 * @param array $configOptions
3675 * @param boolean $dieOnError
3677 abstract public function connect(array $configOptions = null, $dieOnError = false);
3680 * Generates sql for create table statement for a bean.
3682 * @param string $tablename
3683 * @param array $fieldDefs
3684 * @param array $indices
3685 * @return string SQL Create Table statement
3687 abstract public function createTableSQLParams($tablename, $fieldDefs, $indices);
3690 * Generates the SQL for changing columns
3692 * @param string $tablename
3693 * @param array $fieldDefs
3694 * @param string $action
3695 * @param bool $ignoreRequired Optional, true if we should ignor this being a required field
3696 * @return string|array
3698 abstract protected function changeColumnSQL($tablename, $fieldDefs, $action, $ignoreRequired = false);
3701 * Disconnects from the database
3703 * Also handles any cleanup needed
3705 abstract public function disconnect();
3708 * Get last database error
3709 * This function should return last error as reported by DB driver
3710 * and should return false if no error condition happened
3711 * @return string|false Error message or false if no error happened
3713 abstract public function lastDbError();
3716 * Check if this query is valid
3717 * Validates only SELECT queries
3718 * @param string $query
3721 abstract public function validateQuery($query);
3724 * Check if this driver can be used
3727 abstract public function valid();
3730 * Check if certain database exists
3731 * @param string $dbname
3733 abstract public function dbExists($dbname);
3736 * Get tables like expression
3737 * @param string $like Expression describing tables
3740 abstract public function tablesLike($like);
3744 * @param string $dbname
3746 abstract public function createDatabase($dbname);
3750 * @param string $dbname
3752 abstract public function dropDatabase($dbname);
3755 * Get database configuration information (DB-dependent)
3756 * @return array|null
3758 abstract public function getDbInfo();
3761 * Check if certain DB user exists
3762 * @param string $username
3764 abstract public function userExists($username);
3768 * @param string $database_name
3769 * @param string $host_name
3770 * @param string $user
3771 * @param string $password
3773 abstract public function createDbUser($database_name, $host_name, $user, $password);
3776 * Check if the database supports fulltext indexing
3777 * Note that database driver can be capable of supporting FT (see supports('fulltext))
3778 * but particular instance can still have it disabled
3781 abstract public function full_text_indexing_installed();
3784 * Generate fulltext query from set of terms
3785 * @param string $field Field to search against
3786 * @param array $terms Search terms that may be or not be in the result
3787 * @param array $must_terms Search terms that have to be in the result
3788 * @param array $exclude_terms Search terms that have to be not in the result
3790 abstract public function getFulltextQuery($field, $terms, $must_terms = array(), $exclude_terms = array());
3793 * Get install configuration for this DB
3796 abstract public function installConfig();