oci_connect

(PHP 5, PHP 7, PHP 8, PECL OCI8 >= 1.1.0)

oci_connect — Establece una conexión con un servidor Oracle

Descripción

oci_connect(
    string $username,
    string $password,
    ?string $connection_string = null,
    string $encoding = "",
    int $session_mode = OCI_DEFAULT
): resource|false

Devuelve un identificador de conexión, necesario para la mayoría de las llamadas OCI8.

Para mejorar el rendimiento, la mayoría de las aplicaciones deberían utilizar conexiones persistentes con oci_pconnect() en lugar de oci_connect(). Consulte la sección sobre la gestión de conexiones para obtener información general sobre la gestión de conexiones y el agrupamiento de conexiones.

Las llamadas siguientes (tras la primera) a la función oci_connect() con los mismos parámetros devolverán el manejador de conexión devuelto en la primera llamada. Esto significa que las transacciones realizadas sobre un manejador estarán activas en los demás, siempre que utilicen la misma conexión subyacente. Si 2 manejadores deben tener transacciones aisladas, utilice en su lugar la función oci_new_connect().

Parámetros

username

El nombre de usuario de Oracle.

password

La contraseña del usuario.

connection_string

Contiene la instancia Oracle a la que debemos conectarnos. Esto puede ser una » cadena de conexión rápida, un nombre de conexión del archivo tnsnames.ora, o el nombre de una instancia local Oracle.

Si no se especifica o es null, PHP utiliza variables de entorno como TWO_TASK (en Linux) o LOCAL (en Windows) y ORACLE_SID para determinar la instancia Oracle a la que debemos conectarnos.

