SYSTEM$READ_YAML_FROM_SEMANTIC_VIEW¶
:doc:` セマンティックビュー</user-guide/views-semantic/overview>` に対して、YAML 形式の :doc:` セマンティックモデルの仕様 </user-guide/snowflake-cortex/cortex-analyst/semantic-model-spec>` を返します。
- こちらもご参照ください。
構文¶
SYSTEM$READ_YAML_FROM_SEMANTIC_VIEW( '<semantic_view_name>' ) 引数¶
'semantic_view_name'セマンティックビューの名前。
セマンティックビューが現在のスキーマやデータベースとは異なるスキーマまたはデータベースにある場合は、部分的または完全修飾名 を指定してください(例:
my_schema.my_semantic_viewまたはmy_db.my_schema.my_semantic_view)。
戻り値¶
セマンティックモデルの YAML 形式による 仕様を含む VARCHAR 値を返します。
アクセス制御の要件¶
この SQL コマンドの実行に使用される ロール には、 最低 1 つ の次の 権限 が必要です。
権限 | オブジェクト | メモ |
|---|---|---|
指定なし | セマンティックビュー |
スキーマ内のオブジェクトに対して操作を実行するには、親データベースとスキーマに対する USAGE 権限が必要です。スキーマに対する 任意の権限を付与されたロールは、そのロールがスキーマを解決できることに注意してください。たとえば、スキーマに対するCREATE権限を付与されたロールは、そのスキーマにオブジェクトを作成できますが、そのスキーマに対するUSAGE*も*付与されている必要はありません。
指定された権限のセットを使用してカスタムロールを作成する手順については、 カスタムロールの作成 をご参照ください。
セキュリティ保護可能なオブジェクト に対して SQL アクションを実行するためのロールと権限付与に関する一般的な情報については、 アクセス制御の概要 をご参照ください。
使用上の注意¶
データベース、スキーマ、またはビューの名前が 二重引用符で囲まれた識別子 (たとえば、名前にスペースが含まれている場合)、名前を二重引用符で囲む必要があります。例:
SELECT SYSTEM$READ_YAML_FROM_SEMANTIC_VIEW( '"my database"."my schema"."my semantic view"' ); 例¶
次の例は、データベース my_db とスキーマ my_schema にある tpch_analysis という名前のセマンティックビューの YAML 仕様を返します。
SELECT SYSTEM$READ_YAML_FROM_SEMANTIC_VIEW( 'my_db.my_schema.tpch_rev_analysis' ); +-------------------------------------------------------------+ | READ_YAML_FROM_SEMANTIC_VIEW | |-------------------------------------------------------------| | name: TPCH_REV_ANALYSIS | | description: Semantic view for revenue analysis | | tables: | | - name: CUSTOMERS | | description: Main table for customer data | | base_table: | | database: SNOWFLAKE_SAMPLE_DATA | | schema: TPCH_SF1 | | table: CUSTOMER | | primary_key: | | columns: | | - C_CUSTKEY | | dimensions: | | - name: CUSTOMER_NAME | | synonyms: | | - customer name | | description: Name of the customer | | expr: customers.c_name | | data_type: VARCHAR(25) | | - name: C_CUSTKEY | | expr: C_CUSTKEY | | data_type: VARCHAR(134217728) | | - name: LINE_ITEMS | | description: Line items in orders | | base_table: | | database: SNOWFLAKE_SAMPLE_DATA | | schema: TPCH_SF1 | | table: LINEITEM | | primary_key: | | columns: | | - L_ORDERKEY | | - L_LINENUMBER | | dimensions: | | - name: L_ORDERKEY | | expr: L_ORDERKEY | | data_type: VARCHAR(134217728) | | - name: L_LINENUMBER | | expr: L_LINENUMBER | | data_type: VARCHAR(134217728) | | facts: | | - name: DISCOUNTED_PRICE | | description: Extended price after discount | | expr: l_extendedprice * (1 - l_discount) | | data_type: "NUMBER(25,4)" | | - name: LINE_ITEM_ID | | expr: "CONCAT(l_orderkey, '-', l_linenumber)" | | data_type: VARCHAR(134217728) | | - name: ORDERS | | synonyms: | | - sales orders | | description: All orders table for the sales domain | | base_table: | | database: SNOWFLAKE_SAMPLE_DATA | | schema: TPCH_SF1 | | table: ORDERS | | primary_key: | | columns: | | - O_ORDERKEY | | dimensions: | | - name: ORDER_DATE | | description: Date when the order was placed | | expr: o_orderdate | | data_type: DATE | | - name: ORDER_YEAR | | description: Year when the order was placed | | expr: YEAR(o_orderdate) | | data_type: "NUMBER(4,0)" | | - name: O_ORDERKEY | | expr: O_ORDERKEY | | data_type: VARCHAR(134217728) | | - name: O_CUSTKEY | | expr: O_CUSTKEY | | data_type: VARCHAR(134217728) | | facts: | | - name: COUNT_LINE_ITEMS | | expr: COUNT(line_items.line_item_id) | | data_type: "NUMBER(18,0)" | | metrics: | | - name: AVERAGE_LINE_ITEMS_PER_ORDER | | description: Average number of line items per order | | expr: AVG(orders.count_line_items) | | - name: ORDER_AVERAGE_VALUE | | description: Average order value across all orders | | expr: AVG(orders.o_totalprice) | | relationships: | | - name: LINE_ITEM_TO_ORDERS | | left_table: LINE_ITEMS | | right_table: ORDERS | | relationship_columns: | | - left_column: L_ORDERKEY | | right_column: O_ORDERKEY | | - name: ORDERS_TO_CUSTOMERS | | left_table: ORDERS | | right_table: CUSTOMERS | | relationship_columns: | | - left_column: O_CUSTKEY | | right_column: C_CUSTKEY | | | +-------------------------------------------------------------+