COMMENT
COMMENT ステートメントは、種々のデータベース・オブジェクトのカタ ログ記述にコメントを追加したり、置換したりします。
呼び出し
このステートメントは、アプリケーション・プログラムに組み込むことも、 あるいは対話式に実行することもできます。 これは、動的に準備できる実行可能ステートメントです。
権限
表、ビュー、別名、列、タイプ、パッケージ、シーケンス、変数、または XSR オブジェクトに対してコメントを付けるには、ステートメントの権限 ID が保持する特権に、次のうち少なくとも 1 つを含める必要があります。
- ステートメント内の表、ビュー、別名、タイプ、パッケージ、シーケンス、変数、または XSR オブジェクトの場合
- その表、ビュー、別名、タイプ、パッケージ、シーケンス、変数、または XSR オブジェクトに対する ALTER 特権、および
- その表、ビュー、別名、索引、タイプ、パッケージ、シーケンス、変数、または XSR オブジェクトが入っているライブラリーに対する *EXECUTE システム権限
- 管理権限
制約またはトリガーに対してコメントを付けるには、ステートメントの権限 ID が保持する特権に、次のうち少なくともいずれか 1 つを含める必要があります。
- ステートメント内の制約またはトリガーのサブジェクト表に対して、
- 対象表に対する ALTER 特権
- 対象表が入っているライブラリーに対するシステム権限の *EXECUTE
- データベース管理者権限
索引に対してコメントを付けるには、ステートメントの権限 ID が保持する特権に、次のうち少なくとも 1 つを含める必要があります。
- ステートメントで識別される索引に対して、
- その索引についての *OBJALTER システム権限
- 索引が入っているライブラリーに対する *EXECUTE システム権限
- 管理権限
関数に対してコメントを付けるには、ステートメントの権限 ID が保持する特権に、次のうち少なくともいずれか 1 つを含める必要があります。
- SYSFUNCS および SYSROUTINES カタログ・ビューと表の場合
- SYSROUTINES に対する UPDATE 特権
- SYSFUNCS に対する *OBJOPR システム権限、および
- QSYS2 ライブラリーに対する *EXECUTE システム権限
- 管理権限
プロシージャーに対してコメントを付けるには、ステートメントの権限 ID が保持する特権に、次のうち少なくともいずれか 1 つを含める必要があります。
- SYSPROCS および SYSROUTINES カタログ・ビューと表の場合:
- SYSROUTINES に対する UPDATE 特権
- SYSPROCS に対する *OBJOPR システム権限、および
- QSYS2 ライブラリーに対する *EXECUTE システム権限
- 管理権限
パラメーターに対してコメントを付けるには、ステートメントの権限 ID が保持する特権に、次のうち少なくともいずれか 1 つを含める必要があります。
- SYSPARMS カタログ表の場合
- その表に対する UPDATE 特権、および
- QSYS2 ライブラリーに対する *EXECUTE システム権限
- 管理権限
マスクまたは許可に対してコメントを付けるには、次が必要です。
- ステートメントの権限 ID には、 IBM® i のデータベース・セキュリティー管理者機能を実行する権限が付与されている必要があります。管理権限を参照してください。
シーケンスに対してコメントを付けるには、ステートメントの権限 ID が保持する特権に、次のうち少なくともいずれか 1 つを含める必要もあります。
- Change Data Area (CHGDTAARA)、CL コマンドに対する *USE 権限
- 管理権限
変数に対してコメントを付けるには、ステートメントの権限 ID が保持する特権に、次のうち少なくともいずれか 1 つを含める必要もあります。
- SYSVARIABLES カタログ表の場合
- その SYSVARIABLES に対する UPDATE 特権、および
- QSYS2 ライブラリーに対する *EXECUTE システム権限
- 管理権限
XSR オブジェクトに対してコメントを付けるには、ステートメントの権限 ID が保持する特権に、次のうち少なくともいずれか 1 つを含める必要もあります。
- XSROBJECTS カタログ表の場合
- その XSROBJECTS に対する UPDATE 特権、および
- QSYS2 ライブラリーに対する *EXECUTE システム権限
- 管理権限
SQL 特権に対応するシステム権限の説明については、 表またはビューへの権限を検査する際の対応するシステム権限、 ユーザー定義タイプへの権限を検査する際の対応するシステム権限、 シーケンスへの権限を検査する際の対応するシステム権限、 変数への権限を検査する際の対応するシステム権限、 パッケージへの権限を検査する際の対応するシステム権限、 および XSR オブジェクトへの権限を検査する際の対応するシステム権限を参照してください。
構文
>>-COMMENT--ON--------------------------------------------------> >--+-+-ALIAS--alias-name---------------------------------------------------+--IS--string-constant-+->< | +-COLUMN--+-table-name.column-name-+----------------------------------+ | | | '-view-name.column-name--' | | | +-CONSTRAINT--constraint-name-----------------------------------------+ | | +-+-+-FUNCTION-+--function-name--+------------------------------+-+---+ | | | | '-ROUTINE--' '-(--+--------------------+--)-' | | | | | | | .-,--------------. | | | | | | | | V | | | | | | | | '---parameter-type-+-' | | | | | '-SPECIFIC--+-FUNCTION-+--specific-name-------------------------' | | | | '-ROUTINE--' | | | +-INDEX--index-name---------------------------------------------------+ | | +-MASK--mask-name-----------------------------------------------------+ | | +-PACKAGE--package-name--+-------------------------+------------------+ | | | | .-VERSION-. | | | | | '-+---------+--version-id-' | | | +-PARAMETER--+-routine-name.parameter-name----------+-----------------+ | | | '-SPECIFIC--+-FUNCTION--+--特定名.パラメーター名-' | | | | +-PROCEDURE-+ | | | | '-ROUTINE---' | | | +-PERMISSION--permission-name-----------------------------------------+ | | +-+-+-PROCEDURE-+--procedure-name--+------------------------------+-+-+ | | | | '-ROUTINE---' '-(--+--------------------+--)-' | | | | | | | .-,--------------. | | | | | | | | V | | | | | | | | '---parameter-type-+-' | | | | | '-SPECIFIC--+-PROCEDURE-+--specific-name--------------------------' | | | | '-ROUTINE---' | | | +-SEQUENCE--sequence-name---------------------------------------------+ | | +-TABLE--+-table-name-+-----------------------------------------------+ | | | '-view-name--' | | | +-TRIGGER--trigger-name-----------------------------------------------+ | | +-TYPE--+-distinct-type-name-+----------------------------------------+ | | | '-array-type-name----' | | | +-VARIABLE--variable-name---------------------------------------------+ | | '-XSROBJECT--xsrobject-name-------------------------------------------' | +-multiple-column-list-------------------------------------------------------------------------+ '-multiple-parameter-list----------------------------------------------------------------------'
説明
- ALIAS alias-name
- コメントの適用対象である別名を識別します。この別名 は、現行サーバーに存在している別名を 示すものでなければなりません。
- COLUMN
- 列に対してコメントの追加、またはコメントの置き換えを行うことを指定しま
す。
- table-name.column-name または view-name.column-name
- コメントの追加、または置き換えを行う列を識別します。表名 またはビュー名 は、現行サーバーにある表またはビューを示すものでなければなりませんが、宣言済み一時表を示すものであってはなりません。列名 は、その表またはビューの列を識別するものでなければなりません。
- CONSTRAINT
-
制約に対してコメントの追加や置換を行うことを指定します。
- constraint-name
- コメントを適用する制約を識別します。 constraint-name は、現行サーバーに存在する制約を識別する必要があります。
- FUNCTION または SPECIFIC FUNCTION
- コメントの適用対象である関数を識別します。
この関数は現行サーバーに存在していなければならず、ユーザー定義関数である必要があります。
関数は、それぞれその名前、関数シグニチャー、あるいは特定名によって識別することができます。
- FUNCTION function-name
- 関数を名前によって識別します。 function-name は厳密に 1 つの関数を示す必要があります。この関数には、パラメーター をいくつでも定義することができます。指定されたスキーマまたは暗黙のスキーマの中に、指定された名前 の関数が複数ある場合、エラーが戻されます。
- FUNCTION function-name (parameter-type, ...)
- 関数を一意的に識別する関数シグニチャーによって、関数を識別します。
function-name
(parameter-type,...) は、指定された関数シグニチャーを持つ関数を識別しなければなりません。
指定されたパラメーターは、関数の作成時に指定された、
対応する位置にあるデータ・タイプと一致していなければなりません。
コメントする関数インスタンスを識別する場合、
データ・タイプの数とデータ・タイプの論理連結が使用されます。
データ・タイプの同義語は、一致として扱われます。
デフォルトがあるパラメーターは、このシグニチャーに含まれていなければなりません。
function-name () を指定する場合、識別される関数にパラメーターを使用することはできません。
- function-name
- 関数の名前を識別します。
- (parameter-type, ...)
- 関数のパラメーターを識別します。
非修飾の特殊タイプ名を指定する場合、データベース・マネージャーはその特殊タイプのスキーマ名を解決するための SQL パスを検索します。
長さ属性、精度属性、あるいは位取り属性があるデータ・タイプの場合、以下のいずれかを使用します。
- 空の括弧は、データベース・マネージャーがデータ・タイプの一致の判別に際して属性を無視することを示します。例えば、DEC() は、DEC(7,2) のデータ・タイプで定義された関数のパラメーターに一致するものとみなされます。 ただし、FLOAT に空の括弧を指定することはできません。これは、そのパラメーター値が特定のデータ・タイプ (REAL または DOUBLE) を示しているからです。
- 長さ属性、精度属性、あるいは位取り属性に特定の値を指定した場合、 その値は、CREATE FUNCTION ステートメントの中で暗黙的または明示的に指定された値と正確に一致している必要があります。 データ・タイプが FLOAT の場合、 突き合わせはデータ・タイプ (REAL または DOUBLE) に基づいて行われるので、 精度は指定された値に厳密に一致している必要はありません。
- 長さ属性、精度属性、または位取り属性が明示的に指定されておらず、空の括弧も指定されていない場合、該当のデータ・タイプのデフォルト属性が暗黙指定されます。暗黙の長さは、CREATE FUNCTION ステートメントの中で暗黙的または明示的に指定さ れた値と正確に一致している必要があります。
FOR DATA 文節または CCSID 文節の指定はオプショナルです。 いずれの文節も指定しないと、データ・タイプが一致するかどうかを判定する場合に、データベース・マネージャーが属性を無視することを示します。 どちらか一方の文節を指定する場合は、CREATE FUNCTION ステートメントに 暗黙的または明示的に指定されている値と一致させる必要があります。
- AS LOCATOR
- 関数が、このパラメーターのロケーターを受け取るように定義されることを示します。 AS LOCATOR を指定する場合は、データ・タイプは LOB または XML、あるいは LOB または XML に基づく特殊タイプでなければなりません。 AS LOCATOR を指定した場合、FOR SBCS DATA または FOR MIXED DATA を指定してはなりません。
- SPECIFIC FUNCTION specific-name
- 関数を特定名によって識別します。 specific-name は、現行サーバーに存在する特定の関数を示している必要があります。
- INDEX index-name
- コメントが適用される索引を指定します。 この索引名 は、現行サーバーに存在している索引を示すものでなければなりません。
- MASK mask-name
- コメントを適用するマスクを指定します。 マスク名 は、現行サーバーに存在するマスクを示していなければ なりません。
- PACKAGE package-name
- コメントを付けるパッケージを識別します。
このパッケージ名 は、現行サーバーに存在してい
るパッケージを識別していなければなりません。1
- VERSION version-id
- バージョン ID は、作成時にパッケージに割り当てられたバージョン ID です。 バージョン ID を指定しない場合、バージョン ID として NULL ストリングが使用されます。
- PARAMETER
- パラメーターに対してコメントの追加や置換を行うことを指定
します。
- ルーチン名.パラメーター名
- コメントが適用されるパラメーターを識別します。 このパラメーターの指定対象には、プロシージャーや関数があります。 ルーチン名 では、現行サーバーに存在しているプロシージャーや関数を識別し、パラメーター名 では、そのプロシージャーや関数のパラメーターを識別する必要があります。
- 特定名.パラメーター名
- コメントが適用されるパラメーターを識別します。 このパラメーターの指定対象には、プロシージャーや関数があります。 特定名 では、現行サーバーに存在しているプロシージャーや関数を識別し、パラメーター名 では、そのプロシージャーや関数のパラメーターを識別する必要があります。
- PERMISSION permission-name
- コメントを適用する権限を指定します。 許可名 は、現行サーバーに存在する許可を 示していなければなりません。
- PROCEDURE または SPECIFIC PROCEDURE
- コメントが適用されるプロシージャーを識別します。
このプロシージャー名 は、現行サーバーに存在しているプロシージャーを識別していなければなりません。
- PROCEDURE procedure-name
- プロシージャーを名前によって識別します。 プロシージャー名 は、ただ 1 つのプロシージャーを識別していなければなりません。 このプロシージャーには、パラメーターをいくつでも定義することができます。 指定されたスキーマまたは暗黙のスキーマの中に、 指定された名前のプロシージャーが複数ある場合、エラーが戻されます。
- PROCEDURE procedure-name (parameter-type, ...)
- プロシージャーを一意的に識別するプロシージャー・シグニチャーによって、プロシージャーを識別します。
procedure-name (parameter-type,...) では、指定されたプロシージャー・シグニチャーを持つプロシージャーを識別する必要があります。
指定されたパラメーターは、プロシージャーの作成時に指定された、
対応する位置にあるデータ・タイプと一致していなければなりません。
コメントする対象のプロシージャー・インスタンスを識別するために、
データ・タイプの数とデータ・タイプの論理連結が使用されます。
データ・タイプの同義語は、一致として扱われます。
デフォルトがあるパラメーターは、このシグニチャーに含まれていなければなりません。
プロシージャー名 () を指定する場合、識別されるプロシージャー にパラメーターを使用することはできません。
- procedure-name
- プロシージャーの名前を識別します。
- (parameter-type, ...)
- プロシージャーのパラメーターを識別します。
非修飾の特殊タイプ名または配列タイプ名を指定する場合、データベース・マネージャーはその特殊タイプまたは配列タイプのスキーマ名を解決するための SQL パスを検索します。
長さ属性、精度属性、あるいは位取り属性があるデータ・タイプの場合、以下のいずれかを使用します。
- 空の括弧は、データベース・マネージャーがデータ・タイプの一致の判別に際して属性を無視することを示します。例えば、DEC() は、DEC(7,2) のデータ・タイプで定義されたプロシージャーのパラメーターに一致するものとみなされます。 ただし、FLOAT に空の括弧を指定することはできません。これは、そのパラメーター値が特定のデータ・タイプ (REAL または DOUBLE) を示しているからです。
- 長さ属性、精度属性、あるいは位取り属性に特定の値を指定する場合、その値は、 CREATE PROCEDURE ステートメントの中で暗黙的または明示的に指定された値と正確に一致している必要があります。 データ・タイプが FLOAT の場合、 突き合わせはデータ・タイプ (REAL または DOUBLE) に基づいて行われるので、 精度は指定された値に厳密に一致している必要はありません。
- 長さ属性、精度属性、または位取り属性が明示的に指定されておらず、空の括弧も指定されていない場合、該当のデータ・タイプのデフォルト属性が暗黙指定されます。暗黙の長さは、CREATE PROCEDURE ステートメントの中で暗黙的または明示的 に指定された値と正確に一致している必要があります。
FOR DATA 文節または CCSID 文節の指定はオプショナルです。 いずれの文節も指定しないと、データ・タイプが一致するかどうかを判定する場合に、データベース・マネージャーが属性を無視することを示します。 どちらか一方の文節を指定する場合は、CREATE PROCEDURE ステートメントに 暗黙的または明示的に指定されている値と一致させる必要があります。
- AS LOCATOR
- プロシージャーが、このパラメーターのロケーターを受け取るように定義されることを示します。 AS LOCATOR を指定する場合は、データ・タイプは LOB または XML、あるいは LOB または XML に基づく特殊タイプでなければなりません。 AS LOCATOR を指定した場合、FOR SBCS DATA または FOR MIXED DATA を指定してはなりません。
- SPECIFIC PROCEDURE specific-name
- プロシージャーを特定名によって識別します。 特定名 は、現行サーバーに存在してい る特定のプロシージャーを識別していなければなりません。
- SEQUENCE sequence-name
- コメントが適用されるシーケンスを識別します。シーケンス名 は、現行サーバーに存在するシーケンスを示すものでなければなりません。
- TABLE table-name または view-name
- コメントを付ける表またはビューを識別します。表名 またはビュー名 は、現行サーバーにある表またはビューを示すものでなければなりませんが、宣言済み一時表を示すものであってはなりません。
- TRIGGER trigger-name
- コメントが適用されるトリガーを識別します。トリガー名 は、現行サーバーに存在して いるトリガーを識別していなければなりません。
- TYPE distinct-type-name または array-type-name
- コメントを適用する特殊タイプまたは配列タイプを識別します。特殊タイプ名 または 配列タイプ名 は、現行サーバーに存在するタイプを示すものでなければなりません。
- VARIABLE variable-name
- コメントを適用する変数を識別します。この変数名 は、現行サーバーに存在している変数を識別していなければなりません。
- XSROBJECT xsrobject-name
- コメントを適用する XSR オブジェクトを識別します。このXSR オブジェクト名 は、現行サーバーに存在しているXSR オブジェクトを示すものでなければなりません。
- IS
- この後に、付加または置換するコメントを指定します。
- string-constant
- 2000 文字 (シーケンスの場合は 500 文字) 以内であれば、どんな文字ストリング定数でも構いません。
multiple-column-list
表またはビューの複数の列に対してコメントを行うには、その表またはビューを指定してから、以下の形式のリストを括弧で囲んで指定します。
(column-name IS string-constant,
column-name IS string-constant, ... )列名は修飾してはなりません。それぞれの名前は、指定した表またはビューの列を識別しなければならず、その表またはビューは、現行サーバーに存在していなければなりません。
multiple-parameter-list
プロシージャーや関数の複数のパラメーターに対してコメントを付けるには、プロシージャー名、関数名、または特定名を指定してから、次の形式でリストを括弧で囲んで指定します。
(parameter-name IS string-constant,
parameter-name IS string-constant, ... )パラメーター名は修飾することはできません。また、それぞれの名前では、指定されたプロシージャーや関数のパラメーターを識別し、しかも、そのプロシージャーや関数は現行サーバーに入れておく必要があります。
注
代替構文: 以下のキーワードは、旧リリースとの互換性を維持するためにサポートされている同義語です。 これらのキーワードは標準キーワードではないので、原則として使用しないようにしてください。
- PACKAGE の同義語として、キーワード PROGRAM を使用することができます。
- キーワード DATA TYPE または DISTINCT TYPE を TYPE の同義語として使用することができます。
例
例 1: 表 EMPLOYEE に関するコメントを挿入します。
COMMENT ON TABLE EMPLOYEE
IS 'Reflects first quarter 2000 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: DEPARTMENT 表内の 2 列に対してコメントを入力します。
COMMENT ON DEPARTMENT
(MGRNO IS 'EMPLOYEE NUMBER OF DEPARTMENT MANAGER',
ADMRDEPT IS 'DEPARTMENT NUMBER OF ADMINISTERING DEPARTMENT')例 5: パッケージ PAYROLL に関するコメントを挿入します。
COMMENT ON PACKAGE PAYROLL
IS 'This package is used for distributed payroll processing.'1 識別されたパッケージがバージョン ID を持っている場合、
コメントは 176 バイトに制限されます。