Zend_Db_Adapter_Oracle Class Reference

Inheritance diagram for Zend_Db_Adapter_Oracle:

Public Member Functions
	isConnected ()
	closeConnection ()
	setLobAsString ($lobAsString)
	getLobAsString ()
	prepare ($sql)
	quoteTableAs ($ident, $alias=null, $auto=false)
	lastSequenceId ($sequenceName)
	nextSequenceId ($sequenceName)
	lastInsertId ($tableName=null, $primaryKey=null)
	listTables ()
	describeTable ($tableName, $schemaName=null)
	setFetchMode ($mode)
	limit ($sql, $count, $offset=0)
	_getExecuteMode ()
	supportsParameters ($type)
	getServerVersion ()
Public Member Functions inherited from Zend_Db_Adapter_Abstract
	__construct ($config)
	getConnection ()
	getConfig ()
	setProfiler ($profiler)
	getProfiler ()
	getStatementClass ()
	setStatementClass ($class)
	query ($sql, $bind=array())
	beginTransaction ()
	commit ()
	rollBack ()
	insert ($table, array $bind)
	update ($table, array $bind, $where='')
	delete ($table, $where='')
	select ()
	getFetchMode ()
	fetchAll ($sql, $bind=array(), $fetchMode=null)
	fetchRow ($sql, $bind=array(), $fetchMode=null)
	fetchAssoc ($sql, $bind=array())
	fetchCol ($sql, $bind=array())
	fetchPairs ($sql, $bind=array())
	fetchOne ($sql, $bind=array())
	quote ($value, $type=null)
	quoteInto ($text, $value, $type=null, $count=null)
	quoteIdentifier ($ident, $auto=false)
	quoteColumnAs ($ident, $alias, $auto=false)
	quoteTableAs ($ident, $alias=null, $auto=false)
	getQuoteIdentifierSymbol ()
	lastSequenceId ($sequenceName)
	nextSequenceId ($sequenceName)
	foldCase ($key)
	__sleep ()
	__wakeup ()
	listTables ()
	describeTable ($tableName, $schemaName=null)
	isConnected ()
	closeConnection ()
	prepare ($sql)
	lastInsertId ($tableName=null, $primaryKey=null)
	setFetchMode ($mode)
	limit ($sql, $count, $offset=0)
	supportsParameters ($type)
	getServerVersion ()

Protected Member Functions
	_connect ()
	_quote ($value)
	_beginTransaction ()
	_commit ()
	_rollBack ()
Protected Member Functions inherited from Zend_Db_Adapter_Abstract
	_checkRequiredOptions (array $config)
	_whereExpr ($where)
	_quote ($value)
	_quoteIdentifierAs ($ident, $alias=null, $auto=false, $as=' AS ')
	_quoteIdentifier ($value, $auto=false)
	_connect ()
	_beginTransaction ()
	_commit ()
	_rollBack ()

Protected Attributes
	$_config
	$_numericDataTypes
	$_execute_mode = null
	$_defaultStmtClass = 'Zend_Db_Statement_Oracle'
	$_lobAsString = null
Protected Attributes inherited from Zend_Db_Adapter_Abstract
	$_config = array()
	$_fetchMode = Zend_Db::FETCH_ASSOC
	$_profiler
	$_defaultStmtClass = 'Zend_Db_Statement'
	$_defaultProfilerClass = 'Zend_Db_Profiler'
	$_connection = null
	$_caseFolding = Zend_Db::CASE_NATURAL
	$_autoQuoteIdentifiers = true
	$_numericDataTypes
	$_allowSerialization = true
	$_autoReconnectOnUnserialize = false

Detailed Description

Definition at line 40 of file Oracle.php.

Member Function Documentation

_beginTransaction()

_beginTransaction ( )

protected

Leave autocommit mode and begin a transaction.

Returns

void

Definition at line 454 of file Oracle.php.

    {
        $this->_setExecuteMode(OCI_DEFAULT);
    }

