com.caucho.quercus.lib.db
Class OracleModule

java.lang.Object
  com.caucho.quercus.module.AbstractQuercusModule
      com.caucho.quercus.lib.db.OracleModule

All Implemented Interfaces:

QuercusModule

public class OracleModule
extends AbstractQuercusModule

Quercus oracle routines. NOTE from php.net: "... These functions allow you to access Oracle 10, Oracle 9, Oracle 8 and Oracle 7 databases using the Oracle Call Interface (OCI). They support binding of PHP variables to Oracle placeholders, have full LOB, FILE and ROWID support, and allow you to use user-supplied define variables. Requirements You will need the Oracle client libraries to use this extension. Windows users will need libraries with version at least 10 to use the php_oci8.dll. ..."

Field Summary

static int	OCI_ASSOC
static int	OCI_B_BFILE
static int	OCI_B_BIN
static int	OCI_B_BLOB
static int	OCI_B_CFILEE
static int	OCI_B_CLOB
static int	OCI_B_CURSOR
static int	OCI_B_NTY
static int	OCI_B_ROWID
static int	OCI_BOTH
static int	OCI_COMMIT_ON_SUCCESS
static int	OCI_D_FILE
static int	OCI_D_LOB
static int	OCI_D_ROWID
static int	OCI_DEFAULT
static int	OCI_DESCRIBE_ONLY
static int	OCI_DTYPE_FILE
static int	OCI_DTYPE_LOB
static int	OCI_DTYPE_ROWID
static int	OCI_EXACT_FETCH
static int	OCI_FETCHSTATEMENT_BY_COLUMN
static int	OCI_FETCHSTATEMENT_BY_ROW
static int	OCI_LOB_BUFFER_FREE
static int	OCI_NUM
static int	OCI_RETURN_LOBS
static int	OCI_RETURN_NULLS
static int	OCI_SEEK_CUR
static int	OCI_SEEK_END
static int	OCI_SEEK_SET
static int	OCI_SYSDATE
static int	OCI_SYSDBA
static int	OCI_SYSOPER
static int	OCI_TEMP_BLOB
static int	OCI_TEMP_CLOB
static int	SQLT_AFC
static int	SQLT_AVC
static int	SQLT_BDOUBLE
static int	SQLT_BFILEE
static int	SQLT_BFLOAT
static int	SQLT_BIN
static int	SQLT_BLOB
static int	SQLT_CFILE
static int	SQLT_CFILEE
static int	SQLT_CHR
static int	SQLT_CLOB
static int	SQLT_FILE
static int	SQLT_FLT
static int	SQLT_INT
static int	SQLT_LBI
static int	SQLT_LNG
static int	SQLT_LVC
static int	SQLT_NTY
static int	SQLT_NUM
static int	SQLT_ODT
static int	SQLT_RDD
static int	SQLT_RSET
static int	SQLT_STR
static int	SQLT_VCS

Fields inherited from class com.caucho.quercus.module.AbstractQuercusModule

PHP_INI_ALL, PHP_INI_PERDIR, PHP_INI_SYSTEM, PHP_INI_USER

Constructor Summary

OracleModule()

Method Summary

