Source for file oci8.php
Documentation is available at oci8.php
// +----------------------------------------------------------------------+
// | PHP versions 4 and 5 |
// +----------------------------------------------------------------------+
// | Copyright (c) 1998-2004 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: oci8.php,v 1.56 2005/12/28 10:14:57 lsmith Exp $
require_once 'MDB2/Driver/Manager/Common.php';
* MDB2 oci8 driver for the management modules
* @author Lukas Smith <smith@pooteeweet.org>
* @param object $db database object that is extended by this class
* @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)) {
$username = $db->options ['database_name_prefix']. $name;
$password = $db->dsn ['password'] ? $db->dsn ['password'] : $name;
$tablespace = $db->options ['default_tablespace']
? ' DEFAULT TABLESPACE '. $db->options ['default_tablespace'] : '';
$query = 'CREATE USER '. $username. ' IDENTIFIED BY '. $password. $tablespace;
$result = $db->standaloneQuery ($query, null , true );
if (PEAR ::isError ($result)) {
$query = 'GRANT CREATE SESSION, CREATE TABLE, UNLIMITED TABLESPACE, CREATE SEQUENCE TO '. $username;
$result = $db->standaloneQuery ($query, null , true );
if (PEAR ::isError ($result)) {
$query = 'DROP USER '. $username. ' CASCADE';
$result2 = $db->standaloneQuery ($query, null , true );
if (PEAR ::isError ($result2)) {
return $db->raiseError (MDB2_ERROR , null , null ,
'createDatabase: could not setup the database user ('. $result->getUserinfo ().
') and then could drop its records ('. $result2->getUserinfo (). ')');
* drop an existing database
* @param object $db database object that is extended by this class
* @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)) {
$username = $db->options ['database_name_prefix']. $name;
return $db->standaloneQuery ('DROP USER '. $username. ' CASCADE', null , true );
// {{{ _makeAutoincrement()
* 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
* @return mixed MDB2_OK on success, a MDB2 error on failure
function _makeAutoincrement ($name, $table, $start = 1 )
$db = & $this->getDBInstance ();
if (PEAR ::isError ($db)) {
$index_name = $table . '_AUTOINCREMENT_PK';
'fields' => array ($name),
$result = $db->manager ->createConstraint ($table, $index_name, $definition);
if (PEAR ::isError ($result)) {
return $db->raiseError (MDB2_ERROR , null , null ,
'_makeAutoincrement: primary key for autoincrement PK could not be created');
$table = $db->quoteIdentifier ($table, true );
$name = $db->quoteIdentifier ($name, true );
$query = " SELECT MAX($name) FROM $table";
$start = $this->db->queryOne ($query, 'integer');
if (PEAR ::isError ($start)) {
$result = $db->manager ->createSequence ($table, $start);
$result = $db->manager ->createSequence ($table, $start);
if (PEAR ::isError ($result)) {
return $db->raiseError (MDB2_ERROR , null , null ,
'_makeAutoincrement: sequence for autoincrement PK could not be created');
$sequence_name = $db->quoteIdentifier ($db->getSequenceName ($seq_name), true );
$trigger_name = $table . '_AUTOINCREMENT_PK';
$trigger_name = $db->quoteIdentifier ($trigger_name, true );
$trigger_sql = " CREATE TRIGGER $trigger_name BEFORE INSERT ON $table";
$trigger_sql.= " FOR EACH ROW BEGIN IF (:new.$name IS NULL) THEN SELECT ";
$trigger_sql.= " $sequence_name.NEXTVAL INTO :new.$name FROM DUAL; END IF; END;";
return $db->exec ($trigger_sql);
// {{{ _dropAutoincrement()
* drop an existing autoincrement sequence + trigger
* @param string $table name of the table
* @return mixed MDB2_OK on success, a MDB2 error on failure
function _dropAutoincrement ($table)
$db = & $this->getDBInstance ();
if (PEAR ::isError ($db)) {
$trigger_name = $table . '_AUTOINCREMENT_PK';
$trigger_name = $db->quoteIdentifier ($trigger_name, true );
$trigger = $db->queryOne (" SELECT trigger_name FROM user_triggers WHERE trigger_name = '$trigger_name'" );
if (PEAR ::isError ($trigger)) {
$trigger_sql = 'DROP TRIGGER ' . $trigger_name;
$result = $db->exec ($trigger_sql);
if (PEAR ::isError ($result)) {
return $db->raiseError (MDB2_ERROR , null , null ,
'_dropAutoincrement: trigger for autoincrement PK could not be dropped');
$result = $db->manager ->dropSequence ($table);
if (PEAR ::isError ($result)) {
return $db->raiseError (MDB2_ERROR , null , null ,
'_dropAutoincrement: sequence for autoincrement PK could not be dropped');
$index_name = $table . '_AUTOINCREMENT_PK';
$result = $db->manager ->dropConstraint ($table, $index_name);
if (PEAR ::isError ($result)) {
return $db->raiseError (MDB2_ERROR , null , null ,
'_dropAutoincrement: primary key for autoincrement PK could not be dropped');
* @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.
* @return mixed MDB2_OK on success, a MDB2 error on failure
$result = parent ::createTable ($name, $fields);
if (PEAR ::isError ($result)) {
foreach ($fields as $field_name => $field) {
return $this->_makeAutoincrement ($field_name, $name);
* @param string $name name of the table that should be dropped
* @return mixed MDB2_OK on success, a MDB2 error on failure
$result = $this->_dropAutoincrement ($name);
if (PEAR ::isError ($result)) {
return parent ::dropTable ($name);
* 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.
* @return mixed MDB2_OK on success, a MDB2 error on failure
$db = & $this->getDBInstance ();
if (PEAR ::isError ($db)) {
foreach ($changes as $change_name => $change) {
return $db->raiseError (MDB2_ERROR_CANNOT_ALTER , null , null ,
'alterTable: change type "'. $change_name. '" not yet supported');
$name = $db->quoteIdentifier ($name, true );
foreach ($changes['add'] as $field_name => $field) {
$fields[] = $db->getDeclaration ($field['type'], $field_name, $field, $name);
$result = $db->exec (" ALTER TABLE $name ADD (". implode(', ', $fields). ')');
if (PEAR ::isError ($result)) {
foreach ($changes['change'] as $field_name => $field) {
$fields[] = $field_name. ' ' . $db->getDeclaration ($field['definition']['type'], '', $field['definition']);
$result = $db->exec (" ALTER TABLE $name MODIFY (". implode(', ', $fields). ')');
if (PEAR ::isError ($result)) {
foreach ($changes['rename'] as $field_name => $field) {
$field_name = $db->quoteIdentifier ($field_name, true );
$result = $db->exec (" ALTER TABLE $name RENAME COLUMN $field_name TO ". $db->quoteIdentifier ($field['name'], true ));
if (PEAR ::isError ($result)) {
foreach ($changes['remove'] as $field_name => $field) {
$fields[] = $db->quoteIdentifier ($field_name, true );
$result = $db->exec (" ALTER TABLE $name DROP COLUMN ". implode(', ', $fields));
if (PEAR ::isError ($result)) {
$change_name = $db->quoteIdentifier ($changes['name'], true );
$result = $db->exec (" ALTER TABLE $name RENAME TO ". $change_name);
if (PEAR ::isError ($result)) {
* @return mixed data array on success, a MDB2 error on failure
$db = & $this->getDBInstance ();
if (PEAR ::isError ($db)) {
if ($db->options ['database_name_prefix']) {
$query = 'SELECT SUBSTR(username, '
. (strlen($db->options ['database_name_prefix'])+1 )
. ") FROM sys.dba_users WHERE username LIKE '"
. $db->options ['database_name_prefix']. "%'";
$query = 'SELECT username FROM sys.dba_users';
$result2 = $db->standaloneQuery ($query, array ('text'), false );
if (PEAR ::isError ($result2)) {
$result = $result2->fetchCol ();
if (PEAR ::isError ($result)) {
if ($db->options ['portability'] & MDB2_PORTABILITY_FIX_CASE
&& $db->options ['field_case'] == CASE_LOWER
$result = array_map(($db->options ['field_case'] == CASE_LOWER ? 'strtolower' : 'strtoupper'), $result);
* list all users in the current database
* @return mixed data array on success, a MDB2 error on failure
$db = & $this->getDBInstance ();
if (PEAR ::isError ($db)) {
$query = 'SELECT username FROM sys.all_users';
return $db->queryCol ($query);
* list all views in the current database
* @return mixed data array on success, a MDB2 error on failure
$db = & $this->getDBInstance ();
if (PEAR ::isError ($db)) {
$query = 'SELECT view_name FROM sys.user_views';
$result = $db->queryCol ($query);
if (PEAR ::isError ($result)) {
if ($db->options ['portability'] & MDB2_PORTABILITY_FIX_CASE
&& $db->options ['field_case'] == CASE_LOWER
$result = array_map(($db->options ['field_case'] == CASE_LOWER ? 'strtolower' : 'strtoupper'), $result);
* list all functions 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 sys.user_source WHERE line = 1 AND type = 'FUNCTION'";
$result = $db->queryCol ($query);
if (PEAR ::isError ($result)) {
if ($db->options ['portability'] & MDB2_PORTABILITY_FIX_CASE
&& $db->options ['field_case'] == CASE_LOWER
$result = array_map(($db->options ['field_case'] == CASE_LOWER ? 'strtolower' : 'strtoupper'), $result);
* list all tables in the current database
* @return mixed data array on success, a MDB error on failure
$db = & $this->getDBInstance ();
if (PEAR ::isError ($db)) {
$query = 'SELECT table_name FROM sys.user_tables';
$result = $db->queryCol ($query);
if (PEAR ::isError ($result)) {
if ($db->options ['portability'] & MDB2_PORTABILITY_FIX_CASE
&& $db->options ['field_case'] == CASE_LOWER
$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 MDB error on failure
$db = & $this->getDBInstance ();
if (PEAR ::isError ($db)) {
$query = " SELECT column_name FROM user_tab_columns WHERE table_name='$table' ORDER BY column_id";
$result = $db->queryCol ($query);
if (PEAR ::isError ($result)) {
if ($db->options ['portability'] & MDB2_PORTABILITY_FIX_CASE
&& $db->options ['field_case'] == CASE_LOWER
$result = array_map(($db->options ['field_case'] == CASE_LOWER ? 'strtolower' : 'strtoupper'), $result);
// {{{ 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)) {
$query = " SELECT index_name name FROM user_indexes WHERE table_name='$table'";
$indexes = $db->queryCol ($query, 'text');
if (PEAR ::isError ($indexes)) {
foreach ($indexes as $index) {
if ($index = $this->_isIndexName ($index)) {
if ($db->options ['portability'] & MDB2_PORTABILITY_FIX_CASE
&& $db->options ['field_case'] == CASE_LOWER
// {{{ listTableConstraints()
* list all sonstraints 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)) {
$query = " SELECT index_name name FROM user_constraints WHERE table_name='$table'";
$constraints = $db->queryCol ($query);
if (PEAR ::isError ($constraints)) {
foreach ($constraints as $constraint) {
if ($constraint = $this->_isIndexName ($constraint)) {
$result[$constraint] = true;
if ($db->options ['portability'] & MDB2_PORTABILITY_FIX_CASE
&& $db->options ['field_case'] == CASE_LOWER
* @param object $db database object that is extended by this class
* @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 );
return $db->exec (" CREATE SEQUENCE $sequence_name START WITH $start INCREMENT BY 1".
($start < 1 ? " MINVALUE $start" : ''));
* @param object $db database object that is extended by this class
* @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 SEQUENCE $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 sequence_name FROM sys.user_sequences";
$table_names = $db->queryCol ($query);
if (PEAR ::isError ($table_names)) {
for ($i = 0 , $j = count($table_names); $i < $j; ++ $i) {
if ($sqn = $this->_isSequenceName ($table_names[$i])) {
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:32:24 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.
|