関数・クラス解説

db2_get_option

version:PECL ibm_db2 >= 1.6.0 (公式)

ステートメントリソースあるいは接続リソースからオプションの値を取得する

公式リファレンス

書式

db2_get_option ( resource $resource , string $option ) : string|false

説明

ステートメントリソースあるいは接続リソースから、指定したオプションの値を取得します。

パラメータ

resource
db2_prepare() が返す有効なステートメントリソース、 あるいは db2_connect() や db2_pconnect() が返す有効な接続リソース。
option
ステートメントや接続の、有効なオプション。 以下の新しいオプションが、ibm_db2 バージョン 1.6.0 以降で使用可能です。 これらは、有用な情報を提供します。これらの情報は、 db2_get_option() によって取得します。
注意: 以前のバージョンの ibm_db2 では、これらの新しいオプションはサポートしていません。 各オプションの値を設定する際、 サーバーによっては指定したすべての内容を処理できないことがあります。 その場合、値が切り詰められます。 指定したオプションが正しく変換されてホストシステムに送信されることを確実にするには、 A から Z までの文字と 0 から 9 までの数字、そしてアンダースコア (_) とピリオド (.) のみを使用するようにします。
userid
SQL_ATTR_INFO_USERID - ヌル終端の文字列へのポインタで、DB2 接続の際にホストデータベースサーバーに送信する クライアントのユーザー ID として使用します。
注意: z/OS および OS/390 サーバー版の DB2 は 16 文字までの長さをサポートしています。 このユーザー ID を、認証時に使用するユーザー ID と混同しないでください。 これは識別のためだけに使用するものであり、認証には用いられません。
acctstr
SQL_ATTR_INFO_ACCTSTR - ヌル終端の文字列へのポインタで、DB2 接続の際にホストデータベースサーバーに送信する クライアントのアカウンティング・ストリングとして使用します。
注意: z/OS および OS/390 サーバー版の DB2 は 200 文字までの長さをサポートしています。
applname
SQL_ATTR_INFO_APPLNAME - ヌル終端の文字列へのポインタで、DB2 接続の際にホストデータベースサーバーに送信する クライアントのアプリケーション名として使用します。
注意: z/OS および OS/390 サーバー版の DB2 は 32 文字までの長さをサポートしています。
wrkstnname
SQL_ATTR_INFO_WRKSTNNAME - ヌル終端の文字列へのポインタで、DB2 接続の際にホストデータベースサーバーに送信する クライアントのワークステーション名として使用します。
注意: z/OS および OS/390 サーバー版の DB2 は 18 文字までの長さをサポートしています。
次の表は、どのオプションがどのリソース型で使用できるのかをまとめたものです。
リソースとパラメータの対応
キー リソース型
  接続 ステートメント 結果セット
userid SQL_ATTR_INFO_USERID X X -
acctstr SQL_ATTR_INFO_ACCTSTR X X -
applname SQL_ATTR_INFO_APPLNAME X X -
wrkstnname SQL_ATTR_INFO_WRKSTNNAME X X -

返値

成功した場合に接続属性の現在の設定内容、 失敗した場合に FALSE を返します。

サンプル

例1 接続リソースのパラメータの設定および取得

