archived-doc-ja/reference/pdo/constants.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 7e384b24f7e37c6b4caf735f3601179cc65ef8f9 Maintainer: mumumu Status: ready -->
<!-- Generated by xml_proto.php v2.1. Found in /scripts directory of phpdoc. -->
<appendix xml:id="pdo.constants" xmlns="http://docbook.org/ns/docbook">
 &reftitle.constants;
 &extension.constants;

 &reference.pdo.constants.fetch-modes;

 <section xml:id="pdo.constants.cursors" annotations="chunk:false">
  <title>カーソル</title>

  <simpara>
   <constant>PDO::ATTR_CURSOR_NAME</constant> も参照ください。
  </simpara>

  <variablelist>
   <varlistentry xml:id="pdo.constants.fetch-ori-next">
    <term>
     <constant>PDO::FETCH_ORI_NEXT</constant>
     (<type>int</type>)
    </term>
    <listitem>
     <simpara>
      結果セットの次の行を取得します。スクローラブルなカーソルでのみ有効です。
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="pdo.constants.fetch-ori-prior">
    <term>
     <constant>PDO::FETCH_ORI_PRIOR</constant>
     (<type>int</type>)
    </term>
    <listitem>
     <simpara>
      結果セットの前の行を取得します。スクローラブルなカーソルでのみ有効です。
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="pdo.constants.fetch-ori-first">
    <term>
     <constant>PDO::FETCH_ORI_FIRST</constant>
     (<type>int</type>)
    </term>
    <listitem>
     <simpara>
      結果セットの先頭の行を取得します。スクローラブルなカーソルでのみ有効です。
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="pdo.constants.fetch-ori-last">
    <term>
     <constant>PDO::FETCH_ORI_LAST</constant>
     (<type>int</type>)
    </term>
    <listitem>
     <simpara>
      結果セットの最後の行を取得します。スクローラブルなカーソルでのみ有効です。
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="pdo.constants.fetch-ori-abs">
    <term>
     <constant>PDO::FETCH_ORI_ABS</constant>
     (<type>int</type>)
    </term>
    <listitem>
     <simpara>
      結果セットから行番号で指定した行を取得します。スクローラブルなカーソルでのみ有効です。
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="pdo.constants.fetch-ori-rel">
    <term>
     <constant>PDO::FETCH_ORI_REL</constant>
     (<type>int</type>)
    </term>
    <listitem>
     <simpara>
      結果セットのカーソルの現在の位置を基準とする相対位置により指定された行を
      取得します。スクローラブルなカーソルでのみ有効です。
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="pdo.constants.cursor-fwdonly">
    <term>
     <constant>PDO::CURSOR_FWDONLY</constant>
     (<type>int</type>)
    </term>
    <listitem>
     <simpara>
      前進のみ可能なカーソルを有する
      <classname>PDOStatement</classname> オブジェクトを生成します。
      これはデフォルトのカーソルです。
      なぜなら、処理が一番高速で、
      PHP ではもっとも一般的なデータアクセスパターンだからです。
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="pdo.constants.cursor-scroll">
    <term>
     <constant>PDO::CURSOR_SCROLL</constant>
     (<type>int</type>)
    </term>
    <listitem>
     <simpara>
      スクローラブルカーソルを有する
      <classname>PDOStatement</classname> オブジェクトを作成します。
      結果セットから取得した行を制御するための
      <constant>PDO::FETCH_ORI_<replaceable>*</replaceable></constant>
      定数を指定してください。
     </simpara>
    </listitem>
   </varlistentry>
  </variablelist>
 </section>

 <section annotations="chunk:false">
  <title>その他の定数</title>
  <variablelist>
   <varlistentry xml:id="pdo.constants.param-bool">
    <term>
     <constant>PDO::PARAM_BOOL</constant>
     (<type>int</type>)
    </term>
    <listitem>
     <simpara>
      ブールデータ型を表します。
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="pdo.constants.param-null">
    <term>
     <constant>PDO::PARAM_NULL</constant>
     (<type>int</type>)
    </term>
    <listitem>
     <simpara>
      SQL NULL データ型を表します。
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="pdo.constants.param-int">
    <term>
     <constant>PDO::PARAM_INT</constant>
     (<type>int</type>)
    </term>
    <listitem>
     <simpara>
      SQL INTEGER データ型を表します。
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="pdo.constants.param-str">
    <term>
     <constant>PDO::PARAM_STR</constant>
     (<type>int</type>)
    </term>
    <listitem>
     <simpara>
      SQL CHAR, VARCHAR, または他の文字列データ型を表します。
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="pdo.constants.param-str-natl">
    <term>
     <constant>PDO::PARAM_STR_NATL</constant>
     (<type>int</type>)
    </term>
    <listitem>
     <simpara>
      国内の文字セットを使用する文字列であることを示すフラグです。
     </simpara>
     <simpara>
      PHP 7.2.0 以降で利用可能です。
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="pdo.constants.param-str-char">
    <term>
     <constant>PDO::PARAM_STR_CHAR</constant>
     (<type>int</type>)
    </term>
    <listitem>
     <simpara>
      通常の文字セットを使用する文字列であることを示すフラグです。
     </simpara>
     <simpara>
      PHP 7.2.0 以降で利用可能です。
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="pdo.constants.param-lob">
    <term>
     <constant>PDO::PARAM_LOB</constant>
     (<type>int</type>)
    </term>
    <listitem>
     <simpara>
      SQL ラージオブジェクト型を表します。
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="pdo.constants.param-stmt">
    <term>
     <constant>PDO::PARAM_STMT</constant>
     (<type>int</type>)
    </term>
    <listitem>
     <simpara>
      レコードセット型を表します。
      この型は現在どのドライバでもサポートされていません。
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="pdo.constants.param-input-output">
    <term>
     <constant>PDO::PARAM_INPUT_OUTPUT</constant>
     (<type>int</type>)
    </term>
    <listitem>
     <simpara>
     パラメータがストアドプロシージャ用の入出力パラメータであることを指定します。
     この値は、 <constant>PDO::PARAM_<replaceable>*</replaceable></constant>
     定数のビットORとして指定する必要があります。
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="pdo.constants.attr-autocommit">
    <term>
     <constant>PDO::ATTR_AUTOCOMMIT</constant>
     (<type>int</type>)
    </term>
    <listitem>
     <simpara>
      この値が &false; の場合、PDO は接続がトランザクションを開始できるように
      オートコミットを無効にしようとします。
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="pdo.constants.attr-prefetch">
    <term>
     <constant>PDO::ATTR_PREFETCH</constant>
     (<type>int</type>)
    </term>
    <listitem>
     <simpara>
      独自アプリケーションにおける、
      メモリ使用量に対する速度のバランスを調整するためのプリフェッチサイズを設定します。
      全てのデータベースとドライバの組み合わせでプリフェッチサイズの設定をサポートしているわけではありません。
      プリフェッチサイズを大きくするとパフォーマンスは向上しますが、
      メモリ使用量は増加します。
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="pdo.constants.attr-timeout">
    <term>
     <constant>PDO::ATTR_TIMEOUT</constant>
     (<type>int</type>)
    </term>
    <listitem>
     <simpara>
      データベースとの通信に対するタイムアウト値を秒で設定します。
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="pdo.constants.attr-errmode">
    <term>
     <constant>PDO::ATTR_ERRMODE</constant>
     (<type>int</type>)
    </term>
    <listitem>
     <simpara>
      この属性についての詳細は、
      <link linkend="pdo.error-handling">エラー及びエラー処理</link>
      を参照ください。
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="pdo.constants.attr-server-version">
    <term>
     <constant>PDO::ATTR_SERVER_VERSION</constant>
     (<type>int</type>)
    </term>
    <listitem>
     <simpara>
      この属性は読み取り専用です。
      PDO が接続している、データベースサーバーのバージョンに関する情報を返します。
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="pdo.constants.attr-client-version">
    <term>
     <constant>PDO::ATTR_CLIENT_VERSION</constant>
     (<type>int</type>)
    </term>
    <listitem>
     <simpara>
      この属性は読み取り専用です。
      PDO ドライバが使っているクライアントライブラリのバージョンに関する情報を返します。
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="pdo.constants.attr-server-info">
    <term>
     <constant>PDO::ATTR_SERVER_INFO</constant>
     (<type>int</type>)
    </term>
    <listitem>
     <simpara>
      この属性は読み取り専用です。
      PDO が接続している、データベースサーバーのメタ情報に関する情報を返します。
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="pdo.constants.attr-connection-status">
    <term>
     <constant>PDO::ATTR_CONNECTION_STATUS</constant>
     (<type>int</type>)
    </term>
    <listitem>
     <simpara>

     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="pdo.constants.attr-case">
    <term>
     <constant>PDO::ATTR_CASE</constant>
     (<type>int</type>)
    </term>
    <listitem>
     <simpara>
      <constant>PDO::CASE_<replaceable>*</replaceable></constant>
      定数で指定されたケースにカラム名を変更します。
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="pdo.constants.attr-cursor-name">
    <term>
     <constant>PDO::ATTR_CURSOR_NAME</constant>
     (<type>int</type>)
    </term>
    <listitem>
     <simpara>
      カーソルに使用する名前を取得または設定します。
      スクローラブルなカーソルと、
      位置を指定した更新を行う場合に最も有用です。
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="pdo.constants.attr-cursor">
    <term>
     <constant>PDO::ATTR_CURSOR</constant>
     (<type>int</type>)
    </term>
    <listitem>
     <simpara>
      カーソルのタイプを指定します。
      PDO は現在、
      <constant>PDO::CURSOR_FWDONLY</constant> と
      <constant>PDO::CURSOR_SCROLL</constant> をサポートしています。
      スクローラブルなカーソルが必要ない限り、
      <constant>PDO::CURSOR_FWDONLY</constant> のままにしてください。
     </simpara>
    </listitem>
   </varlistentry>

   <varlistentry xml:id="pdo.constants.attr-driver-name">
    <term>
     <constant>PDO::ATTR_DRIVER_NAME</constant>
     (<type>int</type>)
    </term>
    <listitem>
     <simpara>
      ドライバ名を返します。
     </simpara>
     <example>
      <title><constant>PDO::ATTR_DRIVER_NAME</constant> を使う</title>
      <programlisting role="php">
 <![CDATA[
 <?php
 if ($db->getAttribute(PDO::ATTR_DRIVER_NAME) == 'mysql') {
   echo "Running on mysql; doing something mysql specific here\n";
 }
 ?>
 ]]>
      </programlisting>
     </example>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="pdo.constants.attr-oracle-nulls">
    <term>
     <constant>PDO::ATTR_ORACLE_NULLS</constant>
     (<type>int</type>)
    </term>
    <listitem>
     <simpara>
      データをフェッチ時に、
      空文字を SQL の NULL 値に変換します。
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="pdo.constants.attr-persistent">
    <term>
     <constant>PDO::ATTR_PERSISTENT</constant>
     (<type>int</type>)
    </term>
    <listitem>
     <simpara>
      新規接続を生成するよりもむしろ持続的接続を要求します。
      この属性に関する詳細は、
      <link linkend="pdo.connections">接続、および接続の管理</link>
      を参照ください。
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="pdo.constants.attr-statement-class">
    <term>
     <constant>PDO::ATTR_STATEMENT_CLASS</constant>
     (<type>int</type>)
    </term>
    <listitem>
     <simpara>
      ステートメントが返すクラス名を設定します。
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="pdo.constants.attr-fetch-catalog-names">
    <term>
     <constant>PDO::ATTR_FETCH_CATALOG_NAMES</constant>
     (<type>int</type>)
    </term>
    <listitem>
     <simpara>
      結果セット中の各カラム名にカタログ名を追加します。
      カタログ名とカラム名は、小数点 (.) で区切られます。
      この属性のサポートはドライバレベルで行われます。
      つまり、お使いのドライバではサポートされていない可能性があります。
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="pdo.constants.attr-fetch-table-names">
    <term>
     <constant>PDO::ATTR_FETCH_TABLE_NAMES</constant>
     (<type>int</type>)
    </term>
    <listitem>
     <simpara>
      結果セット中の各カラム名に、
      そのカラムを含むテーブル名を先頭に付加します。
      テーブル名とカラム名は小数点(.)で区切られます。
      この属性のサポートはドライバレベルで行われます。
      つまり、お使いのドライバではサポートされていない可能性があります。
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="pdo.constants.attr-stringify-fetches">
    <term>
     <constant>PDO::ATTR_STRINGIFY_FETCHES</constant>
     (<type>int</type>)
    </term>
    <listitem>
     <simpara>
      全てのフェッチする値 (&null; を除く) を強制的に文字列として扱います。
      <constant>PDO::ATTR_ORACLE_NULLS</constant> を
      <constant>PDO::NULL_TO_STRING</constant> に設定しない限り、
      &null; は変更されません。
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="pdo.constants.attr-max-column-len">
    <term>
     <constant>PDO::ATTR_MAX_COLUMN_LEN</constant>
     (<type>int</type>)
    </term>
    <listitem>
     <simpara>
      カラム名の最大の長さを設定します。
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="pdo.constants.attr-default-fetch-mode">
    <term>
     <constant>PDO::ATTR_DEFAULT_FETCH_MODE</constant>
     (<type>int</type>)
    </term>
    <listitem>
     <simpara>

     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="pdo.constants.attr-emulate-prepares">
    <term>
     <constant>PDO::ATTR_EMULATE_PREPARES</constant>
     (<type>int</type>)
    </term>
    <listitem>
     <simpara>

     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="pdo.constants.attr-default-str-param">
    <term>
     <constant>PDO::ATTR_DEFAULT_STR_PARAM</constant>
     (<type>int</type>)
    </term>
    <listitem>
     <simpara>
      デフォルトの文字列のパラメータタイプを設定します。
      <constant>PDO::PARAM_STR_NATL</constant>
      と <constant>PDO::PARAM_STR_CHAR</constant> のうち、
      いずれかひとつを選べます。
     </simpara>
     <simpara>
      PHP 7.2.0 以降で利用可能です。
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="pdo.constants.errmode-silent">
    <term>
     <constant>PDO::ERRMODE_SILENT</constant>
     (<type>int</type>)
    </term>
    <listitem>
     <simpara>
      エラー時にエラーもしくは例外を発生させません。
      開発者の方は明示的にエラーをチェックするようにしてください。
      PHP 8.0.0 より前のバージョンでは、これがデフォルトのモードでした。
      この属性に関する詳細は、
      <link linkend="pdo.error-handling">エラー及びエラー処理</link>
      を参照ください。
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="pdo.constants.errmode-warning">
    <term>
     <constant>PDO::ERRMODE_WARNING</constant>
     (<type>int</type>)
    </term>
    <listitem>
     <simpara>
      エラーが発生した場合、
      PHP の <constant>E_WARNING</constant> メッセージを発行します。
      この属性に関する詳細は、
      <link linkend="pdo.error-handling">エラー及びエラー処理</link>
      を参照ください。
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="pdo.constants.errmode-exception">
    <term>
     <constant>PDO::ERRMODE_EXCEPTION</constant>
     (<type>int</type>)
    </term>
    <listitem>
     <simpara>
      エラーが発生した場合、
      <classname>PDOException</classname> をスローします。
      PHP 8.0.0 以降では、これがデフォルトのモードです。
      この属性に関する詳細は、
      <link linkend="pdo.error-handling">エラー及びエラー処理</link>
      を参照ください。
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="pdo.constants.case-natural">
    <term>
     <constant>PDO::CASE_NATURAL</constant>
     (<type>int</type>)
    </term>
    <listitem>
     <simpara>
      カラム名をデータベースドライバにより返されたままにします。
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="pdo.constants.case-lower">
    <term>
     <constant>PDO::CASE_LOWER</constant>
     (<type>int</type>)
    </term>
    <listitem>
     <simpara>
      カラム名を小文字にします。
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="pdo.constants.case-upper">
    <term>
     <constant>PDO::CASE_UPPER</constant>
     (<type>int</type>)
    </term>
    <listitem>
     <simpara>
      カラム名を大文字にします。
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="pdo.constants.null-natural">
    <term>
     <constant>PDO::NULL_NATURAL</constant>
     (<type>int</type>)
    </term>
    <listitem>
     <simpara>

     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="pdo.constants.null-empty-string">
    <term>
     <constant>PDO::NULL_EMPTY_STRING</constant>
     (<type>int</type>)
    </term>
    <listitem>
     <simpara>

     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="pdo.constants.null-to-string">
    <term>
     <constant>PDO::NULL_TO_STRING</constant>
     (<type>int</type>)
    </term>
    <listitem>
     <simpara>

     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="pdo.constants.err-none">
    <term>
     <constant>PDO::ERR_NONE</constant>
     (<type>string</type>)
    </term>
    <listitem>
     <simpara>
      SQLSTATE  <literal>'00000'</literal> は、
      SQL ステートメントがエラーや警告がなく発行に成功したことを意味します。
      この定数はエラーが発生したかどうかを判別するために
      <methodname>PDO::errorCode</methodname> もしくは
      <methodname>PDOStatement::errorCode</methodname> をチェックする際に
      便利です。この場合、通常はエラー状態を発生したメソッドからの戻りコードを
      検査することによって検知します。
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="pdo.constants.param-evt-alloc">
    <term>
     <constant>PDO::PARAM_EVT_ALLOC</constant>
     (<type>int</type>)
    </term>
    <listitem>
     <simpara>
      割り当てられたときに発生するイベント。
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="pdo.constants.param-evt-free">
    <term>
     <constant>PDO::PARAM_EVT_FREE</constant>
     (<type>int</type>)
    </term>
    <listitem>
     <simpara>
      割り当てが解除されたときに発生するイベント。
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="pdo.constants.param-evt-exec-pre">
    <term>
     <constant>PDO::PARAM_EVT_EXEC_PRE</constant>
     (<type>int</type>)
    </term>
    <listitem>
     <simpara>
      プリペアドステートメントの実行前に発生するイベント。
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="pdo.constants.param-evt-exec-post">
    <term>
     <constant>PDO::PARAM_EVT_EXEC_POST</constant>
     (<type>int</type>)
    </term>
    <listitem>
     <simpara>
      プリペアドステートメントの実行後に発生するイベント。
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="pdo.constants.param-evt-fetch-pre">
    <term>
     <constant>PDO::PARAM_EVT_FETCH_PRE</constant>
     (<type>int</type>)
    </term>
    <listitem>
     <simpara>
      結果セットから結果を取得する前に発生するイベント。
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="pdo.constants.param-evt-fetch-post">
    <term>
     <constant>PDO::PARAM_EVT_FETCH_POST</constant>
     (<type>int</type>)
    </term>
    <listitem>
     <simpara>
      結果セットから結果を取得した後に発生するイベント。
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="pdo.constants.param-evt-normalize">
    <term>
     <constant>PDO::PARAM_EVT_NORMALIZE</constant>
     (<type>int</type>)
    </term>
    <listitem>
     <simpara>
      バインドパラメータの登録時に発生するイベント。
      これにより、ドライバがパラメータ名を正規化できるようになります。
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="pdo.constants.sqlite-deterministic">
    <term>
     <constant>PDO::SQLITE_DETERMINISTIC</constant>
     (<type>int</type>)
    </term>
    <listitem>
     <simpara>
      <methodname>PDO::sqliteCreateFunction</methodname>
      で作られる関数が決定論的であることを指定します。
      つまり、同じ入力が与えられると、
      単一のSQLステートメントの範疇では同じ結果が常に返されます。
      (PHP 7.1.4 以降で使用可能です)
     </simpara>
    </listitem>
   </varlistentry>
  </variablelist>
 </section>
</appendix>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->