Manifest-Referenz für Organisations-Freigabeangebot¶

Präfix für das Organisations-Freigabeangebot¶

Jedes Manifest eines Organisations-Freigabeangebots beginnt mit den folgenden Feldern:

• title (String, erforderlich, max. 110 Zeichen): Titel des Freigabeangebots.

• description (Zeichenfolge, optional, maximale Länge 7.500): Beschreibung des Freigabeangebots. Die Markdown-Syntax wird unterstützt.

• resources (Zeichenfolge, optional): Ressourcen für das Freigabeangebot.

• listing_terms (übergeordnete Felder mit untergeordneten Feldern, optional): Bedingungen für das Freigabeangebot.

• organization_profile (Zeichenfolge, optional): Optionales benutzerdefiniertes Organisationsprofil. Der Standardwert ist „INTERNAL“, wenn nichts anderes angegeben ist.

resources¶

Ressourcen für das Freigabeangebot.

Das optionale Feld resources enthält die folgenden Name/Wert-Paare:

• resources.documentation (String, erforderlich): Ein vollqualifizierter Link zu einer Seite auf Ihrer Website, wo eine detailliertere Dokumentation zu Ihrem Angebot zu finden ist. Muss mit http oder https beginnen.

• resources.media (Zeichenfolge, optional): Ein vollqualifizierter Link zu einem nicht aufgelisteten oder öffentlichen YouTube-Video für das Freigabeangebot.

Weitere Informationen über die Art der Informationen, die Sie in diesem Feld angeben können, finden Sie unter Details zu Freigabeangeboten.

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

listing_terms¶

Legt die Nutzungsbedingungen für das Freigabeangebot fest.

Das optionale Feld listing_terms enthält die folgenden Name/Wert-Paare:

• listing_terms.type

  • CUSTOM - Nur CUSTOM wird unterstützt, Sie müssen einen Wert für listing_terms.link angeben.

• listing_terms.link: Ein vollständig qualifizierter Link zu den Angebotsbedingungen des Anbieters, der mit http oder https beginnen muss.

Weitere Informationen finden Sie unter Nutzungsbedingungen in der Tabelle unter Grundlegende Informationen.

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

data_dictionary¶

Das optionale Feld data_dictionary enthält Informationen zur Datenvorschau und zu den Spaltentypen für die Objekte im Freigabeangebot.

Das Feld data_dictionary enthält eine Liste von bis zu fünf Data Dictionary-Einträgen:

• data_dictionary.featured (erforderlich bei Verwendung von data_dictionary): muss „featured“ sein.

• data_dictionary.featured.database (erforderlich bei Verwendung von data_dictionary): Der Name der Datenbank.

• data_dictionary.featured.objects (erforderlich bei Verwendung von data_dictionary): Eine Liste mit den folgenden Name/Wert-Paaren:

  • name (Zeichenfolge, erforderlich): Der Name des Objekts.

  • schema (Zeichenfolge, erforderlich): Das mit dem Datenwörterbuch verbundene Schema.

  • domain (erforderlich):

    Eine der folgenden Berechtigungen:

    • DATABASE

    • SCHEMA

    • TABLE

    • VIEW

    • EXTERNAL_TABLE

    • MATERIALIZED_VIEW

    • DIRECTORY_TABLE

    • FUNCTION

    • COLUMN

Weitere Informationen finden Sie unter Datenprodukt - Datenwörterbuch.

data_dictionary-Beispiel¶

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

usage_examples¶

Das optionale Feld usage_examples enthält eine Liste der folgenden Name/Wert-Paare:

• usage.title (Zeichenfolge, erforderlich): Der Titel des Verwendungsbeispiels. Die maximale Länge beträgt 110 Zeichen.

• usage.description (Zeichenfolge, optional): Eine Beschreibung des Verwendungsbeispiels. Die maximale Länge beträgt 300 Zeichen.

• usage.query (Zeichenfolge, erforderlich): Die Abfrage, die mit dem Verwendungsbeispiel verbunden ist. Die maximale Länge beträgt 30.000 Zeichen.

Weitere Informationen finden Sie unter SQL-Beispielabfragen.

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

data_attributes¶

Datenattribute versorgen die Verbraucher mit Informationen zum Freigabeangebot.

Das optionale Feld data_attributes enthält die folgenden Name/Wert-Paare:

• data_attributes.refresh_rate (erforderlich)

  Eine der folgenden Möglichkeiten: Gibt an, wie oft Ihr Datenprodukt in Snowflake aktualisiert wird.

  • CONTINUOUSLY

  • HOURLY

  • DAILY

  • WEEKLY

  • MONTHLY

  • QUARTERLY

  • ANNUALLY

  • STATIC

