Référence au manifeste de listing d’organisation¶

Préfixe de listing d’organisations¶

Chaque manifeste du listing d’organisations commence par les champs suivants :

• title (Chaîne, obligatoire, longueur maximale 110) : titre de l’annonce.

• description (Chaîne, facultatif, longueur maximale 7500) : Description du listing. La syntaxe Markdown est prise en charge.

• resources (chaîne, facultatif) : Ressources du listing.

• listing_terms (champs parent et enfant, facultatif) : Conditions du listing.

• organization_profile (Chaîne, facultative) : e-mail. Profil d’organisation personnalisé facultatif. Si non spécifié, INTERNAL par défaut.

resources¶

Ressources pour le listing.

Le champ facultatif resources contient les paires nom-valeur suivantes :

• resources.documentation (chaîne, obligatoire) : lien complet vers une page de votre site Internet avec une documentation plus détaillée sur l’annonce. Doit commencer par http ou par https.

• resources.media (chaîne, facultative) : un lien complet vers une vidéo YouTube publique ou non répertoriée pour le listing.

Pour plus d’informations sur le type d’éléments que vous pouvez inclure dans ce champ, consultez Détails.

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

listing_terms¶

Définit les conditions de service du listing.

Le champ facultatif listing_terms contient les paires nom-valeur suivantes :

• listing_terms.type

  • CUSTOM : seul CUSTOM est pris en charge. Si listing_terms.type est spécifié, vous devez également spécifier une valeur pour listing_terms.link.

• listing_terms.link: Un lien pleinement qualifié vers les termes du listing du fournisseur, qui doit commencer par http ou https.

Pour plus d’informations, reportez-vous à la section Conditions de service dans le tableau dans Informations de base.

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

data_dictionary¶

Le champ facultatif data_dictionary fournit des informations sur l’avant-première des données et les types de colonnes pour les objets du listing.

Le champ data_dictionary contient une liste de cinq entrées de dictionnaire de données maximum :

• data_dictionary.featured (obligatoire lors de l’utilisation de data_dictionary) : doit être « featured ».

• data_dictionary.featured.database (exigence pour l’utilisation de data_dictionary) : Le nom de la base de données.

• data_dictionary.featured.objects (exigence pour l’utilisation de data_dictionary) : Une liste des paires nom-valeur suivantes :

  • name (chaîne, exigence) : Le nom de l’objet.

  • schema (chaîne, exigence) : Le schéma associé au dictionnaire de données.

  • domain (obligatoire) :

    Un des éléments suivants :

    • DATABASE

    • SCHEMA

    • TABLE

    • VIEW

    • EXTERNAL_TABLE

    • MATERIALIZED_VIEW

    • DIRECTORY_TABLE

    • FUNCTION

    • COLUMN

Pour plus d’informations, voir Produit de données : dictionnaire de données.

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

Le champ facultatif **** usage_examples contient une liste des paires nom-valeur suivantes :

• usage.title (Chaîne, exigence) : Le titre de l’exemple d’utilisation. La longueur maximale est de 110 caractères.

• usage.description (chaîne, facultatif) : Une description de l’exemple d’utilisation. La longueur maximale est de 300 caractères.

• usage.query (Chaîne, exigence) : La requête associée à l’exemple d’utilisation. La longueur maximale est de 30 000 caractères.

Pour plus d’informations, voir Exemple de requêtes 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'";
. . .

data_attributes¶

Les attributs de données fournissent aux consommateurs des informations sur les listings.

Le champ facultatif data_attributes contient les paires nom-valeur suivantes :

• data_attributes.refresh_rate (obligatoire)

  L’une des options suivantes : Spécifie la fréquence de mise à jour de votre produit de données dans Snowflake.

  • CONTINUOUSLY

  • HOURLY

  • DAILY

  • WEEKLY

  • MONTHLY

  • QUARTERLY

  • ANNUALLY

  • STATIC

