DESCRIBE SEMANTIC VIEW¶

セマンティックビューを構成する論理テーブル、ディメンション、ファクト、およびメトリックのプロパティを説明します。

こちらもご覧ください:: CREATE SEMANTIC VIEW , ALTER SEMANTIC VIEW , DROP SEMANTIC VIEW , SHOW SEMANTIC VIEWS , SHOW SEMANTIC DIMENSIONS , SHOW SEMANTIC DIMENSIONS FOR METRIC , SHOW SEMANTIC FACTS , SHOW SEMANTIC METRICS

構文¶

{ DESCRIBE | DESC } SEMANTIC VIEW <name>

パラメーター¶

name

説明するセマンティックビューの識別子を指定します。

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

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

出力¶

コマンド出力は、論理テーブル、関係、ファクト、ディメンション、メトリック、およびセマンティックビュー自体のプロパティとメタデータを提供します。

ビューの各行は、次のプロパティを表します。

論理テーブル
関係
ファクト
ディメンション
メトリック
セマンティックビュー自体

以下はコマンドの出力例です。

+--------------+------------------------------+---------------+--------------------------+----------------------------------------+
| object_kind  | object_name                  | parent_entity | property                 | property_value                         |
|--------------+------------------------------+---------------+--------------------------+----------------------------------------|
| NULL         | NULL                         | NULL          | COMMENT                  | Comment about the semantic view        |
| TABLE        | CUSTOMERS                    | NULL          | BASE_TABLE_DATABASE_NAME | SNOWFLAKE_SAMPLE_DATA                  |
| ...          | ...                          | ...           | ...                      | ...                                    |
| DIMENSION    | CUSTOMER_NAME                | CUSTOMERS     | TABLE                    | CUSTOMERS                              |
| ...          | ...                          | ...           | ...                      | ...                                    |
| RELATIONSHIP | LINE_ITEM_TO_ORDERS          | LINE_ITEMS    | TABLE                    | LINE_ITEMS                             |
| ...          | ...                          | ...           | ...                      | ...                                    |
| FACT         | DISCOUNTED_PRICE             | LINE_ITEMS    | TABLE                    | LINE_ITEMS                             |
| ...          | ...                          | ...           | ...                      | ...                                    |
| METRIC       | AVERAGE_LINE_ITEMS_PER_ORDER | ORDERS        | TABLE                    | ORDERS                                 |
| ...          | ...                          | ...           | ...                      | ...                                    |
+--------------+------------------------------+---------------+--------------------------+----------------------------------------+

上記のように、各行は、論理テーブル、ディメンション、関係、メトリック、またはファクトのプロパティを表します。例:

最初の行は、セマンティックビュー自体の comment プロパティの値です。
2行目は、 customers という論理テーブルの base_table_database_name プロパティの値です。

ビューには以下の列があります。


列	説明
`object_kind`	この行のプロパティを持つオブジェクトのタイプ。値は次のいずれかになります。 `TABLE` （ビューの論理テーブル） `RELATIONSHIP` `DIMENSION` `FACT` `METRIC` ``DERIVED_METRIC``（:ref:`派生メトリック<label-semantic_views_create_derived_metrics>`用） `CUSTOM_INSTRUCTIONS` （カスタム指示用） `NULL` （コメントなど、セマンティックビュー自体に適用されるプロパティ）。
`object_name`	この行のプロパティを持つディメンション、ファクト、メトリック、論理テーブル、または関係の名前。セマンティックビュー自体のプロパティを表す行と、カスタム指示を表す行の場合、この列の値はNULLです。
`parent_entity`	ディメンション、ファクト、メトリック、または関係の親エンティティの名前。この列の値は、以下を表す行の NULL です。セマンティックビュー自体。論理テーブルのプロパティ。派生メトリックのプロパティ。カスタム手順のプロパティ。
`property`	論理テーブル、制約、関係、ディメンション、ファクト、メトリック、カスタム指示、またはセマンティックビューのプロパティ名。この列の値はオブジェクトのタイプによって異なります（`object_kind`）。 `object_kind` 列の値に基づくプロパティとその設定可能な値の詳細については、以下のセクションをご参照ください。 `TABLE` については、論理テーブルのプロパティをご参照ください。 `CONSTRAINT` の場合、制約のプロパティをご参照ください。 `RELATIONSHIP` については、関係のプロパティをご参照ください。 `FACT`、 `DIMENSION`、 `METRIC` については、ファクト、ディメンション、メトリクスのプロパティをご参照ください。 `CUSTOM_INSTRUCTION` の場合、カスタム指示のプロパティをご参照ください。 `NULL` については、セマンティックビューのプロパティをご参照ください。
`property_value`	論理テーブル、関係、ディメンション、ファクト、メトリック、カスタム指示、またはセマンティックビューのプロパティの値。