• data_attributes.geography (erforderlich):

  Gibt geografische Informationen für das Datenprodukt an.

  • granularity (string, erforderlich)

    Geografische Abdeckung des Datensatzes.

    Eine der folgenden Berechtigungen:

    • LATITUDE_LONGITUDE

    • ADDRESS

    • POSTAL_CODE

    • CITY

    • COUNTY

    • STATE

    • COUNTRY

    • REGION_CONTINENT

  • geo_option (string, erforderlich)

    Eine der folgenden Berechtigungen:

    • NOT_APPLICABLE

    • GLOBAL

    • COUNTRIES

  • coverage (erforderlich aufgrund der Auswahl von geo_option):

    • states (String-Liste) – enthält eine beliebige Liste gültiger Namen von US-Bundesstaaten.

    Or

    • continents (String-Liste):

      Einer der folgenden Punkte:

      • ASIA

      • EUROPE

      • AFRICA

      • NORTH AMERICA

      • SOUTH AMERICA

      • OCEANIA

      • ANTARCTICA

  • time (erforderlich):

    Gibt den Zeitraum für das Datenprodukt an.

    • granularity (erforderlich)

    Eine der folgenden Berechtigungen:

    • EVENT_BASED

    • HOURLY

    • DAILY

    • WEEKLY

    • MONTHLY

    • YEARLY

    • time_range (erforderlich) enthält die folgenden Name/Wert-Paare:

      • time_frame (erforderlich)

        Eine der folgenden Berechtigungen:

        • NEXT

        • LAST

        • BETWEEN

      • unit (erforderlich)

        Eine der folgenden Berechtigungen:

        • DAYS

        • WEEKS

        • MONTHS

        • YEARS

      • value (erforderlich, wenn time_frame NEXT/LAST ist, Ganzzahl). Der Bereich reicht von 1 bis 100.

      • start_time (erforderlich, wenn time_frame BETWEEN ist, Zeichenfolgen-Datum). Die Startzeit für das Datenprodukt. Das Format ist MM-DD-YYYY.

      • end_time (erforderlich, wenn time_frame BETWEEN ist, String date), Format MM-DD-YYYY.

Weitere Informationen zu Datenproduktattributen finden Sie unter Datenprodukt – Attribute.

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

organization_targets¶

Das erforderliche Feld organization_targets definiert, wer das Freigabeangebot sehen und darauf zugreifen kann.

Enthält die Felder discovery und access, von denen eines angegeben werden muss.

discovery

Erforderlich, wenn access angegeben ist, ansonsten optional. Legt fest, wer das Freigabeangebot sehen kann. Wenn nicht vorhanden, können keine Konten das Freigabeangebot sehen.

access

Erforderlich, wenn discovery angegeben ist, ansonsten optional. Legt fest, wer auf das Freigabeangebot zugreifen kann.

Sowohl discovery als auch access enthalten die gleichen untergeordneten Felder.

Entweder:

all_accounts : {true | false}

Wenn true, können alle Konten das Freigabeangebot finden oder darauf zugreifen. Wenn faalse, können keine Konten das Freigabeangebot finden oder darauf zugreifen.

Oder ein Array von Konten, gefolgt von dem optionalen Array roles innerhalb der angegebenen Konten.

- account: "<Kontoname>"

Wenn roles vorhanden ist, wird eine Liste von Rollen innerhalb des Kontos angegeben, die auf das Freigabeangebot zugreifen oder es sehen können. Beispiel:

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

organization_target-Beispiele¶

Die folgenden Beispiele zeigen verschiedene Kombinationen der Felder discovery und access.

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

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

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

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

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

support_contact¶

Die E-Mail-Adresse für Support-Informationen, die mit dem Freigabeangebot verbunden sind.

Erforderlich, wenn das Feld : discovery angegeben wird.

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

approver_contact¶

Die E-Mail-Adresse des Genehmigers des Freigabeangebots.

Erforderlich, wenn das Feld : discovery angegeben wird.

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

Copy

locations¶

Gibt die optionalen locations an, die das Freigabeangebot sehen oder darauf zugreifen können.

Das Feld access_regions ist erforderlich, wenn :code: locations angegeben ist, und muss eines der folgenden Unterfelder enthalten:

• ALL - Alle Regionen können das Freigabeangebot sehen oder darauf zugreifen.

• Ein Array mit den Namen der Regionen, denen das Präfix PUBLIC vorangestellt ist und die das Freigabeangebot sehen oder darauf zugreifen können. Zum Beispiel access_regions: - name: PUBLIC.AWS_US_WEST_2.

  . . .
  locations:
    access_regions:
    - name: "<names | ALL>"
  . . .
  

  Copy

Eine vollständige Liste der Regionen finden Sie unter SHOW REGIONS.