Source for file sqlite.php
Documentation is available at sqlite.php
// +----------------------------------------------------------------------+
// | PHP versions 4 and 5 |
// +----------------------------------------------------------------------+
// | Copyright (c) 1998-2006 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: sqlite.php,v 1.59 2006/09/17 20:03:51 lsmith Exp $
require_once 'MDB2/Driver/Manager/Common.php';
* MDB2 SQLite driver for the management modules
* @author Lukas Smith <smith@pooteeweet.org>
* @param string $name name of the database that should be created
* @return mixed MDB2_OK on success, a MDB2 error on failure
$db = & $this->getDBInstance ();
if (PEAR ::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__ );
* 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 (PEAR ::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__ );
* 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 (PEAR ::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 (PEAR ::isError ($fields)) {
foreach ($fields as $field => $value) {
$definition = $db->reverse ->getTableFieldDefinition ($name, $field);
if (PEAR ::isError ($definition)) {
$fields[$field] = $definition[0 ];
$indexes = $db->manager ->listTableIndexes ($name);
if (PEAR ::isError ($indexes)) {
foreach ($indexes as $index => $value) {
$definition = $db->reverse ->getTableIndexDefinition ($name, $index);
if (PEAR ::isError ($definition)) {
$indexes[$index] = $definition;
$constraints = $db->manager ->listTableConstraints ($name);
if (PEAR ::isError ($constraints)) {
foreach ($constraints as $constraint => $value) {
if (!empty ($definition['primary'])) {
$options['primary'] = $definition['fields'];
$definition = $db->reverse ->getTableConstraintDefinition ($name, $constraint);
if (PEAR ::isError ($definition)) {
$constraints[$constraint] = $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 );
$result = $this->dropTable ($name);
if (PEAR ::isError ($result)) {
$result = $this->createTable ($name_new, $fields, $options);
if (PEAR ::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 (PEAR ::isError ($stmt)) {
foreach ($data as $row) {
$result = $stmt->execute ($row);
if (PEAR ::isError ($result)) {
* @return mixed data array on success, a MDB2 error on failure
$db = & $this->getDBInstance ();
if (PEAR ::isError ($db)) {
return $db->raiseError (MDB2_ERROR_UNSUPPORTED , null , null ,
'list databases is not supported', __FUNCTION__ );
* @return mixed data array on success, a MDB2 error on failure
$db = & $this->getDBInstance ();
if (PEAR ::isError ($db)) {
return $db->raiseError (MDB2_ERROR_UNSUPPORTED , null , null ,
'list databases is not supported', __FUNCTION__ );
* list all tables in the current database
* @return mixed data array on success, a MDB2 error on failure
$db = & $this->getDBInstance ();
if (PEAR ::isError ($db)) {
$query = "SELECT name FROM sqlite_master WHERE type='table' AND sql NOT NULL ORDER BY name";
$table_names = $db->queryCol ($query);
if (PEAR ::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 tables in the current database
* @param string $table name of table that should be used in method
* @return mixed data array on success, a MDB2 error on failure
$db = & $this->getDBInstance ();
if (PEAR ::isError ($db)) {
$result = $db->loadModule ('Reverse', null , true );
if (PEAR ::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 (PEAR ::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'];
* 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 (PEAR ::isError ($db)) {
$table = $db->quoteIdentifier ($table, true );
$name = $db->getIndexName ($name);
$query = " CREATE 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) . ')';
return $db->exec ($query);
* @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 (PEAR ::isError ($db)) {
$name = $db->getIndexName ($name);
return $db->exec (" DROP INDEX $name" );
// {{{ listTableIndexes()
* list all indexes in a table
* @param string $table name of table that should be used in method
* @return mixed data array on success, a MDB2 error on failure
$db = & $this->getDBInstance ();
if (PEAR ::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 (PEAR ::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 (PEAR ::isError ($db)) {
if (!empty ($definition['primary'])) {
return $db->alterTable ($table, array (), false , array ('primary' => $definition['fields']));
$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) . ')';
return $db->exec ($query);
* 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 (PEAR ::isError ($db)) {
if ($primary || $name == 'PRIMARY') {
return $db->alterTable ($table, array (), false , array ('primary' => null ));
$name = $db->getIndexName ($name);
return $db->exec (" DROP INDEX $name" );
// {{{ listTableConstraints()
* list all constraints in a table
* @param string $table name of table that should be used in method
* @return mixed data array on success, a MDB2 error on failure
$db = & $this->getDBInstance ();
if (PEAR ::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 (PEAR ::isError ($indexes)) {
foreach ($indexes as $sql) {
if (preg_match("/^create unique index ([^ ]+) on /i", $sql, $tmp)) {
$index = $this->_fixIndexName ($tmp[1 ]);
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 (PEAR ::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 (PEAR ::isError ($res)) {
$res = $db->exec (" INSERT INTO $sequence_name ($seqcol_name) VALUES (". ($start-1 ). ')');
if (!PEAR ::isError ($res)) {
$result = $db->exec (" DROP TABLE $sequence_name" );
if (PEAR ::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 (PEAR ::isError ($db)) {
$sequence_name = $db->quoteIdentifier ($db->getSequenceName ($seq_name), true );
return $db->exec (" DROP TABLE $sequence_name" );
* list all sequences in the current database
* @return mixed data array on success, a MDB2 error on failure
$db = & $this->getDBInstance ();
if (PEAR ::isError ($db)) {
$query = "SELECT name FROM sqlite_master WHERE type='table' AND sql NOT NULL ORDER BY name";
$table_names = $db->queryCol ($query);
if (PEAR ::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 14:48:15 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.
|