組織リストのマニフェストリファレンス¶

プロバイダーとして、組織内リストを使ってデータ製品を組織内で安全に共有することができます。組織リストをプログラムで作成するには、YAML（https://yaml.org/spec/）で記述されたマニフェストが必要です。マニフェストの形式と個々のフィールドについては、ここで提供される情報を使用してください。

組織リストフィールドは、より大きなリストマニフェスト参照の一部です。組織リストフィールドをプログラムで追加または変更するには、 DESCRIBE LISTING および ALTER LISTING コマンドを使用して、リストマニフェストを検索および変更します。

組織リストマニフェスト¶

注釈

組織リストフィールドには、以下のいずれかを指定できます:

オプション - 組織リスト用のオプションです。
必須 - 組織リストには必須です。

組織リストマニフェストの一般的な形式は以下の通りです。

#
# Organization listing manifest
#
title: <Required listing title>
description: <listing description>
resources: <optional listing resources>
listing_terms: <optional listing terms>
data_dictionary: <optional data dictionary>
usage_examples: <optional usage examples>
data_attributes: <optional data attributes>
organization_profile: <Optional custom organization profile. Default "INTERNAL">
organization_targets:
  - # Required
support_contact: "<support email address>"
  - # Required
approver_contact: "<approver email address"
  - # Required when the organization_targets includes the organization_targets.discover field
request_approval_type:
  - # Optional. Can be REQUEST_AND_APPROVE_IN_SNOWFLAKE or REQUEST_AND_APPROVE_OUTSIDE_SNOWFLAKE.
locations:
  - # Optional list of regions to share into.
auto_fulfillment:
  - # Required when the target accounts are outside the provider's region, otherwise optional.

Copy

組織リストフィールド¶

組織リストマニフェストには、プレフィックスの後ろに続く必須フィールドとオプションのフィールドのセットが含まれます。

組織リストのプレフィックス¶

各組織リストマニフェストは、以下のフィールドで始まります。

title （文字列、必須、最大長110）: リストのタイトル。
description （文字列、オプション、最大長7500）: リストの説明。Markdown構文に対応しています。
resources （文字列、オプション）: リストのリソース。
listing_terms （子フィールドを持つ親、オプション）: リストの条件。
organization_profile （文字列、オプション）:オプションのカスタム組織プロファイル。指定しない場合はデフォルトの INTERNAL になっています。

`resources`¶

リストのリソースです。

オプション の resources フィールドには、以下の名前と値のペアが含まれます。

resources.documentation （文字列、必須）: リストのより詳細なドキュメントがある会社ウェブサイトのページへの完全修飾されたリンク。 http または https で始まる必要があります。
resources.media （文字列、オプション）: リストの非公開または公開YouTube動画への完全修飾リンク。

このフィールドに含めることができる情報のタイプの詳細については、詳細をご参照ください。

`resources` の例¶

. . .
resources:
  documentation: https://www.example.com/documentation/
  media: https://www.youtube.com/watch?v=MEFlT3dc3uc
. . .

Copy

`listing_terms`¶

リストのサービス利用規約を定義します。

オプション の listing_terms フィールドには、以下の名前と値のペアが含まれます。

listing_terms.type
- CUSTOM - CUSTOM のみがサポートされています。:codenowrap: listing_terms.type が指定されている場合は、 :codenowrap: listing_terms.link の値も指定する必要があります。
listing_terms.link: プロバイダーのリスト利用規約への完全修飾リンク。http または https で始まる必要があります。

詳細については、基本情報の表にある 利用規約 をご参照ください。

注釈

コンシューマーはリストの条件をプログラム的に受け入れることができます。詳細については、 Snowflakeサポートにお問い合わせください。

`listing_terms` の例¶

. . .
listing_terms:
  type: "CUSTOM"
  link: "http://example.com/my/listing/terms"
. . .

Copy

`data_dictionary`¶

オプション の data_dictionary フィールドは、リスト内のオブジェクトのデータプレビューと列タイプに関する詳細を確認できます。

data_dictionary フィールドには、最大5つのデータディクショナリエントリのリストが含まれています:

