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

# oci_pconnect

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

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

### 説明

function 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 サーバーへ接続する

`↑` and `↓` to navigate • `Enter` to select • `Esc` to close • `/` to open