Skip to content

Commit

Permalink
Add missing OCI8 constants
Browse files Browse the repository at this point in the history
  • Loading branch information
haszi committed Jun 28, 2024
1 parent 3c9bf39 commit cf1c594
Showing 1 changed file with 123 additions and 1 deletion.
124 changes: 123 additions & 1 deletion reference/oci8/constants.xml
Original file line number Diff line number Diff line change
Expand Up @@ -397,7 +397,7 @@
<row xml:id="constant.sqlt-rset">
<entry><constant>SQLT_RSET</constant></entry>
<entry>
The same as <constant>OCI_B_CURSOR</constant>.
The same as <constant>OCI_B_CURSOR</constant>.
</entry>
</row>
<row xml:id="constant.sqlt-str">
Expand Down Expand Up @@ -475,6 +475,128 @@
</tbody>
</tgroup>
</table>
<variablelist role="constant_list">
<title>OCI8 Transparent Application Failover (TAF) Constants</title>
<varlistentry xml:id="constant.oci-fo-abort">
<term>
<constant>OCI_FO_ABORT</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
Failover was unsuccessful and there is no option of retrying.
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.oci-fo-begin">
<term>
<constant>OCI_FO_BEGIN</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
Failover has detected a lost connection and failover is starting.
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.oci-fo-end">
<term>
<constant>OCI_FO_END</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
Failover completed successfully.
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.oci-fo-error">
<term>
<constant>OCI_FO_ERROR</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
Failover was unsuccessful but it gives the application the opportunity
to handle the error and return <constant>OCI_FO_RETRY</constant> to retry failover.
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.oci-fo-none">
<term>
<constant>OCI_FO_NONE</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
The user has not requested a failover type.
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.oci-fo-reauth">
<term>
<constant>OCI_FO_REAUTH</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
An Oracle user has been re-authenticated.
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.oci-fo-retry">
<term>
<constant>OCI_FO_RETRY</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
The failover should be attempted again by Oracle.
In case of an error while failing over to a new
connection, TAF is able to retry the failover.
Typically, the application code should sleep for
a while before returning <constant>OCI_FO_RETRY</constant>.
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.oci-fo-select">
<term>
<constant>OCI_FO_SELECT</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
The user has requested SELECT failover as well.
It allows users with open cursors to continue fetching from them after failure.
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.oci-fo-session">
<term>
<constant>OCI_FO_SESSION</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
The user has requested only session failover.
For example, if a user's connection is lost,
then a new session is automatically created for the user on the backup.
This type of failover does not attempt to recover SELECTs.
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.oci-fo-txnal">
<term>
<constant>OCI_FO_TXNAL</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
The user has requested a transaction failover.
</simpara>
</listitem>
</varlistentry>
</variablelist>
</appendix>

<!-- Keep this comment at the end of the file
Expand Down

0 comments on commit cf1c594

Please sign in to comment.