Para usar el método de conexión rápida, PHP debe estar vinculado con la biblioteca cliente Oracle 10g o superior. La cadena de conexión rápida para Oracle 10g o superior es de la forma : [//]host_name[:port][/service_name]. Desde Oracle 11g, la sintaxis es : [//]host_name[:port][/service_name][:server_type][/instance_name]. Opciones adicionales fueron introducidas con Oracle 19c Los nombres de los servicios pueden ser encontrados ejecutando la utilidad Oracle lsnrctl status en la máquina que ejecuta la base de datos.

El archivo tnsnames.ora puede estar en el camino de búsqueda de Oracle Net, que incluye /your/path/to/instantclient/network/admin, $ORACLE_HOME/network/admin y /etc. Una solución alternativa sería definir TNS_ADMIN para que el archivo $TNS_ADMIN/tnsnames.ora sea leído. Asegúrese de que el demonio que ejecuta el servidor web tenga acceso de lectura a este archivo.

encoding

Determina el juego de caracteres utilizado por la biblioteca cliente Oracle. El juego de caracteres no necesita ser idéntico al utilizado por la base de datos. Si no coincide, Oracle hará lo mejor posible para convertir los datos desde el juego de caracteres de la base de datos. Dependiendo de los juegos de caracteres, el resultado puede no ser perfecto. Además, esta conversión requiere un poco de tiempo del sistema.

Si no se especifica, la biblioteca cliente Oracle determinará un juego de caracteres desde la variable de entorno NLS_LANG.

Pasar este parámetro puede reducir el tiempo de conexión.

session_mode

Este parámetro está disponible a partir de PHP 5 (PECL OCI8 1.1) y acepta los siguientes valores : OCI_DEFAULT, OCI_SYSOPER y OCI_SYSDBA. Si bien la constante OCI_SYSOPER o la constante OCI_SYSDBA es especificada, esta función intentará establecer una conexión privilegiada usando identidades externas. Las conexiones privilegiadas están desactivadas por omisión. Para activarlas, debe definir la opción oci8.privileged_connect a On.

PHP 5.3 (PECL OCI8 1.3.4) introducen el valor de modo OCI_CRED_EXT. Este modo solicita a Oracle usar una identificación externa o bien del sistema operativo, que debe ser configurada en la base de datos. El flag OCI_CRED_EXT solo puede ser usado con el nombre de usuario "/" asociado a una contraseña vacía. La opción oci8.privileged_connect puede ser definida a On o Off.

OCI_CRED_EXT puede ser combinado con el modo OCI_SYSOPER o el modo OCI_SYSDBA.

OCI_CRED_EXT no es soportado en Windows por razones de seguridad.

Valores devueltos

Devuelve un identificador de conexión o false si ocurre un error.

Historial de cambios

Versión	Descripción
8.0.0, PECL OCI8 3.0.0	`connection_string` ahora es nullable.

Ejemplos

Ejemplo #1 Ejemplo con oci_connect() utilizando la sintaxis simplificada

<?php

// Conexión al servicio XE (es decir, la base de datos) en la máquina "localhost"
$conn = oci_connect('hr', 'welcome', 'localhost/XE');
if (!$conn) {
    $e = oci_error();
    trigger_error(htmlentities($e['message'], ENT_QUOTES), E_USER_ERROR);
}

$stid = oci_parse($conn, 'SELECT * FROM employees');
oci_execute($stid);

echo "<table border='1'>\n";
while ($row = oci_fetch_array($stid, OCI_ASSOC+OCI_RETURN_NULLS)) {
    echo "<tr>\n";
    foreach ($row as $item) {
        echo "    <td>" . ($item !== null ? htmlentities($item, ENT_QUOTES) : "") . "</td>\n";
    }
    echo "</tr>\n";
}
echo "</table>\n";

?>

Ejemplo #2 Ejemplo con oci_connect() utilizando un nombre de conexión de red

<?php

// Conexión a la base de datos MYDB descrita en el archivo tnsnames.ora,
// Un ejemplo de entrada tnsnames.ora para MYDB podría ser:
//   MYDB =
//     (DESCRIPTION =
//       (ADDRESS = (PROTOCOL = TCP)(HOST = mymachine.oracle.com)(PORT = 1521))
//       (CONNECT_DATA =
//         (SERVER = DEDICATED)
//         (SERVICE_NAME = XE)
//       )
//     )

$conn = oci_connect('hr', 'welcome', 'MYDB');
if (!$conn) {
    $e = oci_error();
    trigger_error(htmlentities($e['message'], ENT_QUOTES), E_USER_ERROR);
}

$stid = oci_parse($conn, 'SELECT * FROM employees');
oci_execute($stid);

echo "<table border='1'>\n";
while ($row = oci_fetch_array($stid, OCI_ASSOC+OCI_RETURN_NULLS)) {
    echo "<tr>\n";
    foreach ($row as $item) {
        echo "    <td>" . ($item !== null ? htmlentities($item, ENT_QUOTES) : "") . "</td>\n";
    }
    echo "</tr>\n";
}
echo "</table>\n";

?>

Ejemplo #3 Ejemplo con oci_connect() utilizando un juego de caracteres específico

<?php

$conn = oci_connect('hr', 'welcome', 'localhost/XE', 'AL32UTF8');
if (!$conn) {
    $e = oci_error();
    trigger_error(htmlentities($e['message'], ENT_QUOTES), E_USER_ERROR);
}

$stid = oci_parse($conn, 'SELECT * FROM employees');
oci_execute($stid);

echo "<table border='1'>\n";
while ($row = oci_fetch_array($stid, OCI_ASSOC+OCI_RETURN_NULLS)) {
    echo "<tr>\n";
    foreach ($row as $item) {
        echo "    <td>" . ($item !== null ? htmlentities($item, ENT_QUOTES) : "") . "</td>\n";
    }
    echo "</tr>\n";
}
echo "</table>\n";

?>

Ejemplo #4 Ejemplo con múltiples llamadas a la función oci_connect()

<?php

$c1 = oci_connect("hr", "welcome", 'localhost/XE');
$c2 = oci_connect("hr", "welcome", 'localhost/XE');

// Tanto $c1 como $c2 muestran el mismo identificador de recursos PHP, lo que significa
// que se trata de la misma conexión a la base de datos
echo "c1 is $c1<br>\n";
echo "c2 is $c2<br>\n";

function create_table($conn)
{
    $stmt = oci_parse($conn, "create table hallo (test varchar2(64))");
    oci_execute($stmt);
    echo "Created table<br>\n";
}

function drop_table($conn)
{
    $stmt = oci_parse($conn, "drop table hallo");
    oci_execute($stmt);
    echo "Dropped table<br>\n";
}

function insert_data($connname, $conn)
{
    $stmt = oci_parse($conn, "insert into hallo
              values(to_char(sysdate,'DD-MON-YY HH24:MI:SS'))");
    oci_execute($stmt, OCI_DEFAULT);
    echo "$connname inserted row without committing<br>\n";
}

function rollback($connname, $conn)
{
    oci_rollback($conn);
    echo "$connname rollback<br>\n";
}

function select_data($connname, $conn)
{
    $stmt = oci_parse($conn, "select * from hallo");
    oci_execute($stmt, OCI_DEFAULT);
    echo "$connname ----selecting<br>\n";
    while (oci_fetch($stmt)) {
        echo "    " . oci_result($stmt, "TEST") . "<br>\n";
    }
    echo "$connname ----done<br>\n";
}

create_table($c1);

insert_data('c1', $c1);   // Inserta una fila utilizando c1
sleep(2);                 // Se espera para ver un timestamp diferente para la segunda fila
insert_data('c2', $c2);   // Inserta una fila utilizando c2

select_data('c1', $c1);   // Se devuelven los resultados de las 2 inserciones
select_data('c2', $c2);   // Se devuelven los resultados de las 2 inserciones

rollback('c1', $c1);      // Revertir la transacción utilizando c1

select_data('c1', $c1);   // Las 2 inserciones han sido revertidas
select_data('c2', $c2);

drop_table($c1);

// El cierre de una conexión hace que las variables PHP sean inaccesibles, pero las demás
// pueden seguir siendo utilizadas
oci_close($c1);
echo "c1 is $c1<br>\n";
echo "c2 is $c2<br>\n";

// Salida:
//    c1 is Resource id #5
//    c2 is Resource id #5
//    Created table
//    c1 inserted row without committing
//    c2 inserted row without committing
//    c1 ----selecting
//        09-DEC-09 12:14:43
//        09-DEC-09 12:14:45
//    c1 ----done
//    c2 ----selecting
//        09-DEC-09 12:14:43
//        09-DEC-09 12:14:45
//    c2 ----done
//    c1 rollback
//    c1 ----selecting
//    c1 ----done
//    c2 ----selecting
//    c2 ----done
//    Dropped table
//    c1 is
//    c2 is Resource id #5

?>

Notas

Nota:
Si ha ocurrido un problema durante la instalación de la extensión OCI8, una de las manifestaciones será un problema durante la conexión. Consulte la sección Instalación/Configuración para obtener más información en caso de errores.

Ver también

oci_pconnect() - Establece una conexión persistente a un servidor Oracle
oci_new_connect() - Conexión al servidor Oracle utilizando una sola conexión
oci_close() - Cierra una conexión Oracle

Found A Problem?

Learn How To Improve This Page • Submit a Pull Request • Report a Bug

＋add a note

User Contributed Notes 9 notes

down

M0no at ethonfusino dot com ¶

22 years ago

If your oracle database is on a remote system within your local network and you don't want to worry about the tnsnames file you can try this.



$db = "(DESCRIPTION=(ADDRESS_LIST = (ADDRESS = (PROTOCOL = TCP)(HOST = 192.168.XX.XXX)(PORT = 1521)))(CONNECT_DATA=(SID=XXXX)))";



$c1 = ocilogon("name","password",$db);



Hope this helps someone.

down

Leandro da Cunha Campos ¶

16 years ago

ONE ALTERNATIVE OF CONNECT IN ORACLE RAC "Real Application Clusters"



<?php

$dbstr ="(DESCRIPTION =(ADDRESS = (PROTOCOL = TCP)(HOST =ip1)(PORT = 1521))

(CONNECT_DATA =

(SERVER = DEDICATED)

(SERVICE_NAME = banco)

(INSTANCE_NAME = banco1)))"; 

 

$dbstr1 ="(DESCRIPTION =(ADDRESS = (PROTOCOL = TCP)(HOST =ip2)(PORT = 1521))

(CONNECT_DATA =

(SERVER = DEDICATED)

(SERVICE_NAME = banco)

(INSTANCE_NAME = banco2)))"; 

 