• data_attributes.geography (obligatoire) :

  Spécifie les informations géographiques pour le produit de données.

  • granularity (chaîne, obligatoire)

    Couverture géographique de l’ensemble de données.

    Un des éléments suivants :

    • LATITUDE_LONGITUDE

    • ADDRESS

    • POSTAL_CODE

    • CITY

    • COUNTY

    • STATE

    • COUNTRY

    • REGION_CONTINENT

  • geo_option (chaîne, obligatoire)

    Un des éléments suivants :

    • NOT_APPLICABLE

    • GLOBAL

    • COUNTRIES

  • coverage (exigence basée sur la sélection de geo_option) :

    • states (liste d’états) contenant n’importe quelle liste de noms d’états américains valides.

    Or

    • continents (liste des continents) :

      L’un des éléments suivants :

      • ASIA

      • EUROPE

      • AFRICA

      • NORTH AMERICA

      • SOUTH AMERICA

      • OCEANIA

      • ANTARCTICA

  • time (obligatoire) :

    Spécifie la période pour le produit de données.

    • granularity (obligatoire)

    Un des éléments suivants :

    • EVENT_BASED

    • HOURLY

    • DAILY

    • WEEKLY

    • MONTHLY

    • YEARLY

    • time_range (obligatoire) contenant les paires nom/valeur suivantes :

      • time_frame (obligatoire)

        Un des éléments suivants :

        • NEXT

        • LAST

        • BETWEEN

      • unit (obligatoire)

        Un des éléments suivants :

        • DAYS

        • WEEKS

        • MONTHS

        • YEARS

      • value (exigence lorsque time_frame est NEXT/LAST, entier). La plage est comprise entre 1 et 100.

      • start_time (exigence lorsque time_frame est BETWEEN, date de la chaîne). L’heure de début du produit de données. Le format est le suivant : MM-DD-YYYY.

      • end_time (obligatoire lorsque time_frame est BETWEEN, date sous forme de chaîne), format MM-DD-YYYY.

Pour des informations supplémentaires sur les attributs des produits de données, consultez Produit de données - Attributs.

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

Le champ obligatoire organization_targets définit qui peut découvrir le listing et y accéder.

Contient les champs discovery et access, dont l’un doit être spécifié.

discovery

Obligatoire lorsque access n’est pas spécifié, mais facultatif sinon. Définit qui peut découvrir l’annonce. Si non spécifié, aucun compte ne peut découvrir l’annonce.

access

Obligatoire lorsque discovery n’est pas spécifié, mais facultatif sinon. Définit qui peut accéder à l’annonce.

discovery et access contiennent les mêmes champs enfants.

Deux possibilités :

all_internal_accounts : {true | false}

Lorsque la valeur est définie sur true, tous les comptes internes peuvent trouver l’annonce ou y accéder. Lorsque la valeur est définie sur false, aucun compte ne peut trouver l’annonce ni y accéder.

Soit un tableau de comptes, suivi du tableau optionnel roles dans les comptes spécifiés.

- account: "<account_name>"

Lorsque roles est présent, il spécifie une liste de rôles au sein du compte qui peuvent accéder au listing ou le découvrir. Par exemple :

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

Exemples organization_target¶

Les exemples suivants présentent diverses combinaisons des champs discovery et access.

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

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

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

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

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

support_contact¶

L’adresse électronique pour les informations d’assistance associées au listing.

Obligatoire lorsque le champ discovery est spécifié.

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

approver_contact¶

L’adresse électronique de l’approbateur du listing.

Obligatoire lorsque le champ discovery est spécifié.

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

Spécifie les locations optionnels qui peuvent découvrir ou accéder au listing.

Le champ access_regions est obligatoire lorsque locations est spécifié et doit inclure l’un des sous-champs suivants :

• ALL - Toutes les régions peuvent découvrir le listing ou y accéder.

• Un tableau de noms de régions préfixés par PUBLIC qui peuvent découvrir le listing ou y accéder. Par exemple access_regions : - name : PUBLIC.AWS_US_WEST_2.

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

  Copy

Pour une liste complète des régions, voir SHOW REGIONS.

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

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

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

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

Object level auto_fulfillment example¶

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