 |
 |
 |
 |
|
|
Date: 08/31/00
- Next message: Luca Perugini: "[PHP-DOC] cvs: phpdoc /it/chapters install.xml"
- Previous message: Luca Perugini: "[PHP-DOC] cvs: phpdoc /it/functions posix.xml"
- Messages sorted by: [ date ] [ thread ] [ subject ] [ author ]
perugini Thu Aug 31 08:31:23 2000 EDT
Modified files:
/phpdoc/it/functions oracle.xml
Log:
Uptaded: sync with en tree.
Index: phpdoc/it/functions/oracle.xml
diff -u phpdoc/it/functions/oracle.xml:1.2 phpdoc/it/functions/oracle.xml:1.3
--- phpdoc/it/functions/oracle.xml:1.2 Sat Jun 24 00:38:44 2000
+++ phpdoc/it/functions/oracle.xml Thu Aug 31 08:31:23 2000
@@ -20,27 +20,26 @@
</funcprototype>
</funcsynopsis>
<para>
- Returns true if the bind succeeds, otherwise false. Details
+ Returns true if the bind succeeds, otherwise false. Details
about the error can be retrieved using the
<function>ora_error</function> and
- <function>ora_errorcode</function> functions.</para>
-
+ <function>ora_errorcode</function> functions.
+ </para>
<para>
This function binds the named PHP variable with a SQL parameter.
- The SQL parameter must be in the form ":name". With the optional
+ The SQL parameter must be in the form ":name". With the optional
type parameter, you can define whether the SQL parameter is an
- in/out (0, default), in (1) or out (2) parameter. As of PHP
+ in/out (0, default), in (1) or out (2) parameter. As of PHP
3.0.1, you can use the constants ORA_BIND_INOUT, ORA_BIND_IN and
- ORA_BIND_OUT instead of the numbers.</para>
-
+ ORA_BIND_OUT instead of the numbers.
+ </para>
<para>
ora_bind must be called after <function>ora_parse</function> and
before <function>ora_exec</function>. Input values can be given
by assignment to the bound PHP variables, after calling
<function>ora_exec</function> the bound PHP variables contain the output
values if available.
-
-<informalexample>
+ <informalexample>
<programlisting role="php">
<?php
ora_parse($curs, "declare tmp INTEGER; begin tmp := :in; :out := tmp; :x := 7.77; end;");
@@ -51,9 +50,9 @@
ora_exec($curs);
echo "Result: $result<BR>Out: $output<BR>In: $input";
?>
-</programlisting>
- </informalexample></para>
-
+ </programlisting>
+ </informalexample>
+ </para>
</refsect1>
</refentry>
@@ -71,19 +70,18 @@
</funcprototype>
</funcsynopsis>
<para>
- Returns true if the close succeeds, otherwise false. Details
+ Returns true if the close succeeds, otherwise false. Details
about the error can be retrieved using the
<function>ora_error</function> and
- <function>ora_errorcode</function> functions.</para>
-
+ <function>ora_errorcode</function> functions.
+ </para>
<para>
This function closes a data cursor opened with
- <function>ora_open</function>.</para>
-
+ <function>ora_open</function>.
+ </para>
</refsect1>
</refentry>
-
<refentry id="function.ora-columnname">
<refnamediv>
<refname>Ora_ColumnName</refname>
@@ -101,11 +99,33 @@
<para>
Returns the name of the field/column
<parameter>column</parameter> on the cursor
- <parameter>cursor</parameter>. The returned name is in all
- uppercase letters.</para>
+ <parameter>cursor</parameter>. The returned name is in all
+ uppercase letters.
+ </para>
</refsect1>
</refentry>
+ <refentry id="function.ora-columnsize">
+ <refnamediv>
+ <refname>Ora_ColumnSize</refname>
+ <refpurpose>get size of Oracle result column</refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>Description</title>
+ <funcsynopsis>
+ <funcprototype>
+ <funcdef>int <function>Ora_ColumnSize</function></funcdef>
+ <paramdef>int <parameter>cursor</parameter></paramdef>
+ <paramdef>int <parameter>column</parameter></paramdef>
+ </funcprototype>
+ </funcsynopsis>
+ <para>
+ Returns the size of the Oracle column
+ <parameter>column</parameter> on the cursor
+ <parameter>cursor</parameter>.
+ </para>
+ </refsect1>
+ </refentry>
<refentry id="function.ora-columntype">
<refnamediv>
@@ -124,7 +144,7 @@
<para>
Returns the Oracle data type name of the field/column
<parameter>column</parameter> on the cursor
- <parameter>cursor</parameter>. The returned type will be one of
+ <parameter>cursor</parameter>. The returned type will be one of
the following:
<simplelist>
<member><literal>"VARCHAR2"</literal></member>
@@ -136,11 +156,11 @@
<member><literal>"ROWID"</literal></member>
<member><literal>"DATE"</literal></member>
<member><literal>"CURSOR"</literal></member>
- </simplelist></para>
+ </simplelist>
+ </para>
</refsect1>
</refentry>
-
<refentry id="function.ora-commit">
<refnamediv>
<refname>Ora_Commit</refname>
@@ -154,17 +174,19 @@
<paramdef>int <parameter>conn</parameter></paramdef>
</funcprototype>
</funcsynopsis>
- <para>Returns true on success, false on error. Details about the
- error can be retrieved using the <function>ora_error</function>
- and <function>ora_errorcode</function> functions. This function
- commits an Oracle transaction. A transaction is defined as all
- the changes on a given connection since the last commit/rollback,
- autocommit was turned off or when the connection was established.</para>
-
+ <para>
+ Returns true on success, false on error. Details about the
+ error can be retrieved using the <function>ora_error</function>
+ and <function>ora_errorcode</function> functions.
+ </para>
+ <para>
+ This function commits an Oracle transaction. A transaction is defined as
+ all the changes on a given connection since the last commit/rollback,
+ autocommit was turned off or when the connection was established.
+ </para>
</refsect1>
</refentry>
-
<refentry id="function.ora-commitoff">
<refnamediv>
<refname>Ora_CommitOff</refname>
@@ -179,18 +201,17 @@
</funcprototype>
</funcsynopsis>
<para>
- Returns true on success, false on error. Details about the error
+ Returns true on success, false on error. Details about the error
can be retrieved using the <function>ora_error</function> and
- <function>ora_errorcode</function> functions.</para>
-
+ <function>ora_errorcode</function> functions.
+ </para>
<para>
This function turns off automatic commit after each
- <function>ora_exec</function>.</para>
-
+ <function>ora_exec</function>.
+ </para>
</refsect1>
</refentry>
-
<refentry id="function.ora-commiton">
<refnamediv>
<refname>Ora_CommitOn</refname>
@@ -206,16 +227,46 @@
</funcsynopsis>
<para>
This function turns on automatic commit after each
- <function>ora_exec</function> on the given connection.</para>
-
+ <function>ora_exec</function> on the given connection.
+ </para>
<para>
- Returns true on success, false on error. Details about the error
+ Returns true on success, false on error. Details about the error
can be retrieved using the <function>ora_error</function> and
- <function>ora_errorcode</function> functions.</para>
-
+ <function>ora_errorcode</function> functions.
+ </para>
</refsect1>
</refentry>
+ <refentry id="function.ora-do">
+ <refnamediv>
+ <refname>Ora_Do</refname>
+ <refpurpose>Parse, Exec, Fetch</refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>Description</title>
+ <funcsynopsis>
+ <funcprototype>
+ <funcdef>int <function>ora_do</function></funcdef>
+ <paramdef>int <parameter>conn</parameter></paramdef>
+ <paramdef>string <parameter>query</parameter></paramdef>
+ </funcprototype>
+ </funcsynopsis>
+ <para>
+ This function is quick combination of <function>ora_parse</function>,
+ <function>ora_exec</function> and <function>ora_fetch</function>.
+ It will parse and execute a statement, then fetch the first result row.
+ </para>
+ <para>
+ Returns true on success, false on error. Details about the error
+ can be retrieved using the <function>ora_error</function> and
+ <function>ora_errorcode</function> functions.
+ </para>
+ <para>
+ See also <function>ora_parse</function>,<function>ora_exec</function>,
+ and <function>ora_fetch</function>.
+ </para>
+ </refsect1>
+ </refentry>
<refentry id="function.ora-error">
<refnamediv>
@@ -236,23 +287,28 @@
where <replaceable>XXX</replaceable> is where the error comes
from and <replaceable>NNNNN</replaceable> identifies the error
message.
- <note>
- <para>Support for connection ids was added in 3.0.4.</para>
- </note></para>
+ </para>
<para>
+ <note>
+ <para>Support for connection ids was added in 3.0.4.</para>
+ </note>
+ </para>
+ <para>
On UNIX versions of Oracle, you can find details about an error
- message like this: <computeroutput>
-<prompt>$</prompt> <userinput>oerr ora <replaceable>00001</replaceable></userinput> 00001, 00000,
+ message like this:
+ <computeroutput>
+<prompt>$</prompt> <userinput>oerr ora
+<replaceable>00001</replaceable></userinput> 00001, 00000,
"unique constraint (%s.%s) violated" // *Cause: An update or insert
statement attempted to insert a duplicate key // For Trusted
ORACLE configured in DBMS MAC mode, you may see // this message
if a duplicate entry exists at a different level. // *Action: Either
-remove the unique restriction or do not insert the key </computeroutput></para>
-
+remove the unique restriction or do not insert the key
+ </computeroutput>
+ </para>
</refsect1>
</refentry>
-
<refentry id="function.ora-errorcode">
<refnamediv>
<refname>Ora_ErrorCode</refname>
@@ -270,14 +326,13 @@
Returns the numeric error code of the last executed statement on
the specified cursor or connection.
<comment>FIXME: should possible values be listed?</comment>
- <note>
- <para>Support for connection ids was added in 3.0.4.</para>
- </note></para>
-
+ <note>
+ <para>Support for connection ids was added in 3.0.4.</para>
+ </note>
+ </para>
</refsect1>
</refentry>
-
<refentry id="function.ora-exec">
<refnamediv>
<refname>Ora_Exec</refname>
@@ -292,14 +347,17 @@
</funcprototype>
</funcsynopsis>
<para>
- Returns true on success, false on error. Details about the error
+ Returns true on success, false on error. Details about the error
can be retrieved using the <function>ora_error</function> and
- <function>ora_errorcode</function> functions.</para>
-
+ <function>ora_errorcode</function> functions.
+ </para>
+ <simpara>
+ See also <function>ora_parse</function>,
+ <function>ora_fetch</function>, and <function>ora_do</function>.
+ </simpara>
</refsect1>
</refentry>
-
<refentry id="function.ora-fetch">
<refnamediv>
<refname>Ora_Fetch</refname>
@@ -315,20 +373,66 @@
</funcsynopsis>
<para>
Returns true (a row was fetched) or false (no more rows, or an
- error occured). If an error occured, details can be retrieved
+ error occured). If an error occured, details can be retrieved
using the <function>ora_error</function> and
- <function>ora_errorcode</function> functions. If there was no
+ <function>ora_errorcode</function> functions. If there was no
error, <function>ora_errorcode</function> will return 0.
- Retrieves a row of data from the specified cursor.</para>
-
+ </para>
+ <para>
+ Retrieves a row of data from the specified cursor.
+ </para>
+ <simpara>
+ See also <function>ora_parse</function>,<function>ora_exec</function>,
+ and <function>ora_do</function>.
+ </simpara>
</refsect1>
</refentry>
+ <refentry id="function.ora-fetch-into">
+ <refnamediv>
+ <refname>Ora_Fetch_Into</refname>
+ <refpurpose>Fetch a row into the specified result array</refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>Description</title>
+ <funcsynopsis>
+ <funcprototype>
+ <funcdef>int <function>ora_fetch_into</function></funcdef>
+ <paramdef>int <parameter>cursor</parameter></paramdef>
+ <paramdef>array <parameter>result</parameter></paramdef>
+ <paramdef>int
+ <parameter>
+ <optional>flags</optional>
+ </parameter>
+ </paramdef>
+ </funcprototype>
+ </funcsynopsis>
+ <para>
+ You can fetch a row into an array with this function.
+ <example>
+ <title>Oracle fetch into array</title>
+ <programlisting role="php">
+<?php
+array($results);
+ora_fetch_into($cursor, &$results);
+echo $results[0];
+echo $results[1];
+?>
+ </programlisting>
+ </example>
+ Note that you need to fetch the array by reference.
+ </para>
+ <simpara>
+ See also <function>ora_parse</function>,<function>ora_exec</function>,
+ <function>ora_fetch</function>, and <function>ora_do</function>.
+ </simpara>
+ </refsect1>
+ </refentry>
<refentry id="function.ora-getcolumn">
<refnamediv>
<refname>Ora_GetColumn</refname>
- <refpurpose>get data from a fetched row</refpurpose>
+ <refpurpose>get data from a fetched column</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
@@ -340,18 +444,19 @@
</funcprototype>
</funcsynopsis>
<para>
- Returns the column data. If an error occurs, False is returned
+ Returns the column data. If an error occurs, False is returned
and <function>ora_errorcode</function>
- will return a non-zero value. Note, however, that a test for False
+ will return a non-zero value. Note, however, that a test for False
on the results from this function may be true in cases where there is
not error as well (NULL result, empty string, the number 0, the
- string "0"). Fetches the data for a column or function
- result.</para>
-
+ string "0").
+ </para>
+ <para>
+ Fetches the data for a column or function result.
+ </para>
</refsect1>
</refentry>
-
<refentry id="function.ora-logoff">
<refnamediv>
<refname>Ora_Logoff</refname>
@@ -366,15 +471,19 @@
</funcprototype>
</funcsynopsis>
<para>
- Returns true on success, False on error. Details about the error
- can be retrieved using the <function>ora_error</function> and <function>ora_errorcode</function>
- functions. Logs out the user and disconnects from the
- server.</para>
-
+ Returns true on success, false on error. Details about the error
+ can be retrieved using the <function>ora_error</function> and
+ <function>ora_errorcode</function> functions.
+ </para>
+ <para>
+ Logs out the user and disconnects from the server.
+ </para>
+ <simpara>
+ See also <function>ora_logon</function>.
+ </simpara>
</refsect1>
</refentry>
-
<refentry id="function.ora-logon">
<refnamediv>
<refname>Ora_Logon</refname>
@@ -391,8 +500,8 @@
</funcsynopsis>
<para>
Establishes a connection between PHP and an Oracle database with the
- given username and password.</para>
-
+ given username and password.
+ </para>
<para>
Connections can be made using <productname>SQL*Net</productname>
by supplying the <acronym>TNS</acronym> name to
@@ -401,22 +510,91 @@
<programlisting role="php">
$conn = Ora_Logon("user<emphasis> <email protected></emphasis>", "pass");
</programlisting>
- </informalexample></para>
-
+ </informalexample>
+ </para>
<para>
If you have character data with non-ASCII characters, you should
make sure that <envar>NLS_LANG</envar> is set in your
- environment. For server modules, you should set it in the
- server's environment before starting the server.</para>
-
+ environment. For server modules, you should set it in the
+ server's environment before starting the server.
+ </para>
<para>
Returns a connection index on success, or false on failure.
- Details about the error can be retrieved using the <function>ora_error</function> and <function>ora_errorcode</function>
- functions.</para>
+ Details about the error can be retrieved using the
+ <function>ora_error</function> and <function>ora_errorcode</function>
+ functions.
+ </para>
+ </refsect1>
+ </refentry>
+
+ <refentry id="function.ora-plogon">
+ <refnamediv>
+ <refname>Ora_pLogon</refname>
+ <refpurpose>
+ Open a persistent Oracle connection
+ </refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>Description</title>
+ <funcsynopsis>
+ <funcprototype>
+ <funcdef>int <function>ora_plogon</function></funcdef>
+ <paramdef>string <parameter>user</parameter></paramdef>
+ <paramdef>string <parameter>password</parameter></paramdef>
+ </funcprototype>
+ </funcsynopsis>
+ <para>
+ Establishes a persistant connection between PHP and an Oracle database with
+ the given username and password.
+ </para>
+ <simpara>
+ See also <function>ora_logon</function>.
+ </simpara>
+ </refsect1>
+ </refentry>
+ <refentry id="function.ora-numcols">
+ <refnamediv>
+ <refname>Ora_Numcols</refname>
+ <refpurpose>Returns the number of columns</refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>Description</title>
+ <funcsynopsis>
+ <funcprototype>
+ <funcdef>int <function>ora_numcols</function></funcdef>
+ <paramdef>int <parameter>cursor_ind</parameter></paramdef>
+ </funcprototype>
+ </funcsynopsis>
+ <para>
+ <function>ora_numcols</function> returns the number of columns in a result.
+ Only returns meaningful values after an parse/exec/fetch sequence.
+ </para>
+ <simpara>
+ See also <function>ora_parse</function>,<function>ora_exec</function>,
+ <function>ora_fetch</function>, and <function>ora_do</function>.
+ </simpara>
</refsect1>
</refentry>
+ <refentry id="function.ora-numrows">
+ <refnamediv>
+ <refname>Ora_Numrows</refname>
+ <refpurpose>Returns the number of rows</refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>Description</title>
+ <funcsynopsis>
+ <funcprototype>
+ <funcdef>int <function>ora_numrows</function></funcdef>
+ <paramdef>int <parameter>cursor_ind</parameter></paramdef>
+ </funcprototype>
+ </funcsynopsis>
+ <para>
+ <function>ora_numrows</function> returns the number of rows in a result.
+ </para>
+ </refsect1>
+ </refentry>
<refentry id="function.ora-open">
<refnamediv>
@@ -432,17 +610,16 @@
</funcprototype>
</funcsynopsis>
<para>
- Opens an Oracle cursor associated with connection.</para>
-
+ Opens an Oracle cursor associated with connection.
+ </para>
<para>
- Returns a cursor index or False on failure. Details about the
- error can be retrieved using the <function>ora_error</function> and <function>ora_errorcode</function>
- functions.</para>
-
+ Returns a cursor index or False on failure. Details about the
+ error can be retrieved using the <function>ora_error</function>
+ and <function>ora_errorcode</function> functions.
+ </para>
</refsect1>
</refentry>
-
<refentry id="function.ora-parse">
<refnamediv>
<refname>Ora_Parse</refname>
@@ -460,13 +637,19 @@
</funcsynopsis>
<para>
This function parses an SQL statement or a PL/SQL block and
- associates it with the given cursor. Returns 0 on success or -1 on
- error.</para>
-
+ associates it with the given cursor.
+ </para>
+ <para>
+ Returns 0 on success or -1 on
+ error.
+ </para>
+ <simpara>
+ See also <function>ora_exec</function>,
+ <function>ora_fetch</function>, and <function>ora_do</function>.
+ </simpara>
</refsect1>
</refentry>
-
<refentry id="function.ora-rollback">
<refnamediv>
<refname>Ora_Rollback</refname>
@@ -481,19 +664,17 @@
</funcprototype>
</funcsynopsis>
<para>
- This function undoes an Oracle transaction. (See
+ This function undoes an Oracle transaction. (See
<function>ora_commit</function> for the definition of a
- transaction.)</para>
-
+ transaction.)
+ </para>
<para>
- Returns true on success, false on error. Details about the error
+ Returns true on success, false on error. Details about the error
can be retrieved using the <function>ora_error</function> and
- <function>ora_errorcode</function> functions.</para>
-
+ <function>ora_errorcode</function> functions.
+ </para>
</refsect1>
</refentry>
-
-
</reference>
<!-- Keep this comment at the end of the file
@@ -506,7 +687,7 @@
sgml-indent-step:1
sgml-indent-data:t
sgml-parent-document:nil
-sgml-default-dtd-file:"../manual.ced"
+sgml-default-dtd-file:"../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
- Next message: Luca Perugini: "[PHP-DOC] cvs: phpdoc /it/chapters install.xml"
- Previous message: Luca Perugini: "[PHP-DOC] cvs: phpdoc /it/functions posix.xml"
- Messages sorted by: [ date ] [ thread ] [ subject ] [ author ]