COMMENT ステートメント

呼び出し

このステートメントは、アプリケーション・プログラムに組み込んだり、動的 SQL ステートメントを使用して発行したりすることができます。 これは、DYNAMICRULES の実行動作がパッケージに効力を持つ場合にのみ、動的に準備できる実行可能ステートメントです (SQLSTATE 42509)。

許可

表スペース、ストレージ・グループ、またはデータベース・パーティション・グループ、およびバッファー・プールの場合、許可 ID は SYSCTRL 権限または SYSADM 権限を持っている必要がある点に注意してください。

構文

objects

alias-designator

function-designator

procedure-designator

remote-server

server-version

service-class-designator

Notes:

• ¹ Index-name can be the name of either an index or an index specification.

説明

別名指定子 (alias-designator)

別名 alias-name

<!---->alias-name<!----> (別名) に対するコメントの追加または置き換えを行うことを指定します。 alias-name には、現行のサーバー上の既存の別名を指定する必要があります (SQLSTATE 42704)。

FOR TABLE、FOR MODULE、または FOR SEQUENCE

別名のオブジェクト・タイプを指定します。

FOR TABLE

別名は、表、ビュー、またはニックネームに対するものです。 コメントは、SYSCAT.TABLES カタログ・ビューの別名を記述する行の REMARKS 列の値を置き換えます。

FOR MODULE

別名は、モジュールに対するものです。 コメントは、SYSCAT.MODULES カタログ・ビューの別名を記述する行の REMARKS 列の値を置き換えます。

FOR SEQUENCE

別名は、シーケンスに対するものです。 コメントは、SYSCAT.SEQUENCES カタログ・ビューの別名を記述する行の REMARKS 列の値を置き換えます。

PUBLIC が指定される場合、alias-name は現在のサーバーに存在するパブリック別名を指定するものでなければなりません (SQLSTATE 42704)。

監査ポリシー policy-name

監査ポリシーに対するコメントの追加または置き換えを行うことを指定します。 policy-name は、現行のサーバーに存在する監査ポリシーを識別するものでなければなりません (SQLSTATE 42704)。 コメントは、 SYSCAT.AUDITPOLICIES 監査ポリシーを記述する行のカタログ・ビュー。

COLUMN table-name.column-name または view-name.column-name

列に対するコメントを追加または置き換えることを指定します。 table-name.column-name または view-name.column-name の組み合わせは、現行のサーバー上の既存の列と表の組み合わせを指定していなければなりません (SQLSTATE 42704)。 しかし、グローバル一時表を指定してはなりません (SQLSTATE 42995)。 コメントは、SYSCAT.COLUMNS カタログ・ビューのその列を記述する行の REMARKS 列の値を置き換えます。

制約 table-name.constraint-name

制約に対するコメントの追加または置き換えを指定します。 table-name.constraint-name の組み合わせは、 制約とそれが制約する表を指定していなければなりません。これらは、 現行のサーバーに存在していなければなりません (SQLSTATE 42704)。 コメントは、SYSCAT.TABCONST カタログ・ビューのその制約を記述する行の REMARKS 列の値を置き換えます。

データベース・パーティション・グループ db-partition-group-name

データベース・パーティション・グループに対するコメントの追加または置き換えを指定します。 db-partition-group-name には、現行のサーバー上の既存の特定のデータベース・パーティション・グループを指定する必要があります (SQLSTATE 42704)。 コメントは、SYSCAT.DBPARTITIONGROUPS カタログ・ビューのうち、 そのデータベース・パーティション・グループを記述する行の REMARKS 列の値を置き換えます。

関数指定子 (function-designator)

関数に対するコメントの追加または置き換えを指定します。 詳しくは、 関数、メソッド、およびプロシージャーの指定子を参照してください。

SYSIBM、SYSIBMADM、SYSFUN、 または SYSPROC スキーマ (SQLSTATE 42832) の関数についてのコメントを付けることはできません。

コメントは、SYSCAT.ROUTINES カタログ・ビューのうち、その関数を記述する行の REMARKS 列の値を置き換えます。

FUNCTION MAPPING function-mapping-name

