Source for file sqlite.php
Documentation is available at sqlite.php
// +----------------------------------------------------------------------+
// | PHP versions 4 and 5 |
// +----------------------------------------------------------------------+
// | Copyright (c) 1998-2008 Manuel Lemos, Tomas V.V.Cox, |
// | Stig. S. Bakken, Lukas Smith, Lorenzo Alberton |
// | 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. |
// +----------------------------------------------------------------------+
// | Authors: Lukas Smith <smith@pooteeweet.org> |
// | Lorenzo Alberton <l.alberton@quipo.it> |
// +----------------------------------------------------------------------+
// $Id: sqlite.php 327310 2012-08-27 15:16:18Z danielc $
require_once 'MDB2/Driver/Manager/Common.php';
* MDB2 SQLite driver for the management modules
* @author Lukas Smith <smith@pooteeweet.org>
* @author Lorenzo Alberton <l.alberton@quipo.it>
* @param string $name name of the database that should be created
* @param array $options array with charset info
* @return mixed MDB2_OK on success, a MDB2 error on failure
$db = $this->getDBInstance ();
if (MDB2 ::isError ($db)) {
$database_file = $db->_getDatabaseFile ($name);
return $db->raiseError (MDB2_ERROR_ALREADY_EXISTS , null , null ,
'database already exists', __FUNCTION__ );
$handle = @sqlite_open ($database_file, $db->dsn ['mode'], $php_errormsg);
return $db->raiseError (MDB2_ERROR_CANNOT_CREATE , null , null ,
(isset ($php_errormsg) ? $php_errormsg : 'could not create the database file'), __FUNCTION__ );
if (!empty ($options['charset'])) {
$query = 'PRAGMA encoding = ' . $db->quote ($options['charset'], 'text');
@sqlite_query ($query, $handle);
* 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)) {
$database_file = $db->_getDatabaseFile ($name);
return $db->raiseError (MDB2_ERROR_CANNOT_DROP , null , null ,
'database does not exist', __FUNCTION__ );
$result = @unlink($database_file);
return $db->raiseError (MDB2_ERROR_CANNOT_DROP , null , null ,
(isset ($php_errormsg) ? $php_errormsg : 'could not remove the database file'), __FUNCTION__ );
// {{{ _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']) && (strtoupper($definition['onupdate']) != 'NO ACTION')) {
$query .= ' ON UPDATE '. $definition['onupdate'];
if (!empty ($definition['ondelete']) && (strtoupper($definition['ondelete']) != 'NO ACTION')) {
$query .= ' ON DELETE '. $definition['ondelete'];
if (!empty ($definition['deferrable'])) {
$query .= ' NOT DEFERRABLE';
if (!empty ($definition['initiallydeferred'])) {
$query .= ' INITIALLY DEFERRED';
$query .= ' INITIALLY IMMEDIATE';
// {{{ _getCreateTableQuery()
* Create a basic SQL query for a new table creation
* @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
* @param array $options An associative array of table options
* @return mixed string (the SQL query) on success, a MDB2 error on failure
function _getCreateTableQuery ($name, $fields, $options = array ())
$db = $this->getDBInstance ();
if (MDB2 ::isError ($db)) {
return $db->raiseError (MDB2_ERROR_CANNOT_CREATE , null , null ,
'no valid table name specified', __FUNCTION__ );
return $db->raiseError (MDB2_ERROR_CANNOT_CREATE , null , null ,
'no fields specified for table "'. $name. '"', __FUNCTION__ );
$query_fields = $this->getFieldDeclarationList ($fields);
if (MDB2 ::isError ($query_fields)) {
if (!empty ($options['primary'])) {
$query_fields.= ', PRIMARY KEY ('. implode(', ', array_keys($options['primary'])). ')';
if (!empty ($options['foreign_keys'])) {
foreach ($options['foreign_keys'] as $fkname => $fkdef) {
$query_fields.= ', CONSTRAINT '. $fkname. ' FOREIGN KEY ('. implode(', ', array_keys($fkdef['fields'])). ')';
$query_fields.= ' REFERENCES '. $fkdef['references']['table']. ' ('. implode(', ', array_keys($fkdef['references']['fields'])). ')';
$name = $db->quoteIdentifier ($name, true );
if (!empty ($options['temporary'])) {
$result .= $this->_getTemporaryTableQuery ();
$result .= " TABLE $name ($query_fields)";
* @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
* @param array $options An associative array of table options
* @return mixed MDB2_OK on success, a MDB2 error on failure
function createTable($name, $fields, $options = array ())
$result = parent ::createTable ($name, $fields, $options);
if (MDB2 ::isError ($result)) {
// create triggers to enforce FOREIGN KEY constraints
if (!empty ($options['foreign_keys'])) {
$db = $this->getDBInstance ();
if (MDB2 ::isError ($db)) {
foreach ($options['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',
//create the [insert|update] triggers on the FK table
$referenced_fields = array_keys($fkdef['references']['fields']);
$query = 'CREATE TRIGGER %s BEFORE %s ON '. $name
. ' SELECT RAISE(ROLLBACK, \'%s on table "'. $name. '" violates FOREIGN KEY constraint "'. $fkname. '"\')'
$aliased_fields = array ();
foreach ($referenced_fields as $field) {
$aliased_fields[] = $fkdef['references']['table'] . '.'. $field . ' AS '. $field;
$query .= implode(',', $aliased_fields)
. ' FROM '. $fkdef['references']['table']
for ($i=0; $i< count($table_fields); $i++ ) {
$conditions[] = $referenced_fields[$i] . ' = NEW.'. $table_fields[$i];
$query .= implode(' AND ', $conditions). ') IS NULL; END;';
$result = $db->exec (sprintf($query, $trigger_names['insert'], 'INSERT', 'insert'));
if (MDB2 ::isError ($result)) {
$result = $db->exec (sprintf($query, $trigger_names['update'], 'UPDATE', 'update'));
if (MDB2 ::isError ($result)) {
//create the ON [UPDATE|DELETE] triggers on the primary table
$restrict_action = 'SELECT RAISE(ROLLBACK, \'%s on table "'. $name. '" violates FOREIGN KEY constraint "'. $fkname. '"\')'
$aliased_fields = array ();
foreach ($table_fields as $field) {
$aliased_fields[] = $name . '.'. $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'
. ' AND (' . implode(' OR ', $conditions2) . ')';
$cascade_action_update = 'UPDATE '. $name. ' SET '. implode(', ', $new_values) . ' WHERE '. implode(' AND ', $conditions);
$cascade_action_delete = 'DELETE FROM '. $name. ' WHERE '. implode(' AND ', $conditions);
$setnull_action = 'UPDATE '. $name. ' 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 ($name, $field);
if (MDB2 ::isError ($field_definition)) {
return $field_definition;
$default_values[] = $table_field . ' = '. $field_definition[0 ]['default'];
$setdefault_action = 'UPDATE '. $name. ' SET '. implode(', ', $default_values). ' WHERE '. implode(' AND ', $conditions);
$query = 'CREATE TRIGGER %s'
. ' %s ON '. $fkdef['references']['table']
if ('CASCADE' == $fkdef['onupdate']) {
$sql_update = sprintf($query, $trigger_names['pk_update'], 'AFTER UPDATE', 'update') . $cascade_action_update. '; END;';
} elseif ('SET NULL' == $fkdef['onupdate']) {
$sql_update = sprintf($query, $trigger_names['pk_update'], 'BEFORE UPDATE', 'update') . $setnull_action. '; END;';
} elseif ('SET DEFAULT' == $fkdef['onupdate']) {
$sql_update = sprintf($query, $trigger_names['pk_update'], 'BEFORE UPDATE', 'update') . $setdefault_action. '; END;';
} elseif ('NO ACTION' == $fkdef['onupdate']) {
$sql_update = sprintf($query. $restrict_action, $trigger_names['pk_update'], 'AFTER UPDATE', 'update') . '; END;';
} elseif ('RESTRICT' == $fkdef['onupdate']) {
$sql_update = sprintf($query. $restrict_action, $trigger_names['pk_update'], 'BEFORE UPDATE', 'update') . '; END;';
if ('CASCADE' == $fkdef['ondelete']) {
$sql_delete = sprintf($query, $trigger_names['pk_delete'], 'AFTER DELETE', 'delete') . $cascade_action_delete. '; END;';
} elseif ('SET NULL' == $fkdef['ondelete']) {
$sql_delete = sprintf($query, $trigger_names['pk_delete'], 'BEFORE DELETE', 'delete') . $setnull_action. '; END;';
} elseif ('SET DEFAULT' == $fkdef['ondelete']) {
$sql_delete = sprintf($query, $trigger_names['pk_delete'], 'BEFORE DELETE', 'delete') . $setdefault_action. '; END;';
} elseif ('NO ACTION' == $fkdef['ondelete']) {
$sql_delete = sprintf($query. $restrict_action, $trigger_names['pk_delete'], 'AFTER DELETE', 'delete') . '; END;';
} elseif ('RESTRICT' == $fkdef['ondelete']) {
$sql_delete = sprintf($query. $restrict_action, $trigger_names['pk_delete'], 'BEFORE DELETE', 'delete') . '; END;';
if (MDB2 ::isError ($result)) {
$result = $db->exec ($sql_delete);
if (MDB2 ::isError ($result)) {
$result = $db->exec ($sql_update);
if (MDB2 ::isError ($result)) {
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)) {
$name = $db->quoteIdentifier ($name, true );
$result = $db->exec (" DROP 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)) {
$query .= ' '. $db->quoteIdentifier ($table, true );
$result = $db->exec ($query);
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
function alterTable($name, $changes, $check, $options = array ())
$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__ );
$db->loadModule ('Reverse', null , true );
// actually sqlite 2.x supports no ALTER TABLE at all .. so we emulate it
$fields = $db->manager ->listTableFields ($name);
if (MDB2 ::isError ($fields)) {
foreach ($fields as $field => $value) {
$definition = $db->reverse ->getTableFieldDefinition ($name, $field);
if (MDB2 ::isError ($definition)) {
$fields[$field] = $definition[0 ];
$indexes = $db->manager ->listTableIndexes ($name);
if (MDB2 ::isError ($indexes)) {
foreach ($indexes as $index => $value) {
$definition = $db->reverse ->getTableIndexDefinition ($name, $index);
if (MDB2 ::isError ($definition)) {
$indexes[$index] = $definition;
$constraints = $db->manager ->listTableConstraints ($name);
if (MDB2 ::isError ($constraints)) {
$options['foreign_keys'] = array ();
foreach ($constraints as $constraint => $value) {
if (!empty ($definition['primary'])) {
$options['primary'] = $definition['fields'];
//remove from the $constraint array, it's already handled by createTable()
unset ($constraints[$constraint]);
$c_definition = $db->reverse ->getTableConstraintDefinition ($name, $constraint);
if (MDB2 ::isError ($c_definition)) {
if (!empty ($c_definition['foreign'])) {
$options['foreign_keys'][$constraint] = $c_definition;
//remove from the $constraint array, it's already handled by createTable()
unset ($constraints[$constraint]);
$constraints[$constraint] = $c_definition;
$create_order = $select_fields = array_keys($fields);
foreach ($changes as $change_name => $change) {
foreach ($change as $field_name => $field) {
$fields[$field_name] = $field;
$create_order[] = $field_name;
foreach ($change as $field_name => $field) {
unset ($fields[$field_name]);
$select_fields = array_diff($select_fields, array ($field_name));
$create_order = array_diff($create_order, array ($field_name));
foreach ($change as $field_name => $field) {
$fields[$field_name] = $field['definition'];
foreach ($change as $field_name => $field) {
unset ($fields[$field_name]);
$fields[$field['name']] = $field['definition'];
$create_order[array_search($field_name, $create_order)] = $field['name'];
return $db->raiseError (MDB2_ERROR_CANNOT_ALTER , null , null ,
'change type "'. $change_name. '" not yet supported', __FUNCTION__ );
if (!empty ($select_fields)) {
$query = 'SELECT '. implode(', ', $select_fields). ' FROM '. $db->quoteIdentifier ($name, true );
$data = $db->queryAll ($query, null , MDB2_FETCHMODE_ORDERED );
if (MDB2 ::isError ($result)) {
$result = $this->createTable($name_new, $fields, $options);
if (MDB2 ::isError ($result)) {
foreach ($indexes as $index => $definition) {
foreach ($constraints as $constraint => $definition) {
if (!empty ($select_fields) && !empty ($data)) {
$query = 'INSERT INTO '. $db->quoteIdentifier ($name_new, true );
$stmt = $db->prepare ($query, null , MDB2_PREPARE_MANIP );
if (MDB2 ::isError ($stmt)) {
foreach ($data as $row) {
$result = $stmt->execute ($row);
if (MDB2 ::isError ($result)) {
* @return mixed array of database names on success, a MDB2 error on failure
$db = $this->getDBInstance ();
if (MDB2 ::isError ($db)) {
return $db->raiseError (MDB2_ERROR_UNSUPPORTED , null , null ,
'list databases is not supported', __FUNCTION__ );
* @return mixed array of user names on success, a MDB2 error on failure
$db = $this->getDBInstance ();
if (MDB2 ::isError ($db)) {
return $db->raiseError (MDB2_ERROR_UNSUPPORTED , null , null ,
'list databases is not supported', __FUNCTION__ );
* list all views in the current database
* @return mixed array of view names on success, a MDB2 error on failure
$db = $this->getDBInstance ();
if (MDB2 ::isError ($db)) {
$query = "SELECT name FROM sqlite_master WHERE type='view' AND sql NOT NULL";
$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 the views in the database that reference a given table
* @param string table for which all referenced views should be found
* @return mixed array of view names on success, a MDB2 error on failure
$db = $this->getDBInstance ();
if (MDB2 ::isError ($db)) {
$query = "SELECT name, sql FROM sqlite_master WHERE type='view' AND sql NOT NULL";
$views = $db->queryAll ($query, array ('text', 'text'), MDB2_FETCHMODE_ASSOC );
if (MDB2 ::isError ($views)) {
foreach ($views as $row) {
if (preg_match(" /^create view .* \bfrom\b\s+\b{$table}\b /i" , $row['sql'])) {
if (!empty ($row['name'])) {
$result[$row['name']] = true;
if ($db->options ['portability'] & MDB2_PORTABILITY_FIX_CASE ) {
* list all tables in the current database
* @return mixed array of table names on success, a MDB2 error on failure
$db = $this->getDBInstance ();
if (MDB2 ::isError ($db)) {
$query = "SELECT name FROM sqlite_master WHERE type='table' AND sql NOT NULL ORDER BY name";
$table_names = $db->queryCol ($query);
if (MDB2 ::isError ($table_names)) {
foreach ($table_names as $table_name) {
if (!$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);
* 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)) {
$result = $db->loadModule ('Reverse', null , true );
if (MDB2 ::isError ($result)) {
$query = "SELECT sql FROM sqlite_master WHERE type='table' AND ";
if ($db->options ['portability'] & MDB2_PORTABILITY_FIX_CASE ) {
$query.= 'LOWER(name)='. $db->quote (strtolower($table), 'text');
$query.= 'name='. $db->quote ($table, 'text');
$sql = $db->queryOne ($query);
if (MDB2 ::isError ($sql)) {
$columns = $db->reverse ->_getTableColumns ($sql);
foreach ($columns as $column) {
if ($db->options ['portability'] & MDB2_PORTABILITY_FIX_CASE ) {
if ($db->options ['field_case'] == CASE_LOWER ) {
$fields[] = $column['name'];
// {{{ 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 = "SELECT name FROM sqlite_master WHERE type='trigger' AND sql NOT NULL";
if ($db->options ['portability'] & MDB2_PORTABILITY_FIX_CASE ) {
$query.= ' AND LOWER(tbl_name)='. $db->quote (strtolower($table), 'text');
$query.= ' AND tbl_name='. $db->quote ($table, 'text');
$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);
* 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 support() 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_name => $field) {
$field_string = $db->quoteIdentifier ($field_name, true );
if (!empty ($field['sorting'])) {
switch ($field['sorting']) {
$fields[] = $field_string;
$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)) {
$name = $db->getIndexName ($name);
$result = $db->exec (" DROP INDEX $name" );
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)) {
$table = $db->quote ($table, 'text');
$query = "SELECT sql FROM sqlite_master WHERE type='index' AND ";
if ($db->options ['portability'] & MDB2_PORTABILITY_FIX_CASE ) {
$query.= " tbl_name=$table";
$query.= " AND sql NOT NULL ORDER BY name";
$indexes = $db->queryCol ($query, 'text');
if (MDB2 ::isError ($indexes)) {
foreach ($indexes as $sql) {
if (preg_match("/^create index ([^ ]+) on /i", $sql, $tmp)) {
$index = $this->_fixIndexName ($tmp[1 ]);
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)) {
if (!empty ($definition['primary'])) {
return $db->manager ->alterTable ($table, array (), false , array ('primary' => $definition['fields']));
if (!empty ($definition['foreign'])) {
return $db->manager ->alterTable ($table, array (), false , array ('foreign_keys' => array ($name => $definition)));
$table = $db->quoteIdentifier ($table, true );
$name = $db->getIndexName ($name);
$query = " CREATE UNIQUE INDEX $name ON $table";
foreach ($definition['fields'] as $field_name => $field) {
$field_string = $field_name;
if (!empty ($field['sorting'])) {
switch ($field['sorting']) {
$fields[] = $field_string;
$query .= ' ('. implode(', ', $fields) . ')';
$result = $db->exec ($query);
if (MDB2 ::isError ($result)) {
* 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
if ($primary || $name == 'PRIMARY') {
return $this->alterTable($table, array (), false , array ('primary' => null ));
$db = $this->getDBInstance ();
if (MDB2 ::isError ($db)) {
//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
return $this->alterTable($table, array (), false , array ('foreign_keys' => array ($name => null )));
$name = $db->getIndexName ($name);
$result = $db->exec (" DROP INDEX $name" );
if (MDB2 ::isError ($result)) {
* 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)) {
$table = $db->quote ($table, 'text');
$query = "SELECT sql FROM sqlite_master WHERE type='index' AND ";
if ($db->options ['portability'] & MDB2_PORTABILITY_FIX_CASE ) {
$query.= " tbl_name=$table";
$query.= " AND sql NOT NULL ORDER BY name";
$indexes = $db->queryCol ($query, 'text');
if (MDB2 ::isError ($indexes)) {
foreach ($indexes as $sql) {
if (preg_match("/^create unique index ([^ ]+) on /i", $sql, $tmp)) {
$index = $this->_fixIndexName ($tmp[1 ]);
// also search in table definition for PRIMARY KEYs...
$query = "SELECT sql FROM sqlite_master WHERE type='table' AND ";
if ($db->options ['portability'] & MDB2_PORTABILITY_FIX_CASE ) {
$query.= " AND sql NOT NULL ORDER BY name";
$table_def = $db->queryOne ($query, 'text');
if (MDB2 ::isError ($table_def)) {
if (preg_match("/\bPRIMARY\s+KEY\b/i", $table_def, $tmp)) {
$result['primary'] = true;
// ...and for FOREIGN KEYs
if (preg_match_all("/\bCONSTRAINT\b\s+([^\s]+)\s+\bFOREIGN\s+KEY/imsx", $table_def, $tmp)) {
foreach ($tmp[1 ] as $fk) {
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
* @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 );
$query = " CREATE TABLE $sequence_name ($seqcol_name INTEGER PRIMARY KEY DEFAULT 0 NOT NULL)";
$res = $db->exec ($query);
if (MDB2 ::isError ($res)) {
$res = $db->exec (" INSERT INTO $sequence_name ($seqcol_name) VALUES (". ($start-1 ). ')');
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
* @return mixed array of sequence names on success, a MDB2 error on failure
$db = $this->getDBInstance ();
if (MDB2 ::isError ($db)) {
$query = "SELECT name FROM sqlite_master WHERE type='table' AND sql NOT NULL ORDER BY name";
$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:26 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.
|