Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

oci_set_client_info(3) [php man page]

OCI_SET_CLIENT_INFO(3)													    OCI_SET_CLIENT_INFO(3)

oci_set_client_info - Sets the client information

SYNOPSIS
bool oci_set_client_info (resource $connection, string $client_info) DESCRIPTION
Sets the client information for Oracle tracing. The client information is registered with the database when the next 'roundtrip' 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
o $connection -An Oracle connection identifier, returned by oci_connect(3), oci_pconnect(3), or oci_new_connect(3). o $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 roundtrip, 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 10 g onwards. Tip Performance With older versions of OCI8 or the Oracle Database, the client information can be set using the Oracle DBMS_APPLICATION_INFO pack- age. This is less efficient than using oci_set_client_info(3). Caution Roundtrip Gotcha Some but not all OCI8 functions cause roundtrips. Roundtrips to the database may not occur with queries when result caching is enabled. SEE ALSO
oci_set_module_name(3), oci_set_action(3), oci_set_client_identifier(3). PHP Documentation Group OCI_SET_CLIENT_INFO(3)

Check Out this Related Man Page

OCI_SET_CLIENT_IDENTIFIER(3)											      OCI_SET_CLIENT_IDENTIFIER(3)

oci_set_client_identifier - Sets the client identifier

SYNOPSIS
bool oci_set_client_identifier (resource $connection, string $client_identifier) DESCRIPTION
Sets the client identifier used by various database components to identify lightweight application users who authenticate as the same database user. 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. The identifier can subsequently be queried, for example with SELECT SYS_CONTEXT('USERENV','CLIENT_IDENTIFIER') FROM DUAL. Database admin- istration views such as V$SESSION will also contain the value. It can be used with DBMS_MONITOR.CLIENT_ID_TRACE_ENABLE for tracing and can also be used for auditing. The value may be retained across page requests that use the same persistent connection. PARAMETERS
o $connection -An Oracle connection identifier, returned by oci_connect(3), oci_pconnect(3), or oci_new_connect(3). o $client_identifier - User chosen string up to 64 bytes long. RETURN VALUES
Returns TRUE on success or FALSE on failure. EXAMPLES
Example #1 Setting the client identifier to the application user <?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); // ... ?> NOTES
Caution Roundtrip Gotcha Some but not all OCI8 functions cause roundtrips. Roundtrips to the database may not occur with queries when result caching is enabled. SEE ALSO
oci_set_module_name(3), oci_set_action(3), oci_set_client_info(3). PHP Documentation Group OCI_SET_CLIENT_IDENTIFIER(3)
Man Page