_commit()

_commit ( )

protected

Commit a transaction and return to autocommit mode.

Returns

void

Exceptions

Zend_Db_Adapter_Oracle_Exception

See also

Zend_Db_Adapter_Oracle_Exception

Definition at line 465 of file Oracle.php.

    {
        if (!oci_commit($this->_connection)) {
            #require_once 'Zend/Db/Adapter/Oracle/Exception.php';
            throw new Zend_Db_Adapter_Oracle_Exception(oci_error($this->_connection));
        }
        $this->_setExecuteMode(OCI_COMMIT_ON_SUCCESS);
    }

_connect()

_connect ( )

protected

Creates a connection resource.

Returns

void

Exceptions

Zend_Db_Adapter_Oracle_Exception

See also

Zend_Db_Adapter_Oracle_Exception

Zend_Db_Adapter_Oracle_Exception

Definition at line 107 of file Oracle.php.

    {
        if (is_resource($this->_connection)) {
            // connection already exists
            return;
        }

        if (!extension_loaded('oci8')) {
            #require_once 'Zend/Db/Adapter/Oracle/Exception.php';
            throw new Zend_Db_Adapter_Oracle_Exception('The OCI8 extension is required for this adapter but the extension is not loaded');
        }

        $this->_setExecuteMode(OCI_COMMIT_ON_SUCCESS);

        $connectionFuncName = ($this->_config['persistent'] == true) ? 'oci_pconnect' : 'oci_connect';

        $this->_connection = @$connectionFuncName(
                $this->_config['username'],
                $this->_config['password'],
                $this->_config['dbname'],
                $this->_config['charset']);

        // check the connection
        if (!$this->_connection) {
            #require_once 'Zend/Db/Adapter/Oracle/Exception.php';
            throw new Zend_Db_Adapter_Oracle_Exception(oci_error());
        }
    }

_getExecuteMode()

_getExecuteMode

(

)

Returns

int

Definition at line 601 of file Oracle.php.

    {
        return $this->_execute_mode;
    }

_quote()

_quote (   $value )

protected

Quote a raw string.

Parameters

string

$value

Raw string

Returns

string Quoted string

Definition at line 226 of file Oracle.php.

    {
        if (is_int($value) || is_float($value)) {
            return $value;
        }
        $value = str_replace("'", "''", $value);
        return "'" . addcslashes($value, "\000\n\r\\\032") . "'";
    }

_rollBack()

_rollBack ( )

protected

Roll back a transaction and return to autocommit mode.

Returns

void

Exceptions

Zend_Db_Adapter_Oracle_Exception

See also

Zend_Db_Adapter_Oracle_Exception

Definition at line 483 of file Oracle.php.

    {
        if (!oci_rollback($this->_connection)) {
            #require_once 'Zend/Db/Adapter/Oracle/Exception.php';
            throw new Zend_Db_Adapter_Oracle_Exception(oci_error($this->_connection));
        }
        $this->_setExecuteMode(OCI_COMMIT_ON_SUCCESS);
    }

closeConnection()

closeConnection

(

)

Force the connection to close.

Returns

void

Definition at line 159 of file Oracle.php.

    {
        if ($this->isConnected()) {
            oci_close($this->_connection);
        }
        $this->_connection = null;
    }

describeTable()

describeTable	(		$tableName,
			$schemaName = null
	)

Returns the column descriptions for a table.

The return value is an associative array keyed by the column name, as returned by the RDBMS.

The value of each array element is an associative array with the following keys:

SCHEMA_NAME => string; name of schema TABLE_NAME => string; COLUMN_NAME => string; column name COLUMN_POSITION => number; ordinal position of column in table DATA_TYPE => string; SQL datatype name of column DEFAULT => string; default expression of column, null if none NULLABLE => boolean; true if column can have nulls LENGTH => number; length of CHAR/VARCHAR SCALE => number; scale of NUMERIC/DECIMAL PRECISION => number; precision of NUMERIC/DECIMAL UNSIGNED => boolean; unsigned property of an integer type PRIMARY => boolean; true if column is part of the primary key PRIMARY_POSITION => integer; position of column in primary key IDENTITY => integer; true if column is auto-generated with unique values