論理テーブルのプロパティ¶

object_kind 列に TABLE が含まれる場合、 property 列には以下の値を含めることができます。


プロパティ名	説明
`BASE_TABLE_DATABASE_NAME`	論理テーブルを含んでいるデータベース名。
`BASE_TABLE_SCHEMA_NAME`	論理テーブルを含んでいるスキーマ名。
`BASE_TABLE_NAME`	論理テーブルの名前。
`SYNONYMS`	論理テーブルの同義語を表している VARCHAR 値の配列。
`PRIMARY_KEY`	論理テーブルの主キーを構成する列の名前を指定している VARCHAR 値の配列。

制約のプロパティ¶

``object_kind``列に``CONSTRAINT``が含まれる場合、その行は:ref:`範囲結合<label-semantic_views_custom_range_joins>`に使用される制約を表します。``property``列には、次の値を含めることができます。


プロパティ名	説明
`CONSTRAINT_TYPE`	値は `DISTINCT_RANGE` です。
`START_COLUMN`	範囲の開始を表す列の名前を指定します。
`END_COLUMN`	範囲の終了を表す列の名前を指定します。

関係のプロパティ¶

object_kind 列に RELATIONSHIP が含まれる場合、 property 列には以下の値を含めることができます。


プロパティ名	説明
`TABLE`	関係内のいずれかの論理テーブルの名前。
`FOREIGN_KEY`	関係で使用されるその論理テーブルの列名。
`REF_TABLE`	関係内のもう一方の論理テーブルの名前。
`REF_KEY`	次の値のいずれかです。 :ref:`範囲結合<label-semantic_views_custom_range_joins>`を表す関係の場合、次のキーを持つオブジェクトのJSON形式の文字列を含む配列。 ``start_column``キーは、範囲の開始を表す列の名前を指定します。 ``end_column``キーは、範囲の終了を表す列の名前を指定します。 ``type``キーは``RANGE``です。 :ref:`ASOF結合<label-semantic_views_create_relationships_asof>`を表す関係の場合、次の要素を含む配列。最初のテーブルの列の名前。次のフィールドを持つJSONオブジェクト： `column`：2番目のテーブルの列の名前。 `type`: `ASOF`. 他のタイプの関係における、その関係の他の論理テーブルの列の名前。

ファクト、ディメンション、メトリクスのプロパティ¶

object_kind 列に FACT、 DIMENSION、 METRIC が含まれる場合、 property 列には以下の値を含めることができます。


プロパティ名	説明
`TABLE`	ディメンション、ファクト、またはメトリックの定義に使用される論理テーブルの名前。
`EXPRESSION`	ディメンション、ファクト、またはメトリックの SQL 式。
`DATA_TYPE`	評価される SQL 式の SQL データ型。
`ACCESS_MODIFIER`	プライベートファクトとメトリックに使用される `PRIVATE`。他のすべてに使用される `PUBLIC`。

注釈

派生メトリックの場合、 TABLE プロパティは存在しません。

さらに、行が Cortex Search Serviceを使用するディメンションを表している場合、 property 列には以下の値を含めることができます。


プロパティ名	説明
`CORTEX_SEARCH_SERVICE_COLUMN_NAME`	Cortex Search Serviceが検索を許可する列の名前。
`CORTEX_SEARCH_SERVICE_DATABASE_NAME`	Cortex Search Serviceを含むデータベースの名前。
`CORTEX_SEARCH_SERVICE_SCHEMA_NAME`	Cortex Search Serviceを含むスキーマの名前。
`CORTEX_SEARCH_SERVICE_NAME`	Cortex Search Serviceの名前。

カスタム指示のプロパティ¶

object_kind 列に CUSTOM_INSTRUCTIONS が含まれる場合、 property 列には以下の値を含めることができます。