if(!@($conn = oci_connect('user','password',$dbstr1)))

{ $conn = oci_connect('user','password',$dbstr) or die (ocierror()); }

?>

down

sixd at php dot net ¶

17 years ago

If you want to specify a connection timeout in case there is network problem, you can edit the client side (e.g. PHP side) sqlnet.ora file and set SQLNET.OUTBOUND_CONNECT_TIMEOUT. This sets the upper time limit for establishing a connection right through to the DB, including the time for attempts to connect to other services.   It is available from Oracle 10.2.0.3 onwards.

In Oracle 11.1, a slightly lighter-weight solution TCP.CONNECT_TIMEOUT was introduced.  It also is a sqlnet.ora parameter.  It bounds just the TCP connection establishment time, which is mostly where connection problem are seen.

The client sqlnet.ora file should be put in the same directory as the tnsnames.ora file.

down

blake dot lewis at gmail dot com ¶

12 years ago

Using ldap for Oracle name resolution:

  The web server will need the environmental variable TNS_ADMIN='Directory of tnsname.ora' unless the default location is used. I use '/etc/tns_admin'. Confirm using the phpinfo().

  There are three files needed in the TNS_ADMIN location: tnsnames.ora, sqlnet.ora and ldap.ora. If you are only using ldap, tnsnames.ora is not needed.

  To sqlnet.ora add:
     NAMES.DIRECTORY_PATH=(TNSNAMES,LDAP)

  To ldap.ora add:
     DIRECTORY_SERVERS=(ldap_server_fqdn:port)
     DEFAULT_ADMIN_CONTEXT=""
     DIRECTORY_SERVER_TYPE=OID

  For a quick and dirty ldap tnsnames server use tnsManager by Dave Berry. Oracle OID or Openldap can used, but are complicated to setup. tnsManager is a no brainer. The quick part: give it a tnsnames.ora file and start it up. The dirty parts: I can't get Toad and SQLDeveloper to work with it, it ignores the domain and it is no longer being maintained.

  The order of values in NAMES.DIRECTORY_PATH in sqlnet.ora determines which look up 'adapter' is used, in this case it is tnsnames.ora file and then ldap. I use ldap for general consumption and tnsnames.ora file to override ldap or entries that are not for general consumption.

  If you have the full Oracle client you have tnsping. 'tnsping ORACLE_SID' will tell you what adapter you are using: 'Used LDAP adapter to resolve the alias'.