Todo:

Discover integer unsigned property.

Parameters

string	$tableName
string	$schemaName	OPTIONAL

Returns

array

Use FETCH_NUM so we are not dependent on the CASE attribute of the PDO connection

Oracle does not support auto-increment keys.

Definition at line 355 of file Oracle.php.

    {
        $version = $this->getServerVersion();
        if (($version === null) || version_compare($version, '9.0.0', '>=')) {
            $sql = "SELECT TC.TABLE_NAME, TC.OWNER, TC.COLUMN_NAME, TC.DATA_TYPE,
                    TC.DATA_DEFAULT, TC.NULLABLE, TC.COLUMN_ID, TC.DATA_LENGTH,
                    TC.DATA_SCALE, TC.DATA_PRECISION, C.CONSTRAINT_TYPE, CC.POSITION
                FROM ALL_TAB_COLUMNS TC
                LEFT JOIN (ALL_CONS_COLUMNS CC JOIN ALL_CONSTRAINTS C
                    ON (CC.CONSTRAINT_NAME = C.CONSTRAINT_NAME AND CC.TABLE_NAME = C.TABLE_NAME AND CC.OWNER = C.OWNER AND C.CONSTRAINT_TYPE = 'P'))
                  ON TC.TABLE_NAME = CC.TABLE_NAME AND TC.COLUMN_NAME = CC.COLUMN_NAME
                WHERE UPPER(TC.TABLE_NAME) = UPPER(:TBNAME)";
            $bind[':TBNAME'] = $tableName;
            if ($schemaName) {
                $sql .= ' AND UPPER(TC.OWNER) = UPPER(:SCNAME)';
                $bind[':SCNAME'] = $schemaName;
            }
            $sql .= ' ORDER BY TC.COLUMN_ID';
        } else {
            $subSql="SELECT AC.OWNER, AC.TABLE_NAME, ACC.COLUMN_NAME, AC.CONSTRAINT_TYPE, ACC.POSITION
                from ALL_CONSTRAINTS AC, ALL_CONS_COLUMNS ACC
                  WHERE ACC.CONSTRAINT_NAME = AC.CONSTRAINT_NAME
                    AND ACC.TABLE_NAME = AC.TABLE_NAME
                    AND ACC.OWNER = AC.OWNER
                    AND AC.CONSTRAINT_TYPE = 'P'
                    AND UPPER(AC.TABLE_NAME) = UPPER(:TBNAME)";
            $bind[':TBNAME'] = $tableName;
            if ($schemaName) {
                $subSql .= ' AND UPPER(ACC.OWNER) = UPPER(:SCNAME)';
                $bind[':SCNAME'] = $schemaName;
            }
            $sql="SELECT TC.TABLE_NAME, TC.OWNER, TC.COLUMN_NAME, TC.DATA_TYPE,
                    TC.DATA_DEFAULT, TC.NULLABLE, TC.COLUMN_ID, TC.DATA_LENGTH,
                    TC.DATA_SCALE, TC.DATA_PRECISION, CC.CONSTRAINT_TYPE, CC.POSITION
                FROM ALL_TAB_COLUMNS TC, ($subSql) CC
                WHERE UPPER(TC.TABLE_NAME) = UPPER(:TBNAME)
                  AND TC.OWNER = CC.OWNER(+) AND TC.TABLE_NAME = CC.TABLE_NAME(+) AND TC.COLUMN_NAME = CC.COLUMN_NAME(+)";
            if ($schemaName) {
                $sql .= ' AND UPPER(TC.OWNER) = UPPER(:SCNAME)';
            }
            $sql .= ' ORDER BY TC.COLUMN_ID';
        }

        $stmt = $this->query($sql, $bind);

        $result = $stmt->fetchAll(Zend_Db::FETCH_NUM);

        $table_name      = 0;
        $owner           = 1;
        $column_name     = 2;
        $data_type       = 3;
        $data_default    = 4;
        $nullable        = 5;
        $column_id       = 6;
        $data_length     = 7;
        $data_scale      = 8;
        $data_precision  = 9;
        $constraint_type = 10;
        $position        = 11;

        $desc = array();
        foreach ($result as $key => $row) {
            list ($primary, $primaryPosition, $identity) = array(false, null, false);
            if ($row[$constraint_type] == 'P') {
                $primary = true;
                $primaryPosition = $row[$position];
                $identity = false;
            }
            $desc[$this->foldCase($row[$column_name])] = array(
                'SCHEMA_NAME'      => $this->foldCase($row[$owner]),
                'TABLE_NAME'       => $this->foldCase($row[$table_name]),
                'COLUMN_NAME'      => $this->foldCase($row[$column_name]),
                'COLUMN_POSITION'  => $row[$column_id],
                'DATA_TYPE'        => $row[$data_type],
                'DEFAULT'          => $row[$data_default],
                'NULLABLE'         => (bool) ($row[$nullable] == 'Y'),
                'LENGTH'           => $row[$data_length],
                'SCALE'            => $row[$data_scale],
                'PRECISION'        => $row[$data_precision],
                'UNSIGNED'         => null, // @todo
                'PRIMARY'          => $primary,
                'PRIMARY_POSITION' => $primaryPosition,
                'IDENTITY'         => $identity
            );
        }
        return $desc;
    }

