DB_oci8
The methods PEAR DB uses to interact with PHP's oci8 extension for interacting with Oracle databases
Definitely works with versions 8 and 9 of Oracle.
These methods overload the ones declared in DB_common.
Be aware... OCIError() only appears to return anything when given a statement, so functions return the generic DB_ERROR instead of more useful errors that have to do with feedback from the database.
Located in /web/lib/external/pear-db/DB/oci8.php (line 53)
PEAR | --DB_common | --DB_oci8
resource
$connection
(line 122)
The raw database connection created by PHP
string
$dbsyntax
= 'oci8' (line 67)
The database syntax variant to be used (db2, access, etc.), if any
array
$dsn
= array() (line 128)
The DSN information for connecting to a database
array
$errorcode_map
= array(1 => DB_ERROR_CONSTRAINT,
900 => DB_ERROR_SYNTAX,
904 => DB_ERROR_NOSUCHFIELD,
913 => DB_ERROR_VALUE_COUNT_ON_ROW,
921 => DB_ERROR_SYNTAX,
923 => DB_ERROR_SYNTAX,
942 => DB_ERROR_NOSUCHTABLE,
955 => DB_ERROR_ALREADY_EXISTS,
1400 => DB_ERROR_CONSTRAINT_NOT_NULL,
1401 => DB_ERROR_INVALID,
1407 => DB_ERROR_CONSTRAINT_NOT_NULL,
1418 => DB_ERROR_NOT_FOUND,
1476 => DB_ERROR_DIVZERO,
1722 => DB_ERROR_INVALID_NUMBER,
2289 => DB_ERROR_NOSUCHTABLE,
2291 => DB_ERROR_CONSTRAINT,
2292 => DB_ERROR_CONSTRAINT,
2449 => DB_ERROR_CONSTRAINT,
12899 => DB_ERROR_INVALID,
) (line 96)
A mapping of native error codes to DB error codes
array
$features
= array('limit' => 'alter',
'new_link' => '5.0.0',
'numrows' => 'subquery',
'pconnect' => true,
'prepare' => true,
'ssl' => false,
'transactions' => true,
) (line 82)
The capabilities of this DB implementation
The 'new_link' element contains the PHP version that first provided new_link support for this DBMS. Contains false if it's unsupported.
Meaning of the 'limit' element:
- 'emulate' = emulate with fetch row by number
- 'alter' = alter the query
- false = skip rows
resource
$last_stmt
(line 155)
The result or statement handle from the most recently executed query
string
$phptype
= 'oci8' (line 61)
The DB driver type (mysql, oci8, odbc, etc.)
Inherited Variables
Inherited from DB_common
Determines the number of rows affected by a data maniuplation query
- is returned for queries that don't manipulate data.
- DB_common::affectedRows()
- Determines the number of rows affected by a data maniuplation query
Enables or disables automatic commits
- bool $onoff: true turns it on, false turns it off
- DB_common::autoCommit()
- Enables or disables automatic commits
Commits the current transaction
- DB_common::commit()
- Commits the current transaction
Connect to the database server, log in and open the database
Don't call this method directly. Use DB::connect() instead.
If PHP is at version 5.0.0 or greater:
- Generally, oci_connect() or oci_pconnect() are used.
- But if the new_link DSN option is set to true, oci_new_connect() is used.
PEAR DB's oci8 driver supports the following extra DSN options:
- charset The character set to be used on the connection. Only used if PHP is at version 5.0.0 or greater and the Oracle server is at 9.2 or greater. Available since PEAR DB 1.7.0.
- new_link If set to true, causes subsequent calls to connect() to return a new connection link instead of the existing one. WARNING: this is not portable to other DBMS's. Available since PEAR DB 1.7.0.
- array $dsn: the data source name
- bool $persistent: should the connection be persistent?
Creates a new sequence
- string $seq_name: name of the new sequence
- DB_common::createSequence()
- Creates a new sequence
Deletes a sequence
- string $seq_name: name of the sequence to be deleted
- DB_common::dropSequence()
- Deletes a sequence
Gets the DBMS' native error code produced by the last query
- DB_common::errorNative()
- Gets the DBMS' native error code produced by the last query
Executes a DB statement prepared with prepare().
To determine how many rows of a result set get buffered using ocisetprefetch(), see the "result_buffering" option in setOptions(). This option was added in Release 1.7.0.
- resource $stmt: a DB statement resource returned from prepare()
- mixed $data: array, string or numeric data to be used in execution of the statement. Quantity of items passed must match quantity of placeholders in query: meaning 1 for non-array items or the quantity of elements in the array.
- DB_common::execute()
- Executes a DB statement prepared with prepare()
Places a row from the result set into the given array
Formating of the array and the data therein are configurable. See DB_result::fetchInto() for more information.
This method is not meant to be called directly. Use DB_result::fetchInto() instead. It can't be declared "protected" because DB_result is a separate object.
- resource $result: the query result resource
- array $arr: the referenced array to put the data in
- int $fetchmode: how the resulting array should be indexed
- int $rownum: the row number to fetch (0 = first row)
- &$arr
Frees the internal resources associated with a prepared query
- resource $stmt: the prepared statement's resource
- bool $free_resource: should the PHP resource be freed too? Use false if you need to get data from the result set later.
- DB_common::freePrepared()
- Frees the internal resources associated with a prepared query
Deletes the result set and frees the memory occupied by the result set
This method is not meant to be called directly. Use DB_result::free() instead. It can't be declared "protected" because DB_result is a separate object.
- resource $result: PHP's query result resource
Obtains the query string needed for listing a given type of objects
- string $type: the kind of objects you want to retrieve
- DB_common::getSpecialQuery()
- Obtains the query string needed for listing a given type of objects
Adds LIMIT clauses to a query string according to current DBMS standards
- string $query: the query to modify
- int $from: the row to start to fetching (0 = the first row)
- int $count: the numbers of rows to fetch
- mixed $params: array, string or numeric data to be used in execution of the statement. Quantity of items passed must match quantity of placeholders in query: meaning 1 placeholder for non-array parameters or 1 placeholder per array element.
- DB_common::modifyLimitQuery()
- Adds LIMIT clauses to a query string according to current DBMS standards
Changes a query string for various DBMS specific reasons
"SELECT 2+2" must be "SELECT 2+2 FROM dual" in Oracle.
- string $query: the query string to modify
- DB_common::modifyQuery()
- Changes a query string for various DBMS specific reasons
Returns the next free id in a sequence
- string $seq_name: name of the sequence
- boolean $ondemand: when true, the seqence is automatically created if it does not exist
- DB_common::nextId()
- Returns the next free id in a sequence
Move the internal oracle result pointer to the next available result
- a $result: valid oci8 result resource
Gets the number of columns in a result set
This method is not meant to be called directly. Use DB_result::numCols() instead. It can't be declared "protected" because DB_result is a separate object.
- resource $result: PHP's query result resource
Gets the number of rows in a result set
Only works if the DB_PORTABILITY_NUMROWS portability option is turned on.
This method is not meant to be called directly. Use DB_result::numRows() instead. It can't be declared "protected" because DB_result is a separate object.
- resource $result: PHP's query result resource
- DB_common::numRows()
- Determines the number of rows in a query result
Produces a DB_Error object regarding the current problem
- int $errno: if the error is being manually raised pass a DB_ERROR* constant here. If this isn't passed the error information gathered from the DBMS.
Prepares a query for multiple execution with execute().
With oci8, this is emulated.
prepare() requires a generic query as string like
- INSERT INTO numbers VALUES (?, ?, ?)
Three types of placeholders can be used:
- ? a quoted scalar value, i.e. strings, integers
- ! value is inserted 'as is'
- & requires a file name. The file's contents get inserted into the query (i.e. saving binary data in a db)
- "UPDATE foo SET col=? WHERE col='over \& under'"
- string $query: the query to be prepared
- DB_common::prepare()
- Prepares a query for multiple execution with execute()
Formats a float value for use within a query in a locale-independent manner.
- float $float: the float value to be quoted.
- DB_common::quoteFloat()
- Formats a float value for use within a query in a locale-independent manner.
Reverts the current transaction
- DB_common::rollback()
- Reverts the current transaction
Sends a query to the database server
To determine how many rows of a result set get buffered using ocisetprefetch(), see the "result_buffering" option in setOptions(). This option was added in Release 1.7.0.
- string $query: the SQL query string
Returns information about a table or a result set
NOTE: only supports 'table' and 'flags' if $result is a table name.
NOTE: flags won't contain index information.
- object|string $result: DB_result object from a query or a string containing the name of a table. While this also accepts a query result resource identifier, this behavior is deprecated.
- int $mode: a valid tableInfo mode
- DB_common::tableInfo()
- Returns information about a table or a result set
Inherited Methods
Inherited From DB_common
DB_common::DB_common()
DB_common::affectedRows()
Inherited From PEAR
Documentation generated on Wed, 09 Feb 2011 09:02:29 +0700 by phpDocumentor 1.4.2