oci_set_client_identifier

PHP 5 >= 5.3.2, PHP 7, PHP 8, PECL OCI8 >= 1.4.0
oci_set_client_identifier - Sets the client identifier
Manual
Code Examples

oci_set_client_identifier( resource$connection, string$client_id ): bool

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 'round-trip' 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 administration 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

connection

An Oracle connection identifier, returned by oci_connect, oci_pconnect, or oci_new_connect.

client_id

User chosen string up to 64 bytes long.

Return Values

Returns true on success or false on failure.

Notes

Caution:
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.

Related Functions

Example of oci_set_client_identifier

Show all examples for oci_set_client_identifier

PHP Version:


Function oci_set_client_identifier:

Oracle OCI8 Functions

Most used PHP functions