java.lang.String[]	getLoadedExtensions() Returns true for the oracle extension.
static boolean	oci_bind_array_by_name(Env env, OracleStatement stmt, java.lang.String name, ArrayValue varArray, int maxTableLength, int maxItemLength, int type) Binds PHP array to Oracle PL/SQL array by name.
static boolean	oci_bind_by_name(Env env, OracleStatement stmt, java.lang.String placeholderName, Value variable, int maxLength, int type) Binds the PHP variable to the Oracle placeholder
static boolean	oci_cancel(Env env, OracleStatement stmt) Cancels reading from cursor
static boolean	oci_close(Env env, Oracle conn) Closes Oracle connection
static boolean	oci_commit(Env env, Oracle conn) Commits outstanding statements
static Value	oci_connect(Env env, java.lang.String username, java.lang.String password, java.lang.String db, java.lang.String charset, int sessionMode) Establishes a connection to the Oracle server
static boolean	oci_define_by_name(Env env, OracleStatement stmt, java.lang.String columnName, Value variable, int type) Uses a PHP variable for the define-step during a SELECT
static java.lang.String	oci_error(Env env, Value resource) Returns the last error found
static boolean	oci_execute(Env env, OracleStatement stmt, int mode) Executes a statement
static ArrayValue	oci_fetch_all(Env env, OracleStatement stmt, Value output, int skip, int maxrows, int flags) Fetches all rows of result data into an array
static ArrayValue	oci_fetch_array(Env env, OracleStatement stmt, int mode) Returns the next row from the result data as an associative or numeric array, or both
static ArrayValue	oci_fetch_assoc(Env env, OracleStatement stmt) Returns the next row from the result data as an associative array
static Value	oci_fetch_object(Env env, OracleStatement stmt) Returns the next row from the result data as an object
static ArrayValue	oci_fetch_row(Env env, OracleStatement stmt) Returns the next row from the result data as a numeric array
static boolean	oci_fetch(Env env, OracleStatement stmt) Fetches the next row into result-buffer
static boolean	oci_field_is_null(Env env, OracleStatement stmt, Value fieldNameOrNumber) Checks if the field is NULL
static Value	oci_field_name(Env env, OracleStatement stmt, int fieldNumber) Returns the name of a field from the statement
static LongValue	oci_field_precision(Env env, OracleStatement stmt, int field) Tell the precision of a field
static LongValue	oci_field_scale(Env env, OracleStatement stmt, int field) Tell the scale of the field
static Value	oci_field_size(Env env, OracleStatement stmt, Value fieldNameOrNumber) Returns field's size
static int	oci_field_type_raw(Env env, OracleStatement stmt, int field) Tell the raw Oracle data type of the field
static Value	oci_field_type(Env env, OracleStatement stmt, int fieldNumber) Returns field's data type
static boolean	oci_free_statement(Env env, OracleStatement stmt) Frees all resources associated with statement or cursor
static void	oci_internal_debug(Env env, int onoff) Enables or disables internal debug output
static boolean	oci_lob_copy(Env env, OracleOciLob lobTo, OracleOciLob lobFrom, int length) Copies large object
static boolean	oci_lob_is_equal(Env env, OracleOciLob lob1, OracleOciLob lob2) Compares two LOB/FILE locators for equality
static OracleOciCollection	oci_new_collection(Env env, Oracle conn, java.lang.String tdo, java.lang.String schema) Allocates new collection object
static Value	oci_new_connect(Env env, java.lang.String username, java.lang.String password, java.lang.String db, java.lang.String charset, int sessionMode) Establishes a new connection to the Oracle server
static OracleStatement	oci_new_cursor(Env env, Oracle conn) Allocates and returns a new cursor (statement handle)
static OracleOciLob	oci_new_descriptor(Env env, Oracle conn, int type) Initializes a new empty LOB or FILE descriptor
static Value	oci_num_fields(Env env, OracleStatement stmt) Returns the number of result columns in a statement
static LongValue	oci_num_rows(Env env, OracleStatement stmt) Returns number of rows affected during statement execution Note: This function does not return number of rows selected! For SELECT statements this function will return the number of rows, that were fetched to the buffer with oci_fetchxxxx() functions.
static OracleStatement	oci_parse(Env env, Oracle conn, java.lang.String query) Prepares Oracle statement for execution
static boolean	oci_password_change(Env env, Oracle conn, java.lang.String username, java.lang.String oldPassword, java.lang.String newPassword) Changes password of Oracle's user
static Value	oci_pconnect(Env env, java.lang.String username, java.lang.String password, java.lang.String db, java.lang.String charset, int sessionMode) Connect to an Oracle database using a persistent connection
static Value	oci_result(Env env, OracleStatement stmt, Value field) Returns field's value from the fetched row
static Value	oci_rollback(Env env, Oracle conn) Rolls back outstanding transaction
static java.lang.String	oci_server_version(Env env, Oracle conn) Returns server version
static boolean	oci_set_prefetch(Env env, OracleStatement stmt, int rows) Sets number of rows to be prefetched
static java.lang.String	oci_statement_type(Env env, OracleStatement stmt) Returns the type of an OCI statement
static boolean	ocibindbyname(Env env, OracleStatement stmt, java.lang.String variable, Value value, int maxLength, int type) Alias of oci_bind_by_name()
static boolean	ocicancel(Env env, OracleStatement stmt) Alias of oci_cancel()
static Value	ocicloselob(Env env, Oracle conn) Alias of OCI-Lob->close
static Value	ocicollappend(Env env, Oracle conn) Alias of OCI-Collection->append
static Value	ocicollassign(Env env, Oracle conn) Alias of OCI-Collection->assign
static Value	ocicollassignelem(Env env, Oracle conn) Alias of OCI-Collection->assignElem
static Value	ocicollgetelem(Env env, Oracle conn) Alias of OCI-Collection->getElem
static Value	ocicollmax(Env env, Oracle conn) Alias of OCI-Collection->max
static Value	ocicollsize(Env env, Oracle conn) Alias of OCI-Collection->size
static Value	ocicolltrim(Env env, Oracle conn) Alias of OCI-Collection->trim
static boolean	ocicolumnisnull(Env env, OracleStatement stmt, Value field) Alias of oci_field_is_null()
static Value	ocicolumnname(Env env, OracleStatement stmt, int fieldNumber) Alias of oci_field_name()
static Value	ocicolumnprecision(Env env, OracleStatement stmt, int field) Alias of oci_field_precision()
static Value	ocicolumnscale(Env env, OracleStatement stmt, int field) Alias of oci_field_scale()
static Value	ocicolumnsize(Env env, OracleStatement stmt, Value field) Alias of oci_field_size()
static Value	ocicolumntype(Env env, OracleStatement stmt, int fieldNumber) Alias of oci_field_type()
static int	ocicolumntyperaw(Env env, OracleStatement stmt, int field) Alias of oci_field_type_raw()
static boolean	ocicommit(Env env, Oracle conn) Alias of oci_commit()
static boolean	ocidefinebyname(Env env, OracleStatement stmt, java.lang.String columnName, Value variable, int type) Alias of oci_define_by_name()
static java.lang.String	ocierror(Env env, Value resource) Alias of oci_error()
static boolean	ociexecute(Env env, OracleStatement stmt, int mode) Alias of oci_execute()
static boolean	ocifetch(Env env, OracleStatement stmt) Alias of oci_fetch()
static Value	ocifetchinto(Env env, OracleStatement stmt, Value result, int mode) Fetches the next row into an array
static Value	ocifetchstatement(Env env, OracleStatement stmt, Value output, int skip, int maxrows, int flags) Alias of oci_fetch_all()
static Value	ocifreecollection(Env env, Oracle conn) Alias of OCI-Collection->free
static boolean	ocifreecursor(Env env, OracleStatement stmt) Alias of oci_free_statement()
static Value	ocifreedesc(Env env, Oracle conn) Alias of OCI-Lob->free
static boolean	ocifreestatement(Env env, OracleStatement stmt) Alias of oci_free_statement()
static void	ociinternaldebug(Env env, int onoff) Alias of oci_internal_debug()
static Value	ociloadlob(Env env, Oracle conn) Alias of OCI-Lob->load
static boolean	ocilogoff(Env env, Oracle conn) Alias of oci_close()
static Value	ocilogon(Env env, java.lang.String username, java.lang.String password, java.lang.String db, java.lang.String charset, int sessionMode) Alias of oci_connect()
static OracleOciCollection	ocinewcollection(Env env, Oracle conn, java.lang.String tdo, java.lang.String schema) Alias of oci_new_collection()
static OracleStatement	ocinewcursor(Env env, Oracle conn) Alias of oci_new_cursor()
static OracleOciLob	ocinewdescriptor(Env env, Oracle conn, int type) Alias of oci_new_descriptor()
static Value	ocinlogon(Env env, java.lang.String username, java.lang.String password, java.lang.String db, java.lang.String charset, int sessionMode) Alias of oci_new_connect()
static Value	ocinumcols(Env env, OracleStatement stmt) Alias of oci_num_fields()
static OracleStatement	ociparse(Env env, Oracle conn, java.lang.String query) Alias of oci_parse()
static Value	ociplogon(Env env, java.lang.String username, java.lang.String password, java.lang.String db, java.lang.String charset, int sessionMode) Alias of oci_pconnect()
static Value	ociresult(Env env, OracleStatement stmt, Value field) Alias of oci_result()
static Value	ocirollback(Env env, Oracle conn) Alias of oci_rollback()
static Value	ocirowcount(Env env, OracleStatement stmt) Alias of oci_num_rows()
static Value	ocisavelob(Env env, Oracle conn) Alias of OCI-Lob->save
static Value	ocisavelobfile(Env env, Oracle conn) Alias of OCI-Lob->import
static java.lang.String	ociserverversion(Env env, Oracle conn) Alias of oci_server_version()
static boolean	ocisetprefetch(Env env, OracleStatement stmt, int rows) Alias of oci_set_prefetch()
static java.lang.String	ocistatementtype(Env env, OracleStatement stmt) Alias of oci_statement_type()
static Value	ociwritelobtofile(Env env, Oracle conn) Alias of OCI-Lob->export
static Value	ociwritetemporarylob(Env env, Oracle conn) Alias of OCI-Lob->writeTemporary

