<!--
$Header: /usr/prj/pg/cvsroot/doc/doc/src/sgml/ref/comment.sgml,v 1.5 2001/06/27 08:00:34 natsuyo Exp $
Postgres documentation
-->

<refentry id="SQL-COMMENT">
 <refmeta>
  <refentrytitle id="SQL-COMMENT-TITLE">
   COMMENT
  </refentrytitle>
  <refmiscinfo>SQL<!-- Language Statements -->言語</refmiscinfo>
 </refmeta>
 <refnamediv>
  <refname>
   COMMENT
  </refname>
  <refpurpose>
   <!-- Add comment to an object -->オブジェクトにコメントを追加します。<indexterm><primary>COMMENT</primary></indexterm><indexterm><primary>SQL</primary><secondary>COMMENT</secondary></indexterm><indexterm><primary sortas="おぶじぇくと">オブジェクト</primary><secondary sortas="こめんとのついか">コメントの追加</secondary></indexterm>
  </refpurpose>
 </refnamediv>
 <refsynopsisdiv>
  <refsynopsisdivinfo>
   <date>1999-07-20</date>
  </refsynopsisdivinfo>
<synopsis>
COMMENT ON
[
  [ DATABASE | INDEX | RULE | SEQUENCE | TABLE | TYPE | VIEW ]
  <replaceable class="PARAMETER">object_name</replaceable> |
  COLUMN <replaceable class="PARAMETER">table_name</replaceable>.<replaceable class="PARAMETER">column_name</replaceable>|
  AGGREGATE <replaceable class="PARAMETER">agg_name</replaceable> <replaceable class="PARAMETER">agg_type</replaceable>|
  FUNCTION <replaceable class="PARAMETER">func_name</replaceable> (<replaceable class="PARAMETER">arg1</replaceable>, <replaceable class="PARAMETER">arg2</replaceable>, ...)|
  OPERATOR <replaceable class="PARAMETER">op</replaceable> (<replaceable class="PARAMETER">leftoperand_type</replaceable> <replaceable class="PARAMETER">rightoperand_type</replaceable>) |
  TRIGGER <replaceable class="PARAMETER">trigger_name</replaceable> ON <replaceable class="PARAMETER">table_name</replaceable>
] IS <replaceable class="PARAMETER">'text'</replaceable>
</synopsis>
  
  <refsect2 id="R2-SQL-COMMENT-1">
   <refsect2info>
    <date>1999-10-25</date>
   </refsect2info>
   <title>
    <!-- Inputs -->入力
   </title>

    <variablelist>
     <varlistentry>
      <term><replaceable class="PARAMETER">object_name、table_name、
      column_name、agg_name、func_name、op、trigger_name</replaceable></term>
      <listitem>
       <para>
	<!-- The name of the object to be be commented. -->
        コメントを付けるオブジェクトの名前です。
       </para>
      </listitem>
     </varlistentry>
     <varlistentry>
      <term><replaceable class="PARAMETER">text</replaceable></term>
      <listitem>
       <para>
	<!-- The comment to add. -->
        追加するコメントです。
       </para>
      </listitem>
     </varlistentry>
    </variablelist>
  </refsect2>
  
  <refsect2 id="R2-SQL-COMMENT-2">
   <refsect2info>
    <date>1998-09-08</date>
   </refsect2info>
   <title>
    <!-- Outputs -->出力
   </title>

    <variablelist>
     <varlistentry>
      <term><computeroutput>
COMMENT
       </computeroutput></term>
      <listitem>
       <para>
        <!-- 
	Message returned if the table is successfully commented. -->
        テーブルのコメント付けが成功した場合に返されるメッセージです。
       </para>
      </listitem>
     </varlistentry>
    </variablelist>
  </refsect2>
 </refsynopsisdiv>

 <refsect1 id="R1-SQL-COMMENT-1">
  <refsect1info>
   <date>1998-10-25</date>
  </refsect1info>
  <title>
   <!-- Description -->
   説明
  </title>
  <para>
   <!-- 
   <command>COMMENT</command> adds a comment to an object that can be 
    easily retrieved with <command>psql</command>'s
    <command>&bsol;dd</command>, <command>&bsol;d+</command>, or <command>&bsol;l+</command> commands.
    To remove a comment, use <literal>NULL</literal>.
    Comments are automatically dropped when the object is dropped. -->

    <command>COMMENT</command>は、<command>psql</command>の<command>&bsol;dd</command>、<command>&bsol;d+</command>、<command>&bsol;l+</command>などで簡単に取りだすことができるオブジェクトにコメントを追加します。コメントを削除するには<literal>NULL</literal>を使います。コメントはオブジェクトが削除されると自動的に削除されます。

  </para>
 </refsect1>

 <refsect1 id="R1-SQL-COMMENT-2">
  <title>
   <!-- Usage -->使用方法
  </title>
  <para>
   <!-- Comment the table <literal>mytable</literal>: -->
   テーブル<literal>mytable</literal>に「This is my table」というコメントを付けます。
</para>


<programlisting>
COMMENT ON mytable IS 'This is my table.';
</programlisting>

  <para>
   <!-- Some more examples: -->
   いくつかほかの例を示します。
</para>

<programlisting>
COMMENT ON DATABASE my_database IS 'Development Database';
COMMENT ON INDEX my_index IS 'Enforces uniqueness on employee id';
COMMENT ON RULE my_rule IS 'Logs UPDATES of employee records';
COMMENT ON SEQUENCE my_sequence IS 'Used to generate primary keys';
COMMENT ON TABLE my_table IS 'Employee Information';
COMMENT ON TYPE my_type IS 'Complex Number support';
COMMENT ON VIEW my_view IS 'View of departmental costs';
COMMENT ON COLUMN my_table.my_field IS 'Employee ID number';
COMMENT ON AGGREGATE my_aggregate (double precision) IS 'Computes sample variance';
COMMENT ON FUNCTION my_function (timestamp) IS 'Returns Roman Numeral';
COMMENT ON OPERATOR ^ (text, text) IS 'Performs intersection of two text';
COMMENT ON TRIGGER my_trigger ON my_table IS 'Used for R.I.';
</programlisting>
 </refsect1>
 
 <refsect1 id="R1-SQL-COMMENT-3">
  <title>
   <!-- Compatibility -->互換性
  </title>
  
  <refsect2 id="R2-SQL-COMMENT-4">
   <refsect2info>
    <date>1998-09-08</date>
   </refsect2info>
   <title>
    SQL92
   </title>
   <para>
    <!-- 
    There is no <command>COMMENT</command> in <acronym>SQL92</acronym>.
    -->
    <acronym>SQL92</acronym>には<command>COMMENT</command>はありません。

   </para>
  </refsect2>
 </refsect1>
</refentry>

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