php-doc-en/reference/oci8/functions/oci-set-client-identifier.xml
Daniel Egeberg 0640e024d4 Fixed PHP bug #51978
for file in `ack -i '\bA\s+SQL' -l`; do perl -i -pe 's/\b(a)(\s+SQL)/\1n\2/gi' $file; done


git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@300101 c90b9560-bf6c-de11-be94-00142212c4b1
2010-06-02 18:45:11 +00:00

133 lines
3.3 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.oci-set-client-identifier" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>oci_set_client_identifier</refname>
<refpurpose>Sets the client identifier</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>oci_set_client_identifier</methodname>
<methodparam><type>resource</type><parameter>connection</parameter></methodparam>
<methodparam><type>string</type><parameter>client_identifier</parameter></methodparam>
</methodsynopsis>
<para>
Sets the client identifier used by various database components to
identify lightweight application users who authenticate as the same
database user.
</para>
<para>
The client identifier is registered with the database when the next
'roundtrip' from PHP to the database occurs, typically when an SQL
statement is executed.
</para>
<para>
The identifier can subsequently be queried from database administration
views such as <literal>V$SESSION</literal>. It can be used with
<literal>DBMS_MONITOR.CLIENT_ID_TRACE_ENABLE</literal> for tracing.
It can be used for auditing.
</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>client_identifier</parameter></term>
<listitem>
<para>
User chosen string up to 64 bytes long.
</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 client identifier to the application user</title>
<programlisting role="php">
<![CDATA[
<?php
// Find the application user's login name
session_start();
$un = my_validate_session($_SESSION['username']);
$c = oci_connect('myschema', 'welcome', 'localhost/XE');
// Tell Oracle who that user is
oci_set_client_identifier($c, $un);
// The next roundtrip to the database will piggyback the identifier
$s = oci_parse($c, 'select mydata from mytable');
oci_execute($s);
...
?>
]]>
</programlisting>
</example>
</para>
</refsect1>
<refsect1 role="notes">
&reftitle.notes;
&oci.roundtrip.caution;
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>oci_set_module_name</function></member>
<member><function>oci_set_action</function></member>
<member><function>oci_set_client_info</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
-->