<!--
$Header: /usr/prj/pg/cvsroot/doc/doc/src/sgml/libpgeasy.sgml,v 1.6 2001/08/28 03:41:35 i-kaori Exp $
-->

 <chapter id="pgeasy-chapter">
  <!--<title id="pgeasy">libpgeasy - Simplified C Library</title>-->
  <title id="pgeasy">libpgeasy――簡易Cライブラリ</title>
<indexterm><primary>libpgeasy</primary></indexterm>
<indexterm><primary>PostgreSQL</primary><secondary>libpgeasy</secondary></indexterm>

  <note>
   <title><!--Author-->著者</title>

   <para>
    <!--Written by--> Bruce Momjian
    （<email>pgman@candle.pha.pa.us</email>）
    <!--and last updated-->最終更新日2000-03-30
   </para>
  </note>

  <para>
   <!--<productname>pgeasy</productname> allows you to cleanly interface
   to the <productname>libpq</productname> library,
   more like a 4GL SQL interface.-->

   <productname>pgeasy</productname>は、4GL SQLインターフェイスのように、<productname>libpq</productname>ライブラリと簡潔に連係をさせるものです。
  </para>

  <para>
   <!--It consists of set of simplified C functions that encapsulate the
   functionality of libpq.
   The functions are:-->

   <productname>pgeasy</productname>は、libpqの機能をカプセル化した、平易なC関数で構成されています。関数として、以下のものがあります。
</para>

   <itemizedlist>
    <listitem>
     <para>
PGresult   *doquery(char *query);
     </para>
    </listitem>

    <listitem>
     <para>
PGconn     *connectdb(char *options);
     </para>
    </listitem>

    <listitem>
     <para>
void        disconnectdb();
     </para>
    </listitem>

    <listitem>
     <para>
int         fetch(void *param,...);
     </para>
    </listitem>

    <listitem>
     <para>
int         fetchwithnulls(void *param,...);
     </para>
    </listitem>

    <listitem>
     <para>
void        reset_fetch();
     </para>
    </listitem>

    <listitem>
     <para>
void        on_error_continue();
     </para>
    </listitem>

    <listitem>
     <para>
void        on_error_stop();
     </para>
    </listitem>

    <listitem>
     <para>
PGresult   *get_result();
     </para>
    </listitem>

    <listitem>
     <para>
void        set_result(PGresult *newres);
     </para>
    </listitem>

    <listitem>
     <para>
void        unset_result(PGresult *oldres);
     </para>
    </listitem>
   </itemizedlist>

  <para>
   <!--Many functions return a structure or value, so you can do more work
   with the result if required.-->

   多くの関数は、構造体または値を返すので、必要ならばその結果を使ってさまざまなことができます。
  </para>

  <para>
   <!--You basically connect to the database with <function>connectdb</function>,
   issue your query with <function>doquery</function>,
   fetch the results with <function>fetch</function>,
   and finish with <function>disconnectdb</function>.-->

   <function>connectdb</function>でデータベースと接続し、<function>doquery</function>で問い合わせを発行し、<function>fetch</function>で結果を取り出し、<function>disconnectdb</function>で接続を切断します。
  </para>

  <para>
   <!--For <literal>SELECT</literal> queries, <function>fetch</function>
   allows you to pass pointers as parameters, and on return the variables
   are filled with data from the binary cursor you opened.  These binary
   cursors can not be used if you are running the
   <productname>pgeasy</productname>
   client on a system with a different architecture than the database
   server.  If you pass a NULL pointer parameter, the column is skipped.
   <function>fetchwithnulls</function> allows you to retrieve the NULL
   status of the field by passing an <literal>int*</literal>
   after each result pointer, which returns true or false if the field is null.

   You can always use libpq functions on the PGresult pointer returned
   by <function>doquery</function>.
   <function>reset_fetch</function> starts the fetch back at the beginning.-->

   <literal>SELECT</literal>問い合わせにおいて、<function>fetch</function>関数は引数にポインタを引き渡し、変数に開いたバイナリカーソルからのデータが格納されたものが返ってきます。これらのバイナリカーソルは、データベースサーバー以外のアーキテクチャのシステムで<productname>pgeasy</productname>クライアントを起動させている場合には使用できません。NULLのポインタを引き渡した場合は、列は飛ばされます。<function>fetchwithnulls</function>は、フィールドがNULLかどうかの結果を返す<literal>int*</literal>を各結果ポインタの後に置き、フィールドがNULL状態でも結果を回収します。<function>doquery</function>によって返されたPGresultのポインタはlibpq関数のどの部分でも使用することができます。
  </para>

  <para>
   <!--<function>get_result</function>,
   <function>set_result</function>,
   and
   <function>unset_result</function>
   allow you to handle multiple result sets at the same time.-->

   <function>get_result</function>関数、<function>set_result</function>関数、<function>unset_result</function>関数は同時に複数の結果を操作することができます。
  </para>

  <para>
   <!--There are a variety of demonstration programs in the
   source directory.-->

   ソースディレクトリにはサンプルプログラムがたくさん掲載されています。
  </para>
 </chapter>

<!-- 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:
-->