関数マッピングに対するコメントの追加または置き換えを指定します。 function-mapping-name には、現行のサーバー上の既存の関数マッピングを指定する必要があります (SQLSTATE 42704)。 コメントは、SYSCAT.FUNCMAPPINGS カタログ・ビューのうち、 その関数マッピングを記述する行の REMARKS 列の値を置き換えます。

ヒストグラム・テンプレート template-name

ヒストグラム・テンプレートに対するコメントを追加または置換することを指定します。 template-name は、現行のサーバーに存在するヒストグラム・テンプレートを識別するものでなければなりません (SQLSTATE 42704)。 コメントは、SYSCAT.HISTOGRAMTEMPLATES カタログ・ビューのうち、 そのヒストグラム・テンプレートを記述する行の REMARKS 列の値を置き換えます。

INDEX 指標名

索引または SPECIFICATION ONLY 指定の索引に対するコメントを追加または置換することを指定します。 index-name には、現行のサーバー上の既存の特定の索引、または SPECIFICATION ONLY 指定の索引のいずれかを指定する必要があります (SQLSTATE 42704)。 コメントは、SYSCAT.INDEXES カタログ・ビューのうち、 その索引または SPECIFICATION ONLY 指定の索引を記述する行の REMARKS 列の値を置き換えます。

MASK マスク名

コメントを適用する列マスクを指定します。 mask-name には、現行サーバーに存在する列マスクを指定する必要があります (SQLSTATE 42704)。 コメントは、SYSCAT.CONTROLS カタログ表の、マスクを記述する行の REMARKS 列に置かれます。

MODULE モジュール名

モジュールに対するコメントの追加または置き換えを指定します。 module-name は、現行サーバーに存在するモジュールを示していなければなりません (SQLSTATE 42704)。 指定する名前はモジュールの別名であってはなりません (SQLSTATE 560CT)。 コメントは、SYSCAT.MODULES カタログ・ビューのうち、そのモジュールを記述する行の REMARKS 列の値を置き換えます。

NICKNAME ニックネーム

ニックネームに対するコメントの追加または置き換えを指定します。 nickname には、現行のサーバー上の既存のニックネームを指定する必要があります (SQLSTATE 42704)。 コメントは、SYSCAT.TABLES カタログ・ビューのニックネームを記述する行の REMARKS 列の値を置き換えます。

PACKAGE パッケージ名

パッケージに対するコメントを追加または置換することを指定します。 パッケージ名は、現行サーバーに存在するパッケージを識別するものでなければなりません (SQLSTATE 42704)。 コメントは、SYSCAT.PACKAGES カタログ・ビューのうち、 そのパッケージを記述する行の REMARKS 列の値を置き換えます。

VERSION バージョン ID

コメントを付けるパッケージ・バージョンを指定します。 値が指定されない場合には、空ストリングがバージョンのデフォルトになります。 パッケージ名は同じですがバージョンが異なる複数のパッケージが存在する場合には、 COMMENT ステートメントの単一の呼び出しで、1 つのパッケージ・バージョンにのみ、コメントを付けることができます。 次のような場合は、バージョン ID を二重引用符で区切ってください。

• バージョン ID が VERSION(AUTO) プリコンパイラー・オプションによって生成された場合
• バージョン ID が数字で始まる場合
• バージョン ID が小文字であったり、大/小文字混合である場合

ステートメントをオペレーティング・システムのコマンド・プロンプトから呼び出す場合は、 各二重引用符の区切り文字の前に円記号を置いて、 オペレーティング・システムによって区切り文字が外されないようにします。

PERMISSION 許可名

コメントを適用する行権限を指定します。 permission-name は、現行サーバーに存在する行の許可を識別するものでなければなりません (SQLSTATE 42704、SQLCODE -204)。 コメントは、SYSCAT.CONTROLS カタログ表の、権限を記述する行の REMARKS 列に置かれます。

プロシージャー指定子 (procedure-designator)

プロシージャーに対するコメントを追加または置換することを指定します。 詳しくは、 関数、メソッド、およびプロシージャーの指定子を参照してください。

SYSIBM、SYSIBMADM、SYSFUN、 または SYSPROC スキーマ (SQLSTATE 42832) のプロシージャーについてのコメントを付けることはできません。

