列表清单引用¶

列表前缀¶

每个列表清单都以下列字段开头：

• :code:`title`（字符串，必填，最大长度 110）：列表标题。

• subtitle （字符串，对于私密列表为可选，对于 Marketplace 列表为必填，最大长度 110）：列表副标题。

• :code:`description`（字符串，必填，最大长度 7500）：列表描述。支持 Markdown 语法。

• :code:`custom_contact`（字符串，可选）：电子邮件。必须是有效、格式正确的电子邮件地址。

• :code:`profile`（字符串，它对于私密列表为可选，但对于 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 时为必填项）：指向提供商列表条款的完全限定链接，必须以 :code:`http 或 https 开头。

有关更多信息，请参阅 基本信息 中表内的 服务条款。

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

targets¶

targets 字段对于 Marketplace 列表和私密列表均为必填。

包含一个列表，最多 100 个元素：

• targets.accounts （如果 targets.region 不存在，则为必填）：与之共享列表的账户列表。

  每个目标账户都必须采用 <OrgName>.<AccountName> 格式，其中：

  • 可使用 SELECT CURRENT_ORGANIZATION_NAME(); 获取 OrgName 。

  • 可以使用 SHOW ACCOUNTS 或使用 Snowsight 从 account_name 获取 AccountName。

或

• targets.regions （如果 targets.accounts 不存在，则为必填）：

  与之共享列表的区域的列表。

  每个目标区域的形式都必须是“region_groups_type.snowflake_region”。此外，还支持“ALL”以包括所有区域。

  例如“PUBLIC.AWS_US_EAST_1”。

  有关区域组类型和 Snowflake 区域的完整列表，请执行：

  SHOW REGIONS IN DATA EXCHANGE SNOWFLAKE_DATA_MARKETPLACE;
  

  Copy

For more information, see 业务需求.

. . .
targets:
   accounts: ["Org1.Account1", "Org2.Account2"]
. . .

. . .
targets:
   regions: ["PUBLIC.AWS_US_EAST_1", "PUBLIC.AZURE_WESTUS2"]
. . .

auto_fulfillment¶

Cross-Cloud Auto-Fulfillment 允许与列表相关联的数据产品自动履行到其他 Snowflake 区域。auto_fulfillment 字段定义了自动履行的发生方式。

有关 Cross-Cloud Auto-Fulfillment 的更多信息，请参阅 列表的自动履行

如果您要将数据共享到多个区域，则仅需要自动履行。如果您与同一区域的账户共享，请不要启用它。

如果您在多个区域共享数据，则 auto_fulfillment：

• 在数据产品是应用程序包时为必填。

• 在数据产品通过私密列表共享时为必填。

• 在数据产品通过公共列表共享时为必填。

包含以下名称值对：

• auto_fulfillment.refresh_schedule

  • <num> MINUTE – 分钟数。最短 10 分钟，最长 8 天（11520 分钟）。

    如果将 refresh_type 指定为 SUB_DATABASE_WITH_REFERENCE_USAGE，不要包括此设置。应用程序包的刷新计划必须在账户级别定义，不能在列表级别指定。

    有关更多信息，请参阅 设置账户级刷新间隔。

• USING CRON <expression> – 定义数据产品自动履行刷新计划。

  USING CRON 和 REPLICATION SCHEDULE 的语法是相同的。请参阅 参数。

• auto_fulfillment.refresh_type （使用 auto_fulfillment 时为必填）：必须是以下之一 –

  • SUB_DATABASE – 数据库复制（对象级别）– 推荐。

  • SUB_DATABASE_WITH_REFERENCE_USAGE – 应用程序包。

  • FULL_DATABASE – 完整数据库复制。

• auto_fulfillment.refresh_schedule_override`（可选）：覆盖所有使用相同数据库的列表的定义更新刷新频率。当这个值为 :code:`FALSE 时，当多个共享同一数据库的列表具有不同的刷新频率时，列表更新失败。

  • TRUE – 启用刷新频率覆盖。

  • FALSE –（默认）禁用刷新频率覆盖。

另请参阅 列表的自动履行。

. . .
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
. . .

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

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

business_needs¶

Listings are grouped by business needs for easy discovery. Business need is a describes how a specific listing meets a given business need. For more information, see 业务需求.

. . .
business_needs:
 - name: "Real World Data (RWD)"
   description: "Global weather data"
. . .

. . .
business_needs:
 - name: "Real World Data (RWD)"
   description: "Global weather data"
   type: STANDARD
. . .

. . .
business_needs:
 - name: "Machinery Maintenance"
   description: "Repair and maintenance data for machinery"
   type: CUSTOM
. . .

categories¶

categories 字段指定列表所属的类别或区域。类别对于私密列表为可选，但对于 Marketplace 列表为必填。

在 Snowflake Marketplace 中，使用类别按区域浏览列表，并帮助使用者找到您的数据。

categories 字段是一个列表，但只能包含下面集合中的一个条目：

• BUSINESS

• CONNECTORS

• DEMOGRAPHICS

• ECONOMY

• ENERGY

• ENVIRONMENT

• FINANCIAL

• GOVERNMENT

• HEALTH

• IDENTITY

• LEGAL

• LOCAL

• LOOKUP_TABLES

• MARKETING

• MEDIA

• SECURITY

• SPORTS

• TRANSPORTATION

• TRAVEL

• WEATHER

. . .
categories:
 - ECONOMY
. . .

compliance_badges¶

compliances_badges 字段用于表明某列表已经过第三方审计机构的审核，并且经认证符合特定标准或法规的要求。

配置合规性徽章时，最多可以指定三种类型。包括每个徽章的到期日期和随附的第三方认证文件。

以下字段用于配置合规性徽章：

• compliance_badges：用于为列表声明和配置合规性徽章。提供商可以在 compliance_badges 属性内声明多项合规性认证。

  • type：正在申请合规性认证。以下列表显示了可能的值：

    • SOC2

    • HIPAA

    • ISO27001

  • expiry：合规性认证到期的日期。

  • files：用于验证合规性认证的文件列表。

For more information, see 列表合规徽章.

. . .
compliance_badges:
  - type: SOC2
    expiry: 12-25-2026
    files:
      - soc2_compliance_verification.pdf
  - type: HIPAA
    expiry: 06-07-2026
    files:
      - hipaa_compliance_verification.pdf
. . .

data_attributes¶

数据属性可让使用者深入了解有关列表的信息，如刷新率和其他特征。

data_attributes 字段对于私密列表为可选，但对于 Marketplace 列表为必填。

For additional information on data product attributes, see 数据产品 – 属性.

包含以下名称值对：

• data_attributes.refresh_rate (required for data listings; optional for app listings)

  指定数据产品在 Snowflake 中的更新频率。

  其中之一：

  • CONTINUOUSLY

  • HOURLY

  • DAILY

  • WEEKLY

  • MONTHLY

  • QUARTERLY

  • ANNUALLY

  • STATIC

• :code:`data_attributes.geography`（必填），包含：

  指定数据产品覆盖的地理区域。

  • :code:`granularity`（字符串，必填）

    数据集的地理覆盖范围。

    其中之一：

    • LATITUDE_LONGITUDE

    • ADDRESS

    • POSTAL_CODE

    • CITY

    • COUNTY

    • STATE

    • COUNTRY

    • REGION_CONTINENT

  • :code:`geo_option`（字符串，必填）

    其中之一：

    • NOT_APPLICABLE

    • GLOBAL

    • COUNTRIES

  • coverage`（根据所选的 :code:`geo_option 来确定是否必填），包含：

    • states (list of states) containing any list of valid U.S. state names.

    Or

    • continents (list of continents):

      以下任意一项：

      • ASIA

      • EUROPE

      • AFRICA

      • NORTH AMERICA

      • SOUTH AMERICA

      • OCEANIA

      • ANTARCTICA

  • :code:`time`（必填），包含：

    指定数据产品覆盖的时间段。

    • :code:`granularity`（必填）

    其中之一：

    • EVENT_BASED

    • HOURLY

    • DAILY

    • WEEKLY

    • MONTHLY

    • YEARLY

    • :code:`time_range`（必填），包含以下名称/值对：

      • :code:`time_frame`（必填）

        其中之一：

        • NEXT

        • LAST

        • BETWEEN

      • :code:`unit`（必填）

        其中之一：

        • DAYS

        • WEEKS

        • MONTHS

        • YEARS

      • value`（当 :code:`time_frame 为 NEXT/LAST 时为必填，整型），范围 1-100。

      • start_time`（当 :code:`time_frame 为 BETWEEN 时为必填，字符串日期），格式为 MM-DD-YYYY。

      • end_time`（当 :code:`time_frame 为 BETWEEN 时为必填，字符串日期），格式为 MM-DD-YYYY。

. . .
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 字段可让使用者在将列表安装到自己的账户之前，深入了解列表的内容和结构。对于公开列表，为必填，对于所有其他列表类型，为选填。

data_dictionary 字段包含由最多五个数据字典条目组成的列表：

• data_dictionary.featured`（使用 :code:`data_dictionary 时为必填）：必须为“featured”。

• data_dictionary.featured.database`（使用 :code:`data_dictionary 时为必填）：数据库名称。

• data_dictionary.featured.objects`（使用 :code:`data_dictionary 时为必填）：名称值对的列表 –

  • :code:`name`（字符串，必填）：对象名称

  • :code:`schema`（字符串，必填）：架构

  • :code:`domain`（必填）：

    其中之一：

    • DATABASE

    • SCHEMA

    • TABLE

    • VIEW

    • EXTERNAL_TABLE

    • MATERIALIZED_VIEW

    • DIRECTORY_TABLE

    • FUNCTION

    • COLUMN

另请参阅 数据产品 – 数据字典。

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

data_preview¶

data_preview 字段允许提供商在从列表数据生成的数据预览样本中识别和隐藏个人身份信息 (PII)。PII 数据是指能够直接或间接识别个人身份的信息。对于公开列表，为必填，对于所有其他列表类型，为选填。

data_preview 字段包括以下条目：

• data_preview.has_pii`（在使用 :code:`data_preview 时需要）：表示 PII 是否包含在列表数据中。

  • TRUE - PII 包含在列表数据中。

  • FALSE - PII 不包括在列表数据中。

• data_preview.metadata_overrides`（当 :code:`data_preview.has_pii 是 TRUE 时建议使用）：确定 PII 列表数据的位置，以及该数据集内包含要隐藏或公开的 PII 的对象。

  • :code:`database`（字符串，必填）：数据库名称。

  • :code:`objects`（列表，必填）：在数据预览示例中隐藏或显示列的对象：

    • :code:`schema`（字符串，必填）：架构名称。

    • :code:`domain`（字符串，必填）：域名。

    • :code:`name`（字符串，必填）：对象名称

    • :code:`pii_columns`（列表，可选）：包含 PII 的列。

    • :code:`overridden_pii_columns`（列表，可选）：Snowflake 分类标识为包含 PII 的列，但应在与消费者共享的数据预览样本中可用。

      Snowflake 会定期对生成的数据预览运行分类。运行 SHOW 命令时，任何包含 PII 的列都会在:code:classified_pii_columns 中定义。

      被 Snowflake 识别为包含 PII 的列仅在数据预览样本中对列表使用者隐藏。如果列表提供商确定列被错误地标识为包含 PII，他们可以使用 overridden_pii_columns 指定希望包含在数据预览样本中的特定列。

. . .
data_preview:
 has_pii: TRUE
 metadata_overrides:
    database: WEATHERDATA
    objects:
       - schema: PUBLIC
         domain: TABLE
         name: GLOBAL_WEATHER
         pii_columns: [ADDRESS, PHONE]
         overridden_pii_columns: [FIRST_NAME, LAST_NAME]
. . .

draft_access_type¶

Specifies how access to a draft listing is controlled.

This field determines the access model for the listing while it's in draft status. This is especially relevant for compliance badging, as providers await approval of a listing's badge or badges by the Snowflake compliance team.

The allowed values for draft_access_type are:

• UNKNOWN

• FREE

• PAID

• LIMITED_TRIAL

• BY_REQUEST

external_targets¶

The external_targets field is used to share public or private V2 listings.

The access field is required when external_targets is specified, and it must include one of the following sub-fields:

• organization: When creating a private listing, specify the organization name and accounts that can access the listing.

• account: When creating a private listing, optionally specify the roles within an account that can access the listing.

• all_organizations: When creating a public listing, set this to true.

locations¶

Specifies the optional locations that can discover or access the listing.

The access_regions field is required when locations is specified, and it must include one of the following sub-fields:

• ALL: All regions can discover or access the listing.

• name: An array of regions of the form "region_groups_type.snowflake_region" that can discover or access the listing; for example, access_regions: - name: PUBLIC.AWS_US_WEST_2.

Available region groupings for VPS deployments include the following:

• AWS_US_EAST_1 ("US East (N. Virginia)")

• AWS_US_EAST_2 ("US East (Ohio)")

• AWS_US_WEST_2 ("US West (Oregon)")

• AWS_EU_WEST_1 ("EU (Ireland)")

• AWS_EU_WEST_2 ("EU (London)")

• AZURE_EASTUS2 ("East US 2 (Virginia)")

• AZURE_CENTRALUS ("Central US (Iowa)")

monetization_display_order¶

The optional monetization_display_order field specifies the order in which pricing plans are displayed to consumers in Snowflake Marketplace.

. . .
monetization_display_order:
  - offer_id_1
  - offer_id_2
  - offer_id_3
. . .

offers¶

The optional offers field includes a list of up to eight offers that are associated with the listing. The offers field includes the following name value pairs:

• name (String, required ): The user-defined name of the offer. The name must be formatted as all uppercase.

• type (String, required): Must be one of the following types:

  • FILE: Indicates that the offer is defined in a local YAML file.

  • URL: Indicates that the offer is defined in a remote URL.

• path (String, required): The path to the local or remote offers YAML.

. . .
offers:
  - name: PRICING_PLAN_1_DEFAULT_OFFER
    type: FILE
    path: offers/PRICING_PLAN_1_DEFAULT_OFFER.yaml
. . .

pricing_plans¶

The optional pricing_plans field includes a list of pricing plans that are associated with the listing. The pricing_plans field includes the following name value pairs:

• name (String, required): The user-defined name of the pricing plan. The name must be formatted as all uppercase.

• type (String, required): Must be one of the following types:

  • FILE: Indicates that the offer is defined in a local YAML file.

  • URL: Indicates that the offer is defined in a remote URL.

• path (String, required): The path to the local or remote pricing plan YAML.

. . .
pricing_plans:
  - name: PRICING_PLAN_1
    type: FILE
    path: pricingPlans/PRICING_PLAN_1.yaml
. . .

resources¶

资源包含有关列表的信息，包括文档和视频的链接。

resources 字段对于私密列表为可选，但对于 Marketplace 列表为必填。

包含以下名称值对：

• resources.documentation`（字符串，必填）：指向您网站上的页面的完全限定链接，其中包含有关列表的更详细文档。必须以 :code:`http 或 https 开头。

• resources.media (String, optional): A fully qualified link to an unlisted or public YouTube video for the listing.

有关更多信息，请参阅 详细信息。

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

trial_details¶

The optional trial_details field captures trial details associated with the listing and includes the following name value pairs:

• trial_type (String, required ): Specifies the type of the trial. Must be one of the following types:

  • TIME

  • USAGE

  • LIMITED

  • LIMITED_TIME

• trial_time_limit (Integer, optional): Specifies the number of days that the listing will be allowed as a trial, after which the consumer would need to request the full product. A null value indicates that the listing is an unlimited time trial. Either trial_time_limit or trial_usage_limit must be specified.

• trial_usage_limit (Integer, optional): Specifies the number of allowed free uses with this listing, after which the consumer would need to upgrade. Either trial_time_limit or trial_usage_limit must be specified.

• trial_usage_unit (Long, optional): Specifies the unit (such as queries or rows) for the trial usage. Depending on this usage unit, the usage count is incremented accordingly. This field can only be used with trial-usage_limit.

• description (String, optional): A string describing the trial details. The maximum length is 4,096 characters.

. . .
trial_details:
  trial_type: TIME
  trial_time_limit: 30
  description: "This is a 30-day free trial"
. . .

usage_examples¶

usage_examples 字段对于私密列表为可选，但对于 Marketplace 列表为必填。

Contains a list of the following name value pairs:

• usage.title (String, required): Usage example title; maximum length 110 characters.

• usage.description (String, optional): Associated description; maximum length 300 characters.

• usage.query (String, required): Query associated with the usage example; maximum length 30,000 characters.

有关更多信息，请参阅 示例 SQL 查询。

. . .
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'";
. . .

Complete YAML example for a V1 data share listing¶

V1 listings use targets to define the accounts that can access the listing.

title: "Covid data listing"
subtitle: "Listing about covid"
description: "Example covid manifest"
profile: "MyProfile"
listing_terms:
  type: "STANDARD"
targets:
  accounts: ["Org1.Account1", "Org2.Account2"]
auto_fulfillment:
  refresh_schedule: "120 MINUTE"
  refresh_type: "SUB_DATABASE"
business_needs:
  - name: "Life Sciences Commercialization"
    description: "COVID-19 Epidemiological Data"
usage_examples:
  - title: "Get total case count by country"
    description: "Calculates the total number of cases by country, aggregated over time."
    query: "SELECT  COUNTRY_REGION, SUM(CASES) AS Cases FROM ECDC_GLOBAL GROUP BY COUNTRY_REGION;"
data_attributes:
  refresh_rate: HOURLY
  geography:
    granularity:
      - ADDRESS
    geo_option: COUNTRIES
    coverage:
      continents:
        ASIA:
          - INDIA
          - CHINA
        NORTH AMERICA:
          - UNITED STATES
          - CANADA
        EUROPE:
          - UNITED KINGDOM
    time:
      granularity: MONTHLY
      time_range:
      time_frame: BETWEEN
      start_date: 12-24-2020
      end_date: 12-25-2021
data_preview:
  has_pii: TRUE
  metadata_overrides:
    database: WEATHERDATA
    objects:
      schema: PUBLIC
      domain: TABLE
      name: GLOBAL_WEATHER
      pii_columns: [ADDRESS, PHONE]
      overridden_pii_columns: [FIRST_NAME, LAST_NAME]
resources:
  documentation: https://www.example.com/documentation/
  media: https://www.youtube.com/watch?v=MEFlT3dc3uc
categories:
  - HEALTH
compliance_badges:
  - type: SOC2
    expiry: 12-25-2026
    files:
      - soc2_compliance_verification.pdf
  - type: HIPAA
    expiry: 06-07-2026
    files:
      - hipaa_compliance_verification.pdf
trial_details:
  trial_type: TIME
  trial_time_limit: 30
  description: "This is a 30-day free trial"

Complete YAML example for a V2 data share listing¶

V2 listings use external_targets to define the organizations and roles that can access the listing. V2 listings also allow users to define pricing plans and offers.

title: "Covid data listing"
subtitle: "Listing about covid"
description: "Example covid manifest"
profile: "MyProfile"
listing_terms:
  type: "STANDARD"
external_targets:
  access:
    - organization: OrgName2
      accounts: [acc1, acc2]
    - account: acc2
      roles: [role1, role2]
auto_fulfillment:
  refresh_schedule: "120 MINUTE"
  refresh_type: "SUB_DATABASE"
business_needs:
  - name: "Life Sciences Commercialization"
    description: "COVID-19 Epidemiological Data"
usage_examples:
  - title: "Get total case count by country"
    description: "Calculates the total number of cases by country, aggregated over time."
    query: "SELECT  COUNTRY_REGION, SUM(CASES) AS Cases FROM ECDC_GLOBAL GROUP BY COUNTRY_REGION;"
data_attributes:
  refresh_rate: HOURLY
  geography:
    granularity:
      - ADDRESS
    geo_option: COUNTRIES
    coverage:
      continents:
        ASIA:
          - INDIA
          - CHINA
        NORTH AMERICA:
          - UNITED STATES
          - CANADA
        EUROPE:
          - UNITED KINGDOM
    time:
      granularity: MONTHLY
      time_range:
      time_frame: BETWEEN
      start_date: 12-24-2020
      end_date: 12-25-2021
data_preview:
  has_pii: TRUE
  metadata_overrides:
    database: WEATHERDATA
    objects:
      schema: PUBLIC
      domain: TABLE
      name: GLOBAL_WEATHER
      pii_columns: [ADDRESS, PHONE]
      overridden_pii_columns: [FIRST_NAME, LAST_NAME]
locations:
  access_regions:
    - name: "PUBLIC.AWS_US_WEST_2"
monetization_display_order:
  - offer_id_1
pricing_plans:
  - name: PRICING_PLAN_1
    type: FILE
    path: pricingPlans/PRICING_PLAN_1.yaml
offers:
  - name: PRICING_PLAN_1_DEFAULT_OFFER
    type: FILE
    path: offers/PRICING_PLAN_1_DEFAULT_OFFER.yaml
resources:
  documentation: https://www.example.com/documentation/
  media: https://www.youtube.com/watch?v=MEFlT3dc3uc
categories:
  - HEALTH
compliance_badges:
  - type: SOC2
    expiry: 12-25-2026
    files:
      - soc2_compliance_verification.pdf
  - type: HIPAA
    expiry: 06-07-2026
    files:
      - hipaa_compliance_verification.pdf
draft_access_type: "BY_REQUEST"
trial_details:
  trial_type: TIME
  trial_time_limit: 30
  description: "This is a 30-day free trial"