Methods inherited from class com.caucho.quercus.module.AbstractQuercusModule

getConstMap, getIniDefinitions

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

OCI_B_BFILE

public static final int OCI_B_BFILE

See Also:

Constant Field Values

OCI_B_CFILEE

public static final int OCI_B_CFILEE

See Also:

Constant Field Values

OCI_B_CLOB

public static final int OCI_B_CLOB

See Also:

Constant Field Values

OCI_B_BLOB

public static final int OCI_B_BLOB

See Also:

Constant Field Values

OCI_B_ROWID

public static final int OCI_B_ROWID

See Also:

Constant Field Values

OCI_B_CURSOR

public static final int OCI_B_CURSOR

See Also:

Constant Field Values

OCI_B_NTY

public static final int OCI_B_NTY

See Also:

Constant Field Values

OCI_B_BIN

public static final int OCI_B_BIN

See Also:

Constant Field Values

OCI_DTYPE_FILE

public static final int OCI_DTYPE_FILE

See Also:

Constant Field Values

OCI_DTYPE_LOB

public static final int OCI_DTYPE_LOB

See Also:

Constant Field Values

OCI_DTYPE_ROWID

public static final int OCI_DTYPE_ROWID

See Also:

Constant Field Values

OCI_D_FILE

public static final int OCI_D_FILE

