Source for file fbsql.php
Documentation is available at fbsql.php
// +----------------------------------------------------------------------+
// | PHP versions 4 and 5 |
// +----------------------------------------------------------------------+
// | Copyright (c) 1998-2004 Manuel Lemos, Tomas V.V.Cox, |
// | Stig. S. Bakken, Lukas Smith, Frank M. Kromann |
// | 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@backendmedia.com> |
// +----------------------------------------------------------------------+
// $Id: fbsql.php,v 1.21 2005/04/16 22:27:48 lsmith Exp $
require_once 'MDB2/Driver/Manager/Common.php';
* MDB2 FrontBase driver for the management modules
* @author Frank M. Kromann <frank@kromann.info>
* @param string $name name of the database that should be created
* @return mixed MDB2_OK on success, a MDB2 error on failure
$db = & $GLOBALS['_MDB2_databases'][$this->db_index];
if (PEAR ::isError ($result = $db->connect ())) {
$query = " CREATE DATABASE $name";
if (PEAR ::isError ($result = $db->query ($query))) {
* 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 = & $GLOBALS['_MDB2_databases'][$this->db_index];
if (PEAR ::isError ($result = $db->connect ())) {
$query = " DELETE DATABASE $name";
if (PEAR ::isError ($result = $db->query ($query))) {
* @param object $dbs database object that is extended by this class
* @param string $name name of the table that should be dropped
* @return mixed MDB2_OK on success, a MDB2 error on failure
$db = & $GLOBALS['_MDB2_databases'][$this->db_index];
return $db->query (" DROP TABLE $name CASCADE" );
* 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 Metabase parser.
* Additionally, there should be an 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 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 changed_fields 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 Metabase parser.
* If the default property is meant to be added, removed or changed, there
* should also be an entry with index ChangedDefault assigned to 1. Similarly,
* if the notnull constraint is to be added or removed, there should also be
* an entry with index ChangedNotNull assigned to 1.
* Additionally, there should be an entry named Declaration that is expected
* to contain the portion of the field changed declaration already in DBMS
* specific SQL code as it is used in the CREATE TABLE statement.
* 'added_fields' => array(
* 'declaration' => 'quota INT'
* 'removed_fields' => array(
* 'file_limit' => array(),
* 'time_limit' => array()
* 'changed_fields' => array(
* 'declaration' => "gender CHAR(1) DEFAULT 'M'"
* 'renamed_fields' => array(
* 'declaration' => "gender CHAR(1) DEFAULT 'M'"
* @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 = & $GLOBALS['_MDB2_databases'][$this->db_index];
foreach ($changes as $change_name => $change){
'alterTable: change type "'. $change_name. '" not yet supported');
$query = (isset ($changes['name']) ? 'RENAME AS '. $changes['name'] : '');
if (isset ($changes['added_fields'])) {
$fields = $changes['added_fields'];
foreach ($fields as $field_name => $field) {
$query .= 'ADD '. $field['declaration'];
if (isset ($changes['removed_fields'])) {
$fields = $changes['removed_fields'];
foreach ($fields as $field_name => $field) {
$query .= 'DROP '. $field_name;
$renamed_fields = array ();
if (isset ($changes['renamed_fields'])) {
$fields = $changes['renamed_fields'];
foreach ($fields as $field_name => $field) {
$renamed_fields[$field['name']] = $field_name;
if (isset ($changes['changed_fields'])) {
$fields = $changes['changed_fields'];
foreach ($fields as $field_name => $field) {
if (isset ($renamed_fields[$field_name])) {
$old_field_name = $renamed_fields[$field_name];
unset ($renamed_fields[$field_name]);
$old_field_name = $field_name;
$query .= " CHANGE $old_field_name ". $field['declaration'];
if (count($renamed_fields)) {
foreach ($renamed_fields as $renamed_field_name => $renamed_field) {
$old_field_name = $renamed_fields[$renamed_field_name];
$query .= " CHANGE $old_field_name ". $changes['renamed_fields'][$old_field_name]['declaration'];
return $db->query (" ALTER TABLE $name $query" );
* @return mixed data array on success, a MDB2 error on failure
$db = & $GLOBALS['_MDB2_databases'][$this->db_index];
* @return mixed data array on success, a MDB2 error on failure
$db = & $GLOBALS['_MDB2_databases'][$this->db_index];
return $db->queryCol ('SELECT "user_name" FROM'
. ' information_schema.users');
* list all tables in the current database
* @return mixed data array on success, a MDB2 error on failure
$db = & $GLOBALS['_MDB2_databases'][$this->db_index];
$table_names = $db->queryCol ('SELECT "table_name"'
. ' FROM information_schema.tables'
. ' t0, information_schema.schemata t1'
. ' WHERE t0.schema_pk=t1.schema_pk AND'
. ' "table_type" = \'BASE TABLE\''
. ' AND "schema_name" = current_schema');
if (PEAR ::isError ($table_names)) {
for ($i = 0 , $j = count($table_names), $tables = array (); $i < $j; ++ $i) {
$tables[] = $table_names[$i];
* 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 = & $GLOBALS['_MDB2_databases'][$this->db_index];
$fields = $db->queryCol (" SHOW COLUMNS FROM $table" );
* 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 = & $GLOBALS['_MDB2_databases'][$this->db_index];
$query = "CREATE ". (isset ($definition['unique']) ? 'UNIQUE INDEX' : 'INDEX')." $name on $table (";
foreach ($definition['fields'] as $field_name => $field) {
return $db->query ($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 = & $GLOBALS['_MDB2_databases'][$this->db_index];
return $db->query (" ALTER TABLE $table 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 = & $GLOBALS['_MDB2_databases'][$this->db_index];
$indexes_all = $db->queryCol (" SHOW INDEX FROM $table" , 'text', 'key_name');
if (PEAR ::isError ($indexes_all)) {
$found = $indexes = array ();
foreach ($indexes_all as $index_name) {
if ($indexes_all[$index] != 'PRIMARY' && !isset ($found[$index_name])) {
$indexes[] = $index_name;
$found[$index_name] = true;
* @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 = & $GLOBALS['_MDB2_databases'][$this->db_index];
$sequence_name = $db->getSequenceName ($seq_name);
$seqcol_name = $db->options ['seqcol_name'];
$query = " CREATE TABLE $sequence_name ($seqcol_name INTEGER DEFAULT UNIQUE, PRIMARY KEY($seqcol_name))";
$res = $db->query ($query);
$res = $db->query (" SET UNIQUE = 1 FOR $sequence_name" );
if (PEAR ::isError ($res)) {
$res = $db->query (" INSERT INTO $sequence_name ($seqcol_name) VALUES (". ($start-1 ). ')');
if (!PEAR ::isError ($res)) {
$result = $db->query (" DROP TABLE $sequence_name" );
if (PEAR ::isError ($result)) {
'createSequence: could not drop inconsistent sequence table ('.
$result->getMessage (). ' ('. $result->getUserinfo (). '))');
'createSequence: could not create sequence table ('.
$res->getMessage (). ' ('. $res->getUserinfo (). '))');
* @param string $seq_name name of the sequence to be dropped
* @return mixed MDB2_OK on success, a MDB2 error on failure
$db = & $GLOBALS['_MDB2_databases'][$this->db_index];
$sequence_name = $db->getSequenceName ($seq_name);
return $db->query (" DROP TABLE $sequence_name CASCADE" );
* list all sequences in the current database
* @return mixed data array on success, a MDB2 error on failure
$db = & $GLOBALS['_MDB2_databases'][$this->db_index];
$table_names = $db->queryCol ('SHOW TABLES', 'text');
if (PEAR ::isError ($table_names)) {
for ($i = 0 , $j = count($table_names); $i < $j; ++ $i) {
Documentation generated on Mon, 11 Mar 2019 14:20:16 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.
|