コメントは、SYSCAT.ROUTINES カタログ・ビューのうち、そのプロシージャーを記述する行の REMARKS 列の値を置き換えます。

ROLE ロール名

ロールに対するコメントの追加または置き換えを指定します。 role-name は現行のサーバーに存在するロールを識別するものでなければなりません (SQLSTATE 42704)。 コメントは、SYSCAT.ROLES カタログ・ビューのうち、そのロールを記述する行の REMARKS 列の値を置き換えます。

SCHEMA スキーマ名

スキーマに対するコメントを追加または置換することを指定します。 schema-name には、現行のサーバー上の既存のスキーマを指定する必要があります (SQLSTATE 42704)。 コメントは、SYSCAT.SCHEMATA カタログ・ビューのうち、そのスキーマを記述する行の REMARKS 列の値を置き換えます。

セキュリティー・ラベル sec-label-name

sec-label-name という名前のセキュリティー・ラベルに対するコメントを追加または置換することを指定します。 名前は、セキュリティー・ポリシーで修飾され、現行のサーバーの既存のセキュリティー・ラベルを示すものでなければなりません (SQLSTATE 42704)。 コメントは、SYSCAT.SECURITYLABELS カタログ・ビューのうち、 そのセキュリティー・ラベルを記述する行の REMARKS 列の値を置き換えます。

セキュリティー・ラベル・コンポーネント label-comp-name

label-comp-name という名前のセキュリティー・ラベル・コンポーネントに対するコメントを追加または置換することを指定します。 label-comp-name には、現行のサーバー上の既存のセキュリティー・ラベル・コンポーネントを指定する必要があります (SQLSTATE 42704)。 コメントは、SYSCAT.SECURITYLABELCOMPONENTS カタログ・ビューのうち、 そのセキュリティー・ラベル・コンポーネントを記述する行の REMARKS 列の値を置き換えます。

セキュリティー・ポリシー label-pol-name

label-pol-name という名前のセキュリティー・ポリシーに対するコメントを追加または置換することを指定します。 label-pol-name には、現行のサーバー上の既存のセキュリティー・ポリシーを指定する必要があります (SQLSTATE 42704)。 コメントは、SYSCAT.SECURITYPOLICIES カタログ・ビューのうち、 そのセキュリティー・ポリシーを記述する行の REMARKS 列の値を置き換えます。

SEQUENCE シーケンス名

シーケンスに対するコメントの追加または置き換えを指定します。 sequence-name は、現行サーバーに存在するシーケンスを示していなければなりません (SQLSTATE 42704)。 コメントは、SYSCAT.SEQUENCES カタログ・ビューのうち、そのシーケンスを記述する行の REMARKS 列の値を置き換えます。

サーバー server-name

データ・ソースに対するコメントの追加または置き換えを指定します。 server-name には、現行のサーバー上の既存のデータ・ソースを指定する必要があります (SQLSTATE 42704)。 コメントは、SYSCAT.SERVERS カタログ・ビューのうち、そのデータ・ソースを記述する行の REMARKS 列の値を置き換えます。

SERVER OPTION server-option-name FOR リモート・サーバー

サーバー・オプションに対するコメントの追加または置き換えを指定します。

サーバー・オプション名

サーバー・オプションを指定します。 このオプションは、現行のサーバーに存在するものでなければなりません (SQLSTATE 42704)。 コメントは、SYSCAT.SERVEROPTIONS カタログ・ビューのうち、 そのサーバー・オプションを記述する行の REMARKS 列の値を置き換えます。

リモート・サーバー

server-option が適用されるデータ・ソースを示します。

サーバー server-name

server-option が適用されるデータ・ソースを指定します。 server-name には、現行のサーバー上の既存のデータ・ソースを指定する必要があります。

TYPE サーバー・タイプ

Server-Option が適用されるデータ・ソースのタイプ ( Db2® for z/OS® または Oracleなど) を指定します。 server-type の指定は、大文字でも小文字でも構いません。 カタログには大文字で格納されます。

バージョン

server-name で指定したデータ・ソースのバージョンを指定します。

version

バージョン番号を指定します。 version は整数でなければなりません。

リリース