getLobAsString()

getLobAsString

(

)

Return whether or not LOB are returned as string

Returns

boolean

Definition at line 184 of file Oracle.php.

    {
        if ($this->_lobAsString === null) {
            // if never set by user, we use driver option if it exists otherwise false
            if (isset($this->_config['driver_options']) &&
                isset($this->_config['driver_options']['lob_as_string'])) {
                $this->_lobAsString = (bool) $this->_config['driver_options']['lob_as_string'];
            } else {
                $this->_lobAsString = false;
            }
        }
        return $this->_lobAsString;
    }

getServerVersion()

getServerVersion

(

)

Retrieve server version in PHP style

Returns

string

Definition at line 628 of file Oracle.php.

    {
        $this->_connect();
        $version = oci_server_version($this->_connection);
        if ($version !== false) {
            $matches = null;
            if (preg_match('/((?:[0-9]{1,2}\.){1,3}[0-9]{1,2})/', $version, $matches)) {
                return $matches[1];
            } else {
                return null;
            }
        } else {
            return null;
        }
    }

isConnected()

isConnected

(

)

Test if a connection is active

Returns

boolean

Definition at line 147 of file Oracle.php.

    {
        return ((bool) (is_resource($this->_connection)
                    && (get_resource_type($this->_connection) == 'oci8 connection'
                     || get_resource_type($this->_connection) == 'oci8 persistent connection')));
        }

lastInsertId()

lastInsertId	(		$tableName = null,
			$primaryKey = null
	)

Gets the last ID generated automatically by an IDENTITY/AUTOINCREMENT column.

As a convention, on RDBMS brands that support sequences (e.g. Oracle, PostgreSQL, DB2), this method forms the name of a sequence from the arguments and returns the last id generated by that sequence. On RDBMS brands that support IDENTITY/AUTOINCREMENT columns, this method returns the last value generated for such a column, and the table name argument is disregarded.

Oracle does not support IDENTITY columns, so if the sequence is not specified, this method returns null.

Parameters

string	$tableName	OPTIONAL Name of table.
string	$primaryKey	OPTIONAL Name of primary key column.

Returns

string