data_dictionary.featured （ data_dictionary を使用する場合は必須）: 「featured」でなければなりません。
data_dictionary.featured.database （data_dictionary を使用する場合は必須）: データベース名。
data_dictionary.featured.objects （data_dictionary を使用する場合は必須）: 以下の名前と値のペアのリスト:
- name （文字列、必須）: オブジェクト名。
- schema （文字列、必須）: データディクショナリに関連付けられたスキーマ。
- domain （必須）:
  
  次のいずれかを使用します。
  - DATABASE
  - SCHEMA
  - TABLE
  - VIEW
  - EXTERNAL_TABLE
  - MATERIALIZED_VIEW
  - DIRECTORY_TABLE
  - FUNCTION
  - COLUMN

詳細については、データ製品 - データディクショナリをご参照ください。

`data_dictionary` の例¶

. . .
data_dictionary:
 featured:
    database: "WEATHERDATA"
    objects:
       - name: "GLOBAL_WEATHER"
         schema: "PUBLIC"
         domain: "TABLE"
       - name: "GLOBAL_WEATHER_REPORT"
         schema: "PUBLIC"
         domain: "TABLE"
. . .

Copy

`usage_examples`¶

オプション の usage_examples フィールドには、以下の名前と値のペアのリストが含まれます。

usage.title （文字列、必須）: 使用例のタイトル。最大文字数は110文字です。
usage.description （文字列、オプション）: 使用例の説明。最大文字数は300文字です。
usage.query （文字列、必須）: 使用例に関連付けられたクエリ。最大文字数は30000文字です。

詳細については、サンプル SQL クエリをご参照ください。

`usage_examples` の例¶

. . .
usage_examples:
  - title: "Return all weather for the US"
    description: "Example of how to select weather information for the United States"
    query: "select * from weather where country_code='USA'";
. . .

Copy

`data_attributes`¶

データ属性は、コンシューマーにリスト情報を提供します。

オプション の data_attributes フィールドには、以下の名前と値のペアが含まれます。

data_attributes.refresh_rate （必須）

以下のいずれか: データ製品がSnowflakeで更新される頻度を指定します。
- CONTINUOUSLY
- HOURLY
- DAILY
- WEEKLY
- MONTHLY
- QUARTERLY
- ANNUALLY
- STATIC
data_attributes.geography （必須）:

データ製品の地理情報を指定します。
- granularity （文字列、必須）
  
  データセットの地理的範囲。
  
  次のいずれかを使用します。
  - LATITUDE_LONGITUDE
  - ADDRESS
  - POSTAL_CODE
  - CITY
  - COUNTY
  - STATE
  - COUNTRY
  - REGION_CONTINENT
- geo_option （文字列、必須）
  
  次のいずれかを使用します。
  - NOT_APPLICABLE
  - GLOBAL
  - COUNTRIES
- coverage （geo_option の選択に応じて必要）:
  - states （文字列のリスト）、有効な米国の州名のリストが含まれます。
  Or
  - continents （大陸のリスト）：
    
    以下のいずれか:
    
    ASIA
    
    EUROPE
    
    AFRICA
    
    NORTH AMERICA
    
    SOUTH AMERICA
    
    OCEANIA
    
    ANTARCTICA
- time （必須）:
  
  データ製品の期間を指定します。
  - granularity （必須）
  次のいずれかを使用します。
  - EVENT_BASED
  - HOURLY
  - DAILY
  - WEEKLY
  - MONTHLY
  - YEARLY
  - time_range （必須）、次の名前と値のペアを含まれます:
    
    time_frame （必須）
    
    次のいずれかを使用します。
    
    NEXT
    
    LAST
    
    BETWEEN
    
    unit （必須）
    
    次のいずれかを使用します。
    
    DAYS
    
    WEEKS
    
    MONTHS
    
    YEARS
    
    value （time_frame がNEXT／LASTの場合は必須、整数）。範囲は1～100です。
    
    start_time （ time_frame が BETWEEN の場合は必須、文字列の日付）。データ製品の開始時間。形式はMM-DD-YYYYです。
    
    end_time （time_frame が BETWEEN の場合は必須、文字列日付）、フォーマット MM-DD-YYYY。

データ製品の属性のその他の情報については、データ製品 - 属性をご参照ください。

`data_attributes` の例¶

. . .
data_attributes:
  refresh_rate: DAILY
  geography:
    granularity:
      - REGION_CONTINENT
    geo_option: COUNTRIES
    coverage:
      continents:
        ASIA:
          - INDIA
          - CHINA
        NORTH AMERICA:
          - UNITED STATES
          - CANADA
        EUROPE:
          - UNITED KINGDOM
    time:
      granularity: MONTHLY
      time_range:
        time_frame: LAST
        unit: MONTHS
        value: 6