See Also:

Constant Field Values

OCI_D_LOB

public static final int OCI_D_LOB

See Also:

Constant Field Values

OCI_D_ROWID

public static final int OCI_D_ROWID

See Also:

Constant Field Values

OCI_SYSDATE

public static final int OCI_SYSDATE

See Also:

Constant Field Values

OCI_TEMP_CLOB

public static final int OCI_TEMP_CLOB

See Also:

Constant Field Values

OCI_TEMP_BLOB

public static final int OCI_TEMP_BLOB

See Also:

Constant Field Values

SQLT_BFILEE

public static final int SQLT_BFILEE

See Also:

Constant Field Values

SQLT_CFILEE

public static final int SQLT_CFILEE

See Also:

Constant Field Values

SQLT_CLOB

public static final int SQLT_CLOB

See Also:

Constant Field Values

SQLT_BLOB

public static final int SQLT_BLOB

See Also:

Constant Field Values

SQLT_RDD

public static final int SQLT_RDD

See Also:

Constant Field Values

SQLT_NTY

public static final int SQLT_NTY

See Also:

Constant Field Values

SQLT_LNG

public static final int SQLT_LNG

See Also:

Constant Field Values

SQLT_LBI

public static final int SQLT_LBI

See Also:

Constant Field Values

SQLT_BIN

