17.05 - COMMENT構文(コメント取得形式) - Advanced SQL Engine - Teradata Database

Teradata Vantage™ - SQLデータ操作言語

Product
Advanced SQL Engine
Teradata Database
Release Number
17.05
Release Date
2021年1月
Content Type
プログラミング リファレンス
Publication ID
B035-1146-175K-JPN
Language
日本語 (日本)
COMMENT [ON] [ object_kind_1 | object_kind_2 ]
  [ database_name. | user_name. ] object_name [;]

構文要素

object_kind_1
必須のデータベース オブジェクトの種類の指定。
object_kind_1の指定内容として有効なものすべてがデータベース オブジェクトというわけではありません。例えば、トリガーとビューは、データベース オブジェクトというよりアクションまたは概念的なグループの定義です。
それらが表わすオブジェクトの種類に関するコメントを取得するには、以下のデータベース オブジェクトの種類を必ず指定してください。
  • COLUMN
  • FUNCTION
  • GLOP SET
  • GROUP
  • MACRO
  • METHOD
  • PROCEDURE
  • PROFILE
  • ROLE
  • TRIGGER
  • TYPE
  • VIEW
object_kind_2
データベース オブジェクトの種類の指定(オプション)。
それらが表わすオブジェクトの種類に関するコメントを取得するために、以下のデータベース オブジェクトの種類を指定できますが、種類は任意です。
  • DATABASE
  • TABLE
  • USER
  • FILE
COMMENT文の意義として必要なのは、オブジェクトの種類を指定する場合に、取得するコメントを持つハッシュ インデックスまたは結合インデックスに対しては、キーワードTABLEを指定する必要があるということです。ただし、TABLEは必須のオブジェクトの種類の指定ではないため、指定するようリクエストはされません。
ファイルのコメントを取得する際にobject_kindを省略する場合は、dbname.uifnameのように、object_nameにファイルのパス全体を含める必要があります。
database_name
user_name
object_nameが含まれるデータベースまたはユーザーを指定します(現在のデータベースまたはユーザーに含まれていない場合)。
object_kindがGROUPの場合は、データベース名またはユーザー名を指定できません。
データベース オブジェクトの名前付けで使用するルールについては、<Teradata Vantage™ - SQLの基本、B035-1141>を参照してください。
object_name
以下を含む、コメントを取得するオブジェクトの名前。
  • マクロ、ストアド プロシージャ、またはユーザー定義関数のパラメータ。
  • ユーザーの基本テーブル、エラー テーブル、ハッシュ インデックス、結合インデックス、またはビューの列。
  • データベースまたはユーザーが含んでいる特定の関数、マクロ、プロファイル、ロール、ストアド プロシージャ、基本テーブル、エラー テーブル、ハッシュ インデックス、結合インデックス、トリガー、またはビュー名。
  • データベースまたはユーザー。
  • UDT。database_name.udt_name.attribute_nameを指定して、STRUCTURED型UDTの特定の属性に対して記述されたコメントを取得できます。
  • メソッド。固有のメソッド名を使用する必要があります。
  • GLOPセット。
オブジェクト名の前にオブジェクトの種類を示すキーワードがない場合、システムは、名前の修飾レベルからオブジェクトを判別しようとします。あいまいさを避けるために、完全修飾名を使用してください。
x.y.zを使用して修飾の階層を示します。xが最も高い(最も粗い)レベルで、zが最も低い(最も細かい)レベルです。
xの階層レベルを指定すると、指定されたオブジェクトは以下のいずれかであると暗黙に示されます。
  • データベース
  • ユーザー
x.yの階層レベルを指定すると、指定されたオブジェクトは以下のいずれかであると暗黙に示されます。
  • 基本テーブル
  • エラー テーブル
  • GLOPセット
  • ハッシュ インデックス
  • 結合インデックス
  • マクロ
  • プロファイル
  • ロール
  • ストアド プロシージャ
  • トリガー
  • ユーザー定義関数
  • データベースまたはユーザーx内のビュー。
x.y.zの階層レベルを指定すると、指定されたオブジェクトは以下のいずれかであると暗黙に示されます。
  • マクロのパラメータ
  • ストアド プロシージャ パラメータ
  • STRUCTURED型UDTの属性
  • テーブルの列
  • UDFパラメータ
  • GLOPセット、UDF、UDT、マクロ、ストアド プロシージャ、プロファイル、ロール、基本テーブル、トリガー、またはビューy内(それらもまた、データベースまたはユーザーxに含まれています)のビュー列。