<!--
$Header: /usr/prj/pg/cvsroot/doc/doc/src/sgml/ref/declare.sgml,v 1.5 2001/09/06 11:38:15 i-kaori Exp $
Postgres documentation
-->

<refentry id="SQL-DECLARE">
 <refmeta>
  <refentrytitle id="SQL-DECLARE-TITLE">
   DECLARE
  </refentrytitle>
  <refmiscinfo>SQL<!-- - Language Statements-->言語</refmiscinfo>
 </refmeta>
 <refnamediv>
  <refname>
   DECLARE
  </refname>
  <refpurpose>
   <!--Defines a cursor for table access-->
   テーブルアクセス用のカーソルを定義します。<indexterm><primary>DECLARE</primary></indexterm><indexterm><primary>SQL</primary><secondary>DECLARE</secondary></indexterm><indexterm><primary sortas="かーそる">カーソル</primary><secondary sortas="さくせい">作成</secondary></indexterm>
  </refpurpose>
 </refnamediv>
 <refsynopsisdiv>
  <refsynopsisdivinfo>
   <date>1999-07-20</date>
  </refsynopsisdivinfo>
<synopsis>
DECLARE <replaceable class="parameter">cursorname</replaceable> [ BINARY ] [ INSENSITIVE ] [ SCROLL ]
    CURSOR FOR <replaceable class="parameter">query</replaceable>
    [ FOR { READ ONLY | UPDATE [ OF <replaceable class="parameter">column</replaceable> [, ...] ] ]
</synopsis>
  <refsect2 id="R2-SQL-DECLARE-1">
   <refsect2info>
    <date>1998-04-15</date>
   </refsect2info>
   <title>
    <!--Inputs-->入力
   </title>
    <variablelist>
     <varlistentry>
      <term><replaceable class="parameter">cursorname</replaceable></term>
      <listitem>
       <para>
	<!--The name of the cursor to be used in subsequent FETCH operations.-->
        この後にFETCH操作などで使用される、カーソルの名前です。
       </para>
      </listitem>
     </varlistentry>

     <varlistentry>
      <term>BINARY</term>
      <listitem>
       <para>
	<!--Causes the cursor to fetch data in binary
	rather than in text format.-->
        カーソルによるデータの取得は、テキスト形式ではなくバイナリ形式になります。
       </para>
      </listitem>
     </varlistentry>

     <varlistentry>
      <term>INSENSITIVE</term>
      <listitem>
       <para>
	<!--<acronym>SQL92</acronym> keyword indicating that data retrieved
	from the cursor should be unaffected by updates from other processes or cursors.
	Since cursor operations occur within transactions
	in <productname>Postgres</productname> this is always the case.
	This keyword has no effect.-->

        カーソルから取り出されたデータが他のプロセスやカーソルによる更新の影響を受けないことを示す、<acronym>SQL92</acronym>のキーワードです。<productname>Postgres</productname>では、カーソル操作はトランザクションの内側で行われますので、常にこの状態になっていますので、このキーワードは効果がありません。
       </para>
      </listitem>
     </varlistentry>

     <varlistentry>
      <term>SCROLL</term>
      <listitem>
       <para>
	<!--<acronym>SQL92</acronym> keyword indicating that data may be retrieved
	in multiple rows per FETCH operation. Since this is allowed at all times
	by <productname>Postgres</productname> this keyword has no effect.-->

        1つのFETCH操作によって複数の行のデータを取り出すことができることを示す、<acronym>SQL92</acronym>のキーワードです。<productname>Postgres</productname>では、常にこれは許可されているので、このキーワードは効果がありません。

       </para>
      </listitem>
     </varlistentry>

     <varlistentry>
      <term><replaceable class="parameter">query</replaceable></term>
      <listitem>
       <para>
	<!--An SQL query which will provide the rows to be governed by the
	cursor.
	Refer to the SELECT statement for further information about
	valid arguments.-->

        カーソルによって管理される行を提供する、1つのSQL問い合わせです。有効な引数に関するより詳細についてはSELECT文を参照してください。

       </para>
      </listitem>
     </varlistentry>

     <varlistentry>
      <term>READ ONLY</term>
      <listitem>
       <para>
	<!--<acronym>SQL92</acronym> keyword indicating that the cursor will be used
	in a read only mode. Since this is the only cursor access mode
	available in <productname>Postgres</productname> this keyword has no effect.-->

        読み取り専用モードでカーソルが使用されることを示す、<acronym>SQL92</acronym>のキーワードです。これは<productname>Postgres</productname>における唯一のカーソルのアクセスモードのため、このキーワードは効果がありません。
       </para>
      </listitem>
     </varlistentry>

     <varlistentry>
      <term>UPDATE</term>
      <listitem>
       <para>
	<!--<acronym>SQL92</acronym> keyword indicating that the cursor will be used
	to update tables. Since cursor updates are not currently
	supported in <productname>Postgres</productname> this keyword
	provokes an informational error message.-->

        カーソルがテーブルの更新に使用されることを示す、<acronym>SQL92</acronym>のキーワードです。カーソルによる更新は今のところ<productname>Postgres</productname>でサポートされていないため、このキーワードはこのことを伝えるエラーメッセージを表示します。

       </para>
      </listitem>
     </varlistentry>

     <varlistentry>
      <term><replaceable class="parameter">column</replaceable></term>
      <listitem>
       <para>
	<!--Column(s) to be updated.
	Since cursor updates are not currently
	supported in <productname>Postgres</productname> the UPDATE clause
	provokes an informational error message.-->

        更新される列（複数可）です。カーソルによる更新は今のところ<productname>Postgres</productname>でサポートされていないので、UPDATE句はこのことを伝えるエラーメッセージを表示します。
        
       </para>
      </listitem>
     </varlistentry>

    </variablelist>
  </refsect2>

  <refsect2 id="R2-SQL-DECLARE-2">
   <refsect2info>
    <date>1998-04-15</date>
   </refsect2info>
   <title>
    <!--Outputs-->出力
   </title>

    <variablelist>
     <varlistentry>
      <term><computeroutput>
SELECT
       </computeroutput></term>
      <listitem>
       <para>
	<!--The message returned if the SELECT is run successfully.-->
        SELECT文の実行が成功した場合に返されるメッセージです。
       </para>
      </listitem>
     </varlistentry>

     <varlistentry>
      <term><computeroutput>
NOTICE:  Closing pre-existing portal "<replaceable class="parameter">cursorname</replaceable>"
       </computeroutput></term>
      <listitem>
       <para>
	<!--This message is reported if the same cursor name was already declared
	in the current transaction block.  The previous definition is
	discarded.-->
        このエラーは、同じカーソルが現在のトランザクションブロックですでに宣言されている場合に表示されます。以前の定義は削除されます。
       </para>
      </listitem>
     </varlistentry>

     <varlistentry>
      <term><computeroutput>
ERROR:  DECLARE CURSOR may only be used in begin/end transaction blocks
       </computeroutput></term>
      <listitem>
       <para>
	<!--This error occurs if the cursor is not declared within a transaction block.-->
        このエラーは、カーソルが現在のトランザクションで定義されていない場合に表示されます。
       </para>
      </listitem>
     </varlistentry>     
    </variablelist>
  </refsect2>
 </refsynopsisdiv>

 <refsect1 id="R1-SQL-DECLARE-1">
  <refsect1info>
   <date>1998-09-04</date>
  </refsect1info>
  <title>
   <!--Description-->説明
  </title>
  <para>
   <!--<command>DECLARE</command> allows a user to create cursors, which
   can be used to retrieve
   a small number of rows at a time out of a larger query. Cursors can
   return data either in text or in binary format using
   <xref linkend="sql-fetch" endterm="sql-fetch-title">.-->

   <command>DECLARE</command>によって、ユーザーは巨大な問い合わせの中から一度に少数の行を取り出すことに使用できるカーソルを作成することができます。<xref linkend="sql-fetch" endterm="sql-fetch-title">を使用して、カーソルからテキストもしくはバイナリのどちらかの形式でデータを返すことができます。
  </para>

  <para>
   <!--Normal cursors return data in text format, either ASCII or another
   encoding scheme depending on how the <productname>Postgres</productname>
   backend was built. Since
   data is stored natively in binary format, the system must
   do a conversion to produce the text format. In addition,
   text formats are often larger in size than the corresponding binary format.
   Once the information comes back in text form,  the client
   application may need to convert it to a binary format to
   manipulate it.
   BINARY cursors give you back the data in the native binary
   representation.-->

   通常のカーソルは、<productname>Postgres</productname>のバックエンドがどのように構築されたかによって、ASCIIまたはその他のエンコードスキーマのテキスト形式でデータを返します。元のデータは固有のバイナリ形式で保存されていますので、システムはテキスト形式を生成するために変換を行う必要があります。また、テキスト形式の場合、対応するバイナリ形式よりもそのサイズが大きくなることがよくあります。情報がテキスト形式で返されると、クライアントアプリケーションは情報を処理するためにバイナリ形式に変換する必要になることがあります。BINARYカーソルによって、固有のバイナリ表現でデータを返すことができます。<indexterm><primary sortas="かーそる">カーソル</primary><secondary sortas="けいしき">形式</secondary></indexterm>
  </para>

  <para>
   <!--As an example, if a query returns a value of one from an integer column,
   you would get a string of '1' with a default cursor
   whereas with a binary cursor you would get
   a 4-byte value equal to control-A ('^A').-->

   たとえば、問い合わせが整数の列から「1」の値を返す場合、デフォルトのカーソルと一緒に'1'という文字列を入手することになりますが、バイナリ形式のカーソルの場合はcontrol-A ('^A')と同一の4バイトの値を入手することになります。
  </para>

  <para>
   <!--BINARY cursors should be used carefully. User applications such
   as <application>psql</application> are not aware of binary cursors
   and expect data to come back in a text format.-->

   バイナリのカーソルは注意して使わなければいけません。<application>psql</application>のようなユーザーアプリケーションはバイナリ形式のカーソルと認識せず、データはテキスト形式で返されるものとみなしています。
  </para>

  <para>
   <!--String representation is architecture-neutral whereas binary
   representation can differ between different machine architectures.
   <emphasis><productname>Postgres</productname> does not resolve
    byte ordering or representation issues for binary cursors</emphasis>.
   Therefore, if your client machine and server machine use different
   representations (e.g., "big-endian" versus "little-endian"),
   you will probably not want your data returned in
   binary format.
   However, binary cursors may be a
   little more efficient since there is less conversion overhead in
   the server to client data transfer.-->

   文字列表現はアーキテクチャに依存しませんが、バイナリ表現はマシンのアーキテクチャによって異なります。<productname>Postgres</productname>はBINARYカーソルに関するバイトオーダとか表現形式の問題などを<emphasis>解決しません。</emphasis>ですから、クライアントマシンとサーバーマシンで異なる表現（たとえば、ビッグエンディアンとリトルエンディアン）を使用する場合、バイナリ形式ではデータを返さない方がよいでしょう。しかし、バイナリ形式のカーソルには、サーバーからクライアントへのデータ転送の際の変換に要するオーバーヘッドが少なくなるという、多少の効果があり得ます。
</para>

   <tip>
    <para>
     <!--If you intend to display the data in
     ASCII,  getting it back in ASCII will save you some
     effort on the client side.-->

     ASCII形式でデータを表示する場合は、ASCII形式で結果を受け取ることでクライアント側でのいくつかの処理を省くことができます。
    </para>
   </tip>

  <refsect2 id="R2-SQL-DECLARE-3">
   <refsect2info>
    <date>1998-09-04</date>
   </refsect2info>
   <title>
    <!--Notes-->注釈
   </title>

   <para>
    <!--Cursors are only available in transactions. Use to
    <xref linkend="sql-begin" endterm="sql-begin-title">,
    <xref linkend="sql-commit" endterm="sql-commit-title">
    and
    <xref linkend="sql-rollback" endterm="sql-rollback-title">
    to define a transaction block.-->

    カーソルはトランザクション内部でのみ使用可能です。トランザクションブロックを定義するには、<xref linkend="sql-begin" endterm="sql-begin-title">、<xref linkend="sql-commit" endterm="sql-commit-title">、<xref linkend="sql-rollback" endterm="sql-rollback-title">を使用してください。
   </para>

   <para>
    <!--In <acronym>SQL92</acronym> cursors are only available in
    embedded <acronym>SQL</acronym> (<acronym>ESQL</acronym>) applications. 
    The <productname>Postgres</productname> backend
    does not implement an explicit <command>OPEN cursor</command>
    statement; a cursor is considered to be open when it is declared.
    However, <application>ecpg</application>, the
    embedded SQL preprocessor for <productname>Postgres</productname>,
    supports the <acronym>SQL92</acronym> cursor conventions, including those
    involving DECLARE and OPEN statements.-->

   <acronym>SQL92</acronym>では、カーソルは埋め込みSQL（<acronym>ESQL</acronym>）アプリケーションでのみ使用可能です。<productname>Postgres</productname>バックエンドでは、明示的な<command>OPEN cursor</command>文を実装していません。カーソルは宣言されたときに開いたものとみなされています。しかし、<productname>Postgres</productname>用の埋め込みSQLプリプロセッサである<application>ecpg</application>では、DECLAREとOPEN文などを含め、<acronym>SQL92</acronym>規定をサポートしています。
   </para>
  </refsect2>
 </refsect1>

 <refsect1 id="R1-SQL-DECLARESTATEMENT-2">
  <title>
   <!--Usage-->使用方法
  </title>
  <para>
   <!--To declare a cursor:-->カーソルを定義するには以下のようにします。
</para>

<programlisting>
DECLARE liahona CURSOR
    FOR SELECT * FROM films;
</programlisting>
 </refsect1>

 <refsect1 id="R1-SQL-DECLARESTATEMENT-3">
  <title>
   <!--Compatibility-->互換性
  </title>

  <refsect2 id="R2-SQL-DECLARESTATEMENT-4">
   <refsect2info>
    <date>1998-04-15</date>
   </refsect2info>
   <title>
    SQL92
   </title>
   <para>
    <!--<acronym>SQL92</acronym> allows cursors only in embedded <acronym>SQL</acronym>
    and in modules. <productname>Postgres</productname> permits cursors to be used
    interactively.
    <acronym>SQL92</acronym> allows embedded or modular cursors to
    update database information.
    All <productname>Postgres</productname> cursors are read only.
    The BINARY keyword is a <productname>Postgres</productname> extension.-->

    <acronym>SQL92</acronym>では、カーソルを埋め込み<acronym>SQL</acronym>内とモジュール内でのみ使用できます。<productname>Postgres</productname>では対話式にカーソルを使うことができます。<acronym>SQL92</acronym>では、埋め込みまたはモジュール型のカーソルを使ってデータベースの情報を更新することができます。すべての<productname>Postgres</productname>のカーソルは読み取り専用です。BINARYキーワードは<productname>Postgres</productname>の言語拡張です。
   </para>
  </refsect2>
 </refsect1>
</refentry>

<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:nil
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
sgml-parent-document:nil
sgml-default-dtd-file:"../reference.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:"/usr/lib/sgml/catalog"
sgml-local-ecat-files:nil
End:
-->