public static final int SQLT_BIN

See Also:

Constant Field Values

SQLT_NUM

public static final int SQLT_NUM

See Also:

Constant Field Values

SQLT_INT

public static final int SQLT_INT

See Also:

Constant Field Values

SQLT_AFC

public static final int SQLT_AFC

See Also:

Constant Field Values

SQLT_CHR

public static final int SQLT_CHR

See Also:

Constant Field Values

SQLT_VCS

public static final int SQLT_VCS

See Also:

Constant Field Values

SQLT_AVC

public static final int SQLT_AVC

See Also:

Constant Field Values

SQLT_STR

public static final int SQLT_STR

See Also:

Constant Field Values

SQLT_LVC

public static final int SQLT_LVC

See Also:

Constant Field Values

SQLT_FLT

public static final int SQLT_FLT

See Also:

Constant Field Values

SQLT_ODT

public static final int SQLT_ODT

See Also:

Constant Field Values

SQLT_BDOUBLE

public static final int SQLT_BDOUBLE

See Also:

Constant Field Values

SQLT_BFLOAT

public static final int SQLT_BFLOAT

See Also:

Constant Field Values

SQLT_RSET

public static final int SQLT_RSET

See Also:

Constant Field Values

SQLT_FILE

public static final int SQLT_FILE

See Also:

Constant Field Values

SQLT_CFILE

public static final int SQLT_CFILE

See Also:

Constant Field Values

OCI_DEFAULT

public static final int OCI_DEFAULT

See Also:

Constant Field Values

OCI_DESCRIBE_ONLY

public static final int OCI_DESCRIBE_ONLY

See Also:

Constant Field Values

OCI_COMMIT_ON_SUCCESS

public static final int OCI_COMMIT_ON_SUCCESS

See Also:

Constant Field Values

OCI_EXACT_FETCH

public static final int OCI_EXACT_FETCH

See Also:

Constant Field Values

OCI_FETCHSTATEMENT_BY_COLUMN

public static final int OCI_FETCHSTATEMENT_BY_COLUMN

See Also:

Constant Field Values

OCI_FETCHSTATEMENT_BY_ROW

public static final int OCI_FETCHSTATEMENT_BY_ROW

See Also:

Constant Field Values

OCI_ASSOC

public static final int OCI_ASSOC

See Also:

Constant Field Values

OCI_NUM

public static final int OCI_NUM

See Also:

Constant Field Values

OCI_BOTH

public static final int OCI_BOTH

See Also:

Constant Field Values

OCI_RETURN_NULLS

public static final int OCI_RETURN_NULLS

See Also:

Constant Field Values

OCI_RETURN_LOBS

public static final int OCI_RETURN_LOBS

See Also:

Constant Field Values

OCI_SYSOPER

public static final int OCI_SYSOPER

See Also:

Constant Field Values

OCI_SYSDBA

public static final int OCI_SYSDBA

See Also:

Constant Field Values

OCI_LOB_BUFFER_FREE

public static final int OCI_LOB_BUFFER_FREE

See Also:

Constant Field Values

OCI_SEEK_SET

public static final int OCI_SEEK_SET

See Also:

Constant Field Values

OCI_SEEK_CUR

public static final int OCI_SEEK_CUR

See Also:

Constant Field Values

OCI_SEEK_END

public static final int OCI_SEEK_END

See Also:

Constant Field Values

Constructor Detail

OracleModule

public OracleModule()

Method Detail

getLoadedExtensions

public java.lang.String[] getLoadedExtensions()

Returns true for the oracle extension.

Specified by:

getLoadedExtensions in interface QuercusModule

Overrides:

getLoadedExtensions in class AbstractQuercusModule

oci_bind_array_by_name

public static boolean oci_bind_array_by_name(Env env,
                                             OracleStatement stmt,
                                             java.lang.String name,
                                             ArrayValue varArray,
                                             int maxTableLength,
                                             int maxItemLength,
                                             int type)

