リストマニフェスト参照¶
プログラムでSnowflakeリストを作成するには、YAML(https://yaml.org/spec/)で記述されたマニフェストが必要です。ここで提供される情報を使用して、マニフェストの形式と個々のセクションについて学習します。
- こちらもご参照ください。
CREATE LISTING、 ALTER LISTING、 DESCRIBE LISTING、 SHOW LISTINGS、 DROP LISTING
注釈
フィールドは以下のいずれかになります。
オプション - Marketplaceのリストまたはプライベートリストのいずれかで省略可。
必須 - Marketplaceのリストまたはプライベートリストのいずれかで必要。
有資格 - Marketplaceのリストまたはプライベートリストでは要件が異なり、オプションか必須かはリストタイプによって異なります。たとえば、プライベートリストでは オプション ですが、Marketplaceリストでは 必須 です。
リストのマニフェストの一般的な形式は次のとおりです。
#
# Listing prefix
#
title: <listing title>
subtitle: <Optional listing subtitle>
description: <listing description>
profile : <Optional name of the provider profile>
listing_terms:
- # Required listing terms that the consumer must sign
auto_fulfillment:
- # Required when the target accounts are outside the provider's region, otherwise optional.
data_dictionary:
- # Optional data dictionary
business_needs:
- # Optional <List>BusinessNeed elements, maximum 6.
usage_examples:
- # Optional <List>UsageExample elements, maximum 10.
targets:
- # Required <List> Consumer accounts to target with this private listing
以下のセクションでは、各リストのマニフェストフィールド、子フィールドの詳細を説明し、関連する例を示します。
リスト接頭辞¶
各リストのマニフェストは、以下のフィールドで始まります。
title
(文字列、必須、最大長110): リストのタイトル。subtitle
(文字列、プライベートの場合はオプション、Marketplaceリストの場合は必須、最大長110): リストのサブタイトル。description
(文字列、必須、最大長7500): リストの説明。custom_contact
(文字列、オプション): メール。有効で正しい形式のメールアドレスである必要があります。profile
(文字列、プライベートリストではオプション、Marketplaceでは必須): 承認されたプロバイダープロファイルの名前。
詳細については、 プロバイダーの基本情報 をご参照ください。
注釈
profile
の値は show profiles in data exchange SNOWFLAKE_DATA_MARKETPLACE;
を実行すると見つけることができます。
リスト接頭辞の例¶
title: Weather information
subtitle: Historical weather by postcode.
description: This listing includes historical weather data by post code.
profile: My provider profile
listing_terms
¶
必須 listing_terms
(必須)フィールドには、以下の名前と値のペアが含まれています。
listing_terms.type
(列挙型、必須): 以下のいずれかである必要があります。STANDARD
- Marketplace製品の標準契約をご参照ください。OFFLINE
- 規約は当事者によってオフラインで交渉されることを示します。CUSTOM
- 指定する場合は、listing_terms.link
の値を指定する必要があります。
listing_terms.link
(タイプが CUSTOM の場合は必須): プロバイダーのリスト用語への完全修飾リンク。http
またはhttps
で始まる必要があります。
詳しくは、 基本情報 内のテーブルにある 利用規約 をご参照ください。
注釈
コンシューマーはリストの条件をプログラム的に受け入れることができます。詳細については、 Snowflakeサポート にお問い合わせください。
listing_terms
の例¶
. . .
listing_terms:
type: "CUSTOM"
link: "http://example.com/my/listing/terms"
. . .
targets
¶
targets
フィールドは、Marketplaceとプライベートリストには必須です。
最大100要素のリストが含まれています:
targets.accounts
(targets.region
が存在しない場合は必須): リストを共有するアカウントのリスト。各対象アカウントは、次を満たす
<OrgName>.<AccountName>
形式でなければなりません。OrgName
は SELECT CURRENT_ORGANIZATION_NAME(); を使用して取得できる。AccountName
は、次を使用してaccount_nameから取得できます。SHOW ACCOUNTS を使用するか、 Snowsight を使用することで取得できる。
または
targets.regions
(targets.accounts
が存在しない場合は必須):リストを共有するリージョンのリスト。
各ターゲットリージョンは、"リージョン_グループ_タイプ.snowflake_リージョン" の形式でなければなりません。さらに、すべてのリージョンを含めるために、"ALL" がサポートされています。
例: "PUBLIC.AWS_US_EAST_1"。
リージョングループタイプおよびSnowflakeリージョンの完全なリストについては、以下を実行してください。
SHOW REGIONS IN DATA EXCHANGE SNOWFLAKE_DATA_MARKETPLACE;
詳細については、 コンシューマーアカウント(プライベートリストのみ) をご参照ください。
targets
例¶
このリストのターゲットアカウントのセットを定義します。
. . .
targets:
accounts: ["Org1.Account1", "Org2.Account2"]
. . .
このリストのターゲットリージョンのセットを定義します。
. . .
targets:
regions: ["PUBLIC.AWS_US_EAST_1", "PUBLIC.AZURE_WESTUS2"]
. . .
auto_fulfillment
¶
クロスクラウドの自動フルフィルメントは、リストに関連付けられたデータ製品を他のSnowflakeリージョンに自動的にフルフィルメントすることを可能にします。 auto_fulfillment
フィールドは、その自動履フルフィルメントがどのように行われるかを定義します。
クロスクラウドの自動フルフィルメントの詳細については、 クロスクラウド自動複製の構成 をご参照ください
同じリージョンのアカウントに共有する場合のみオプションです。それ以外の場合は、必須です。
auto_fulfillment
フィールドは:
データ製品がアプリケーションパッケージの場合は必要です。
ターゲットアカウントがプロバイダーのリージョン外にある場合、プライベートリストに必要です。
オプションですが、データ製品が共有の場合、Marketplaceリストにお勧めします。
以下の名前と値のペアが含まれています:
auto_fulfillment.refresh_schedule
<num> MINUTE
- 分の数最短10分、最長8日または11520分。refresh_type
がSUB_DATABASE_WITH_REFERENCE_USAGE
として指定されている場合は、この設定を含めないでください。アプリケーションパッケージのリフレッシュスケジュールはアカウントレベルで定義する必要があり、リストレベルでは指定できません。詳細については、 アカウントレベルの更新頻度の設定 をご参照ください。
USING CRON <expression>
- データ製品の自動フルフィルメント更新スケジュールを定義します。USING CRON
およびREPLICATION SCHEDULE
の構文は同じです。 CREATE REPLICATION GROUP パラメーター をご参照ください。
auto_fulfillment.refresh_type
(auto_fulfillment
を使用する場合は必須): 以下のいずれかである必要があります。SUB_DATABASE
- データベースのレプリケーション(オブジェクトレベル) - 推奨。SUB_DATABASE_WITH_REFERENCE_USAGE
- アプリケーションパッケージ。FULL_DATABASE
- データベースのレプリケーション(データベース全体)
auto_fulfillment.refresh_schedule_override
(オプション): 同じデータベースを使用するすべてのリストに対して定義された更新頻度を上書きします。この値がFALSE
の場合、同じデータベースを共有する複数のリストの更新頻度が異なると、リストの更新に失敗します。TRUE
- 更新頻度の上書きを有効にします。FALSE
- (デフォルト)更新頻度の上書きを無効にします。
クロスクラウド自動複製の構成 もご参照ください。
auto_fulfillment.refresh_schedule
例¶
次の例では、リストに関連付けられたデータ製品を10分ごとに更新します。
. . .
listing_terms: . . .
. . .
auto_fulfillment:
refresh_schedule: 10 MINUTE
refresh_type: SUB_DATABASE
. . .
次の例では、特定の地域の特定の日時にリストに関連付けられたデータ製品を更新します。
. . .
listing_terms: . . .
. . .
auto_fulfillment:
refresh_schedule: USING CRON 0 17 * * MON-FRI Europe/London
refresh_type: SUB_DATABASE
. . .
次の例では、同じデータベースを共有しており、更新頻度が異なるリストの更新頻度の上書きを有効にします。
. . .
listing_terms: . . .
. . .
auto_fulfillment:
refresh_schedule: 10 MINUTE
refresh_type: SUB_DATABASE
refresh_schedule_override: TRUE
. . .
Snowflake Native App auto_fulfillment
の例¶
SUB_DATABASE_WITH_REFERENCE_USAGE
はアプリケーションパッケージでのみ使用でき、 auto_fulfillment.refresh_schedule
と組み合わせることはできません。
. . .
listing_terms: . . .
. . .
auto_fulfillment:
refresh_type: SUB_DATABASE_WITH_REFERENCE_USAGE
. . .
オブジェクトレベル auto_fulfillment
の例¶
. . .
listing_terms: . . .
. . .
auto_fulfillment:
refresh_type: SUB_DATABASE
. . .
business_needs
¶
リストは、簡単に見つけられるようにビジネスニーズごとにグループ化されています。ビジネスニーズは、特定のリストがどのように指定したビジネスニーズを満たすかを説明します。詳細については、 ビジネスニーズ をご参照ください。
STANDARD ビジネスニーズ¶
business_needs.name
(business_needs
を使用する場合は必須):有効な値:
"360-Degree Customer View"
"Supply Chain"
"Personalize Customer Experiences"
"Inventory Management"
"Accelerating Advertising Revenue"
"Attribution Analysis"
"Contact Data Enrichment"
"Foot Traffic Analytics"
"Audience Segmentation"
"Sentiment Analysis"
"ESG Investment Analysis"
"Fundamental Analysis"
"Quantitative Analysis"
"Risk Analysis"
"Fraud Remediation"
"Customer Onboarding"
"Identity Resolution"
"Asset Valuation"
"Economic Impact Analysis"
"Demand Forecasting"
"Population Health Management"
"Real World Data (RWD)"
"Location Planning"
"Regulatory Reporting"
"Subscriber Acquisition and Retention"
"Life Sciences Commercialization"
"Patient 360"
"Blockchain Analysis"
"Customer Acquisition"
"Data Quality and Cleansing"
"Location Data Enrichment"
"Location Geocoding"
"Machine Learning"
"Market Analysis"
"Pricing Analysis"
"Audience Activation"
business_needs[].description
(business_needs
を使用する場合は必須): 関連するbusiness_needs.nameの説明、最大長1000。
business_needs[].type
: STANDARD (オプション)
CUSTOM ビジネスニーズ¶
カスタムのビジネスニーズには、ユーザー定義の name
、 description
、および値 CUSTOM を持つ必須の type
フィールドが含まれます。
business_needs.name
(business_needs
を使用する場合は必須): ユーザー定義名。
business_needs[].description
(business_needs
を使用する場合は必須): 関連するbusiness_needs.nameの説明、最大長1000。
business_needs[].type
: CUSTOM (カスタムビジネスニーズを定義する場合は必要)。
business_needs
例¶
オプションの type
なしの標準
. . .
business_needs:
- name: "Real World Data (RWD)"
description: "Global weather data"
. . .
オプションの type
付きの標準
. . .
business_needs:
- name: "Real World Data (RWD)"
description: "Global weather data"
type: STANDARD
. . .
必須の type
付きのカスタム
. . .
business_needs:
- name: "Machinery Maintenance"
description: "Repair and maintenance data for machinery"
type: CUSTOM
. . .
categories
¶
categories
フィールドは、リストが属するカテゴリまたはエリアを指定します。カテゴリはプライベートリストではオプションですが、Marketplaceリストでは必須です。
カテゴリは、エリア別にリストを閲覧し、コンシューマーがあなたのデータを見つけやすくするために Snowflake Marketplace で使用されます。
categories
フィールドはリストですが、以下のセットからエントリを1つのみ含むことができます。
BUSINESS
CONNECTORS
DEMOGRAPHICS
ECONOMY
ENERGY
ENVIRONMENT
FINANCIAL
GOVERNMENT
HEALTH
IDENTITY
LEGAL
LOCAL
LOOKUP_TABLES
MARKETING
MEDIA
SECURITY
SPORTS
TRANSPORTATION
TRAVEL
WEATHER
categories
の例¶
. . .
categories:
- ECONOMY
. . .
data_attributes
¶
データ属性は、リフレッシュレートやその他の特性など、リストについての情報に関する洞察をコンシューマーに提供します。
data_attributes
フィールドはプライベートリストではオプションですが、Marketplaceリストでは必須です。
データ製品の属性のその他の詳細については、 データ製品 - 属性 をご参照ください。
以下の名前と値のペアが含まれています:
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
data_dictionary
¶
data_dictionary
フィールドは、コンシューマーがアカウントにインストールする前に、リストのコンテンツと構造に関する洞察を提供します。プライベートリストではオプションですが、Marketplaceリストでは必須です。
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"
. . .
usage_examples
¶
usage_examples
フィールドはプライベートリストではオプションですが、Marketplaceリストでは必須です。
以下の名前と値のペアのリストが含まれています:
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'";
. . .
resources
¶
リソースには、ドキュメントや動画へのリンクなど、リストに関する情報が含まれています。
resources
フィールドはプライベートリストではオプションですが、Marketplaceリストでは必須です。
以下の名前と値のペアが含まれています:
resources.documentation
(文字列、必須): リストのより詳細なドキュメントがある会社ウェブサイトのページへの完全修飾されたリンク。http
またはhttps
で始まる必要があります。resources.media
(文字列、オプション)リストの非公開または公開 YouTube 動画への完全修飾されたリンク。
詳細については、 リストの詳細 をご参照ください。
resources
の例¶
. . .
resources:
documentation: https://www.example.com/documentation/
media: https://www.youtube.com/watch?v=MEFlT3dc3uc
. . .