Definition at line 298 of file Oracle.php.

    {
        if ($tableName !== null) {
            $sequenceName = $tableName;
            if ($primaryKey) {
                $sequenceName .= "_$primaryKey";
            }
            $sequenceName .= '_seq';
            return $this->lastSequenceId($sequenceName);
        }

        // No support for IDENTITY columns; return null
        return null;
    }

lastSequenceId()

lastSequenceId

(

$sequenceName

)

Return the most recent value from the specified sequence in the database. This is supported only on RDBMS brands that support sequences (e.g. Oracle, PostgreSQL, DB2). Other RDBMS brands return null.

Parameters

string

$sequenceName

Returns

string

Definition at line 257 of file Oracle.php.

    {
        $this->_connect();
        $sql = 'SELECT '.$this->quoteIdentifier($sequenceName, true).'.CURRVAL FROM dual';
        $value = $this->fetchOne($sql);
        return $value;
    }

limit()

limit	(		$sql,
			$count,
			$offset = 0
	)

Adds an adapter-specific LIMIT clause to the SELECT statement.

Parameters

string	$sql
integer	$count
integer	$offset	OPTIONAL

Returns

string

Exceptions

Zend_Db_Adapter_Oracle_Exception

See also

Zend_Db_Adapter_Oracle_Exception

Zend_Db_Adapter_Oracle_Exception

Oracle does not implement the LIMIT clause as some RDBMS do. We have to simulate it with subqueries and ROWNUM. Unfortunately because we use the column wildcard "*", this puts an extra column into the query result set.

Definition at line 539 of file Oracle.php.

    {
        $count = intval($count);
        if ($count <= 0) {
            #require_once 'Zend/Db/Adapter/Oracle/Exception.php';
            throw new Zend_Db_Adapter_Oracle_Exception("LIMIT argument count=$count is not valid");
        }

        $offset = intval($offset);
        if ($offset < 0) {
            #require_once 'Zend/Db/Adapter/Oracle/Exception.php';
            throw new Zend_Db_Adapter_Oracle_Exception("LIMIT argument offset=$offset is not valid");
        }

        $limit_sql = "SELECT z2.*
            FROM (
                SELECT z1.*, ROWNUM AS \"zend_db_rownum\"
                FROM (
                    " . $sql . "
                ) z1
            ) z2
            WHERE z2.\"zend_db_rownum\" BETWEEN " . ($offset+1) . " AND " . ($offset+$count);
        return $limit_sql;
    }

listTables()

listTables

(

)

Returns a list of the tables in the database.

Returns

array

Definition at line 318 of file Oracle.php.

    {
        $this->_connect();
        $data = $this->fetchCol('SELECT table_name FROM all_tables');
        return $data;
    }

nextSequenceId()

nextSequenceId

(

$sequenceName

)

Generate a new value from the specified sequence in the database, and return it. This is supported only on RDBMS brands that support sequences (e.g. Oracle, PostgreSQL, DB2). Other RDBMS brands return null.

Parameters

string

$sequenceName

Returns

string

Definition at line 273 of file Oracle.php.

    {
        $this->_connect();
        $sql = 'SELECT '.$this->quoteIdentifier($sequenceName, true).'.NEXTVAL FROM dual';
        $value = $this->fetchOne($sql);
        return $value;
    }

prepare()

prepare

(

$sql

)

Returns an SQL statement for preparation.

Parameters

string

$sql

The SQL statement with placeholders.

Returns

Zend_Db_Statement_Oracle

Definition at line 204 of file Oracle.php.

    {
        $this->_connect();
        $stmtClass = $this->_defaultStmtClass;
        if (!class_exists($stmtClass)) {
            #require_once 'Zend/Loader.php';
            Zend_Loader::loadClass($stmtClass);
        }
        $stmt = new $stmtClass($this, $sql);
        if ($stmt instanceof Zend_Db_Statement_Oracle) {
            $stmt->setLobAsString($this->getLobAsString());
        }
        $stmt->setFetchMode($this->_fetchMode);
        return $stmt;
    }