Copy

`organization_targets`¶

必須 organization_targets フィールドは、リストを発見してアクセスできる人を定義します。

discovery、 access フィールドを含みます。いずれか一方を指定する必要があります。

discovery: access が指定されていない場合は必須ですが、それ以外の場合は **オプション**です。リストを発見できるユーザーを定義します。存在しない場合、どのアカウントもリストを発見することはできません。
access: discovery が指定されていない場合は必須ですが、それ以外の場合は **オプション**です。リストにアクセスできるユーザーを定義します。

discovery と access はいずれも同じ子フィールドを含んでいます。

次のいずれかを実行します。

all_internal_accounts : {true | false}: true の場合、すべての内部アカウントはリストを検索またはアクセスできます。false の場合、どのアカウントもリストを見つけたりアクセスしたりできません。
またはアカウントの配列。その後に指定したアカウント内のオプションの roles 配列が続きます。: - account: "<アカウント名>"

roles がある場合、リストを検索またはアクセスできるアカウント内のロールのリストを指定します。例:

. . . roles: [ 'role1','role2'] . . .

`organization_target` 例¶

以下の例では、 discovery と access フィールドのさまざまな組み合わせを示します。

組織内のすべての内部アカウントがリストを検出し、アクセスできます¶

. . .
organization_targets:
   discovery:
   - all_internal_accounts : true
   access:
   - all_internal_accounts : true
. . .

Copy

検出は可能ですが、アクセスできるのは限られたアカウントのみです¶

組織内のすべての内部アカウントはリストを検出できますが 金融 アカウントのみがリストにアクセスできます。

. . .
organization_targets:
   discovery:
   - all_internal_accounts : true
   access:
   - account: 'finance'
. . .

Copy

検出は可能ですが、アクセスできるのは一部のアカウントのみです¶

組織内のすべての内部アカウントはリストを検出できますが、 金融 または クレジット 内のアカウントのみがリストにアクセスできます。

. . .
organization_targets:
   discovery:
   - all_internal_accounts : true
   access:
   - account: 'finance'
   - account: 'credit'
. . .

Copy

検出は可能ですが、アクセスできるのは限られたアカウントと特定のロールのみです。¶

組織内のすべての内部アカウントはリストを検出できますが、 会計 または 借方 ロールを持つ 金融 アカウントのみがリストにアクセスできます。

. . .
organization_targets:
    discovery:
    - all_internal_accounts : true
    access:
    - account: 'finance'

      roles: [ 'accounting','debit']
. . .

Copy

`support_contact`¶

リストに関連するサポート情報のEメールアドレス。

discovery フィールドが指定されている場合は必須です。

. . .
support_contact: "support@exampledomain.com"
. . .

Copy

`approver_contact`¶

リスト承認者のEメールアドレスです。

discovery フィールドが指定されている場合は必須です。

. . .
  approver_contact: "approver@exampledomain.com"
. . .

Copy

`request_approval_type`¶

Define whether approval requests and approvals will happen inside or outside of Snowflake. Specify one of the following values:

NULL
REQUEST_AND_APPROVE_IN_SNOWFLAKE indicates access requests are submitted and approved within the Snowflake environment.
REQUEST_AND_APPROVE_OUTSIDE_SNOWFLAKE indicates the provider manages access request submissions and approvals independently.

The value for external listings is always NULL.

. . .
  request_approval_type: "REQUEST_AND_APPROVE_IN_SNOWFLAKE"
. . .

Copy

`locations`¶

リストを検出またはアクセスできる オプションの locations を指定します。

locations が指定されている場合、access_regions フィールドは必須であり、次のサブフィールドのいずれかが含まれている必要があります。

ALL - すべてのリージョンでリストを検出してアクセスすることができます。
PUBLIC をプレフィックスとする、リストを検出したりアクセスしたりできるリージョン名の配列です。例: access_regions: - name: PUBLIC.AWS_US_WEST_2
```
. . .
locations:
  access_regions:
  - name: "<names | ALL>"
. . .
```
Copy

リージョンの全一覧は SHOW REGIONS をご覧ください。

`auto_fulfillment`¶

Cross-Cloud Auto-fulfillment allows the data product associated with a listing to be automatically fulfilled to other Snowflake regions. The auto_fulfillment field defines how that auto-fulfillment takes place.

For more information on Cross-Cloud Auto-fulfillment, see リストの自動複製.

Auto-fulfillment is only required if you're sharing data to multiple regions. Do not enable it if you are sharing to accounts in the same region.