プロパティ名	説明
`AI_QUESTION_CATEGORIZATION`	質問を分類する方法を説明する Cortex Analystのカスタム手順。
`AI_SQL_GENERATION`	SQLステートメントを生成する方法を説明する Cortex Analyst のカスタム手順。

セマンティックビューのプロパティ¶

object_kind 列が NULL の場合、 property 列には以下の値を含めることができます。


プロパティ名	説明
`COMMENT`	セマンティックビューについてのコメント。

アクセス制御の要件¶

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


権限	オブジェクト	注意
指定なし	セマンティックビュー

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

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

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

使用上の注意¶

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

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

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

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

例¶

次の例は、 tpch_rev_analysis という名前のセマンティックビューについて説明しています。

DESC SEMANTIC VIEW tpch_rev_analysis;

+--------------+------------------------------+---------------+--------------------------+----------------------------------------+
| object_kind  | object_name                  | parent_entity | property                 | property_value                         |
|--------------+------------------------------+---------------+--------------------------+----------------------------------------|
| NULL         | NULL                         | NULL          | COMMENT                  | Comment about the semantic view        |
| TABLE        | CUSTOMERS                    | NULL          | BASE_TABLE_DATABASE_NAME | SNOWFLAKE_SAMPLE_DATA                  |
| TABLE        | CUSTOMERS                    | NULL          | BASE_TABLE_SCHEMA_NAME   | TPCH_SF1                               |
| TABLE        | CUSTOMERS                    | NULL          | BASE_TABLE_NAME          | CUSTOMER                               |
| TABLE        | CUSTOMERS                    | NULL          | PRIMARY_KEY              | ["C_CUSTKEY"]                          |
| TABLE        | CUSTOMERS                    | NULL          | COMMENT                  | Main table for customer data           |
| DIMENSION    | CUSTOMER_NAME                | CUSTOMERS     | TABLE                    | CUSTOMERS                              |
| DIMENSION    | CUSTOMER_NAME                | CUSTOMERS     | EXPRESSION               | customers.c_name                       |
| DIMENSION    | CUSTOMER_NAME                | CUSTOMERS     | DATA_TYPE                | VARCHAR(25)                            |
| DIMENSION    | CUSTOMER_NAME                | CUSTOMERS     | SYNONYMS                 | ["customer name"]                      |
| DIMENSION    | CUSTOMER_NAME                | CUSTOMERS     | COMMENT                  | Name of the customer                   |
| TABLE        | LINE_ITEMS                   | NULL          | BASE_TABLE_DATABASE_NAME | SNOWFLAKE_SAMPLE_DATA                  |
| TABLE        | LINE_ITEMS                   | NULL          | BASE_TABLE_SCHEMA_NAME   | TPCH_SF1                               |
| TABLE        | LINE_ITEMS                   | NULL          | BASE_TABLE_NAME          | LINEITEM                               |
| TABLE        | LINE_ITEMS                   | NULL          | PRIMARY_KEY              | ["L_ORDERKEY","L_LINENUMBER"]          |
| TABLE        | LINE_ITEMS                   | NULL          | COMMENT                  | Line items in orders                   |
| RELATIONSHIP | LINE_ITEM_TO_ORDERS          | LINE_ITEMS    | TABLE                    | LINE_ITEMS                             |
| RELATIONSHIP | LINE_ITEM_TO_ORDERS          | LINE_ITEMS    | REF_TABLE                | ORDERS                                 |
| RELATIONSHIP | LINE_ITEM_TO_ORDERS          | LINE_ITEMS    | FOREIGN_KEY              | ["L_ORDERKEY"]                         |
| RELATIONSHIP | LINE_ITEM_TO_ORDERS          | LINE_ITEMS    | REF_KEY                  | ["O_ORDERKEY"]                         |
| FACT         | DISCOUNTED_PRICE             | LINE_ITEMS    | TABLE                    | LINE_ITEMS                             |
| FACT         | DISCOUNTED_PRICE             | LINE_ITEMS    | EXPRESSION               | l_extendedprice * (1 - l_discount)     |
| FACT         | DISCOUNTED_PRICE             | LINE_ITEMS    | DATA_TYPE                | NUMBER(25,4)                           |
| FACT         | DISCOUNTED_PRICE             | LINE_ITEMS    | COMMENT                  | Extended price after discount          |
| FACT         | LINE_ITEM_ID                 | LINE_ITEMS    | TABLE                    | LINE_ITEMS                             |
| FACT         | LINE_ITEM_ID                 | LINE_ITEMS    | EXPRESSION               | CONCAT(l_orderkey, '-', l_linenumber)  |
| FACT         | LINE_ITEM_ID                 | LINE_ITEMS    | DATA_TYPE                | VARCHAR(134217728)                     |
| TABLE        | ORDERS                       | NULL          | BASE_TABLE_DATABASE_NAME | SNOWFLAKE_SAMPLE_DATA                  |
| TABLE        | ORDERS                       | NULL          | BASE_TABLE_SCHEMA_NAME   | TPCH_SF1                               |
| TABLE        | ORDERS                       | NULL          | BASE_TABLE_NAME          | ORDERS                                 |
| TABLE        | ORDERS                       | NULL          | SYNONYMS                 | ["sales orders"]                       |
| TABLE        | ORDERS                       | NULL          | PRIMARY_KEY              | ["O_ORDERKEY"]                         |
| TABLE        | ORDERS                       | NULL          | COMMENT                  | All orders table for the sales domain  |
| RELATIONSHIP | ORDERS_TO_CUSTOMERS          | ORDERS        | TABLE                    | ORDERS                                 |
| RELATIONSHIP | ORDERS_TO_CUSTOMERS          | ORDERS        | REF_TABLE                | CUSTOMERS                              |
| RELATIONSHIP | ORDERS_TO_CUSTOMERS          | ORDERS        | FOREIGN_KEY              | ["O_CUSTKEY"]                          |
| RELATIONSHIP | ORDERS_TO_CUSTOMERS          | ORDERS        | REF_KEY                  | ["C_CUSTKEY"]                          |
| METRIC       | AVERAGE_LINE_ITEMS_PER_ORDER | ORDERS        | TABLE                    | ORDERS                                 |
| METRIC       | AVERAGE_LINE_ITEMS_PER_ORDER | ORDERS        | EXPRESSION               | AVG(orders.count_line_items)           |
| METRIC       | AVERAGE_LINE_ITEMS_PER_ORDER | ORDERS        | DATA_TYPE                | NUMBER(36,6)                           |
| METRIC       | AVERAGE_LINE_ITEMS_PER_ORDER | ORDERS        | COMMENT                  | Average number of line items per order |
| FACT         | COUNT_LINE_ITEMS             | ORDERS        | TABLE                    | ORDERS                                 |
| FACT         | COUNT_LINE_ITEMS             | ORDERS        | EXPRESSION               | COUNT(line_items.line_item_id)         |
| FACT         | COUNT_LINE_ITEMS             | ORDERS        | DATA_TYPE                | NUMBER(18,0)                           |
| METRIC       | ORDER_AVERAGE_VALUE          | ORDERS        | TABLE                    | ORDERS                                 |
| METRIC       | ORDER_AVERAGE_VALUE          | ORDERS        | EXPRESSION               | AVG(orders.o_totalprice)               |
| METRIC       | ORDER_AVERAGE_VALUE          | ORDERS        | DATA_TYPE                | NUMBER(30,8)                           |
| METRIC       | ORDER_AVERAGE_VALUE          | ORDERS        | COMMENT                  | Average order value across all orders  |
| DIMENSION    | ORDER_DATE                   | ORDERS        | TABLE                    | ORDERS                                 |
| DIMENSION    | ORDER_DATE                   | ORDERS        | EXPRESSION               | o_orderdate                            |
| DIMENSION    | ORDER_DATE                   | ORDERS        | DATA_TYPE                | DATE                                   |
| DIMENSION    | ORDER_DATE                   | ORDERS        | COMMENT                  | Date when the order was placed         |
| DIMENSION    | ORDER_YEAR                   | ORDERS        | TABLE                    | ORDERS                                 |
| DIMENSION    | ORDER_YEAR                   | ORDERS        | EXPRESSION               | YEAR(o_orderdate)                      |
| DIMENSION    | ORDER_YEAR                   | ORDERS        | DATA_TYPE                | NUMBER(4,0)                            |
| DIMENSION    | ORDER_YEAR                   | ORDERS        | COMMENT                  | Year when the order was placed         |
+--------------+------------------------------+---------------+--------------------------+----------------------------------------+