quoteTableAs()

quoteTableAs	(		$ident,
			$alias = null,
			$auto = false
	)

Quote a table identifier and alias.

Parameters

string | array | Zend_Db_Expr	$ident	The identifier or expression.
string	$alias	An alias for the table.
boolean	$auto	If true, heed the AUTO_QUOTE_IDENTIFIERS config option.

Returns

string The quoted identifier and alias.

Definition at line 243 of file Oracle.php.

    {
        // Oracle doesn't allow the 'AS' keyword between the table identifier/expression and alias.
        return $this->_quoteIdentifierAs($ident, $alias, $auto, ' ');
    }

setFetchMode()

setFetchMode

(

$mode

)

Set the fetch mode.

Todo:

Support FETCH_CLASS and FETCH_INTO.

Parameters

integer

$mode

A fetch mode.

Returns

void

Exceptions

Zend_Db_Adapter_Oracle_Exception

See also

Zend_Db_Adapter_Oracle_Exception

Zend_Db_Adapter_Oracle_Exception

Definition at line 504 of file Oracle.php.

    {
        switch ($mode) {
            case Zend_Db::FETCH_NUM:   // seq array
            case Zend_Db::FETCH_ASSOC: // assoc array
            case Zend_Db::FETCH_BOTH:  // seq+assoc array
            case Zend_Db::FETCH_OBJ:   // object
                $this->_fetchMode = $mode;
                break;
            case Zend_Db::FETCH_BOUND: // bound to PHP variable
                #require_once 'Zend/Db/Adapter/Oracle/Exception.php';
                throw new Zend_Db_Adapter_Oracle_Exception('FETCH_BOUND is not supported yet');
                break;
            default:
                #require_once 'Zend/Db/Adapter/Oracle/Exception.php';
                throw new Zend_Db_Adapter_Oracle_Exception("Invalid fetch mode '$mode' specified");
                break;
        }
    }

setLobAsString()

setLobAsString

(

$lobAsString

)

Activate/deactivate return of LOB as string

Parameters

string

$lob_as_string

Returns

Zend_Db_Adapter_Oracle

Definition at line 173 of file Oracle.php.

    {
        $this->_lobAsString = (bool) $lobAsString;
        return $this;
    }

supportsParameters()

supportsParameters

(

$type

)

Check if the adapter supports real SQL parameters.

Parameters

string

$type

'positional' or 'named'

Returns

bool

Definition at line 612 of file Oracle.php.

    {
        switch ($type) {
            case 'named':
                return true;
            case 'positional':
            default:
                return false;
        }
    }

Field Documentation

$_config

$_config

protected

Initial value:

= array(
        'dbname'       => null,
        'username'     => null,
        'password'     => null,
        'persistent'   => false
    )

Definition at line 54 of file Oracle.php.

$_defaultStmtClass

$_defaultStmtClass = 'Zend_Db_Statement_Oracle'

protected

Definition at line 91 of file Oracle.php.

$_execute_mode

$_execute_mode = null

protected

Definition at line 84 of file Oracle.php.

$_lobAsString

$_lobAsString = null

protected

Definition at line 99 of file Oracle.php.

$_numericDataTypes

$_numericDataTypes

protected

Initial value:

= array(
        Zend_Db::INT_TYPE    => Zend_Db::INT_TYPE,
        Zend_Db::BIGINT_TYPE => Zend_Db::BIGINT_TYPE,
        Zend_Db::FLOAT_TYPE  => Zend_Db::FLOAT_TYPE,
        'BINARY_DOUBLE'      => Zend_Db::FLOAT_TYPE,
        'BINARY_FLOAT'       => Zend_Db::FLOAT_TYPE,
        'NUMBER'             => Zend_Db::FLOAT_TYPE,
    )

Definition at line 72 of file Oracle.php.

---

The documentation for this class was generated from the following file:

• vendor/magento/zendframework1/library/Zend/Db/Adapter/Oracle.php