COMMENT構文要素(コメント配置形式) - Advanced SQL Engine - Teradata Database

Teradata Vantage™ - SQLデータ定義言語 構文規則および例

Product
Advanced SQL Engine
Teradata Database
Release Number
17.10
Published
2021年7月
Language
日本語
Last Update
2021-09-23
dita:mapPath
ja-JP/spp1591731285373.ditamap
dita:ditavalPath
ja-JP/wrg1590696035526.ditaval
dita:id
B035-1144
Product Category
Software
Teradata Vantage
object_kind_1
必須のデータベース オブジェクトの種類の指定。
object_kind_1の有効な指定は、すべてがデータベース オブジェクトではありません。例えば、トリガーとビューは、データベース オブジェクトではなくアクションの定義です。
表わすオブジェクトの種類についてのコメントを書き込むには、次のデータベース オブジェクトの種類を指定する必要があります。
  • COLUMN
  • FUNCTION
  • GLOP SET
  • MACRO
  • MAP
  • METHOD
  • PROCEDURE
  • PROFILE
  • ROLE
  • TRIGGER
  • TYPE
  • VIEW
object_kind_2
データベース オブジェクトの種類の仕様(オプション)。
結合インデックスの場合、オブジェクトの種類は指定しないでください。
オブジェクトの種類のコメントを取得するために、次のデータベース オブジェクトの種類を指定できますが、キーワードは必須ではありません。
  • DATABASE
  • FILE

    ユーザーがインストールしたファイル(UIF)のFILEを指定しない場合は、データベース名を指定する必要があります。

  • TABLE
  • USER
database_name
現在のデータベースまたはユーザーに含まれていない場合、object_nameを含むデータベース。
user_name
現在のデータベースまたはユーザーに含まれていない場合、object_nameを含むユーザー。
comment
オブジェクトの説明。
文字列の最大の長さは、サポートされる任意のクライアントの文字セットで255文字です。
新しい文字列を指定することにより、既存の文字列を変更することができます。
文字列を指定しないと、すでに格納されている文字列が返されます。
object_name
コメントを追加したいオブジェクトの名前。次のオブジェクトにコメントを追加できます。
  • マクロ内のパラメータ、SQLプロシージャ、またはユーザー定義関数。
  • ユーザー基本テーブルまたはビューの列。
  • データベースまたはユーザーが所有する特定の関数、マクロ、ファイル、プロファイル、ロール、SQLプロシージャ、基本テーブル、トリガー、またはビューの名前。
  • データベースまたはユーザー。
  • UDT.

    database_name.udt_name.attribute_nameを指定することにより、STRUCTURED型UDTの特定の属性にコメントを追加することができます。

    attribute_nameの最大サイズは、128 Unicode文字です。

  • メソッド。

    メソッドを指定する場合は、その特定のメソッド名を使用する必要があります。

  • GLOPセット。

    オブジェクト名の前にオブジェクトの種類を示すキーワードがない場合、データベースは名前の修飾レベルからオブジェクトを判別しようとします。不明確な場合は、完全修飾名を使用します。

    x.y.zによって修飾の階層を示します。xはデータベース、ユーザーなどの最も高いレベルで、zはパラメータ、属性などの最も低いレベルです。

次のテーブルに、object_nameの階層を示します。
階層レベル 暗黙的に設定されるオブジェクト
x
  • データベース
  • ユーザー
x.y
  • 基本テーブル
  • エラー テーブル
  • GLOPセット
  • ハッシュ インデックス
  • 結合インデックス
  • マクロ
  • プロファイル
  • ロール
  • プロシージャ
  • トリガー
  • UDF
  • ビュー

    データベースxまたはユーザーx内にあります。

x.y.z
  • マクロのパラメータ
  • プロシージャ パラメータ
  • STRUCTURED型UDTの属性
  • テーブルの列
  • UDFパラメータ
  • ビューの列

    データベースxまたはユーザーx内の、実テーブル、エラー テーブル、GLOPセット、ハッシュ インデックス、結合インデックス、マクロ、プロファイル、ロール、プロシージャ、トリガー、UDF、またはビューy内にあります。