php-doc-en/reference/oci8/functions/oci-set-db-operation.xml
2018-12-18 21:10:59 +00:00

138 lines
3.3 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.oci-set-db-operation">
<refnamediv>
<refname>oci_set_db_operation</refname>
<refpurpose>Sets the database operation</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>oci_set_db_operation</methodname>
<methodparam><type>resource</type><parameter>connection</parameter></methodparam>
<methodparam><type>string</type><parameter>dbop</parameter></methodparam>
</methodsynopsis>
<para>
Sets the DBOP for Oracle tracing.
</para>
<para>
The database operation name is registered with the database when the next
'round-trip' from PHP to the database occurs, typically when a SQL
statement is executed.
</para>
<para>
The database operation can subsequently be queried from database administration
views such as <literal>V$SQL_MONITOR</literal>.
</para>
<para>
The <function>oci_set_db_operation</function> function is available
when OCI8 uses Oracle 12 (or later) Client libraries and Oracle Database 12 (or later).
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>connection</parameter></term>
<listitem>
&oci.parameter.connection;
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>dbop</parameter></term>
<listitem>
<para>
User chosen string.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Setting the DBOP</title>
<programlisting role="php">
<![CDATA[
<?php
$c = oci_connect('hr', 'welcome', 'localhost/XE');
// Record the operation
oci_set_db_operation($c, 'main query');
// Code that causes a round-trip, for example a query:
$s = oci_parse($c, 'select * from dual');
oci_execute($s);
oci_fetch_all($s, $res);
sleep(30);
?>
]]>
</programlisting>
<screen>
<![CDATA[
// While the script is running, the administrator can see the database operations
// being performed:
sqlplus system/welcome
SQL> select dbop_name from v$sql_monitor;
]]>
</screen>
</example>
</para>
</refsect1>
<refsect1 role="notes">
&reftitle.notes;
&oci.roundtrip.caution;
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>oci_set_action</function></member>
<member><function>oci_set_module_name</function></member>
<member><function>oci_set_client_info</function></member>
<member><function>oci_set_client_identifier</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- 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
-->