/* データベースへの接続パラメータ */ $database = 'SAMPLE'; $user     = 'db2inst1'; $password = 'ibmdb2'; /* 接続リソースの取得 */ $conn = db2_connect($database, $user, $password); echo "Client attributes passed through connection string:\n"; /* 有効なキーと値のペアを持つ連想配列を作成 */ /* 接続文字列を介して属性をアサイン */ /* 指定されたオプションにアクセス */ $options1 = array('userid' => 'db2inst1'); $conn1 = db2_connect($database, $user, $password, $options1); $val = db2_get_option($conn1, 'userid'); echo $val . "\n"; $options2 = array('acctstr' => 'account'); $conn2 = db2_connect($database, $user, $password, $options2); $val = db2_get_option($conn2, 'acctstr'); echo $val . "\n"; $options3 = array('applname' => 'myapp'); $conn3 = db2_connect($database, $user, $password, $options3); $val = db2_get_option($conn3, 'applname'); echo $val . "\n"; $options4 = array('wrkstnname' => 'workstation'); $conn4 = db2_connect($database, $user, $password, $options4); $val = db2_get_option($conn4, 'wrkstnname'); echo $val . "\n"; echo "Client attributes passed post-connection:\n"; /* 有効なキーと値のペアを持つ連想配列を作成 */ /* 接続作成後に属性をアサイン */ /* 指定されたオプションにアクセス */ $options5 = array('userid' => 'db2inst1'); $conn5 = db2_connect($database, $user, $password); $rc = db2_set_option($conn5, $options5, 1); $val = db2_get_option($conn5, 'userid'); echo $val . "\n"; $options6 = array('acctstr' => 'account'); $conn6 = db2_connect($database, $user, $password); $rc = db2_set_option($conn6, $options6, 1); $val = db2_get_option($conn6, 'acctstr'); echo $val . "\n"; $options7 = array('applname' => 'myapp'); $conn7 = db2_connect($database, $user, $password); $rc = db2_set_option($conn7, $options7, 1); $val = db2_get_option($conn7, 'applname'); echo $val . "\n"; $options8 = array('wrkstnname' => 'workstation'); $conn8 = db2_connect($database, $user, $password); $rc = db2_set_option($conn8, $options8, 1); $val = db2_get_option($conn8, 'wrkstnname'); echo $val . "\n";

上の例の出力は以下となります。

Client attributes passed through connection string: db2inst1 account myapp workstation Client attributes passed post-connection: db2inst1 account myapp workstation

参考

  • db2_connect() - データベースへの接続を返す
  • db2_cursor_type() - ステートメントリソースが使用しているカーソルの型を返す
  • db2_exec() - SQL 文を直接実行する
  • db2_set_option() - 接続リソースあるいはステートメントリソースのオプションを設定する
  • db2_pconnect() - データベースへの持続的接続を返す
  • db2_prepare() - 実行する SQL 文を準備する
  • ワード検索


    ※入力キーワードが、関数名・説明文・タグに含まれるものを検索

    関数名アルファベット別

    A B C D E F G H I J
    K L M N O P Q R S T
    U V W X Y Z _

    最終更新一覧

    stristr
     大文字小文字を区別せず文字列を検索し、ヒット箇所以降(あるいは以前)の文字列を返却

    stripslashes
     バックスラッシュでエスケープされた文字列から、バックスラッシュを取り除く

    stripos
     大文字小文字を区別せずに文字列が最初に現れる位置を取得する

    stripcslashes
     addcslashes() でクォートされた文字列をアンクォートする

    strip_tags
     文字列から HTML と PHP のタグを除去して返却

    strcspn
     指定した文字が最初に現れる位置を調べる

    strcoll
     ロケールに基づいて2つの文字列を比較し同じか(あるいは大小)を判定する

    strcmp
     2つの文字列を比較し同じか(あるいは大小)を判定する

    strchr
     strstr() のエイリアス

    strcasecmp
     2つの文字列を比較(大文字小文字を区別せず同じとみなす)

    カテゴリー一覧

    PHP の振る舞いの変更
    音声フォーマットの操作
    認証サービス
    コマンドライン関連
    圧縮およびアーカイブ
    暗号
    データベース関連
    日付および時刻関連
    ファイルシステム
    自然言語および文字エンコーディング
    画像処理および作成
    メール関連
    数学
    テキスト以外の MIME 型
    プロセス制御
    その他の基本モジュール
    その他のサービス
    検索エンジン用の拡張モジュール
    サーバー固有のモジュール
    セッション関連
    テキスト処理
    変数・データ型関連
    ウェブサービス
    Windows 用のモジュール
    XML 操作
    GUI用の拡張モジュール