Binds PHP array to Oracle PL/SQL array by name. oci_bind_array_by_name() binds the PHP array varArray to the Oracle placeholder name, which points to Oracle PL/SQL array. Whether it will be used for input or output will be determined at run-time. The maxTableLength parameter sets the maximum length both for incoming and result arrays. Parameter maxItemLength sets maximum length for array items. If maxItemLength was not specified or equals to -1, oci_bind_array_by_name() will find the longest element in the incoming array and will use it as maximum length for array items. type parameter should be used to set the type of PL/SQL array items. See list of available types below.

Parameters:

env - the PHP executing environment

stmt - the Oracle statement

name - the Oracle placeholder

varArray - the array to be binded

maxTableLength - maximum table length

maxItemLength - maximum item length

type - one of the following types:
SQLT_NUM - for arrays of NUMBER.
SQLT_INT - for arrays of INTEGER (Note: INTEGER it is actually a synonym for NUMBER(38), but SQLT_NUM type won't work in this case even though they are synonyms).
SQLT_FLT - for arrays of FLOAT.
SQLT_AFC - for arrays of CHAR.
SQLT_CHR - for arrays of VARCHAR2.
SQLT_VCS - for arrays of VARCHAR.
SQLT_AVC - for arrays of CHARZ.
SQLT_STR - for arrays of STRING.
SQLT_LVC - for arrays of LONG VARCHAR.
SQLT_ODT - for arrays of DATE.

Returns:

true on success of false on failure

oci_bind_by_name

public static boolean oci_bind_by_name(Env env,
                                       OracleStatement stmt,
                                       java.lang.String placeholderName,
                                       Value variable,
                                       int maxLength,
                                       int type)

Binds the PHP variable to the Oracle placeholder

Parameters:

type - one of the following types: SQLT_INT - for integers; SQLT_CHR - for VARCHARs; SQLT_RSET - for cursors, that were created before with oci_new_cursor() OCI_B_BFILE (integer) Used with oci_bind_by_name() when binding BFILEs. OCI_B_CFILEE (integer) Used with oci_bind_by_name() when binding CFILEs. OCI_B_CLOB (integer) Used with oci_bind_by_name() when binding CLOBs. OCI_B_BLOB (integer) Used with oci_bind_by_name() when binding BLOBs. OCI_B_ROWID (integer) Used with oci_bind_by_name() when binding ROWIDs. OCI_B_CURSOR (integer) Used with oci_bind_by_name() when binding cursors, previously allocated with oci_new_descriptor(). OCI_B_NTY (integer) Used with oci_bind_by_name() when binding named data types. Note: in PHP < 5.0 it was called OCI_B_SQLT_NTY. OCI_B_BIN (integer) SQLT_FILE (integer) SQLT_BFILEE (integer) The same as OCI_B_BFILE. SQLT_CFILE (integer) SQLT_CFILEE (integer) The same as OCI_B_CFILEE. SQLT_CLOB (integer) The same as OCI_B_CLOB. SQLT_BLOB (integer) The same as OCI_B_BLOB. SQLT_RDD (integer) The same as OCI_B_ROWID. SQLT_NTY (integer) The same as OCI_B_NTY. SQLT_LNG (integer) Used with oci_bind_by_name() to bind LONG values. SQLT_LBI (integer) Used with oci_bind_by_name() to bind LONG RAW values. SQLT_BIN (integer) Used with oci_bind_by_name() to bind RAW values.

oci_cancel

public static boolean oci_cancel(Env env,
                                 OracleStatement stmt)

Cancels reading from cursor

oci_close

public static boolean oci_close(Env env,
                                Oracle conn)

Closes Oracle connection

oci_commit

public static boolean oci_commit(Env env,
                                 Oracle conn)

Commits outstanding statements

oci_connect

public static Value oci_connect(Env env,
                                java.lang.String username,
                                java.lang.String password,
                                java.lang.String db,
                                java.lang.String charset,
                                int sessionMode)

Establishes a connection to the Oracle server

oci_define_by_name</