MCP Tools Reference: dataform.googleapis.com

Tool: query_compilation_actions

Gibt die Aktionen für das Kompilierungsergebnis für ein bestimmtes Dataform-Kompilierungsergebnis zurück.

Der Parameterwert name muss das Format projects/{project_id}/locations/{location}/repositories/{repository}/compilationResults/{compilation_result} haben.

Im folgenden Beispiel wird gezeigt, wie Sie mit curl das MCP-Tool query_compilation_actions aufrufen.

Curl-Anfrage 
                  
curl --location 'https://dataform.googleapis.com/mcp' \
--header 'content-type: application/json' \
--header 'accept: application/json, text/event-stream' \
--data '{
  "method": "tools/call",
  "params": {
    "name": "query_compilation_actions",
    "arguments": {
      // provide these details according to the tool's MCP specification
    }
  },
  "jsonrpc": "2.0",
  "id": 1
}'

Eingabeschema

QueryCompilationResultActions-Anfragenachricht.

QueryCompilationResultActionsRequest

JSON-Darstellung 
{
  "name": string,
  "pageSize": integer,
  "pageToken": string,
  "filter": string
}
Felder
name

string

Erforderlich. Der Name des Kompilierungsergebnisses.
pageSize

integer

Optional. Maximale Anzahl der zurückzugebenden Kompilierungsergebnisse. Der Server gibt möglicherweise weniger Elemente als angefordert zurück. Wenn kein Wert angegeben wurde, wählt der Server ein geeignetes Standardmodell aus.
pageToken

string

Optional. Ein Seitentoken, das von einem vorherigen QueryCompilationResultActions-Aufruf empfangen wurde. Geben Sie dieses an, um die nachfolgende Seite abzurufen.

Beim Paginieren müssen alle anderen für QueryCompilationResultActions bereitgestellten Parameter mit Ausnahme von page_size mit dem Aufruf übereinstimmen, der das Seitentoken bereitgestellt hat.
filter

string

Optional. Optionaler Filter für die zurückgegebene Liste. Derzeit wird das Filtern nur für das Feld file_path unterstützt.

Ausgabeschema

QueryCompilationResultActions-Antwortnachricht.

QueryCompilationResultActionsResponse

JSON-Darstellung 
{
  "compilationResultActions": [
    {
      object (CompilationResultAction)
    }
  ],
  "nextPageToken": string
}
Felder
compilationResultActions[]

object (CompilationResultAction)

Liste der Aktionen für Kompilierungsergebnisse.
nextPageToken

string

Ein Token, das als page_token gesendet werden kann, um die nächste Seite abzurufen. Wenn dieses Feld weggelassen wird, gibt es keine nachfolgenden Seiten.

CompilationResultAction

JSON-Darstellung 
{
  "target": {
    object (Target)
  },
  "canonicalTarget": {
    object (Target)
  },
  "filePath": string,

  // Union field compiled_object can be only one of the following:
  "relation": {
    object (Relation)
  },
  "operations": {
    object (Operations)
  },
  "assertion": {
    object (Assertion)
  },
  "declaration": {
    object (Declaration)
  },
  "notebook": {
    object (Notebook)
  },
  "dataPreparation": {
    object (DataPreparation)
  }
  // End of list of possible types for union field compiled_object.

  // Union field _internal_metadata can be only one of the following:
  "internalMetadata": string
  // End of list of possible types for union field _internal_metadata.
}
Felder
target

object (Target)

Die Kennung dieser Aktion. Eindeutig innerhalb des Kompilierungsergebnisses.
canonicalTarget

object (Target)

Die Kennung der Aktion, wenn das Projekt ohne konfigurierte Überschreibungen kompiliert worden wäre. Eindeutig innerhalb des Kompilierungsergebnisses.
filePath

string

Der vollständige Pfad einschließlich des Dateinamens, in dem sich diese Aktion befindet, relativ zum Arbeitsbereichs-Root.
Union-Feld compiled_object. Das kompilierte Objekt. Für compiled_object ist nur einer der folgenden Werte zulässig:
relation

object (Relation)

Die Datenbankbeziehung, die durch diese Aktion erstellt/aktualisiert wurde.
operations

object (Operations)

Die von dieser Aktion ausgeführten Datenbankvorgänge.
assertion

object (Assertion)

Die von dieser Aktion ausgeführte Assertion.
declaration

object (Declaration)

Die durch diese Aktion deklarierte Deklaration.
notebook

object (Notebook)

Das Notebook, das durch diese Aktion ausgeführt wurde.
dataPreparation

object (DataPreparation)

Die durch diese Aktion ausgeführte Datenvorbereitung.

Union-Feld _internal_metadata.

Für _internal_metadata ist nur einer der folgenden Werte zulässig:
internalMetadata

string