If you share data across multiple regions, the auto_fulfillment is:

Required if your data product is an application package.
Required if your data product is shared through a private listing.
Recommended if your data product is shared through a public listing.

Contains the following name value pairs:

auto_fulfillment.refresh_schedule
- <num> MINUTE - Number of minutes. Minimum 10 minutes, maximum 8 days, or 11520 minutes.
  
  If refresh_type is specified as SUB_DATABASE_WITH_REFERENCE_USAGE, do not include this setting. The refresh schedule for application packages must be defined at the account level and cannot specified at the listing level.
  
  For more information see アカウントレベルの更新間隔を設定する.
USING CRON <expression> - Defines the data product auto-fulfillment refresh schedule.

The syntax for USING CRON and REPLICATION SCHEDULE are the same. See パラメーター.
auto_fulfillment.refresh_type (required when using auto_fulfillment): Must be one of -
- SUB_DATABASE - database replication (object level) - recommended.
- SUB_DATABASE_WITH_REFERENCE_USAGE - application package.
- FULL_DATABASE - database replication (for the entire database)
auto_fulfillment.refresh_schedule_override (optional): Overrides the defined update refresh frequency for all listings that use the same database. When this value is FALSE, listing updates fail when multiple listings sharing the same database have different refresh frequencies.
- TRUE - enables the refresh frequency override.
- FALSE - (default) disables the refresh frequency override.

`auto_fulfillment.refresh_schedule` examples¶

The following example refreshes the data product associated with a listing every 10 minutes:

. . .
listing_terms: . . .
. . .
auto_fulfillment:
  refresh_schedule: 10 MINUTE
  refresh_type: SUB_DATABASE
. . .

Copy

The following example refreshes the data product associated with a listing on specific days and times in specific regions:

. . .
listing_terms: . . .
. . .
auto_fulfillment:
  refresh_schedule: USING CRON  0 17 * * MON-FRI Europe/London
  refresh_type: SUB_DATABASE
. . .

Copy

The following example enables the refresh frequency override for listings that share the same database but have different refresh frequencies:

. . .
listing_terms: . . .
. . .
auto_fulfillment:
  refresh_schedule: 10 MINUTE
  refresh_type: SUB_DATABASE
  refresh_schedule_override: TRUE
. . .

Copy

Snowflake Native App `auto_fulfillment` example¶

SUB_DATABASE_WITH_REFERENCE_USAGE can only be used with application packages and cannot be combined with auto_fulfillment.refresh_schedule.

. . .
listing_terms: . . .
. . .
auto_fulfillment:
  refresh_type: SUB_DATABASE_WITH_REFERENCE_USAGE
. . .

Copy

Object level `auto_fulfillment` example¶

. . .
listing_terms: . . .
. . .
auto_fulfillment:
  refresh_type: SUB_DATABASE
. . .

Copy

組織リストのマニフェストリファレンス¶

組織リストマニフェスト¶

組織リストフィールド¶

組織リストのプレフィックス¶

resources¶

resources の例¶

listing_terms¶

listing_terms の例¶

data_dictionary¶

data_dictionary の例¶

usage_examples¶

usage_examples の例¶

data_attributes¶

data_attributes の例¶

organization_targets¶

organization_target 例¶

組織内のすべての内部アカウントがリストを検出し、アクセスできます¶

検出は可能ですが、アクセスできるのは限られたアカウントのみです¶

検出は可能ですが、アクセスできるのは一部のアカウントのみです¶

検出は可能ですが、アクセスできるのは限られたアカウントと特定のロールのみです。¶

support_contact¶

approver_contact¶

request_approval_type¶

locations¶

auto_fulfillment¶

auto_fulfillment.refresh_schedule examples¶

Snowflake Native App auto_fulfillment example¶

Object level auto_fulfillment example¶

`resources`¶

`resources` の例¶

`listing_terms`¶

`listing_terms` の例¶

`data_dictionary`¶

`data_dictionary` の例¶

`usage_examples`¶

`usage_examples` の例¶

`data_attributes`¶

`data_attributes` の例¶

`organization_targets`¶

`organization_target` 例¶

`support_contact`¶

`approver_contact`¶

`request_approval_type`¶

`locations`¶

`auto_fulfillment`¶

`auto_fulfillment.refresh_schedule` examples¶

Snowflake Native App `auto_fulfillment` example¶

Object level `auto_fulfillment` example¶