DESCRIBE TYPE

:doc:`ユーザー定義型</sql-reference/data-types-user-defined>`について説明します。

DESCRIBE は DESC に短縮できます。

こちらもご参照ください。

CREATE TYPE、 ALTER TYPE、 SHOW TYPES、 DROP TYPE、 UNDROP TYPE

構文

{ DESC | DESCRIBE } TYPE <name>

パラメーター

name

説明するユーザー定義型の識別子を指定します。

識別子にスペースまたは特殊文字が含まれる場合は、文字列全体を二重引用符で囲む必要があります。二重引用符で囲まれた識別子も大文字と小文字が区別されます。

詳細については、 識別子の要件 をご参照ください。

出力

コマンド出力では、次の列にユーザー定義型プロパティとメタデータが提供されます。

列

説明

name

ユーザー定義型の名前。

type

ユーザー定義のベース型であるSnowflake型定義。

created_on

ユーザー定義型が作成された日時。

database_name

ユーザー定義型が保存されているデータベース。

schema_name

ユーザー定義型が保存されているスキーマ。

owner

ユーザー定義型を所有するロール（つまり、ユーザー定義型に対するOWNERSHIP権限を持つロール）の名前。

comment

型に設定されたコメント（該当する場合）。それ以外は``NULL``。

アクセス制御の要件

この操作の実行に使用される ロール には、少なくとも次の 権限 が必要です。

権限

オブジェクト

メモ

指定なし

ユーザー定義型

スキーマ内のオブジェクトを操作するには、親データベースの少なくとも1つの権限と、親スキーマの少なくとも1つの権限が必要です。

指定された権限のセットを使用してカスタムロールを作成する手順については、 カスタムロールの作成 をご参照ください。

セキュリティ保護可能なオブジェクト に対して SQL アクションを実行するためのロールと権限付与に関する一般的な情報については、 アクセス制御の概要 をご参照ください。

使用上の注意

  • このコマンドの出力を後処理するには、 パイプ演算子 （->>）または RESULT_SCAN 関数。どちらのコンストラクトも、出力を クエリできる結果セットとして扱います。

    たとえば、パイプ演算子または RESULT_SCAN 関数を使用して、 SHOW コマンド出力から特定の列を選択したり、行をフィルター処理したりできます。

    出力列を参照する場合は、列名に:ref:二重引用符<label-delimited_identifier>`で囲まれた識別子を使用します。たとえば、出力列 ``type` を選択するには、 SELECT "type" を指定します。

    SHOW コマンドの出力列名は小文字のため、二重引用符で囲まれた識別子を使用する必要があります。二重引用符により、 SELECT リストまたは WHERE 句内の列名が、スキャンされた SHOW コマンド出力内の列名と一致することが保証されます。

例

DESCRIBE TYPEコマンドを使用して、``age``ユーザー定義型に関する詳細を一覧表示します。

DESC TYPE age;

+------+-------------+-------------------------------+---------------+-------------+--------------+---------+
| name | type        | created_on                    | database_name | schema_name | owner        | comment |
|------+-------------+-------------------------------+---------------+-------------+--------------+---------|
| AGE  | NUMBER(3,0) | 2025-11-06 09:23:59.882 -0800 | MY_DB         | MY_SCHEMA   | MY_ROLE      | NULL    |
+------+-------------+-------------------------------+---------------+-------------+--------------+---------+