Source for file Firebird.php
Documentation is available at Firebird.php
* $Id: Firebird.php 1753 2007-06-19 11:10:13Z zYne $
* 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 COPYRIGHT
* OWNER 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.
* This software consists of voluntary contributions made by many individuals
* and is licensed under the LGPL. For more information, see
* <http://www.phpdoctrine.com>.
* @author Konsta Vesterinen <kvesteri@cc.hut.fi>
* @author Lukas Smith <smith@pooteeweet.org> (PEAR MDB2 library)
* @author Lorenzo Alberton <l.alberton@quipo.it> (PEAR MDB2 Interbase driver)
* @license http://www.opensource.org/licenses/lgpl-license.php LGPL
* @category Object Relational Mapping
* @link www.phpdoctrine.com
* @version $Revision: 1753 $
* @param string $name name of the database that should be created
'PHP Interbase API does not support direct queries. You have to ' .
'create the db manually by using isql command or a similar program');
* drop an existing database
* @param string $name name of the database that should be dropped
'PHP Interbase API does not support direct queries. You have ' .
'to drop the db manually by using isql command or a similar program');
* add an autoincrement sequence + trigger
* @param string $name name of the PK field
* @param string $table name of the table
* @param string $start start value for the sequence
$this->conn->beginTransaction();
$query =
'SELECT MAX(' .
$this->conn->quoteIdentifier($name, true) .
') FROM ' .
$this->conn->quoteIdentifier($table, true);
$start =
$this->conn->fetchOne($query, 'integer');
$sequence_name =
$this->conn->formatter->getSequenceName($table);
$trigger_name =
$this->conn->quoteIdentifier($table .
'_AUTOINCREMENT_PK', true);
$table =
$this->conn->quoteIdentifier($table, true);
$name =
$this->conn->quoteIdentifier($name, true);
$triggerSql =
'CREATE TRIGGER ' .
$trigger_name .
' FOR ' .
$table .
'
ACTIVE BEFORE INSERT POSITION 0
IF (NEW.' .
$name .
' IS NULL OR NEW.' .
$name .
' = 0) THEN
NEW.' .
$name .
' = GEN_ID('.
$sequence_name.
', 1);
$result =
$this->conn->exec($triggerSql);
// TODO ? $this->_silentCommit();
* drop an existing autoincrement sequence + trigger
* @param string $table name of the table
//remove autoincrement trigger associated with the table
$triggerName =
$this->conn->quote(strtoupper($table) .
'_AUTOINCREMENT_PK');
return $this->conn->exec("DELETE FROM RDB\$TRIGGERS WHERE UPPER(RDB\$RELATION_NAME)=" .
$table .
" AND UPPER(RDB\$TRIGGER_NAME)=" .
$triggerName);
* @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.
* 'description' => array(
* @param array $options An associative array of table options:
public function createTable($name, array $fields, array $options =
array()) {
// TODO ? $this->_silentCommit();
foreach ($fields as $field_name =>
$field) {
if ( ! empty($field['autoincrement'])) {
'fields' =>
array($field_name =>
array()),
//$pk_name = $name.'_PK';
//create autoincrement sequence + trigger
* Check if planned changes are supported
* @param string $name name of the database that should be dropped
foreach ($changes as $change_name =>
$change) {
return throw new Doctrine_DataDict_Firebird_Exception('it is not supported changes to field default length');
* @param string $name name of the table that should be dropped
* @return mixed MDB2_OK on success, a MDB2 error on failure
//$this->_silentCommit();
* 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.
* 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 Metabase 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.
public function alterTable($name, array $changes, $check)
foreach ($changes as $changeName =>
$change) {
foreach ($changes['change'] as $field) {
if (!empty($changes['add']) &&
is_array($changes['add'])) {
foreach ($changes['add'] as $fieldName =>
$field) {
$query.=
'ADD ' .
$this->getDeclaration($field['type'], $fieldName, $field, $name);
if (!empty($changes['remove']) &&
is_array($changes['remove'])) {
foreach ($changes['remove'] as $field_name =>
$field) {
$field_name =
$this->conn->quoteIdentifier($field_name, true);
$query.=
'DROP ' .
$field_name;
if (!empty($changes['rename']) &&
is_array($changes['rename'])) {
foreach ($changes['rename'] as $field_name =>
$field) {
$field_name =
$this->conn->quoteIdentifier($field_name, true);
$query.=
'ALTER ' .
$field_name .
' TO ' .
$this->conn->quoteIdentifier($field['name'], true);
if (!empty($changes['change']) &&
is_array($changes['change'])) {
// missing support to change DEFAULT and NULLability
foreach ($changes['change'] as $fieldName =>
$field) {
$this->conn->loadModule('Datatype', null, true);
$field_name =
$this->conn->quoteIdentifier($fieldName, true);
$query.=
'ALTER ' .
$field_name.
' TYPE ' .
$this->getTypeDeclaration($field['definition']);
$name =
$this->conn->quoteIdentifier($name, true);
$result =
$this->conn->exec('ALTER TABLE ' .
$name .
' ' .
$query);
* 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()
foreach ($definition['fields'] as $field) {
if (!strcmp($query_sort, '') && isset
($field['sorting'])) {
switch ($field['sorting']) {
$table =
$this->conn->quoteIdentifier($table, true);
$name =
$this->conn->quoteIdentifier($this->conn->formatter->getIndexName($name), true);
$query .=
$query_sort.
' INDEX ' .
$name .
' ON ' .
$table;
foreach (array_keys($definition['fields']) as $field) {
$fields[] =
$this->conn->quoteIdentifier($field, true);
$query .=
' ('.
implode(', ', $fields) .
')';
* 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(),
$table =
$this->conn->quoteIdentifier($table, true);
$name =
$this->conn->quoteIdentifier($this->conn->formatter->getIndexName($name), true);
$query =
"ALTER TABLE $table ADD";
if (!empty($definition['primary'])) {
$query.=
' CONSTRAINT '.
$name;
$query.=
' CONSTRAINT '.
$name;
if (!empty($definition['unique'])) {
foreach (array_keys($definition['fields']) as $field) {
$fields[] =
$this->conn->quoteIdentifier($field, true);
$query .=
' ('.
implode(', ', $fields) .
')';
// TODO ? $this->_silentCommit();
* A method to return the required SQL string that fits between CREATE ... TABLE
* to create the table as a temporary table.
* @return string The string required to be placed between "CREATE" and "TABLE"
* to generate a temporary table, if possible.
return 'GLOBAL TEMPORARY';
* @param string $seqName 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',
public function createSequence($seqName, $start =
1, array $options =
array())
$sequenceName =
$this->conn->formatter->getSequenceName($seqName);
$this->conn->exec('CREATE GENERATOR ' .
$sequenceName);
$this->conn->exec('SET GENERATOR ' .
$sequenceName .
' TO ' .
($start-
1));
* @param string $seqName name of the sequence to be dropped
$sequenceName =
$this->conn->formatter->getSequenceName($seqName);
$sequenceName =
$this->conn->quote($sequenceName);
$query =
"DELETE FROM RDB\$GENERATORS WHERE UPPER(RDB\$GENERATOR_NAME)=" .
$sequenceName;