Source for file mysqli.php
Documentation is available at mysqli.php
// +----------------------------------------------------------------------+
// | PHP versions 4 and 5 |
// +----------------------------------------------------------------------+
// | Copyright (c) 1998-2008 Manuel Lemos, Tomas V.V.Cox, |
// | Stig. S. Bakken, Lukas Smith |
// | All rights reserved. |
// +----------------------------------------------------------------------+
// | MDB2 is a merge of PEAR DB and Metabases that provides a unified DB |
// | API as well as database abstraction for PHP applications. |
// | This LICENSE is in the BSD license style. |
// | Redistribution and use in source and binary forms, with or without |
// | modification, are permitted provided that the following conditions |
// | Redistributions of source code must retain the above copyright |
// | notice, this list of conditions and the following disclaimer. |
// | Redistributions in binary form must reproduce the above copyright |
// | notice, this list of conditions and the following disclaimer in the |
// | documentation and/or other materials provided with the distribution. |
// | Neither the name of Manuel Lemos, Tomas V.V.Cox, Stig. S. Bakken, |
// | Lukas Smith nor the names of his contributors may be used to endorse |
// | or promote products derived from this software without specific prior|
// | written permission. |
// | THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS |
// | "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT |
// | LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS |
// | FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE |
// | REGENTS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, |
// | INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, |
// | BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS|
// | OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED |
// | AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT |
// | LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY|
// | WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE |
// | POSSIBILITY OF SUCH DAMAGE. |
// +----------------------------------------------------------------------+
// | Author: Lukas Smith <smith@pooteeweet.org> |
// +----------------------------------------------------------------------+
// $Id: mysqli.php 327310 2012-08-27 15:16:18Z danielc $
require_once 'MDB2/Driver/Manager/Common.php';
* MDB2 MySQLi driver for the management modules
* @author Lukas Smith <smith@pooteeweet.org>
* @param string $name name of the database that should be created
* @param array $options array with charset, collation info
* @return mixed MDB2_OK on success, a MDB2 error on failure
$db = $this->getDBInstance ();
if (MDB2 ::isError ($db)) {
$name = $db->quoteIdentifier ($name, true );
$query = 'CREATE DATABASE ' . $name;
if (!empty ($options['charset'])) {
$query .= ' DEFAULT CHARACTER SET ' . $db->quote ($options['charset'], 'text');
if (!empty ($options['collation'])) {
$query .= ' COLLATE ' . $db->quote ($options['collation'], 'text');
return $db->standaloneQuery ($query, null , true );
* alter an existing database
* @param string $name name of the database that is intended to be changed
* @param array $options array with charset, collation info
* @return mixed MDB2_OK on success, a MDB2 error on failure
$db = $this->getDBInstance ();
if (MDB2 ::isError ($db)) {
$query = 'ALTER DATABASE '. $db->quoteIdentifier ($name, true );
if (!empty ($options['charset'])) {
$query .= ' DEFAULT CHARACTER SET ' . $db->quote ($options['charset'], 'text');
if (!empty ($options['collation'])) {
$query .= ' COLLATE ' . $db->quote ($options['collation'], 'text');
return $db->standaloneQuery ($query, null , true );
* drop an existing database
* @param string $name name of the database that should be dropped
* @return mixed MDB2_OK on success, a MDB2 error on failure
$db = $this->getDBInstance ();
if (MDB2 ::isError ($db)) {
$name = $db->quoteIdentifier ($name, true );
$query = " DROP DATABASE $name";
return $db->standaloneQuery ($query, null , true );
// {{{ _getAdvancedFKOptions()
* Return the FOREIGN KEY query section dealing with non-standard options
* as MATCH, INITIALLY DEFERRED, ON UPDATE, ...
* @param array $definition
if (!empty ($definition['match'])) {
$query .= ' MATCH '. $definition['match'];
if (!empty ($definition['onupdate'])) {
$query .= ' ON UPDATE '. $definition['onupdate'];
if (!empty ($definition['ondelete'])) {
$query .= ' ON DELETE '. $definition['ondelete'];
* @param string $name Name of the database that should be created
* @param array $fields Associative array that contains the definition of each field of the new table
* The indexes of the array entries are the names of the fields of the table an
* the array entry values are associative arrays like those that are meant to be
* passed with the field definitions to get[Type]Declaration() functions.
* @param array $options An associative array of table options:
* 'collate' => 'utf8_unicode_ci',
* @return mixed MDB2_OK on success, a MDB2 error on failure
function createTable($name, $fields, $options = array ())
$db = $this->getDBInstance ();
if (MDB2 ::isError ($db)) {
// if we have an AUTO_INCREMENT column and a PK on more than one field,
// we have to handle it differently...
if (empty ($options['primary'])) {
foreach ($fields as $fieldname => $def) {
if (!empty ($def['primary'])) {
$pk_fields[$fieldname] = true;
if (!empty ($def['autoincrement'])) {
$autoincrement = $fieldname;
if ((null !== $autoincrement) && count($pk_fields) > 1 ) {
$options['primary'] = $pk_fields;
// the PK constraint is on max one field => OK
$query = $this->_getCreateTableQuery ($name, $fields, $options);
if (MDB2 ::isError ($query)) {
if (null !== $autoincrement) {
// we have to remove the PK clause added by _getIntegerDeclaration()
$query = str_replace('AUTO_INCREMENT PRIMARY KEY', 'AUTO_INCREMENT', $query);
$options_strings = array ();
if (!empty ($options['comment'])) {
$options_strings['comment'] = 'COMMENT = '. $db->quote ($options['comment'], 'text');
if (!empty ($options['charset'])) {
$options_strings['charset'] = 'DEFAULT CHARACTER SET '. $options['charset'];
if (!empty ($options['collate'])) {
$options_strings['charset'].= ' COLLATE '. $options['collate'];
if (!empty ($options['type'])) {
$type = $options['type'];
} elseif ($db->options ['default_table_type']) {
$type = $db->options ['default_table_type'];
$options_strings[] = " ENGINE = $type";
if (!empty ($options_strings)) {
$query .= ' '. implode(' ', $options_strings);
$result = $db->exec ($query);
if (MDB2 ::isError ($result)) {
* @param string $name name of the table that should be dropped
* @return mixed MDB2_OK on success, a MDB2 error on failure
$db = $this->getDBInstance ();
if (MDB2 ::isError ($db)) {
//delete the triggers associated to existing FK constraints
if (!MDB2 ::isError ($constraints) && !empty ($constraints)) {
$db->loadModule ('Reverse', null , true );
foreach ($constraints as $constraint) {
$definition = $db->reverse ->getTableConstraintDefinition ($name, $constraint);
if (!MDB2 ::isError ($definition) && !empty ($definition['foreign'])) {
$result = $this->_dropFKTriggers ($name, $constraint, $definition['references']['table']);
if (MDB2 ::isError ($result)) {
return parent ::dropTable ($name);
* Truncate an existing table (if the TRUNCATE TABLE syntax is not supported,
* it falls back to a DELETE FROM TABLE query)
* @param string $name name of the table that should be truncated
* @return mixed MDB2_OK on success, a MDB2 error on failure
$db = $this->getDBInstance ();
if (MDB2 ::isError ($db)) {
$name = $db->quoteIdentifier ($name, true );
$result = $db->exec (" TRUNCATE TABLE $name" );
if (MDB2 ::isError ($result)) {
* Optimize (vacuum) all the tables in the db (or only the specified table)
* and optionally run ANALYZE.
* @param string $table table name (all the tables if empty)
* @param array $options an array with driver-specific options:
* - timeout [int] (in seconds) [mssql-only]
* - analyze [boolean] [pgsql and mysql]
* - full [boolean] [pgsql-only]
* - freeze [boolean] [pgsql-only]
* @return mixed MDB2_OK success, a MDB2 error on failure
function vacuum($table = null , $options = array ())
$db = $this->getDBInstance ();
if (MDB2 ::isError ($db)) {
if (MDB2 ::isError ($table)) {
$table[$k] = $db->quoteIdentifier ($table[$k], true );
$table = $db->quoteIdentifier ($table, true );
$result = $db->exec ('OPTIMIZE TABLE '. $table);
if (MDB2 ::isError ($result)) {
if (!empty ($options['analyze'])) {
$result = $db->exec ('ANALYZE TABLE '. $table);
if (MDB2 ::isError ($result)) {
* alter an existing table
* @param string $name name of the table that is intended to be changed.
* @param array $changes associative array that contains the details of each type
* of change that is intended to be performed. The types of
* changes that are currently supported are defined as follows:
* New name for the table.
* Associative array with the names of fields to be added as
* indexes of the array. The value of each entry of the array
* should be set to another associative array with the properties
* of the fields to be added. The properties of the fields should
* be the same as defined by the MDB2 parser.
* Associative array with the names of fields to be removed as indexes
* of the array. Currently the values assigned to each entry are ignored.
* An empty array should be used for future compatibility.
* Associative array with the names of fields to be renamed as indexes
* of the array. The value of each entry of the array should be set to
* another associative array with the entry named name with the new
* field name and the entry named Declaration that is expected to contain
* the portion of the field declaration already in DBMS specific SQL code
* as it is used in the CREATE TABLE statement.
* Associative array with the names of the fields to be changed as indexes
* of the array. Keep in mind that if it is intended to change either the
* name of a field and any other properties, the change array entries
* should have the new names of the fields as array indexes.
* The value of each entry of the array should be set to another associative
* array with the properties of the fields to that are meant to be changed as
* array entries. These entries should be assigned to the new values of the
* respective properties. The properties of the fields should be the same
* as defined by the MDB2 parser.
* 'file_limit' => array(),
* 'time_limit' => array()
* @param boolean $check indicates whether the function should just check if the DBMS driver
* can perform the requested table alterations if the value is true or
* actually perform them otherwise.
* @return mixed MDB2_OK on success, a MDB2 error on failure
$db = $this->getDBInstance ();
if (MDB2 ::isError ($db)) {
foreach ($changes as $change_name => $change) {
return $db->raiseError (MDB2_ERROR_CANNOT_ALTER , null , null ,
'change type "'. $change_name. '" not yet supported', __FUNCTION__ );
if (!empty ($changes['name'])) {
$change_name = $db->quoteIdentifier ($changes['name'], true );
$query .= 'RENAME TO ' . $change_name;
if (!empty ($changes['add']) && is_array($changes['add'])) {
foreach ($changes['add'] as $field_name => $field) {
$query.= 'ADD ' . $db->getDeclaration ($field['type'], $field_name, $field);
if (!empty ($changes['remove']) && is_array($changes['remove'])) {
foreach ($changes['remove'] as $field_name => $field) {
$field_name = $db->quoteIdentifier ($field_name, true );
$query.= 'DROP ' . $field_name;
if (!empty ($changes['rename']) && is_array($changes['rename'])) {
foreach ($changes['rename'] as $field_name => $field) {
$rename[$field['name']] = $field_name;
if (!empty ($changes['change']) && is_array($changes['change'])) {
foreach ($changes['change'] as $field_name => $field) {
if (isset ($rename[$field_name])) {
$old_field_name = $rename[$field_name];
unset ($rename[$field_name]);
$old_field_name = $field_name;
$old_field_name = $db->quoteIdentifier ($old_field_name, true );
$query.= " CHANGE $old_field_name " . $db->getDeclaration ($field['definition']['type'], $field_name, $field['definition']);
if (!empty ($rename) && is_array($rename)) {
foreach ($rename as $rename_name => $renamed_field) {
$field = $changes['rename'][$renamed_field];
$renamed_field = $db->quoteIdentifier ($renamed_field, true );
$query.= 'CHANGE ' . $renamed_field . ' ' . $db->getDeclaration ($field['definition']['type'], $field['name'], $field['definition']);
$name = $db->quoteIdentifier ($name, true );
$result = $db->exec (" ALTER TABLE $name $query" );
if (MDB2 ::isError ($result)) {
* @return mixed array of database names on success, a MDB2 error on failure
$db = $this->getDBInstance ();
if (MDB2 ::isError ($db)) {
$result = $db->queryCol ('SHOW DATABASES');
if (MDB2 ::isError ($result)) {
if ($db->options ['portability'] & MDB2_PORTABILITY_FIX_CASE ) {
$result = array_map(($db->options ['field_case'] == CASE_LOWER ? 'strtolower' : 'strtoupper'), $result);
* @return mixed array of user names on success, a MDB2 error on failure
$db = $this->getDBInstance ();
if (MDB2 ::isError ($db)) {
return $db->queryCol ('SELECT DISTINCT USER FROM mysql.USER');
* list all functions in the current database
* @return mixed array of function names on success, a MDB2 error on failure
$db = $this->getDBInstance ();
if (MDB2 ::isError ($db)) {
$query = "SELECT name FROM mysql.proc";
FROM INFORMATION_SCHEMA.ROUTINES
WHERE ROUTINE_TYPE = 'FUNCTION'
$result = $db->queryCol ($query);
if (MDB2 ::isError ($result)) {
if ($db->options ['portability'] & MDB2_PORTABILITY_FIX_CASE ) {
$result = array_map(($db->options ['field_case'] == CASE_LOWER ? 'strtolower' : 'strtoupper'), $result);
// {{{ listTableTriggers()
* list all triggers in the database that reference a given table
* @param string table for which all referenced triggers should be found
* @return mixed array of trigger names on success, a MDB2 error on failure
$db = $this->getDBInstance ();
if (MDB2 ::isError ($db)) {
$query = 'SHOW TRIGGERS';
$table = $db->quote ($table, 'text');
$query .= " LIKE $table";
$result = $db->queryCol ($query);
if (MDB2 ::isError ($result)) {
if ($db->options ['portability'] & MDB2_PORTABILITY_FIX_CASE ) {
$result = array_map(($db->options ['field_case'] == CASE_LOWER ? 'strtolower' : 'strtoupper'), $result);
* list all tables in the current database
* @param string database, the current is default
* @return mixed array of table names on success, a MDB2 error on failure
$db = $this->getDBInstance ();
if (MDB2 ::isError ($db)) {
$query = "SHOW /*!50002 FULL*/ TABLES";
if (null !== $database) {
$query .= " FROM $database";
$query.= "/*!50002 WHERE Table_type = 'BASE TABLE'*/";
$table_names = $db->queryAll ($query, null , MDB2_FETCHMODE_ORDERED );
if (MDB2 ::isError ($table_names)) {
foreach ($table_names as $table) {
if (!$this->_fixSequenceName ($table[0 ], true )) {
if ($db->options ['portability'] & MDB2_PORTABILITY_FIX_CASE ) {
$result = array_map(($db->options ['field_case'] == CASE_LOWER ? 'strtolower' : 'strtoupper'), $result);
* list all views in the current database
* @param string database, the current is default
* @return mixed array of view names on success, a MDB2 error on failure
$db = $this->getDBInstance ();
if (MDB2 ::isError ($db)) {
$query = 'SHOW FULL TABLES';
if (null !== $database) {
$query.= " FROM $database";
$query.= " WHERE Table_type = 'VIEW'";
$result = $db->queryCol ($query);
if (MDB2 ::isError ($result)) {
if ($db->options ['portability'] & MDB2_PORTABILITY_FIX_CASE ) {
$result = array_map(($db->options ['field_case'] == CASE_LOWER ? 'strtolower' : 'strtoupper'), $result);
* list all fields in a table in the current database
* @param string $table name of table that should be used in method
* @return mixed array of field names on success, a MDB2 error on failure
$db = $this->getDBInstance ();
if (MDB2 ::isError ($db)) {
$table = $db->quoteIdentifier ($table, true );
$result = $db->queryCol (" SHOW COLUMNS FROM $table" );
if (MDB2 ::isError ($result)) {
if ($db->options ['portability'] & MDB2_PORTABILITY_FIX_CASE ) {
$result = array_map(($db->options ['field_case'] == CASE_LOWER ? 'strtolower' : 'strtoupper'), $result);
* Get the stucture of a field into an array
* @param string $table name of the table on which the index is to be created
* @param string $name name of the index to be created
* @param array $definition associative array that defines properties of the index to be created.
* Currently, only one property named FIELDS is supported. This property
* is also an associative with the names of the index fields as array
* indexes. Each entry of this array is set to another type of associative
* array that specifies properties of the index that are specific to
* Currently, only the sorting property is supported. It should be used
* to define the sorting direction of the index. It may be set to either
* ascending or descending.
* Not all DBMS support index sorting direction configuration. The DBMS
* drivers of those that do not support it ignore this property. Use the
* function supports() to determine whether the DBMS driver can manage indexes.
* 'sorting' => 'ascending'
* 'last_login' => array()
* @return mixed MDB2_OK on success, a MDB2 error on failure
$db = $this->getDBInstance ();
if (MDB2 ::isError ($db)) {
$table = $db->quoteIdentifier ($table, true );
$name = $db->quoteIdentifier ($db->getIndexName ($name), true );
$query = " CREATE INDEX $name ON $table";
foreach ($definition['fields'] as $field => $fieldinfo) {
if (!empty ($fieldinfo['length'])) {
$fields[] = $db->quoteIdentifier ($field, true ) . '(' . $fieldinfo['length'] . ')';
$fields[] = $db->quoteIdentifier ($field, true );
$query .= ' ('. implode(', ', $fields) . ')';
$result = $db->exec ($query);
if (MDB2 ::isError ($result)) {
* @param string $table name of table that should be used in method
* @param string $name name of the index to be dropped
* @return mixed MDB2_OK on success, a MDB2 error on failure
$db = $this->getDBInstance ();
if (MDB2 ::isError ($db)) {
$table = $db->quoteIdentifier ($table, true );
$name = $db->quoteIdentifier ($db->getIndexName ($name), true );
$result = $db->exec (" DROP INDEX $name ON $table" );
if (MDB2 ::isError ($result)) {
// {{{ listTableIndexes()
* list all indexes in a table
* @param string $table name of table that should be used in method
* @return mixed array of index names on success, a MDB2 error on failure
$db = $this->getDBInstance ();
if (MDB2 ::isError ($db)) {
$non_unique = 'Non_unique';
if ($db->options ['portability'] & MDB2_PORTABILITY_FIX_CASE ) {
if ($db->options ['field_case'] == CASE_LOWER ) {
$table = $db->quoteIdentifier ($table, true );
$query = " SHOW INDEX FROM $table";
$indexes = $db->queryAll ($query, null , MDB2_FETCHMODE_ASSOC );
if (MDB2 ::isError ($indexes)) {
foreach ($indexes as $index_data) {
if ($index_data[$non_unique] && ($index = $this->_fixIndexName ($index_data[$key_name]))) {
if ($db->options ['portability'] & MDB2_PORTABILITY_FIX_CASE ) {
// {{{ createConstraint()
* create a constraint on a table
* @param string $table name of the table on which the constraint is to be created
* @param string $name name of the constraint to be created
* @param array $definition associative array that defines properties of the constraint to be created.
* Currently, only one property named FIELDS is supported. This property
* is also an associative with the names of the constraint fields as array
* constraints. Each entry of this array is set to another type of associative
* array that specifies properties of the constraint that are specific to
* 'user_name' => array(),
* 'last_login' => array()
* @return mixed MDB2_OK on success, a MDB2 error on failure
$db = $this->getDBInstance ();
if (MDB2 ::isError ($db)) {
$idx_name = $db->quoteIdentifier ($db->getIndexName ($name), true );
if (!empty ($definition['primary'])) {
} elseif (!empty ($definition['unique'])) {
} elseif (!empty ($definition['foreign'])) {
return $db->raiseError (MDB2_ERROR_NEED_MORE_DATA , null , null ,
'invalid definition, could not create constraint', __FUNCTION__ );
$table_quoted = $db->quoteIdentifier ($table, true );
$query = " ALTER TABLE $table_quoted ADD $type $idx_name";
if (!empty ($definition['foreign'])) {
$query .= ' FOREIGN KEY';
foreach ($definition['fields'] as $field => $fieldinfo) {
$quoted = $db->quoteIdentifier ($field, true );
if (!empty ($fieldinfo['length'])) {
$quoted .= '(' . $fieldinfo['length'] . ')';
$query .= ' ('. implode(', ', $fields) . ')';
if (!empty ($definition['foreign'])) {
$query.= ' REFERENCES ' . $db->quoteIdentifier ($definition['references']['table'], true );
$referenced_fields = array ();
foreach (array_keys($definition['references']['fields']) as $field) {
$referenced_fields[] = $db->quoteIdentifier ($field, true );
$query .= ' ('. implode(', ', $referenced_fields) . ')';
// add index on FK column(s) or we can't add a FK constraint
// @see http://forums.mysql.com/read.php?22,19755,226009
$result = $this->createIndex($table, $name. '_fkidx', $definition);
if (MDB2 ::isError ($result)) {
$res = $db->exec ($query);
if (MDB2 ::isError ($res)) {
if (!empty ($definition['foreign'])) {
return $this->_createFKTriggers ($table, array ($name => $definition));
* drop existing constraint
* @param string $table name of table that should be used in method
* @param string $name name of the constraint to be dropped
* @param string $primary hint if the constraint is primary
* @return mixed MDB2_OK on success, a MDB2 error on failure
$db = $this->getDBInstance ();
if (MDB2 ::isError ($db)) {
$query = 'ALTER TABLE '. $db->quoteIdentifier ($table, true ) . ' DROP PRIMARY KEY';
$result = $db->exec ($query);
if (MDB2 ::isError ($result)) {
//is it a FK constraint? If so, also delete the associated triggers
$db->loadModule ('Reverse', null , true );
$definition = $db->reverse ->getTableConstraintDefinition ($table, $name);
if (!MDB2 ::isError ($definition) && !empty ($definition['foreign'])) {
//first drop the FK enforcing triggers
$result = $this->_dropFKTriggers ($table, $name, $definition['references']['table']);
if (MDB2 ::isError ($result)) {
//then drop the constraint itself
$table = $db->quoteIdentifier ($table, true );
$name = $db->quoteIdentifier ($db->getIndexName ($name), true );
$query = " ALTER TABLE $table DROP FOREIGN KEY $name";
$result = $db->exec ($query);
if (MDB2 ::isError ($result)) {
$table = $db->quoteIdentifier ($table, true );
$name = $db->quoteIdentifier ($db->getIndexName ($name), true );
$query = " ALTER TABLE $table DROP INDEX $name";
$result = $db->exec ($query);
if (MDB2 ::isError ($result)) {
// {{{ _createFKTriggers()
* Create triggers to enforce the FOREIGN KEY constraint on the table
* NB: since there's no RAISE_APPLICATION_ERROR facility in mysql,
* we call a non-existent procedure to raise the FK violation message.
* @see http://forums.mysql.com/read.php?99,55108,71877#msg-71877
* @param string $table table name
* @param array $foreign_keys FOREIGN KEY definitions
* @return mixed MDB2_OK on success, a MDB2 error on failure
function _createFKTriggers ($table, $foreign_keys)
$db = $this->getDBInstance ();
if (MDB2 ::isError ($db)) {
// create triggers to enforce FOREIGN KEY constraints
if ($db->supports ('triggers') && !empty ($foreign_keys)) {
$table_quoted = $db->quoteIdentifier ($table, true );
foreach ($foreign_keys as $fkname => $fkdef) {
//set actions to default if not set
$fkdef['onupdate'] = empty ($fkdef['onupdate']) ? $db->options ['default_fk_action_onupdate'] : strtoupper($fkdef['onupdate']);
$fkdef['ondelete'] = empty ($fkdef['ondelete']) ? $db->options ['default_fk_action_ondelete'] : strtoupper($fkdef['ondelete']);
'insert' => $fkname. '_insert_trg',
'update' => $fkname. '_update_trg',
'pk_update' => $fkname. '_pk_update_trg',
'pk_delete' => $fkname. '_pk_delete_trg',
$referenced_fields = array_keys($fkdef['references']['fields']);
//create the ON [UPDATE|DELETE] triggers on the primary table
$restrict_action = ' IF (SELECT ';
$aliased_fields = array ();
foreach ($table_fields as $field) {
$aliased_fields[] = $table_quoted . '.'. $field . ' AS '. $field;
$restrict_action .= implode(',', $aliased_fields)
for ($i=0; $i< count($table_fields); $i++ ) {
$conditions[] = $table_fields[$i] . ' = OLD.'. $referenced_fields[$i];
$new_values[] = $table_fields[$i] . ' = NEW.'. $referenced_fields[$i];
$null_values[] = $table_fields[$i] . ' = NULL';
for ($i=0; $i< count($referenced_fields); $i++ ) {
$conditions2[] = 'NEW.'. $referenced_fields[$i] . ' <> OLD.'. $referenced_fields[$i];
$restrict_action .= implode(' AND ', $conditions). ') IS NOT NULL';
$restrict_action2 = empty ($conditions2) ? '' : ' AND (' . implode(' OR ', $conditions2) . ')';
$restrict_action3 = ' THEN CALL %s_ON_TABLE_'. $table. '_VIOLATES_FOREIGN_KEY_CONSTRAINT();'
$restrict_action_update = $restrict_action . $restrict_action2 . $restrict_action3;
$restrict_action_delete = $restrict_action . $restrict_action3; // There is no NEW row in on DELETE trigger
$cascade_action_update = 'UPDATE '. $table_quoted. ' SET '. implode(', ', $new_values) . ' WHERE '. implode(' AND ', $conditions). ';';
$cascade_action_delete = 'DELETE FROM '. $table_quoted. ' WHERE '. implode(' AND ', $conditions). ';';
$setnull_action = 'UPDATE '. $table_quoted. ' SET '. implode(', ', $null_values). ' WHERE '. implode(' AND ', $conditions). ';';
if ('SET DEFAULT' == $fkdef['onupdate'] || 'SET DEFAULT' == $fkdef['ondelete']) {
$db->loadModule ('Reverse', null , true );
$default_values = array ();
foreach ($table_fields as $table_field) {
$field_definition = $db->reverse ->getTableFieldDefinition ($table, $field);
if (MDB2 ::isError ($field_definition)) {
return $field_definition;
$default_values[] = $table_field . ' = '. $field_definition[0 ]['default'];
$setdefault_action = 'UPDATE '. $table_quoted. ' SET '. implode(', ', $default_values). ' WHERE '. implode(' AND ', $conditions). ';';
$query = 'CREATE TRIGGER %s'
. ' %s ON '. $fkdef['references']['table']
. ' SET FOREIGN_KEY_CHECKS = 0; '; //only really needed for ON UPDATE CASCADE
if ('CASCADE' == $fkdef['onupdate']) {
$sql_update = sprintf($query, $trigger_names['pk_update'], 'BEFORE UPDATE', 'update') . $cascade_action_update;
} elseif ('SET NULL' == $fkdef['onupdate']) {
$sql_update = sprintf($query, $trigger_names['pk_update'], 'BEFORE UPDATE', 'update') . $setnull_action;
} elseif ('SET DEFAULT' == $fkdef['onupdate']) {
$sql_update = sprintf($query, $trigger_names['pk_update'], 'BEFORE UPDATE', 'update') . $setdefault_action;
} elseif ('NO ACTION' == $fkdef['onupdate']) {
$sql_update = sprintf($query. $restrict_action_update, $trigger_names['pk_update'], 'AFTER UPDATE', 'update');
} elseif ('RESTRICT' == $fkdef['onupdate']) {
$sql_update = sprintf($query. $restrict_action_update, $trigger_names['pk_update'], 'BEFORE UPDATE', 'update');
if ('CASCADE' == $fkdef['ondelete']) {
$sql_delete = sprintf($query, $trigger_names['pk_delete'], 'BEFORE DELETE', 'delete') . $cascade_action_delete;
} elseif ('SET NULL' == $fkdef['ondelete']) {
$sql_delete = sprintf($query, $trigger_names['pk_delete'], 'BEFORE DELETE', 'delete') . $setnull_action;
} elseif ('SET DEFAULT' == $fkdef['ondelete']) {
$sql_delete = sprintf($query, $trigger_names['pk_delete'], 'BEFORE DELETE', 'delete') . $setdefault_action;
} elseif ('NO ACTION' == $fkdef['ondelete']) {
$sql_delete = sprintf($query. $restrict_action_delete, $trigger_names['pk_delete'], 'AFTER DELETE', 'delete');
} elseif ('RESTRICT' == $fkdef['ondelete']) {
$sql_delete = sprintf($query. $restrict_action_delete, $trigger_names['pk_delete'], 'BEFORE DELETE', 'delete');
$sql_update .= ' SET FOREIGN_KEY_CHECKS = 1; END;';
$sql_delete .= ' SET FOREIGN_KEY_CHECKS = 1; END;';
$db->pushErrorHandling (PEAR_ERROR_RETURN );
$db->expectError (MDB2_ERROR_CANNOT_CREATE );
$result = $db->exec ($sql_delete);
$expected_errmsg = 'This MySQL version doesn\'t support multiple triggers with the same action time and event for one table';
if (MDB2 ::isError ($result)) {
if ($result->getCode () != MDB2_ERROR_CANNOT_CREATE ) {
$db->warnings [] = $expected_errmsg;
$db->pushErrorHandling (PEAR_ERROR_RETURN );
$db->expectError (MDB2_ERROR_CANNOT_CREATE );
$result = $db->exec ($sql_update);
if (MDB2 ::isError ($result) && $result->getCode () != MDB2_ERROR_CANNOT_CREATE ) {
if ($result->getCode () != MDB2_ERROR_CANNOT_CREATE ) {
$db->warnings [] = $expected_errmsg;
* Drop the triggers created to enforce the FOREIGN KEY constraint on the table
* @param string $table table name
* @param string $fkname FOREIGN KEY constraint name
* @param string $referenced_table referenced table name
* @return mixed MDB2_OK on success, a MDB2 error on failure
function _dropFKTriggers ($table, $fkname, $referenced_table)
$db = $this->getDBInstance ();
if (MDB2 ::isError ($db)) {
if (!MDB2 ::isError ($triggers2) && !MDB2 ::isError ($triggers)) {
$pattern = '/^'. $fkname. '(_pk)?_(insert|update|delete)_trg$/i';
foreach ($triggers as $trigger) {
$result = $db->exec ('DROP TRIGGER '. $trigger);
if (MDB2 ::isError ($result)) {
// {{{ listTableConstraints()
* list all constraints in a table
* @param string $table name of table that should be used in method
* @return mixed array of constraint names on success, a MDB2 error on failure
$db = $this->getDBInstance ();
if (MDB2 ::isError ($db)) {
$non_unique = 'Non_unique';
if ($db->options ['portability'] & MDB2_PORTABILITY_FIX_CASE ) {
if ($db->options ['field_case'] == CASE_LOWER ) {
$query = 'SHOW INDEX FROM ' . $db->quoteIdentifier ($table, true );
$indexes = $db->queryAll ($query, null , MDB2_FETCHMODE_ASSOC );
if (MDB2 ::isError ($indexes)) {
foreach ($indexes as $index_data) {
if (!$index_data[$non_unique]) {
if ($index_data[$key_name] !== 'PRIMARY') {
$index = $this->_fixIndexName ($index_data[$key_name]);
//list FOREIGN KEY constraints...
$query = 'SHOW CREATE TABLE '. $db->escape ($table);
$definition = $db->queryOne ($query, 'text', 1 );
if (!MDB2 ::isError ($definition) && !empty ($definition)) {
$pattern = '/\bCONSTRAINT\b\s+([^\s]+)\s+\bFOREIGN KEY\b/Uims';
foreach ($matches[1 ] as $constraint) {
$result[$constraint] = true;
if ($db->options ['portability'] & MDB2_PORTABILITY_FIX_CASE ) {
* @param string $seq_name name of the sequence to be created
* @param string $start start value of the sequence; default is 1
* @param array $options An associative array of table options:
* 'collate' => 'utf8_unicode_ci',
* @return mixed MDB2_OK on success, a MDB2 error on failure
$db = $this->getDBInstance ();
if (MDB2 ::isError ($db)) {
$sequence_name = $db->quoteIdentifier ($db->getSequenceName ($seq_name), true );
$seqcol_name = $db->quoteIdentifier ($db->options ['seqcol_name'], true );
$options_strings = array ();
if (!empty ($options['comment'])) {
$options_strings['comment'] = 'COMMENT = '. $db->quote ($options['comment'], 'text');
if (!empty ($options['charset'])) {
$options_strings['charset'] = 'DEFAULT CHARACTER SET '. $options['charset'];
if (!empty ($options['collate'])) {
$options_strings['charset'].= ' COLLATE '. $options['collate'];
if (!empty ($options['type'])) {
$type = $options['type'];
} elseif ($db->options ['default_table_type']) {
$type = $db->options ['default_table_type'];
$options_strings[] = " ENGINE = $type";
$query = " CREATE TABLE $sequence_name ($seqcol_name INT NOT NULL AUTO_INCREMENT, PRIMARY KEY ($seqcol_name))";
if (!empty ($options_strings)) {
$query .= ' '. implode(' ', $options_strings);
$res = $db->exec ($query);
if (MDB2 ::isError ($res)) {
$query = " INSERT INTO $sequence_name ($seqcol_name) VALUES (". ($start-1 ). ')';
$res = $db->exec ($query);
if (!MDB2 ::isError ($res)) {
$result = $db->exec (" DROP TABLE $sequence_name" );
if (MDB2 ::isError ($result)) {
return $db->raiseError ($result, null , null ,
'could not drop inconsistent sequence table', __FUNCTION__ );
return $db->raiseError ($res, null , null ,
'could not create sequence table', __FUNCTION__ );
* @param string $seq_name name of the sequence to be dropped
* @return mixed MDB2_OK on success, a MDB2 error on failure
$db = $this->getDBInstance ();
if (MDB2 ::isError ($db)) {
$sequence_name = $db->quoteIdentifier ($db->getSequenceName ($seq_name), true );
$result = $db->exec (" DROP TABLE $sequence_name" );
if (MDB2 ::isError ($result)) {
* list all sequences in the current database
* @param string database, the current is default
* @return mixed array of sequence names on success, a MDB2 error on failure
$db = $this->getDBInstance ();
if (MDB2 ::isError ($db)) {
if (null !== $database) {
$query .= " FROM $database";
$table_names = $db->queryCol ($query);
if (MDB2 ::isError ($table_names)) {
foreach ($table_names as $table_name) {
if ($sqn = $this->_fixSequenceName ($table_name, true )) {
if ($db->options ['portability'] & MDB2_PORTABILITY_FIX_CASE ) {
$result = array_map(($db->options ['field_case'] == CASE_LOWER ? 'strtolower' : 'strtoupper'), $result);
Documentation generated on Mon, 11 Mar 2019 15:51:17 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.
|