Source for file fbsql.php
Documentation is available at fbsql.php
// +----------------------------------------------------------------------+
// | PHP versions 4 and 5 |
// +----------------------------------------------------------------------+
// | Copyright (c) 1998-2006 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@pooteeweet.org> |
// +----------------------------------------------------------------------+
// $Id: fbsql.php 327310 2012-08-27 15:16:18Z danielc $
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
* @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";
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 = " DELETE DATABASE $name";
return $db->standaloneQuery ($query, null , true );
* @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 = & $this->getDBInstance ();
if (MDB2 ::isError ($db)) {
$name = $db->quoteIdentifier ($name, true );
$result = $db->exec (" DROP TABLE $name CASCADE" );
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'], $old_field_name, $field['definition']);
if (!empty ($rename) && is_array($rename)) {
foreach ($rename as $renamed_field_name => $renamed_field) {
$old_field_name = $rename[$renamed_field_name];
$field = $changes['rename'][$old_field_name];
$query.= 'CHANGE ' . $db->getDeclaration ($field['definition']['type'], $old_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)) {
return $db->raiseError (MDB2_ERROR_NOT_CAPABLE , null , null ,
'not capable', __FUNCTION__ );
* @return mixed array of user names on success, a MDB2 error on failure
$db = & $this->getDBInstance ();
if (MDB2 ::isError ($db)) {
return $db->queryCol ('SELECT "user_name" FROM information_schema.users');
* 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)) {
$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 (MDB2 ::isError ($table_names)) {
for ($i = 0 , $j = count($table_names); $i < $j; ++ $i) {
if (!$this->_fixSequenceName ($table_names[$i], true )) {
$result[] = $table_names[$i];
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);
* @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 (" ALTER TABLE $table 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)) {
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->queryCol ($query, 'text', $key_name);
if (MDB2 ::isError ($indexes)) {
foreach ($indexes as $index) {
if ($index != 'PRIMARY' && ($index = $this->_fixIndexName ($index))) {
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 DEFAULT UNIQUE, PRIMARY KEY($seqcol_name))";
$res = $db->exec ($query);
$res = $db->exec (" SET UNIQUE = 1 FOR $sequence_name" );
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 CASCADE" );
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)) {
$table_names = $db->queryCol ('SHOW TABLES', 'text');
if (MDB2 ::isError ($table_names)) {
for ($i = 0 , $j = count($table_names); $i < $j; ++ $i) {
if ($sqn = $this->_fixSequenceName ($table_names[$i], 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:07 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.
|