Nur Ausgabe. Alle Metadateninformationen, die intern zum Bereitstellen der Ressource verwendet werden. Beispiele: Zeitstempel, Flags, Statusfelder usw. Das Format dieses Felds ist ein JSON-String.

Beziehung

JSON-Darstellung 
{
  "dependencyTargets": [
    {
      object (Target)
    }
  ],
  "disabled": boolean,
  "tags": [
    string
  ],
  "relationDescriptor": {
    object (RelationDescriptor)
  },
  "relationType": enum (RelationType),
  "selectQuery": string,
  "preOperations": [
    string
  ],
  "postOperations": [
    string
  ],
  "incrementalTableConfig": {
    object (IncrementalTableConfig)
  },
  "partitionExpression": string,
  "clusterExpressions": [
    string
  ],
  "partitionExpirationDays": integer,
  "requirePartitionFilter": boolean,
  "additionalOptions": {
    string: string,
    ...
  },
  "connection": string,
  "tableFormat": enum (TableFormat),
  "fileFormat": enum (FileFormat),
  "storageUri": string
}
Felder
dependencyTargets[]

object (Target)

Eine Liste der Aktionen, von denen diese Aktion abhängt.
disabled

boolean

Gibt an, ob diese Aktion deaktiviert ist (d.h. nicht ausgeführt werden soll).
tags[]

string

Beliebige, benutzerdefinierte Tags für diese Aktion.
relationDescriptor

object (RelationDescriptor)

Deskriptor für die Beziehung und ihre Spalten.
relationType

enum (RelationType)

Der Typ dieser Beziehung.
selectQuery

string

Die SELECT-Abfrage, die Zeilen zurückgibt, die diese Beziehung enthalten soll.
preOperations[]

string

SQL-Anweisungen, die vor dem Erstellen der Beziehung ausgeführt werden sollen.
postOperations[]

string

SQL-Anweisungen, die nach dem Erstellen der Beziehung ausgeführt werden sollen.
incrementalTableConfig

object (IncrementalTableConfig)

Konfiguriert die INCREMENTAL_TABLE-Einstellungen für diese Beziehung. Wird nur festgelegt, wenn relation_type INCREMENTAL_TABLE ist.
partitionExpression

string

Der SQL-Ausdruck, der zum Partitionieren der Relation verwendet wird.
clusterExpressions[]

string

Eine Liste mit Spalten oder SQL-Ausdrücken, die zum Clustern der Tabelle verwendet werden.
partitionExpirationDays

integer

Legt den Partitionsablauf in Tagen fest.
requirePartitionFilter

boolean

Gibt an, ob Abfragen für diese Tabelle einen Prädikatfilter enthalten müssen, der nach der Partitionierungsspalte filtert.
additionalOptions

map (key: string, value: string)

Zusätzliche Optionen, die als Schlüssel/Wert-Paare in die Optionsklausel einer CREATE TABLE- oder CREATE VIEW-Anweisung eingefügt werden. Weitere Informationen zu den unterstützten Optionen finden Sie unter https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language.

Ein Objekt, das eine Liste von "key": value-Paaren enthält. Beispiel: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
connection

string

Optional. Die Verbindung, in der die Anmeldedaten für das Lesen und Schreiben in externen Speicher wie Cloud Storage angegeben werden. Die Verbindung kann das Format {project}.{location}.{connection_id} oder projects/{project}/locations/{location}/connections/{connection_id} haben oder auf DEFAULT festgelegt sein.
tableFormat

enum (TableFormat)

Optional. Das Tabellenformat für die BigQuery-Tabelle.
fileFormat

enum (FileFormat)

Optional. Das Dateiformat für die BigQuery-Tabelle.
storageUri

string

Optional. Das voll qualifizierte Speicherortpräfix des externen Ordners, in dem Tabellendaten gespeichert werden. Der URI sollte das Format gs://bucket/path_to_table/ haben.

Ziel

JSON-Darstellung 
{
  "database": string,
  "schema": string,
  "name": string
}
Felder
database

string

Optional. Die Datenbank der Aktion (Google Cloud-Projekt-ID) .
schema

string

Optional. Das Schema der Aktion (BigQuery-Dataset-ID) in database.
name

string

Optional. Der Name der Aktion zwischen database und schema.

RelationDescriptor

JSON-Darstellung 
{
  "description": string,
  "columns": [
    {
      object (ColumnDescriptor)
    }
  ],
  "bigqueryLabels": {
    string: string,
    ...
  }
}
Felder
description

string

Eine Textbeschreibung der Beziehung.
columns[]

object (ColumnDescriptor)

Eine Liste mit Beschreibungen der Spalten in der Beziehung.
bigqueryLabels

map (key: string, value: string)

Eine Reihe von BigQuery-Labels, die auf die Beziehung angewendet werden sollen.

