Analysespezifikation

Gibt alle Informationen an, die Analyseausführende benötigen, um eine Analyse auszuführen, einschließlich der zu verwendenden Vorlage, der Tabellen, die an die Vorlage übergeben werden sollen, und aller von einer Vorlage verwendeten Variablenwerte. Wenn Sie kein Freiform-SQL verwenden, um Daten abzufragen, verwenden alle Analyseausführenden, die eine Analyse ausführen möchten, diese Spezifikation, um die Vorlage und die Eingabedaten zu definieren.

Schema:

api_version: 2.0.0              # Required: Must be "2.0.0"
spec_type: analysis             # Required: Must be "analysis"
template: <template_id>         # Required: ID of the template to use
name: <analysis_name>           # Optional: Unique name (max 75 chars)
version: <version_string>       # Optional: Version identifier (max 20 chars)
description: <analysis_description>  # Optional: Description (max 1,000 chars)

template_configuration:         # Optional: Values used when running the template
  view_mappings:                # Optional: Mappings for shared data
    source_tables:              # Optional: Tables from data offerings. Populates the source_table array variable.
      - <source_table_name>     # One or more source table names from the TEMPLATE_VIEW_NAME column...
    <argument_name>: <view_name>  # Custom argument to template view name mapping
  local_view_mappings:          # Optional: Mappings for local data
    my_tables:                  # Optional: Tables from local data offerings. Populates the my_table array variable.
      - <my_table_name>         # One or more local table names...
    <argument_name>: <view_name>  # Custom argument to local template view name mapping
  arguments:                    # Optional: Template arguments as key-value pairs
    <argument_name>: <argument_value>  # One or more argument key-value pairs...
  activation:                   # Required for activation templates
    snowflake_collaborator: <alias>  # Collaborator alias for activation destination
    segment_name: <segment_name>     # Unique segment name for this activation
api_version

Die verwendete Version der Collaboration API. Sie müssen 2.0.0 sein.

spec_type

Bezeichner des Spezifikationstyps. Sie müssen analysis sein.

template: template_id

Die ID der Vorlage, die für diese Analyse verwendet werden soll. Dies muss die Vorlagen-ID sein, die beim Registrieren der Vorlage abgerufen wurde, nicht der Name der Vorlage.

name (Optional)

Ein eindeutiger, benutzerfreundlicher Name für diese Analyse. Muss den Regeln für Snowflake-Bezeichner folgen, mit maximal 75 Zeichen, und muss innerhalb Ihres Snowflake Data Clean Room-Kontos eindeutig sein.

version (Optional)

Ein Bezeichner der Version für diese Analysespezifikation (maximal 20 Zeichen). Muss den Regeln für Snowflake-Bezeichner folgen und innerhalb dieses Kontos für diesen Analysenamen eindeutig sein. Ein geeignetes Format ist YYYY_MM_DD_V#. Beispiel: 2025_10_22_V1.

description (Optional)

Eine allgemeine Beschreibung der Funktion dieser Analyse (maximal 1.000 Zeichen).

template_configuration (Optional)

Werte, die beim Ausführen der angegebenen Vorlage verwendet werden.

view_mappings (Optional)

Zuordnen von Argumentnamen zu Namen der Vorlagenansichten für freigegebene Datenangebote.

source_tables (Optional)

Liste der Ansichtsnamen, die zum Ausfüllen der source_table-Vorlagenvariablen verwendet werden. Verwenden Sie die in der Spezifikation des Datenangebots angegebenen Tabellenaliasse. Sie können eine Liste der verfügbaren Ansichten erhalten, indem Sie VIEW_DATA_OFFERINGS aufrufen. Verwenden Sie die Ansichtsnamen aus der Spalte TEMPLATE_VIEW_NAME. Das Format der einzelnen Einträge lautet collaborator_alias.data_offering_ID.dataset_alias.

argument_name: view_name

Kundenspezifische Zuordnung eines Argumentnamens zu einem Namen einer Vorlagenansicht (jeweils maximal 255 Zeichen).

local_view_mappings (Optional)

Zuordnung von Argumentnamen zu Namen lokaler Vorlagenansichten für private Datasets.

my_tables (Optional)

Liste der Tabellennamen, die zum Ausfüllen der my_table-Vorlagenvariablen verwendet werden. Dies ist nur für private Datasets verfügbar, die Sie durch den Aufruf von LINK_LOCAL_DATA_OFFERING verknüpft haben. Das Format der einzelnen Einträge lautet collaborator_alias.data_offering_ID.dataset_alias.

argument_name: view_name

Kundenspezifische Zuordnung eines Argumentnamens zu einem lokalen Namen einer Vorlagenansicht (jeweils maximal 255 Zeichen).

arguments (Optional)

Vorlagenargumente als Schlüssel-Wert-Paare. Argumentwerte können je nach Vorlagenanforderungen Zeichenfolgen, Zahlen, Boolesche Werte, Arrays oder Objekte sein.

activation (Erforderlich für Aktivierungsvorlagen)

Aktivierungsspezifische Konfiguration erforderlich, wenn Aktivierungsvorlagen ausgeführt werden.

snowflake_collaborator

Teilnehmenden-Alias für das Aktivierungsziel (maximal 25 Zeichen). Muss mit einem im Abschnitt collaborator_identifier_aliases der Zusammenarbeitsspezifikation definierten Alias übereinstimmen, und der Teilnehmende muss im Abschnitt activation_destinations aufgeführt sein.

segment_name

Eindeutiger Segmentname für diese Aktivierung (maximal 255 Zeichen). Wird verwendet, um die Ergebnisse der Aktivierung zu identifizieren und zu verfolgen. Muss den Regeln für Snowflake-Bezeichner folgen.