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

プロバイダーとして、組織内リストを使ってデータ製品を組織内で安全に共有することができます。組織リストをプログラムで作成するには、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
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 のみです。 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_accounts : {true | false}: true の場合、すべてのアカウントがリストの検索またはアクセスを行うことができます。false の場合、どのアカウントもリストの検索またはアクセスを行うことはできません。
またはアカウントの配列。その後に指定したアカウント内のオプションの roles 配列が続きます。: - account: "<アカウント名>"

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

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

`organization_target` 例¶

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

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

. . .
organization_targets:
   discovery:
   - all_accounts : true
   access:
   - all_accounts : true
. . .

Copy

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

組織内のすべてのアカウントがリストを検出できますが、アクセスできるのは 財務 アカウントのみです。

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

Copy

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

組織内のすべてのアカウントでリストを検出できますが、アクセスできるのは ファイナンス または クレジット のアカウントトのみです。

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

Copy

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

組織内のすべてのアカウントでリストを検出できますが、アクセスできるのは 会計 または デビッド のロールを持つ 財務 アカウントのみです。

. . .
organization_targets:
    discovery:
    - all_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

`locations`¶

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

access_regions フィールドは、:code: locations が指定されている場合、必須になります。また、以下のサブフィールドのいずれかを含ませる必要があります。

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

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

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

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

組織リストフィールド¶

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

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¶

locations¶

`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`¶

`locations`¶