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

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 4de5cce5d886bf7ea08db8583141ff9715b47073 Maintainer: takagi Status: ready -->
<appendix xml:id="pgsql.constants" xmlns="http://docbook.org/ns/docbook">
 &reftitle.constants;
 &extension.constants;
 
 <variablelist>
  <varlistentry xml:id="constant.pgsql-assoc">
   <term>
    <constant>PGSQL_ASSOC</constant> 
    (<type>integer</type>)
   </term>
   <listitem>
    <simpara>
      <function>pg_fetch_array</function> に渡します。
      フィールド名と値の連想配列を返します。
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.pgsql-num">
   <term>
    <constant>PGSQL_NUM</constant> 
    (<type>integer</type>)
   </term>
   <listitem>
    <simpara>
      <function>pg_fetch_array</function> に渡します。
      フィールド番号と値の数値添字配列を返します。
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.pgsql-both">
   <term>
    <constant>PGSQL_BOTH</constant> 
    (<type>integer</type>)
   </term>
   <listitem>
    <simpara>
      <function>pg_fetch_array</function> に渡します。
      フィールド値の配列を、数値添字（フィールド番号で）と
      連想配列（フィールド名で）の両方で返します。
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.pgsql-connect-force-new">
   <term>
    <constant>PGSQL_CONNECT_FORCE_NEW</constant> 
    (<type>integer</type>)
   </term>
   <listitem>
    <simpara>
      <function>pg_connect</function> に渡し、既存の同一接続を無視して
      新しい接続を確立させるようにします。
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.pgsql-connection-bad">
   <term>
    <constant>PGSQL_CONNECTION_BAD</constant> 
    (<type>integer</type>)
   </term>
   <listitem>
    <simpara>
      <function>pg_connection_status</function> から返され、データベースとの
      接続が不正な状態になっていることを示します。
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.pgsql-connection-ok">
   <term>
    <constant>PGSQL_CONNECTION_OK</constant> 
    (<type>integer</type>)
   </term>
   <listitem>
    <simpara>
      <function>pg_connection_status</function> から返され、データベースとの
      接続が正常であることを示します。
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.pgsql-seek-set">
   <term>
    <constant>PGSQL_SEEK_SET</constant> 
    (<type>integer</type>)
   </term>
   <listitem>
    <simpara>
     <function>pg_lo_seek</function> に渡します。シーク操作は
     オブジェクトの先頭から始められます。
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.pgsql-seek-cur">
   <term>
    <constant>PGSQL_SEEK_CUR</constant> 
    (<type>integer</type>)
   </term>
   <listitem>
    <simpara>
     <function>pg_lo_seek</function> に渡します。シーク操作は
     カレントの位置から始められます。
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.pgsql-seek-end">
   <term>
    <constant>PGSQL_SEEK_END</constant> 
    (<type>integer</type>)
   </term>
   <listitem>
    <simpara>
     <function>pg_lo_seek</function> に渡します。シーク操作は
     オブジェクトの最後から始められます。
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.pgsql-empty-query">
   <term>
    <constant>PGSQL_EMPTY_QUERY</constant> 
    (<type>integer</type>)
   </term>
   <listitem>
    <simpara>
     <function>pg_result_status</function> から返されます。
     サーバーに送信された文字列が空でした。
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.pgsql-command-ok">
   <term>
    <constant>PGSQL_COMMAND_OK</constant> 
    (<type>integer</type>)
   </term>
   <listitem>
    <simpara>
     <function>pg_result_status</function> から返されます。
     コマンドは正常に終了し、何もデータを返しませんでした。
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.pgsql-tuples-ok">
   <term>
    <constant>PGSQL_TUPLES_OK</constant> 
    (<type>integer</type>)
   </term>
   <listitem>
    <simpara>
     <function>pg_result_status</function> から返されます。
     コマンドは正常に終了し、データを返しました
     （<literal>SELECT</literal> や <literal>SHOW</literal> など）。
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.pgsql-copy-out">
   <term>
    <constant>PGSQL_COPY_OUT</constant> 
    (<type>integer</type>)
   </term>
   <listitem>
    <simpara>
     <function>pg_result_status</function> から返されます。
     （サーバーからの）データのコピーが始まりました。
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.pgsql-copy-in">
   <term>
    <constant>PGSQL_COPY_IN</constant> 
    (<type>integer</type>)
   </term>
   <listitem>
    <simpara>
     <function>pg_result_status</function> から返されます。
     （サーバーへの）データのコピーが始まりました。
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.pgsql-bad-response">
   <term>
    <constant>PGSQL_BAD_RESPONSE</constant> 
    (<type>integer</type>)
   </term>
   <listitem>
    <simpara>
     <function>pg_result_status</function> から返されます。
     サーバーからの応答を判別できませんでした。
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.pgsql-nonfatal-error">
   <term>
    <constant>PGSQL_NONFATAL_ERROR</constant> 
    (<type>integer</type>)
   </term>
   <listitem>
    <simpara>
     <function>pg_result_status</function> から返されます。
     致命的ではないエラー（通知や警告など）が発生しました。
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.pgsql-fatal-error">
   <term>
    <constant>PGSQL_FATAL_ERROR</constant> 
    (<type>integer</type>)
   </term>
   <listitem>
    <simpara>
     <function>pg_result_status</function> から返されます。
     致命的なエラーが発生しました。
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.pgsql-transaction-idle">
   <term>
    <constant>PGSQL_TRANSACTION_IDLE</constant> 
    (<type>integer</type>)
   </term>
   <listitem>
    <simpara>
     <function>pg_transaction_status</function> から返されます。
     接続は現在アイドル状態で、トランザクション内ではありません。
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.pgsql-transaction-active">
   <term>
    <constant>PGSQL_TRANSACTION_ACTIVE</constant> 
    (<type>integer</type>)
   </term>
   <listitem>
    <simpara>
     <function>pg_transaction_status</function> から返されます。
     接続内でコマンドを実行中です。クエリが接続を通じて送信され、
     まだ完了していません。
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.pgsql-transaction-intrans">
   <term>
    <constant>PGSQL_TRANSACTION_INTRANS</constant> 
    (<type>integer</type>)
   </term>
   <listitem>
    <simpara>
     <function>pg_transaction_status</function> から返されます。
     接続は現在アイドル状態で、トランザクションブロック内にあります。
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.pgsql-transaction-inerror">
   <term>
    <constant>PGSQL_TRANSACTION_INERROR</constant> 
    (<type>integer</type>)
   </term>
   <listitem>
    <simpara>
     <function>pg_transaction_status</function> から返されます。
     接続は現在アイドル状態で、トランザクション処理に失敗しています。
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.pgsql-transaction-unknown">
   <term>
    <constant>PGSQL_TRANSACTION_UNKNOWN</constant> 
    (<type>integer</type>)
   </term>
   <listitem>
    <simpara>
     <function>pg_transaction_status</function> から返されます。
     接続が正常ではありません。
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.pgsql-diag-severity">
   <term>
    <constant>PGSQL_DIAG_SEVERITY</constant> 
    (<type>integer</type>)
   </term>
   <listitem>
    <simpara>
     <function>pg_result_error_field</function> に渡します。
     深刻度です。その内容は <literal>ERROR</literal>、
     <literal>FATAL</literal>、あるいは <literal>PANIC</literal>
     （エラーメッセージ内）、あるいは <literal>WARNING</literal>、
     <literal>NOTICE</literal>、<literal>DEBUG</literal>、
     <literal>INFO</literal>、あるいは <literal>LOG</literal>
     （通知メッセージ内）、あるいはこれらの各国語版のうちのどれかです。
     常に存在します。
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.pgsql-diag-sqlstate">
   <term>
    <constant>PGSQL_DIAG_SQLSTATE</constant> 
    (<type>integer</type>)
   </term>
   <listitem>
    <simpara>
     <function>pg_result_error_field</function> に渡します。
     エラーの SQLSTATE コードです。SQLSTATE コードは発生したエラーの種別を
     特定します。これは、データベースエラーに対してフロントエンドの
     アプリケーションが適切な操作（エラー処理など）をできるようにするために
     使用されます。このフィールドはローカライズされていません。また、
     常に存在します。
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.pgsql-diag-message-primary">
   <term>
    <constant>PGSQL_DIAG_MESSAGE_PRIMARY</constant> 
    (<type>integer</type>)
   </term>
   <listitem>
    <simpara>
     <function>pg_result_error_field</function> に渡します。
     人間が判読できる最初のエラーメッセージ（たいてい 1 行）です。常に存在します。
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.pgsql-diag-message-detail">
   <term>
    <constant>PGSQL_DIAG_MESSAGE_DETAIL</constant> 
    (<type>integer</type>)
   </term>
   <listitem>
    <simpara>
     <function>pg_result_error_field</function> に渡します。
     オプションの 2 番目のエラーメッセージで、問題に対する詳細な情報を
     含みます。複数行にまたがることもあります。
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.pgsql-diag-message-hint">
   <term>
    <constant>PGSQL_DIAG_MESSAGE_HINT</constant> 
    (<type>integer</type>)
   </term>
   <listitem>
    <simpara>
     <function>pg_result_error_field</function> に渡します。
     オプションのメッセージで、問題に対してどのように対応すべきかを指摘
     します。エラーの詳細情報と違う点は、発生した事実ではなくアドバイス
     （時に不適切な場合もある）をするところです。複数行にまたがることも
     あります。
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.pgsql-diag-statement-position">
   <term>
    <constant>PGSQL_DIAG_STATEMENT_POSITION</constant> 
    (<type>integer</type>)
   </term>
   <listitem>
    <simpara>
     <function>pg_result_error_field</function> に渡します。
     エラーカーソルの位置を、もとのステートメント中の位置として表す
     整数値を保持する文字列です。
     最初の文字の位置は 1 で、それ以降（バイト数ではなく）文字数で
     位置を数えます。
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.pgsql-diag-internal-position">
   <term>
    <constant>PGSQL_DIAG_INTERNAL_POSITION</constant> 
    (<type>integer</type>)
   </term>
   <listitem>
    <simpara>
     <function>pg_result_error_field</function> に渡します。
     <constant>PG_DIAG_STATEMENT_POSITION</constant> と同じ定義ですが、
     こちらはカーソル位置が内部で生成されたコマンドを参照している場合に
     使用されます。このフィールドが存在する場合は、常に
     <constant>PG_DIAG_INTERNAL_QUERY</constant> フィールドも存在します。
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.pgsql-diag-internal-query">
   <term>
    <constant>PGSQL_DIAG_INTERNAL_QUERY</constant> 
    (<type>integer</type>)
   </term>
   <listitem>
    <simpara>
     <function>pg_result_error_field</function> に渡します。
     失敗した内部生成コマンドのテキストです。例としては、PL/pgSQL 関数で
     発行された SQL クエリなどがあてはまります。
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.pgsql-diag-context">
   <term>
    <constant>PGSQL_DIAG_CONTEXT</constant> 
    (<type>integer</type>)
   </term>
   <listitem>
    <simpara>
     <function>pg_result_error_field</function> に渡します。
     エラーが発生した状況を指定します。現在ここに含まれているのは、
     アクティブなプロシージャの関数や内部生成クエリのコール履歴です。
     これはエントリごとに 1 行のデータとなっており、直近のデータが
     先頭にきます。
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.pgsql-diag-source-file">
   <term>
    <constant>PGSQL_DIAG_SOURCE_FILE</constant> 
    (<type>integer</type>)
   </term>
   <listitem>
    <simpara>
     <function>pg_result_error_field</function> に渡します。
     エラーが報告された箇所の、PostgreSQL ソースコードでのファイル名です。
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.pgsql-diag-source-line">
   <term>
    <constant>PGSQL_DIAG_SOURCE_LINE</constant> 
    (<type>integer</type>)
   </term>
   <listitem>
    <simpara>
     <function>pg_result_error_field</function> に渡します。
     エラーが報告された箇所の、PostgreSQL ソースコードでの行番号です。
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.pgsql-diag-source-function">
   <term>
    <constant>PGSQL_DIAG_SOURCE_FUNCTION</constant> 
    (<type>integer</type>)
   </term>
   <listitem>
    <simpara>
     <function>pg_result_error_field</function> に渡します。
     エラーが報告された箇所の、PostgreSQL ソースコードでの関数名です。
    </simpara>
   </listitem>
  </varlistentry>

  <varlistentry xml:id="constant.pgsql-errors-terse">
   <term>
    <constant>PGSQL_ERRORS_TERSE</constant> 
    (<type>integer</type>)
   </term>
   <listitem>
    <simpara>
     <function>pg_set_error_verbosity</function> に渡します。
     返されるメッセージを指定します。ここには深刻度・短い説明および
     発生位置のみを含めます。通常は 1 行に収まるでしょう。
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.pgsql-errors-default">
   <term>
    <constant>PGSQL_ERRORS_DEFAULT</constant> 
    (<type>integer</type>)
   </term>
   <listitem>
    <simpara>
     <function>pg_set_error_verbosity</function> に渡します。
     デフォルトで返されるメッセージで、上の内容に加えて詳細・
     ヒントあるいは詳細情報を含めます（複数行にまたがるかもしれません）。
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.pgsql-errors-verbose">
   <term>
    <constant>PGSQL_ERRORS_VERBOSE</constant> 
    (<type>integer</type>)
   </term>
   <listitem>
    <simpara>
     <function>pg_set_error_verbosity</function> に渡します。
     詳細モードでのメッセージで、有効なフィールドをすべて含めます。
    </simpara>
   </listitem>
  </varlistentry>

  <varlistentry xml:id="constant.pgsql-status-long">
   <term>
    <constant>PGSQL_STATUS_LONG</constant> 
    (<type>integer</type>)
   </term>
   <listitem>
    <simpara>
     <function>pg_result_status</function> に渡します。
     結果として数値が要求されていることを示します。
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.pgsql-status-string">
   <term>
    <constant>PGSQL_STATUS_STRING</constant> 
    (<type>integer</type>)
   </term>
   <listitem>
    <simpara>
     <function>pg_result_status</function> に渡します。
     結果としてテキストのコマンドタグが要求されていることを示します。
    </simpara>
   </listitem>
  </varlistentry>

  <varlistentry xml:id="constant.pgsql-conv-ignore-default">
   <term>
    <constant>PGSQL_CONV_IGNORE_DEFAULT</constant> 
    (<type>integer</type>)
   </term>
   <listitem>
    <simpara>
     <function>pg_convert</function> に渡します。
     変換時に、テーブルのデフォルト値を無視します。
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.pgsql-conv-force-null">
   <term>
    <constant>PGSQL_CONV_FORCE_NULL</constant> 
    (<type>integer</type>)
   </term>
   <listitem>
    <simpara>
     <function>pg_convert</function> に渡します。
     空文字列に対して、SQL の <literal>NULL</literal> を使用します。
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.pgsql-conv-ignore-not-null">
   <term>
    <constant>PGSQL_CONV_IGNORE_NOT_NULL</constant> 
    (<type>integer</type>)
   </term>
   <listitem>
    <simpara>
     <function>pg_convert</function> に渡します。
     &null; を SQL の <literal>NOT NULL</literal> に変換しないように
     します。
    </simpara>
   </listitem>
  </varlistentry>

 </variablelist>
</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
-->