mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-27 14:28:56 +00:00
38a2c74793
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@289408 c90b9560-bf6c-de11-be94-00142212c4b1
139 lines
3.3 KiB
XML
139 lines
3.3 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
<refentry xml:id="function.oci-set-module-name" xmlns="http://docbook.org/ns/docbook">
|
|
<refnamediv>
|
|
<refname>oci_set_module_name</refname>
|
|
<refpurpose>Sets the module name</refpurpose>
|
|
</refnamediv>
|
|
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<type>bool</type><methodname>oci_set_module_name</methodname>
|
|
<methodparam><type>resource</type><parameter>connection</parameter></methodparam>
|
|
<methodparam><type>string</type><parameter>module_name</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
Sets the module name for Oracle tracing.
|
|
</para>
|
|
<para>
|
|
The module name is registered with the database when the next
|
|
'roundtrip' from PHP to the database occurs, typically when a SQL
|
|
statement is executed.
|
|
</para>
|
|
<para>
|
|
The name can subsequently be queried from database administration
|
|
views such as <literal>V$SESSION</literal>. It can be used for
|
|
tracing and monitoring such as with <literal>V$SQLAREA</literal>
|
|
and <literal>DBMS_MONITOR.SERV_MOD_ACT_STAT_ENABLE</literal>.
|
|
</para>
|
|
<para>
|
|
The value may be retained across persistent connections.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>connection</parameter></term>
|
|
<listitem>
|
|
&oci.parameter.connection;
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>module_name</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
User chosen <type>string</type> up to 48 bytes long.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
&return.success;
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="notes">
|
|
&reftitle.notes;
|
|
&oci.availability.note.10g;
|
|
&oci.clientinfo.tip;
|
|
&oci.roundtrip.caution;
|
|
</refsect1>
|
|
|
|
<refsect1 role="examples">
|
|
&reftitle.examples;
|
|
<para>
|
|
<example>
|
|
<title>Setting the module name</title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
|
|
$c = oci_connect('hr', 'welcome', 'localhost/XE');
|
|
|
|
// Record the module
|
|
oci_set_module_name($c, 'Home Page');
|
|
|
|
// Code that causes a roundtrip, 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
|
|
// modules in use:
|
|
|
|
sqlplus system/welcome
|
|
SQL> select module from v$session;
|
|
]]>
|
|
</screen>
|
|
</example>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="seealso">
|
|
&reftitle.seealso;
|
|
<para>
|
|
<simplelist>
|
|
<member><function>oci_set_action</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
|
|
-->
|