php-doc-en/reference/oci8/constants.xml
2014-02-11 00:35:05 +00:00

503 lines
17 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<appendix xml:id="oci8.constants" xmlns="http://docbook.org/ns/docbook">
&reftitle.constants;
&extension.constants;
<table>
<title>OCI8 Function and Method Modes</title>
<tgroup cols="2">
<thead>
<row>
<entry>Constant</entry>
<entry>Description</entry>
</row>
</thead>
<tbody>
<row xml:id="constant.oci-assoc">
<entry><constant>OCI_ASSOC</constant></entry>
<entry>
Used with <function>oci_fetch_all</function> and
<function>oci_fetch_array</function> to get results as an associative
array.
</entry>
</row>
<row xml:id="constant.oci-both">
<entry><constant>OCI_BOTH</constant></entry>
<entry>
Used with <function>oci_fetch_all</function> and
<function>oci_fetch_array</function> to get results as an
array with both associative and number indices.
</entry>
</row>
<row xml:id="constant.oci-commit-on-success">
<entry><constant>OCI_COMMIT_ON_SUCCESS</constant></entry>
<entry>
Statement execution mode for <function>oci_execute</function>
call. Automatically commit changes when the statement has
succeeded.
</entry>
</row>
<row xml:id="constant.oci-cred-ext">
<entry><constant>OCI_CRED_EXT</constant></entry>
<entry>
Used with <function>oci_connect</function> for using
Oracles' External or OS authentication. Introduced in PHP
5.3 and PECL OCI8 1.3.4.
</entry>
</row>
<row xml:id="constant.oci-default">
<entry><constant>OCI_DEFAULT</constant></entry>
<entry>
See <constant>OCI_NO_AUTO_COMMIT</constant>.
</entry>
</row>
<row xml:id="constant.oci-describe-only">
<entry><constant>OCI_DESCRIBE_ONLY</constant></entry>
<entry>
Statement execution mode
for <function>oci_execute</function>. Use this mode if you
want meta data such as the column names but don't want to
fetch rows from the query.
</entry>
</row>
<row xml:id="constant.oci-exact-fetch">
<entry><constant>OCI_EXACT_FETCH</constant></entry>
<entry>
Obsolete. Statement fetch mode. Used when the application
knows in advance exactly how many rows it will be fetching.
This mode turns prefetching off for Oracle release 8 or
later mode. The cursor is canceled after the desired rows
are fetched which may result in reduced server-side
resource usage.
</entry>
</row>
<row xml:id="constant.oci-fetchstatement-by-column">
<entry><constant>OCI_FETCHSTATEMENT_BY_COLUMN</constant></entry>
<entry>
Default mode of <function>oci_fetch_all</function>.
</entry>
</row>
<row xml:id="constant.oci-fetchstatement-by-row">
<entry><constant>OCI_FETCHSTATEMENT_BY_ROW</constant></entry>
<entry>
Alternative mode of <function>oci_fetch_all</function>.
</entry>
</row>
<row xml:id="constant.oci-lob-buffer-free">
<entry><constant>OCI_LOB_BUFFER_FREE</constant></entry>
<entry>
Used with <xref linkend="oci-lob.flush"/> to free
buffers used.
</entry>
</row>
<row xml:id="constant.oci-no-auto-commit">
<entry><constant>OCI_NO_AUTO_COMMIT</constant></entry>
<entry>
Statement execution mode
for <function>oci_execute</function>. The transaction is not
automatically committed when using this mode. For
readability in new code, use this value instead of the
older, equivalent <constant>OCI_DEFAULT</constant> constant.
Introduced in PHP 5.3.2 (PECL OCI8 1.4).
</entry>
</row>
<row xml:id="constant.oci-num">
<entry><constant>OCI_NUM</constant></entry>
<entry>
Used with <function>oci_fetch_all</function> and
<function>oci_fetch_array</function> to get results as an
enumerated array.
</entry>
</row>
<row xml:id="constant.oci-return-lobs">
<entry><constant>OCI_RETURN_LOBS</constant></entry>
<entry>
Used with <function>oci_fetch_array</function> to get the
data value of the LOB instead of the descriptor.
</entry>
</row>
<row xml:id="constant.oci-return-nulls">
<entry><constant>OCI_RETURN_NULLS</constant></entry>
<entry>
Used with <function>oci_fetch_array</function> to get empty
array elements if the row items value is &null;.
</entry>
</row>
<row xml:id="constant.oci-seek-cur">
<entry><constant>OCI_SEEK_CUR</constant></entry>
<entry>
Used with <xref linkend="oci-lob.seek" /> to set the seek position.
</entry>
</row>
<row xml:id="constant.oci-seek-end">
<entry><constant>OCI_SEEK_END</constant></entry>
<entry>
Used with <xref linkend="oci-lob.seek" /> to set the seek position.
</entry>
</row>
<row xml:id="constant.oci-seek-set">
<entry><constant>OCI_SEEK_SET</constant></entry>
<entry>
Used with <xref linkend="oci-lob.seek" /> to set the seek position.
</entry>
</row>
<row xml:id="constant.oci-sysdate">
<entry><constant>OCI_SYSDATE</constant></entry>
<entry>
Obsolete.
</entry>
</row>
<row xml:id="constant.oci-sysdba">
<entry><constant>OCI_SYSDBA</constant></entry>
<entry>
Used with <function>oci_connect</function> to connect with
the SYSDBA privilege. The &php.ini; setting
<link linkend="ini.oci8.privileged-connect">oci8.privileged_connect</link>
should be enabled to use this.
</entry>
</row>
<row xml:id="constant.oci-sysoper">
<entry><constant>OCI_SYSOPER</constant></entry>
<entry>
Used with <function>oci_connect</function> to connect with
the SYSOPER privilege. The &php.ini; setting
<link linkend="ini.oci8.privileged-connect">oci8.privileged_connect</link>
should be enabled to use this.
</entry>
</row>
<row xml:id="constant.oci-temp-blob">
<entry><constant>OCI_TEMP_BLOB</constant></entry>
<entry>
Used with <xref linkend="oci-lob.writetemporary"/>
to indicate that a temporary BLOB should be created.
</entry>
</row>
<row xml:id="constant.oci-temp-clob">
<entry><constant>OCI_TEMP_CLOB</constant></entry>
<entry>
Used with <xref linkend="oci-lob.writetemporary"/>
to indicate that a temporary CLOB should be created.
</entry>
</row>
</tbody>
</tgroup>
</table>
<table>
<title>OCI8 Bind and Define Types</title>
<tgroup cols="2">
<thead>
<row>
<entry>Constant</entry>
<entry>Description</entry>
</row>
</thead>
<tbody>
<row xml:id="constant.oci-b-bfile">
<entry><constant>OCI_B_BFILE</constant></entry>
<entry>
Used with <function>oci_bind_by_name</function> when binding
BFILEs.
</entry>
</row>
<row xml:id="constant.oci-b-bin">
<entry><constant>OCI_B_BIN</constant></entry>
<entry>
Used with <function>oci_bind_by_name</function> to bind RAW values.
</entry>
</row>
<row xml:id="constant.oci-b-blob">
<entry><constant>OCI_B_BLOB</constant></entry>
<entry>
Used with <function>oci_bind_by_name</function> when
binding BLOBs.
</entry>
</row>
<row xml:id="constant.oci-b-bol">
<entry><constant>OCI_B_BOL</constant></entry>
<entry>
Used with <function>oci_bind_by_name</function> to bind a PL/SQL BOOLEAN
variable.
</entry>
</row>
<row xml:id="constant.oci-b-cfilee">
<entry><constant>OCI_B_CFILEE</constant></entry>
<entry>
Used with <function>oci_bind_by_name</function> when binding
CFILEs.
</entry>
</row>
<row xml:id="constant.oci-b-clob">
<entry><constant>OCI_B_CLOB</constant></entry>
<entry>
Used with <function>oci_bind_by_name</function> when binding
CLOBs.
</entry>
</row>
<row xml:id="constant.oci-b-cursor">
<entry><constant>OCI_B_CURSOR</constant></entry>
<entry>
Used with <function>oci_bind_by_name</function> when binding
cursors, previously allocated
with <function>oci_new_descriptor</function>.
</entry>
</row>
<row xml:id="constant.oci-b-int">
<entry><constant>OCI_B_INT</constant></entry>
<entry>
Used with <function>oci_bind_array_by_name</function> to bind arrays of
INTEGER.
</entry>
</row>
<row xml:id="constant.oci-b-nty">
<entry><constant>OCI_B_NTY</constant></entry>
<entry>
Used with <function>oci_bind_by_name</function> when binding
named data types. Note: in PHP &lt; 5.0 it was called
<constant>OCI_B_SQLT_NTY</constant>.
</entry>
</row>
<row xml:id="constant.oci-b-num">
<entry><constant>OCI_B_NUM</constant></entry>
<entry>
Used with <function>oci_bind_array_by_name</function> to bind arrays of
NUMBER.
</entry>
</row>
<row xml:id="constant.oci-b-rowid">
<entry><constant>OCI_B_ROWID</constant></entry>
<entry>
Used with <function>oci_bind_by_name</function> when binding
ROWIDs.
</entry>
</row>
<row xml:id="constant.sqlt-afc">
<entry><constant>SQLT_AFC</constant></entry>
<entry>
Used with <function>oci_bind_array_by_name</function> to bind arrays of
CHAR.
</entry>
</row>
<row xml:id="constant.sqlt-avc">
<entry><constant>SQLT_AVC</constant></entry>
<entry>
Used with <function>oci_bind_array_by_name</function> to bind arrays of
VARCHAR2.
</entry>
</row>
<row xml:id="constant.sqlt-bdouble">
<entry><constant>SQLT_BDOUBLE</constant></entry>
<entry>
Not supported.
</entry>
</row>
<row xml:id="constant.sqlt-bfilee">
<entry><constant>SQLT_BFILEE</constant></entry>
<entry>
The same as <constant>OCI_B_BFILE</constant>.
</entry>
</row>
<row xml:id="constant.sqlt-bfloat">
<entry><constant>SQLT_BFLOAT</constant></entry>
<entry>
Not supported.
</entry>
</row>
<row xml:id="constant.sqlt-bin">
<entry><constant>SQLT_BIN</constant></entry>
<entry>
The same as <constant>OCI_B_BIN</constant>.
</entry>
</row>
<row xml:id="constant.sqlt-blob">
<entry><constant>SQLT_BLOB</constant></entry>
<entry>
The same as <constant>OCI_B_BLOB</constant>.
</entry>
</row>
<row xml:id="constant.sqlt-bol">
<entry><constant>SQLT_BOL</constant></entry>
<entry>
The same as <constant>OCI_B_BOL</constant>.
</entry>
</row>
<row xml:id="constant.sqlt-cfilee">
<entry><constant>SQLT_CFILEE</constant></entry>
<entry>
The same as <constant>OCI_B_CFILEE</constant>.
</entry>
</row>
<row xml:id="constant.sqlt-chr">
<entry><constant>SQLT_CHR</constant></entry>
<entry>
Used with <function>oci_bind_array_by_name</function> to bind arrays of
VARCHAR2.
Also used with <function>oci_bind_by_name</function>.
</entry>
</row>
<row xml:id="constant.sqlt-clob">
<entry><constant>SQLT_CLOB</constant></entry>
<entry>
The same as <constant>OCI_B_CLOB</constant>.
</entry>
</row>
<row xml:id="constant.sqlt-flt">
<entry><constant>SQLT_FLT</constant></entry>
<entry>
Used with <function>oci_bind_array_by_name</function> to bind arrays of
FLOAT.
</entry>
</row>
<row xml:id="constant.sqlt-int">
<entry><constant>SQLT_INT</constant></entry>
<entry>
The same as <constant>OCI_B_INT</constant>.
</entry>
</row>
<row xml:id="constant.sqlt-lbi">
<entry><constant>SQLT_LBI</constant></entry>
<entry>
Used with <function>oci_bind_by_name</function> to bind LONG RAW values.
</entry>
</row>
<row xml:id="constant.sqlt-lng">
<entry><constant>SQLT_LNG</constant></entry>
<entry>
Used with <function>oci_bind_by_name</function> to bind LONG values.
</entry>
</row>
<row xml:id="constant.sqlt-lvc">
<entry><constant>SQLT_LVC</constant></entry>
<entry>
Used with <function>oci_bind_array_by_name</function> to bind arrays of
LONG VARCHAR.
</entry>
</row>
<row xml:id="constant.sqlt-nty">
<entry><constant>SQLT_NTY</constant></entry>
<entry>
The same as <constant>OCI_B_NTY</constant>.
</entry>
</row>
<row xml:id="constant.sqlt-num">
<entry><constant>SQLT_NUM</constant></entry>
<entry>
The same as <constant>OCI_B_NUM</constant>.
</entry>
</row>
<row xml:id="constant.sqlt-odt">
<entry><constant>SQLT_ODT</constant></entry>
<entry>
Used with <function>oci_bind_array_by_name</function> to bind arrays of
LONG.
</entry>
</row>
<row xml:id="constant.sqlt-rdd">
<entry><constant>SQLT_RDD</constant></entry>
<entry>
The same as <constant>OCI_B_ROWID</constant>.
</entry>
</row>
<row xml:id="constant.sqlt-rset">
<entry><constant>SQLT_RSET</constant></entry>
<entry>
The same as <constant>OCI_B_CURSOR</constant>.
</entry>
</row>
<row xml:id="constant.sqlt-str">
<entry><constant>SQLT_STR</constant></entry>
<entry>
Used with <function>oci_bind_array_by_name</function> to bind arrays of
STRING.
</entry>
</row>
<row xml:id="constant.sqlt-uin">
<entry><constant>SQLT_UIN</constant></entry>
<entry>
Not supported.
</entry>
</row>
<row xml:id="constant.sqlt-vcs">
<entry><constant>SQLT_VCS</constant></entry>
<entry>
Used with <function>oci_bind_array_by_name</function> to bind arrays of
VARCHAR.
</entry>
</row>
</tbody>
</tgroup>
</table>
<table>
<title>OCI8 Descriptor Types</title>
<tgroup cols="2">
<thead>
<row>
<entry>Constant</entry>
<entry>Description</entry>
</row>
</thead>
<tbody>
<row xml:id="constant.oci-dtype-file">
<entry><constant>OCI_DTYPE_FILE</constant></entry>
<entry>
This flag tells <function>oci_new_descriptor</function> to
initialize a new FILE descriptor.
</entry>
</row>
<row xml:id="constant.oci-dtype-lob">
<entry><constant>OCI_DTYPE_LOB</constant></entry>
<entry>
This flag tells <function>oci_new_descriptor</function> to
initialize a new LOB descriptor.
</entry>
</row>
<row xml:id="constant.oci-dtype-rowid">
<entry><constant>OCI_DTYPE_ROWID</constant></entry>
<entry>
This flag tells <function>oci_new_descriptor</function> to
initialize a new ROWID descriptor.
</entry>
</row>
<row xml:id="constant.oci-d-file">
<entry><constant>OCI_D_FILE</constant></entry>
<entry>
The same as <constant>OCI_DTYPE_FILE</constant>.
</entry>
</row>
<row xml:id="constant.oci-d-lob">
<entry><constant>OCI_D_LOB</constant></entry>
<entry>
The same as <constant>OCI_DTYPE_LOB</constant>.
</entry>
</row>
<row xml:id="constant.oci-d-rowid">
<entry><constant>OCI_D_ROWID</constant></entry>
<entry>
The same as <constant>OCI_DTYPE_ROWID</constant>.
</entry>
</row>
</tbody>
</tgroup>
</table>
</appendix>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->