version で示されたバージョンのリリース番号を指定します。 release は整数でなければなりません。

修正

release で示されたリリースのモディフィケーション番号を指定します。 mod は整数でなければなりません。

バージョン・ストリング定数

バージョンの正式名称を指定します。 version-string-constant は単一値 (例えば、'8i') にすることができます。あるいは、version、release、そして該当する場合は mod を連結した値にすることができます (例えば、'8.0.3')。

WRAPPER ラッパー名

server-name で示されるデータ・ソースにアクセスするときに使用するラッパーを指定します。

サービス・クラス指定子

SERVICE CLASS サービス・クラス名

サービス・クラスに対するコメントの追加または置き換えを指定します。 service-class-name には、現行のサーバー上の既存のサービス・クラスを指定する必要があります (SQLSTATE 42704)。 サービス・サブクラスのコメントを追加または置換するためには、UNDER 節を使用して service-superclass-name が指定されている必要があります。 コメントは、SYSCAT.SERVICECLASSES カタログ・ビューのうち、 そのサービス・クラスを記述する行の REMARKS 列の値を置き換えます。

UNDER サービス・スーパークラス名

サービス・サブクラスのコメントを追加または置換するときの、サービス・サブクラスのサービス・スーパークラスを指定します。 service-superclass-name には、現行のサーバー上の既存のサービス・スーパークラスを指定する必要があります (SQLSTATE 42704)。

STOGROUP ストレージ・グループ名

ストレージ・グループに対するコメントの追加または置き換えを指定します。 storagegroup-name には、現行のサーバー上の既存の特定のストレージ・グループを指定する必要があります (SQLSTATE 42704)。 コメントは、SYSCAT.STOGROUPS カタログ・ビューのうち、 そのストレージ・グループを記述する行の REMARKS 列の値を置き換えます。

TABLE table-name または view-name

表またはビューに対するコメントを追加または置換することを指定します。 table-name または view-name は、 現行のサーバーの既存の表またはビュー (別名またはニックネームではない) を指定していなければならず (SQLSTATE 42704)、 宣言済み一時表を指定してはなりません (SQLSTATE 42995)。 コメントは、 SYSCAT.TABLES カタログ・ビューのうち、その表またはビューを記述する行の REMARKS 列の値を置き換えます。

TABLESPACE 表スペース名

表スペースに対するコメントを追加または置換することを指定します。 tablespace-name には、現行のサーバー上の既存の特定の表スペースを指定する必要があります (SQLSTATE 42704)。 コメントは、SYSCAT.TABLESPACES カタログ・ビューのうち、その表スペースを記述する行の REMARKS 列の値を置き換えます。

THRESHOLD しきい値名

しきい値に対するコメントの追加または置き換えを指定します。 threshold-name は現行のサーバーに存在するしきい値を識別するものでなければなりません (SQLSTATE 42704)。 コメントは、SYSCAT.THRESHOLDS カタログ・ビューのうち、そのしきい値を記述する行の REMARKS 列の値を置き換えます。

TRIGGER トリガー名

トリガーに対するコメントを追加または置換することを指定します。 trigger-name には、現行のサーバー上の既存の特定のトリガーを指定する必要があります (SQLSTATE 42704)。 コメントは、SYSCAT.TRIGGERS カタログ・ビューのうち、そのトリガーを記述する行の REMARKS 列の値を置き換えます。

トラステッド・コンテキスト context-name

トラステッド・コンテキストに対するコメントの追加または置き換えを指定します。 context-name は現行のサーバーに存在するトラステッド・コンテキストを識別するものでなければなりません (SQLSTATE 42704)。 コメントは、 SYSCAT.CONTEXTS トラステッド・コンテキストを記述する行のカタログ・ビュー。

TYPE タイプ名

ユーザー定義タイプのコメントを追加または置換することを指示します。 type-name には、現行のサーバー上の既存のユーザー定義タイプを指定する必要があります (SQLSTATE 42704)。 コメントは、SYSCAT.DATATYPES カタログ・ビューの REMARKS 列の値を、 ユーザー定義タイプを記述する行に置き換えます。

