oci_pconnect

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

oci_pconnect — 持続的接続を使用してOracle データベースに接続する

説明

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

Oracle サーバーへの持続的接続を生成し、ログオンします。

持続的接続はキャッシュされ、リクエスト間で再利用されることで、各ページロードのオーバーヘッドを軽減します。典型的な PHP アプリケーションでは、Apache の子プロセス (もしくは PHP FPM プロセス) ごとに Oracle サーバーに対してオープンされた単一の持続的接続を有します。より詳細な情報については、 OCI8 接続のハンドリングおよびプーリングのセクションを参照ください。

パラメータ

username

Oracle のユーザー名。

password

username のパスワード。

connection_string

接続先の Oracle インスタンス。 » Easy Connect 文字列、tnsnames.ora ファイルの接続文字列、あるいはローカルの Oracle インスタンス名を指定します。

省略した場合、または null の場合、PHP は環境変数 TWO_TASK (Linux) あるいは LOCAL (Windows) と ORACLE_SID を用いて接続先の Oracle インスタンス を判断します。

Easy Connect 方式を使うには、PHP を Oracle 10g 以降のクライアントライブラリとリンクさせる必要があります。Oracle 10g の Easy Connect 文字列の形式は [//]host_name[:port][/service_name] です。Oracle 11g 以降の場合は、この構文は [//]host_name[:port][/service_name][:server_type][/instance_name] となります。 Oracle 19c では、さらにオプションが追加されています。タイムアウトや keep-alive の設定を含みます。詳細は Oracle のドキュメントを参照して下さい。サービス名を調べるには、Oracle のユーティリティ lsnrctl status をデータベースサーバー上で実行します。

tnsnames.ora ファイルは Oracle Net のサーチパス上にあります。サーチパスに含まれるのは /your/path/to/instantclient/network/admin, $ORACLE_HOME/network/admin, /etc です。もうひとつの方法として、 TNS_ADMIN を指定して $TNS_ADMIN/tnsnames.ora を読み込ませることもできます。ウェブデーモンにそのファイルの読み込み権限を与えておきましょう。

encoding

Oracle クライアントライブラリが使う文字セットを指定します。これは、データベースが用いる文字セットと一致させる必要はありません。一致していない場合は、Oracle が最善を尽くしてデータベースの文字セットとの間の変換を行います。文字セットによっては、この変換結果がうまく使えないこともあります。また、変換にはそれなりの時間を要します。

省略した場合は、 Oracle クライアントライブラリは環境変数 NLS_LANG の値をもとに文字セットを判断します。

このパラメータを渡すことで、接続に要する時間を短縮できます。

session_mode

このパラメータは PHP 5 (PECL OCI8 1.1) 以降で使え、 OCI_DEFAULT、 OCI_SYSOPER そして OCI_SYSDBA といった値を指定することができます。OCI_SYSOPER あるいは OCI_SYSDBA を指定した場合は、この関数は外部の証明書を使った特権接続の確立を試みます。特権接続は、デフォルトでは無効になっています。有効にするには oci8.privileged_connect を On に設定しなければなりません。

PHP 5.3 (PECL OCI8 1.3.4) 以降、 OCI_CRED_EXT モードを使えるようになりました。これは、Oracle に外部認証あるいは OS 認証を使うよう指示します。どちらかをデータベースで設定しておかなければなりません。 OCI_CRED_EXT フラグを使えるのは、ユーザー名が "/" でパスワードが空のときだけです。 oci8.privileged_connect は On あるいは Off のどちらでもかまいません。

OCI_CRED_EXT は、 OCI_SYSOPER あるいは OCI_SYSDBA モードと組み合わせて使います。

OCI_CRED_EXT は、セキュリティ上の理由により Windows ではサポートされていません。

戻り値

接続 ID、あるいはエラー時に false を返します。

例

例1 Easy Connect 構文を使った oci_pconnect() の例

<?php

// "localhost" 上の XE サービス (データベース) に接続します
$conn = oci_pconnect('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) : "&nbsp;") . "</td>\n";
    }
    echo "</tr>\n";
}
echo "</table>\n";

?>

パラメータの使いかたについては、oci_connect() の例も参照ください。

注意

注意: 持続的な Oracle接続の生存時間と最大数は、PHP のプロセス単位で調節できます。次の設定値を利用します。 oci8.persistent_timeout, oci8.ping_interval, oci8.max_persistent 。

参考

oci_connect() - Oracle データベースに接続する
oci_new_connect() - 一意な接続を使って Oracle サーバーへ接続する

add a note

User Contributed Notes 2 notes

down

php at jaggard dot org dot uk ¶

16 years ago


[Editor's note: OCI8 1.3 should not experience the problem described in this user comment. The first use of such a connection will return an Oracle error which will trigger a cleanup in PHP.  Subsequent persistent connection calls will then succeed.  For high availability you might consider doing consecutive oci_pconnect calls in your script.]



If you connect using oci_pconnect and the connection has logged you off but is still valid, there seems to be no way to re-use that connection. The next time I try oci_pconnect and then perform an oci_execute operation, I get a "ORA-01012: not logged on" warning. This problem remains, even if I close the connection using oci_close. I ended up with the following (rather annoying) code.



<?php

    function getOracleConnection()

    {

      if (!function_exists('oci_pconnect'))

        return false;

      $toReturn = oci_pconnect('user', 'pass', 'db');

      if ($testRes = @oci_parse($toReturn, 'SELECT Count(group_type_code) FROM pvo.group_type'))

        if (@oci_execute($testRes))

          if (@oci_fetch_array($testRes))

            return $toReturn;

      oci_close($toReturn);

      if (!function_exists('oci_connect'))

        return false;

      $toReturn = oci_connect('user', 'pass', 'db');

      if ($testRes = @oci_parse($toReturn, 'SELECT Count(group_type_code) FROM pvo.group_type'))

        if (@oci_execute($testRes))

          if (@oci_fetch_array($testRes))

            return $toReturn;

      oci_close($toReturn);

      if (!function_exists('oci_new_connect'))

        return false;

      $toReturn = oci_new_connect('user', 'pass', 'db');

      if ($testRes = @oci_parse($toReturn, 'SELECT Count(group_type_code) FROM pvo.group_type'))

        if (@oci_execute($testRes))

          if (@oci_fetch_array($testRes))

            return $toReturn;

      oci_close($toReturn);

      return false;

    }

?>

down

-1

gotankersley at NOSPAM dot com ¶

12 years ago


Installed on CentOS 6.2, and had lots of trouble getting it to recognize tnsnames.ora.  The fix for me was:

1. Make sure apache is getting the TNS_ADMIN env variable by putting it in the /etc/init.d/httpd file:
 TNS_ADMIN=/usr/lib/oracle/11.2/client64/network/admin
 export PATH TNS_ADMIN

This can be debugging in PHP by <?php echo system('env'); ?> and by verifying that TNS_ADMIN is there.

2. Make sure to use the name at the beginning of the tnsnames.ora file - not the SID (although ideally they should match.  However, if the name at the beginning is XXXX.world then pconnect will expect this - not the SID)

add a note