oci_set_client_info
(PHP 5 >= 5.3.2, PHP 7, PHP 8, PECL OCI8 >= 1.4.0)
oci_set_client_info — Sets the client information
Description
$connection, string $client_info): boolSets the client information for Oracle tracing.
The client information is registered with the database when the next 'round-trip' from PHP to the database occurs, typically when an SQL statement is executed.
The client information can subsequently be queried from database
administration views such as V$SESSION.
The value may be retained across persistent connections.
Parameters
-
connection -
An Oracle connection identifier, returned by oci_connect(), oci_pconnect(), or oci_new_connect().
-
client_info -
User chosen string up to 64 bytes long.
Return Values
Returns true on success or false on failure.
Examples
Example #1 Setting the client information
<?php
$c = oci_connect('hr', 'welcome', 'localhost/XE');
// Record the client information
oci_set_client_info($c, 'My Application Version 2');
// 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);
?>
// While the script is running, the administrator can see the client // information: sqlplus system/welcome SQL> select client_info from v$session;
Notes
Note: Oracle version requirement
This function is available when PHP is linked with Oracle Database libraries from version 10g onwards.
Performance
With older versions of
OCI8 or the Oracle Database, the client information can be set using the Oracle
DBMS_APPLICATION_INFO package. This is less efficient than
using oci_set_client_info().
Round-trip Gotcha
Some but not all OCI8 functions cause round-trips. Round-trips to the database may not occur with queries when result caching is enabled.
See Also
- oci_set_module_name() - Sets the module name
- oci_set_action() - Sets the action name
- oci_set_client_identifier() - Sets the client identifier
- oci_set_db_operation() - Sets the database operation