動的 SQL ステートメントでは、CURRENT SCHEMA 特殊レジスターが、 修飾子のないオブジェクト名の修飾子として使用されます。 静的 SQL ステートメントでは、QUALIFIER プリコンパイル/BIND オプションにより、 修飾子のないオブジェクト名の修飾子が暗黙指定されます。

TYPE MAPPING タイプ・マッピング名

ユーザー定義のデータ・タイプのマッピングに対するコメントを追加または置換することを指定します。 type-mapping-name には、現行のサーバー上の既存のデータ・タイプ・マッピングを指定する必要があります (SQLSTATE 42704)。 コメントは、SYSCAT.TYPEMAPPINGS カタログ・ビューのうち、 そのマッピングを記述する行の REMARKS 列の値を置き換えます。

USAGE LIST 使用法リスト名

使用量リストのコメントを追加または置換することを指定します。 usage-list-name には、現行サーバーに存在する使用量リストを指定する必要があります (SQLSTATE 42704)。 コメントは、SYSCAT.USAGELISTS カタログ・ビューのうち、その使用量リストを記述する行の REMARKS 列の値を置き換えます。

VARIABLE 変数名

グローバル変数に対するコメントの追加または置き換えを指定します。 variable-name は、現在のサーバーに存在するグローバル変数を指定するものでなければなりません (SQLSTATE 42704)。 コメントは、SYSCAT.VARIABLES カタログ・ビューの変数を記述する行の REMARKS 列の値を置き換えます。

WORK ACTION SET ワーク・アクション・セット名

作業アクション・セットに対するコメントの追加または置き換えを指定します。 work-action-set-name には、現行のサーバー上の既存の作業アクション・セットを指定する必要があります (SQLSTATE 42704)。 コメントは、SYSCAT.WORKACTIONSETS カタログ・ビューのうち、その作業アクション・セットを記述する行の REMARKS 列の値を置き換えます。

WORK CLASS SET ワーク・クラス・セット名

作業クラス・セットに対するコメントの追加または置き換えを指定します。 work-class-set-name には、現行のサーバー上に既に存在する作業クラス・セット名を指定する必要があります (SQLSTATE 42704)。 コメントは、SYSCAT.WORKCLASSSETS カタログ・ビューのうち、その作業クラス・セットを記述する行の REMARKS 列の値を置き換えます。

WORKLOAD ワークロード名

ワークロードに対するコメントを追加または置換することを指定します。 workload-name には、現行のサーバー上の既存のワークロードを指定する必要があります (SQLSTATE 42704)。 コメントは、 SYSCAT.WORKLOADS ワークロードを記述する行のカタログ・ビュー。

WRAPPER ラッパー名

ラッパーに対するコメントの追加または置き換えを指定します。 wrapper-name には、現行のサーバー上の既存のラッパーを指定する必要があります (SQLSTATE 42704)。 コメントは、SYSCAT.WRAPPERS カタログ・ビューのうち、 そのラッパーを記述する行の REMARKS 列の値を置き換えます。

XSROBJECT xsrobject-name

XSR オブジェクトに対するコメントの追加または置き換えを行うことを指定します。 xsrobject-name には、現行のサーバー上の既存の XSR オブジェクトを指定する必要があります (SQLSTATE 42704)。 コメントは、 SYSCAT.XSROBJECTS カタログ・ビュー。

IS ストリング定数

追加または置換するコメントを指定します。 string-constant (ストリング定数) には、 最大 254 バイトの任意の文字ストリング定数を指定できます。 (復帰文字 (CR) と改行文字 (LF) はそれぞれ 1 バイトとカウントされます。)

テーブル名|ビュー名 ({ 列名 IS ストリング定数 } ...)

この形式の COMMENT ステートメントを使用すると、 表またはビューの複数の列に対するコメントを指定することができます。 列名は修飾できず、各名前は指定する表またはビューの列を指定するものでなければなりません。 また、その表またはビューは現行のサーバーに存在していなければなりません。 table-name を宣言済み一時表にすることはできません (SQLSTATE 42995)。

作動不能ビューの列にコメントを作成することはできません (SQLSTATE 51024)。

注