Ein Objekt, das eine Liste von "key": value-Paaren enthält. Beispiel: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

ColumnDescriptor

JSON-Darstellung 
{
  "path": [
    string
  ],
  "description": string,
  "bigqueryPolicyTags": [
    string
  ]
}
Felder
path[]

string

Die Kennung für die Spalte. Jeder Eintrag in path steht für eine Verschachtelungsebene.
description

string

Eine Textbeschreibung der Spalte.
bigqueryPolicyTags[]

string

Eine Liste der BigQuery-Richtlinien-Tags, die auf die Spalte angewendet werden.

BigqueryLabelsEntry

JSON-Darstellung 
{
  "key": string,
  "value": string
}
Felder
key

string
value

string

IncrementalTableConfig

JSON-Darstellung 
{
  "incrementalSelectQuery": string,
  "refreshDisabled": boolean,
  "uniqueKeyParts": [
    string
  ],
  "updatePartitionFilter": string,
  "incrementalPreOperations": [
    string
  ],
  "incrementalPostOperations": [
    string
  ]
}
Felder
incrementalSelectQuery

string

Die SELECT-Abfrage, die Zeilen zurückgibt, die in die Beziehung eingefügt werden sollen, wenn sie bereits vorhanden ist und nicht aktualisiert wird.
refreshDisabled

boolean

Gibt an, ob diese Tabelle vor dem Aktualisieren geschützt werden soll.
uniqueKeyParts[]

string

Eine Gruppe von Spalten oder SQL-Ausdrücken, die zur Definition der Eindeutigkeit von Zeilen verwendet werden. Wenn Duplikate (gemäß unique_key_parts) gefunden werden, werden nur die neu ausgewählten Zeilen (gemäß incremental_select_query) in die Beziehung aufgenommen.
updatePartitionFilter

string

Ein bedingter SQL-Ausdruck, mit dem die Menge der vorhandenen Zeilen eingeschränkt wird, die für einen Merge-Vorgang berücksichtigt werden (weitere Informationen finden Sie unter unique_key_parts).
incrementalPreOperations[]

string

SQL-Anweisungen, die vor dem Einfügen neuer Zeilen in die Relation ausgeführt werden sollen.
incrementalPostOperations[]

string

SQL-Anweisungen, die nach dem Einfügen neuer Zeilen in die Relation ausgeführt werden sollen.

AdditionalOptionsEntry

JSON-Darstellung 
{
  "key": string,
  "value": string
}
Felder
key

string
value

string

Vorgänge

JSON-Darstellung 
{
  "dependencyTargets": [
    {
      object (Target)
    }
  ],
  "disabled": boolean,
  "tags": [
    string
  ],
  "relationDescriptor": {
    object (RelationDescriptor)
  },
  "queries": [
    string
  ],
  "hasOutput": boolean
}
Felder
dependencyTargets[]

object (Target)

Eine Liste der Aktionen, von denen diese Aktion abhängt.
disabled

boolean

Gibt an, ob diese Aktion deaktiviert ist (d.h. nicht ausgeführt werden soll).
tags[]

string

Beliebige, benutzerdefinierte Tags für diese Aktion.
relationDescriptor

object (RelationDescriptor)

Deskriptor für eine beliebige Ausgaberelation und ihre Spalten. Wird nur festgelegt, wenn has_output „true“ ist.
queries[]

string

Eine Liste beliebiger SQL-Anweisungen, die unverändert ausgeführt werden.
hasOutput

boolean

Gibt an, ob diese Vorgänge eine Ausgaberelation erzeugen.

Assertion

JSON-Darstellung 
{
  "dependencyTargets": [
    {
      object (Target)
    }
  ],
  "parentAction": {
    object (Target)
  },
  "disabled": boolean,
  "tags": [
    string
  ],
  "selectQuery": string,
  "relationDescriptor": {
    object (RelationDescriptor)
  }
}
Felder
dependencyTargets[]

object (Target)

Eine Liste der Aktionen, von denen diese Aktion abhängt.
parentAction

object (Target)

Die übergeordnete Aktion dieser Behauptung. Nur festlegen, wenn diese Behauptung automatisch generiert wurde.
disabled

boolean

Gibt an, ob diese Aktion deaktiviert ist (d.h. nicht ausgeführt werden soll).
tags[]

string

Beliebige, benutzerdefinierte Tags für diese Aktion.
selectQuery

string

Die SELECT-Abfrage, die null Zeilen zurückgeben muss, damit diese Assertion erfolgreich ist.
relationDescriptor

object (RelationDescriptor)

Deskriptor für die automatisch generierte Ansicht der Behauptung und ihre Spalten.

Deklaration

JSON-Darstellung 
{
  "relationDescriptor": {
    object (RelationDescriptor)
  }
}
Felder
relationDescriptor

object (RelationDescriptor)

