COMMENT (戻り形式) - Teradata Database - Teradata Vantage NewSQL Engine

目的

オブジェクトに属しているコメントがあれば、そのコメントを返します。

呼び出し

実行可能形式。

埋め込みSQLのみ。

構文

object_kind

以下のオブジェクトのいずれか1つ。

• COLUMN
• DATABASE
• FUNCTION
• MACRO
• PROCEDURE
• PROFILE
• ROLE
• TABLE
• TRIGGER
• USER
• VIEW

object_reference

以下のオブジェクト参照のいずれか1つ。

• 列名
• データベース名
• マクロ名
• プロシージャ名
• プロファイル名
• ロール名
• テーブル名
• トリガー名
• ユーザー名
• ユーザー定義関数名
• ビュー名

host_variable_name

コメントを配置するホスト変数の名前。

先行コロンを使用するかどうかは任意ですが、それは強く勧められています。

コロンの前後にブランクを入れるかどうかは任意です。

名前のルールは、クライアント プログラミング言語のルールに準拠します。

host_indicator_name

ホスト標識変数の名前。

ANSI準拠

COMMENTは、ANSI/ISO SQL:2011規格に対するTeradataの拡張機能です。

許可

なし。

データを返すCOMMENT

戻り形式のCOMMENTは、データを返します。

COMMENTの戻り形式のルール

• host_variable_nameのデータ型は、VARCHAR(255)でなければなりません。
• 指定のオブジェクトにコメントが存在しない場合は、host_indicator_nameはNULLを返します。
• COMMENT文は1つのデータ値(要するに、1つの列を含んだ1つの行)だけを返しますが、静的COMMENT文で選択カーソルを使用することもできます。そのカーソル用に、静的選択カーソルの場合と同じ手順を実行してください。
• 動的COMMENT文を実行する場合は、データが返されるので動的カーソルを使用する必要があります。その場合は、動的選択の場合と同じ手順を実行してください。
• COMMENTをカーソルまたは動的SQL文と併用する場合は、INTO句を省略しなければなりません。