• 代替構文: Db2 の以前のバージョンおよび他のデータベース製品との互換性のために、以下の代替の構文がサポートされています。 これらの代替は非標準であり、使用すべきではありません。
  • DATABASE PARTITION GROUP の代わりに NODEGROUP を指定できます。
  • TYPE type-name の代わりに DISTINCT TYPE type-name を指定できます。
  • TYPE type-name の代わりに DATA TYPE type-name を指定できます。
  • ALIAS の代わりに SYNONYM を指定できます。

例

• 例 1: EMPLOYEE 表に関するコメントを追加します。

     COMMENT ON TABLE EMPLOYEE
       IS 'Reflects first quarter reorganization'

• 例 2: EMP_VIEW1 ビューにコメントを追加します。

     COMMENT ON TABLE EMP_VIEW1
       IS 'View of the EMPLOYEE table without salary information'

• 例 3: EMPLOYEE 表の EDLEVEL 列に関するコメントを追加します。

     COMMENT ON COLUMN EMPLOYEE.EDLEVEL
       IS 'highest grade level passed in school'

• 例 4: EMPLOYEE 表の 2 つの異なる列にコメントを追加します。

     COMMENT ON EMPLOYEE
       (WORKDEPT IS 'see DEPARTMENT table for names',
       EDLEVEL IS 'highest grade level passed in school' )

• 例 5: Pellow は、自身の PELLOW スキーマに作成した CENTER 関数についてのコメントを付けます。 シグニチャーを使用して、コメントを付ける特定の関数を指定します。

     COMMENT ON FUNCTION CENTER (INT,FLOAT)
       IS 'Frank''s CENTER fctn, uses Chebychev method'

• 例 6: McBride は、PELLOW スキーマに作成した別の CENTER 関数にコメントを付けます。 特定の名前を使用して、コメントを付ける関数インスタンスを指定します。

     COMMENT ON SPECIFIC FUNCTION PELLOW.FOCUS92 IS
       'Louise''s most triumphant CENTER function, uses the 
            Brownian fuzzy-focus technique'

• 例 7: CHEM スキーマの関数 ATOMIC_WEIGHT にコメントを付けます。ここで、その名前の関数は 1 つしかないことが分かっています。

     COMMENT ON FUNCTION CHEM.ATOMIC_WEIGHT
       IS 'takes atomic nbr, gives atomic weight'

• 例 8: Eigler は、自身の EIGLER スキーマに作成した SEARCH プロシージャーについてのコメントを付けます。 シグニチャーを使用して、コメントを付ける特定のプロシージャーを指定します。

     COMMENT ON PROCEDURE SEARCH (CHAR,INT)
       IS 'Frank''s mass search and replace algorithm'

• 例 9: Macdonald は、EIGLER スキーマに作成した別の SEARCH 関数にコメントを付けます。 特定の名前を使用して、コメントを付けるプロシージャー・インスタンスを指定します。

     COMMENT ON SPECIFIC PROCEDURE EIGLER.DESTROY IS
       'Patrick''s mass search and destroy algorithm'

• 例 10: BIOLOGY スキーマのプロシージャー OSMOSIS にコメントを付けます。 このスキーマではこの名前のプロシージャーは 1 つしかないことが分かっています。

     COMMENT ON PROCEDURE BIOLOGY.OSMOSIS
       IS 'Calculations modelling osmosis'

• 例 11: INDEXSPEC という SPECIFICATION ONLY 指定の索引にコメントを付けます。

     COMMENT ON INDEX INDEXSPEC
       IS 'An index specification that indicates to the optimizer
       that the table referenced by nickname NICK1 has an index.'

• 例 12: デフォルト名が NET8 のラッパーにコメントを付けます。

     COMMENT ON WRAPPER NET8
       IS 'The wrapper for data sources associated with
           Oracle's Net8 client software.'

• 例 13: XML スキーマ HR.EMPLOYEE。

     COMMENT ON XSROBJECT HR.EMPLOYEE
       IS 'This is the base XML Schema for employee data.'

• 例 14: トラステッド・コンテキスト APPSERVER にコメントを作成します。

     COMMENT ON TRUSTED CONTEXT APPSERVER
       IS 'WebSphere Server'

• 例 15: 列マスク M1 にコメントを作成します。

     COMMENT ON MASK M1 IS 'Column mask for column EMP.SALARY'