Deskriptor für die Beziehung und ihre Spalten. Wird nur als Dokumentation verwendet. Die Werte hier führen zu keinen Änderungen an den Metadaten der Beziehung.

Notebook

JSON-Darstellung 
{
  "dependencyTargets": [
    {
      object (Target)
    }
  ],
  "disabled": boolean,
  "contents": string,
  "tags": [
    string
  ]
}
Felder
dependencyTargets[]

object (Target)

Eine Liste der Aktionen, von denen diese Aktion abhängt.
disabled

boolean

Gibt an, ob diese Aktion deaktiviert ist (d.h. nicht ausgeführt werden soll).
contents

string

Der Inhalt des Notebooks.
tags[]

string

Beliebige, benutzerdefinierte Tags für diese Aktion.

DataPreparation

JSON-Darstellung 
{
  "dependencyTargets": [
    {
      object (Target)
    }
  ],
  "disabled": boolean,
  "tags": [
    string
  ],

  // Union field definition can be only one of the following:
  "contentsYaml": string,
  "contentsSql": {
    object (SqlDefinition)
  }
  // End of list of possible types for union field definition.
}
Felder
dependencyTargets[]

object (Target)

Eine Liste der Aktionen, von denen diese Aktion abhängt.
disabled

boolean

Gibt an, ob diese Aktion deaktiviert ist (d.h. nicht ausgeführt werden soll).
tags[]

string

Beliebige, benutzerdefinierte Tags für diese Aktion.
Union-Feld definition. Die Definition für die Datenvorbereitung. Für definition ist nur einer der folgenden Werte zulässig:
contentsYaml

string

Die Definition der Datenvorbereitung, gespeichert als YAML-String.
contentsSql

object (SqlDefinition)

SQL-Definition für eine Datenaufbereitung. Enthält eine SQL-Abfrage und zusätzliche Kontextinformationen.

SqlDefinition

JSON-Darstellung 
{
  "query": string,
  "errorTable": {
    object (ErrorTable)
  },
  "load": {
    object (LoadConfig)
  }
}
Felder
query

string

Die SQL-Abfrage, die die Schritte zur Datenvorbereitung darstellt. Als Pipe-SQL-Abfrageanweisung formatiert.
errorTable

object (ErrorTable)

Fehlertabellenkonfiguration,
load

object (LoadConfig)

Konfiguration laden

ErrorTable

JSON-Darstellung 
{
  "target": {
    object (Target)
  },
  "retentionDays": integer
}
Felder
target

object (Target)

Ziel der Fehlertabelle.
retentionDays

integer

Fehler beim Festlegen des Partitionsablaufs für Fehlertabellen in Tagen. Nur positive Werte sind zulässig.

LoadConfig

JSON-Darstellung 
{

  // Union field mode can be only one of the following:
  "replace": {
    object (SimpleLoadMode)
  },
  "append": {
    object (SimpleLoadMode)
  },
  "maximum": {
    object (IncrementalLoadMode)
  },
  "unique": {
    object (IncrementalLoadMode)
  }
  // End of list of possible types for union field mode.
}
Felder
Union-Feld mode. Der Lademodus mode kann nur einer der folgenden Werte sein:
replace

object (SimpleLoadMode)

Zieltabelle ersetzen
append

object (SimpleLoadMode)

An Zieltabelle anhängen
maximum

object (IncrementalLoadMode)

Datensätze einfügen, in denen der Wert den vorherigen Höchstwert für eine Spalte in der Zieltabelle überschreitet
unique

object (IncrementalLoadMode)

Datensätze einfügen, in denen der Wert einer Spalte noch nicht in der Zieltabelle vorhanden ist

IncrementalLoadMode

JSON-Darstellung 
{
  "column": string
}
Felder
column

string

Spaltenname für inkrementelle Lademodi

RelationType

Gibt den Typ dieser Beziehung an.

Enums
RELATION_TYPE_UNSPECIFIED Standardwert. Dieser Wert wird nicht verwendet.
TABLE Die Beziehung ist eine Tabelle.
VIEW Die Relation ist eine Ansicht.
INCREMENTAL_TABLE Die Relation ist eine inkrementelle Tabelle.
MATERIALIZED_VIEW Die Relation ist eine materialisierte Ansicht.

TableFormat

Unterstützte Tabellenformate für BigQuery-Tabellen.

Enums
TABLE_FORMAT_UNSPECIFIED Standardwert.
ICEBERG Apache Iceberg-Format

FileFormat

Unterstützte Dateiformate für BigQuery-Tabellen.

Enums
FILE_FORMAT_UNSPECIFIED Standardwert.
PARQUET Apache Parquet-Format.

Tool-Annotationen

Destructive Hint: ❌ | Idempotent Hint: ✅ | Read Only Hint: ✅ | Open World Hint: ❌