<?php
  echo system("/PATH/tnsping ".$ORACLE_SID." 2>&1")."<br />";
  echo 'TNS_ADMIN='.getenv('TNS_ADMIN');
?>

ISSUE:
  If connecting with only ORACLE_SID and not ORACLE_SID.DB_DOMAIN, the value of NAMES.DEFAULT_DOMAIN from sqlnet.ora is appended, then for some reason PHP tries the HOSTNAME adapter, and if the database name resolves in DNS, it will fail connecting using the database name as the hostname, because neither SID nor SERVICE_NAME are defined.
  If using tnsManager append '.ANY_DOMAIN' to $ORACLE_SID to hack around the issue above.

  I have tested with:
       11.1.0.7 full client and PHP 5.1.6
       11.2.0.2 full client and PHP 5.4.11

  I have heard that LDAP lookup does not work with older instantclients.

down

sebastien.barbieri _at_ gmail dot com ¶

18 years ago

When you are using Oracle 9.2+ I would say that you MUST use the CHARSET parameter.

Of course, you will not notice it until there is accented character... so just specify it and you will avoid a big headache.

So for example here is our Oracle internal conf:
select * from nls_database_parameters;
 
PARAMETER                      VALUE
------------------------------ ----------------------------------------
…
NLS_LANGUAGE                   AMERICAN
NLS_TERRITORY                  AMERICA
NLS_ISO_CURRENCY               AMERICA
NLS_CHARACTERSET               WE8ISO8859P15
…
 
And there our oci_connect call:

$dbch=ocilogon($user,$pass,$connectString,"WE8ISO8859P15");

Without that, you will get question mark (inversed), squares… instead of most accented character.

Don’t forget to use that for writing as well as for reading.

down

Jonathon Robinson ¶

15 years ago

Regarding the following statement in the documentation:

"The second and subsequent calls to oci_connect() with the same parameters will return the connection handle returned from the first call."



There's one caveat here.  Subsequent calls to oci_connect() will only return the same connection handle as the first call as long as a reference is held to the original handle.



For example, the following code will generate *one* connection handle:



<?php

$dbh = oci_connect($username, $password, $conn_info);

// Do stuff

$dbh = oci_connect$username, $password, $conn_info);

// Do more stuff



The follow code will generate *two* connection handles:

getData();

// Do stuff

getData();

// Do more stuff



getData() {

    $dbh = oci_connect($username, $password, $conn_info);

    // Do stuff

}

?>



This is the result of PHP garbage collecting the handle at the end of the method scope.



If you want to isolate your DB layer through function calls but still want to leverage the fact that oci_connect can return the same handle, just keep a reference to the handle like so:



<?php

getData($username, $password, $conn_info) {

    $dbh = oci_connect($username, $password, $conn_info);

    $key = hash('md5', "$username|$password|$conn_info");

    $GLOBALS[$key] = $dbh;

    // Do stuff

}

?>



I originally logged this as a bug but apparently this is the expected behaviour, likely because oci_close($dbh) just calls unset($dbh).

down

drew dot carmichael at gmail dot com ¶

16 years ago

When using the OCI_CRED_EXT in php 
if the ENV $ORACLE_SID is set the DB does not need to be specified explicitly and the connection will fail unless you provide a NULL DB value when creating the connection. 

The $ORACLE_SID trumps the TNS name look up for the connection. So even a manual connection string in the DB parameter will fail.

So when the $ORACLE_SID Env is set a NULL passed instead of the DB name connects successfully. 

Hope this saves some hair pulling when moving to %.3 and OS Authentications

down

-4

ben at onshop dot co dot uk ¶

19 years ago

There is a useful solution to the problem of securing connection information in the PHP Cookbook (O'Reilly) by David Sklar and Adam Trachtenberg. They propose using 'SetEnv' in the Apache configuration and then accessing the values from within a script using $_SERVER.



Unfortunately using the 'SetEnv' solution exposes your connection information to all users of that virtual host. If they run phpinfo.php or display $_SERVER, I found that they will see the password from any file under the root of that virtual host.



To restrict exposure to a particular directory or specific file:



1. First put an 'Include' to the secret file in httpd.conf. For example:



Include "/web/private/secret.txt"



2. In the password file, use the 'SetEnvIf' directive to enable the Environment variables by directory only or within a specific file. For example:



- For all files in the directory:



SetEnvIf Request_URI "/path/to/my/directory" ORACLE_PASS=5gHj790j



- For a specific file in the directory



SetEnvIf Request_URI "/path/to/my/directory/connection.oracle.php" ORACLE_PASS=5gHj790j

down

-5

blake dot lewis at gmail dot com ¶

12 years ago

Using ldap for Oracle name resolution:



  The web server needs the environmental variable TNS_ADMIN='Directory of tnsname.ora'. I use '/etc/tns_admin'. Confirm using the phpinfo() function.



  There are three files needed in the TNS_ADMIN location: tnsnames.ora, sqlnet.ora and ldap.ora. If you are only using ldap, tnsnames.ora is not needed.



  To sqlnet.ora add: 

     NAMES.DIRECTORY_PATH=(TNSNAMES,LDAP)



  To ldap.ora add:

     DIRECTORY_SERVERS=(ldap_fqdn_hostname:1575)

     DEFAULT_ADMIN_CONTEXT=""

     DIRECTORY_SERVER_TYPE=OID



  For a quick and dirty ldap tnsnames server use tnsManager by Dave Berry. Oracle OID or Openldap can used, but are complicated to setup. tnsManager is a no brainer. The default port is 1575.



  The order of values in NAMES.DIRECTORY_PATH from sqlnet.ora determines which look up 'adapter' is used first, in this case it is tnsnames.ora file and then ldap. I use ldap for general consumption and tnsnames.ora file to override ldap or entries that are not for general consumption.



  If you have the full Oracle client you have tnsping. 'tnsping ORACLE_SID' will tell you what adapter you are using: 'Used LDAP adapter to resolve the alias'.



<?php

  echo system("/PATH/tnsping ".$ORACLE_SID." 2>&1")."<br />";

  echo 'TNS_ADMIN='.getenv('TNS_ADMIN');

?>



ISSUE:

  For some reason PHP tries the HOSTNAME adapter first, and if the database name resolves in DNS, it will try connecting using the database name as the hostname with no SID or SERVICE_NAME defined. All other Oracle clients I have used will not try the HOSTNAME adapter unless it is listed in NAMES.DIRECTORY_PATH.

  I have heard that LDAP look up does not work with older instantclients.

＋add a note