MCP Tools Reference: dataform.googleapis.com

Strumento: query_compilation_actions

Restituisce le azioni del risultato della compilazione per un determinato risultato della compilazione di Dataform.

Il valore parametro name deve essere nel formato projects/{project_id}/locations/{location}/repositories/{repository}/compilationResults/{compilation_result}.

Il seguente esempio di codice mostra come utilizzare curl per chiamare lo strumento MCP query_compilation_actions.

Richiesta curl 
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 MCP tool specification.
    }
  },
  "jsonrpc": "2.0",
  "id": 1
}'

Schema di input

QueryCompilationResultActions messaggio di richiesta.

QueryCompilationResultActionsRequest

Rappresentazione JSON 
{
  "name": string,
  "pageSize": integer,
  "pageToken": string,
  "filter": string
}
Campi
name

string

Obbligatorio. Il nome del risultato della compilazione.
pageSize

integer

Facoltativo. Il numero massimo di risultati di compilazione da restituire. Il server potrebbe restituire meno elementi di quelli richiesti. Se non specificato, il server sceglierà un valore predefinito appropriato.
pageToken

string

Facoltativo. Token di pagina ricevuto da una precedente chiamata QueryCompilationResultActions. Forniscilo per recuperare la pagina successiva.

Durante la paginazione, tutti gli altri parametri forniti a QueryCompilationResultActions, ad eccezione di page_size, devono corrispondere alla chiamata che ha fornito il token di pagina.
filter

string

Facoltativo. Filtro facoltativo per l'elenco restituito. Al momento, il filtro è supportato solo per il campo file_path.

Schema di output

Messaggio di risposta QueryCompilationResultActions.

QueryCompilationResultActionsResponse

Rappresentazione JSON 
{
  "compilationResultActions": [
    {
      object (CompilationResultAction)
    }
  ],
  "nextPageToken": string
}
Campi
compilationResultActions[]

object (CompilationResultAction)

Elenco delle azioni sui risultati di compilazione.
nextPageToken

string

Un token, che può essere inviato come page_token per recuperare la pagina successiva. Se questo campo viene omesso, non verranno visualizzate altre pagine.

CompilationResultAction

Rappresentazione JSON 
{
  "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.
}
Campi
target

object (Target)

L'identificatore di questa azione. Unico all'interno del risultato della compilazione.
canonicalTarget

object (Target)

L'identificatore dell'azione se il progetto fosse stato compilato senza override configurati. Unico all'interno del risultato della compilazione.
filePath

string

Il percorso completo, incluso il nome file, in cui si trova questa azione, relativo alla radice dello spazio di lavoro.
Campo unione compiled_object. L'oggetto compilato. compiled_object può essere solo uno dei seguenti tipi:
relation

object (Relation)

La relazione del database creata/aggiornata da questa azione.
operations

object (Operations)

Le operazioni del database eseguite da questa azione.
assertion

object (Assertion)

L'asserzione eseguita da questa azione.
declaration

object (Declaration)

La dichiarazione dichiarata da questa azione.
notebook

object (Notebook)

Il notebook eseguito da questa azione.
dataPreparation

object (DataPreparation)

La preparazione dei dati eseguita da questa azione.

Campo unione _internal_metadata.

_internal_metadata può essere solo uno dei seguenti tipi:
internalMetadata

string

Solo output. Tutte le informazioni sui metadati utilizzate internamente per pubblicare la risorsa. Ad esempio, timestamp, flag, campi di stato e così via. Il formato di questo campo è una stringa JSON.

Relazione

Rappresentazione JSON 
{
  "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
}
Campi
dependencyTargets[]

object (Target)

Un elenco di azioni da cui dipende questa azione.
disabled

boolean

Indica se questa azione è disattivata (ovvero non deve essere eseguita).
tags[]

string

Tag arbitrari definiti dall'utente per questa azione.
relationDescriptor

object (RelationDescriptor)

Descrittore della relazione e delle relative colonne.
relationType

enum (RelationType)

Il tipo di questa relazione.
selectQuery

string

La query SELECT che restituisce le righe che questa relazione deve contenere.
preOperations[]

string

Istruzioni SQL da eseguire prima di creare la relazione.
postOperations[]

string

Istruzioni SQL da eseguire dopo la creazione della relazione.
incrementalTableConfig

object (IncrementalTableConfig)

Configura le impostazioni di INCREMENTAL_TABLE per questa relazione. Impostato solo se relation_type è INCREMENTAL_TABLE.
partitionExpression

string

L'espressione SQL utilizzata per partizionare la relazione.
clusterExpressions[]

string

Un elenco di colonne o espressioni SQL utilizzate per raggruppare la tabella.
partitionExpirationDays

integer

Imposta la scadenza della partizione in giorni.
requirePartitionFilter

boolean

Specifica se le query su questa tabella devono includere un filtro predicato che filtra in base alla colonna di partizionamento.
additionalOptions

map (key: string, value: string)

Opzioni aggiuntive che verranno fornite come coppie chiave/valore nella clausola options di un'istruzione create table/view. Per saperne di più sulle opzioni supportate, consulta la pagina https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language.

Un oggetto contenente un elenco di coppie "key": value. Esempio: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
connection

string

Facoltativo. La connessione che specifica le credenziali da utilizzare per leggere e scrivere nell'archiviazione esterna, ad esempio Cloud Storage. La connessione può avere il formato {project}.{location}.{connection_id} o projects/{project}/locations/{location}/connections/{connection_id} oppure essere impostata su DEFAULT.
tableFormat

enum (TableFormat)

Facoltativo. Il formato della tabella BigQuery.
fileFormat

enum (FileFormat)

Facoltativo. Il formato del file per la tabella BigQuery.
storageUri

string

Facoltativo. Il prefisso della posizione completamente qualificata della cartella esterna in cui sono archiviati i dati della tabella. L'URI deve essere nel formato gs://bucket/path_to_table/.

Target

Rappresentazione JSON 
{
  "database": string,
  "schema": string,
  "name": string
}
Campi
database

string

Facoltativo. Il database dell'azione (ID progetto Google Cloud) .
schema

string

Facoltativo. Lo schema dell'azione (ID set di dati BigQuery), all'interno di database.
name

string

Facoltativo. Il nome dell'azione, compreso tra database e schema.

RelationDescriptor

Rappresentazione JSON 
{
  "description": string,
  "columns": [
    {
      object (ColumnDescriptor)
    }
  ],
  "bigqueryLabels": {
    string: string,
    ...
  }
}
Campi
description

string

Una descrizione testuale della relazione.
columns[]

object (ColumnDescriptor)

Un elenco di descrizioni delle colonne all'interno della relazione.
bigqueryLabels

map (key: string, value: string)

Un insieme di etichette BigQuery da applicare alla relazione.

Un oggetto contenente un elenco di coppie "key": value. Esempio: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

ColumnDescriptor

Rappresentazione JSON 
{
  "path": [
    string
  ],
  "description": string,
  "bigqueryPolicyTags": [
    string
  ]
}
Campi
path[]

string

L'identificatore della colonna. Ogni voce in path rappresenta un livello di nidificazione.
description

string

Una descrizione testuale della colonna.
bigqueryPolicyTags[]

string

Un elenco di tag di criteri BigQuery che verranno applicati alla colonna.

BigqueryLabelsEntry

Rappresentazione JSON 
{
  "key": string,
  "value": string
}
Campi
key

string
value

string

IncrementalTableConfig

Rappresentazione JSON 
{
  "incrementalSelectQuery": string,
  "refreshDisabled": boolean,
  "uniqueKeyParts": [
    string
  ],
  "updatePartitionFilter": string,
  "incrementalPreOperations": [
    string
  ],
  "incrementalPostOperations": [
    string
  ]
}
Campi
incrementalSelectQuery

string

La query SELECT che restituisce le righe da inserire nella relazione se esiste già e non viene aggiornata.
refreshDisabled

boolean

Indica se questa tabella deve essere protetta dall'aggiornamento.
uniqueKeyParts[]

string

Un insieme di colonne o espressioni SQL utilizzate per definire l'univocità delle righe. Se vengono rilevati duplicati (come definito da unique_key_parts), nella relazione verranno incluse solo le righe appena selezionate (come definito da incremental_select_query).
updatePartitionFilter

string

Un'espressione SQL condizionale utilizzata per limitare l'insieme di righe esistenti prese in considerazione per un'operazione di unione (vedi unique_key_parts per ulteriori informazioni).
incrementalPreOperations[]

string

Istruzioni SQL da eseguire prima di inserire nuove righe nella relazione.
incrementalPostOperations[]

string

Istruzioni SQL da eseguire dopo l'inserimento di nuove righe nella relazione.

AdditionalOptionsEntry

Rappresentazione JSON 
{
  "key": string,
  "value": string
}
Campi
key

string
value

string

Operazioni

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

object (Target)

Un elenco di azioni da cui dipende questa azione.
disabled

boolean

Indica se questa azione è disattivata (ovvero non deve essere eseguita).
tags[]

string

Tag arbitrari definiti dall'utente per questa azione.
relationDescriptor

object (RelationDescriptor)

Descrittore per qualsiasi relazione di output e le relative colonne. Impostato solo se has_output è true.
queries[]

string

Un elenco di istruzioni SQL arbitrarie che verranno eseguite senza modifiche.
hasOutput

boolean

Indica se queste operazioni producono una relazione di output.

Asserzione

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

object (Target)

Un elenco di azioni da cui dipende questa azione.
parentAction

object (Target)

L'azione principale di questa asserzione. Impostato solo se questa asserzione è stata generata automaticamente.
disabled

boolean

Indica se questa azione è disattivata (ovvero non deve essere eseguita).
tags[]

string

Tag arbitrari definiti dall'utente per questa azione.
selectQuery

string

La query SELECT che deve restituire zero righe affinché questa asserzione abbia esito positivo.
relationDescriptor

object (RelationDescriptor)

Descrittore della visualizzazione generata automaticamente dell'asserzione e delle relative colonne.

Dichiarazione

Rappresentazione JSON 
{
  "relationDescriptor": {
    object (RelationDescriptor)
  }
}
Campi
relationDescriptor

object (RelationDescriptor)

Descrittore della relazione e delle relative colonne. Utilizzato solo come documentazione, ovvero i valori qui non comporteranno modifiche ai metadati della relazione.

Notebook

Rappresentazione JSON 
{
  "dependencyTargets": [
    {
      object (Target)
    }
  ],
  "disabled": boolean,
  "contents": string,
  "tags": [
    string
  ]
}
Campi
dependencyTargets[]

object (Target)

Un elenco di azioni da cui dipende questa azione.
disabled

boolean

Indica se questa azione è disattivata (ovvero non deve essere eseguita).
contents

string

I contenuti del notebook.
tags[]

string

Tag arbitrari definiti dall'utente per questa azione.

DataPreparation

Rappresentazione JSON 
{
  "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.
}
Campi
dependencyTargets[]

object (Target)

Un elenco di azioni da cui dipende questa azione.
disabled

boolean

Indica se questa azione è disattivata (ovvero non deve essere eseguita).
tags[]

string

Tag arbitrari definiti dall'utente per questa azione.
Campo unione definition. La definizione della preparazione dei dati. definition può essere solo uno dei seguenti tipi:
contentsYaml

string

La definizione della preparazione dei dati, archiviata come stringa YAML.
contentsSql

object (SqlDefinition)

Definizione SQL per una preparazione dei dati. Contiene una query SQL e informazioni di contesto aggiuntive.

SqlDefinition

Rappresentazione JSON 
{
  "query": string,
  "errorTable": {
    object (ErrorTable)
  },
  "load": {
    object (LoadConfig)
  }
}
Campi
query

string

La query SQL che rappresenta i passaggi di preparazione dei dati. Formattata come istruzione di query SQL Pipe.
errorTable

object (ErrorTable)

Configurazione della tabella degli errori,
load

object (LoadConfig)

Carica configurazione.

ErrorTable

Rappresentazione JSON 
{
  "target": {
    object (Target)
  },
  "retentionDays": integer
}
Campi
target

object (Target)

Destinazione della tabella degli errori.
retentionDays

integer

Scadenza partizione tabella in giorni. Sono consentiti solo valori positivi.

LoadConfig

Rappresentazione JSON 
{

  // 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.
}
Campi
Campo unione mode. La modalità di caricamento mode può essere solo una delle seguenti:
replace

object (SimpleLoadMode)

Sostituisci tabella di destinazione
append

object (SimpleLoadMode)

Aggiungi alla tabella di destinazione
maximum

object (IncrementalLoadMode)

Inserisci i record in cui il valore supera il valore massimo precedente per una colonna nella tabella di destinazione
unique

object (IncrementalLoadMode)

Inserisci record in cui il valore di una colonna non è già presente nella tabella di destinazione

IncrementalLoadMode

Rappresentazione JSON 
{
  "column": string
}
Campi
column

string

Nome della colonna per le modalità di caricamento incrementale

RelationType

Indica il tipo di relazione.

Enum
RELATION_TYPE_UNSPECIFIED Valore predefinito. Questo valore non viene utilizzato.
TABLE La relazione è una tabella.
VIEW La relazione è una visualizzazione.
INCREMENTAL_TABLE La relazione è una tabella incrementale.
MATERIALIZED_VIEW La relazione è una vista materializzata.

TableFormat

Formati di tabella supportati per le tabelle BigQuery.

Enum
TABLE_FORMAT_UNSPECIFIED Valore predefinito.
ICEBERG Formato Apache Iceberg.

FileFormat

Formati di file supportati per le tabelle BigQuery.

Enum
FILE_FORMAT_UNSPECIFIED Valore predefinito.
PARQUET Formato Apache Parquet.

Annotazioni dello strumento

Le annotazioni dello strumento vengono inviate ai client MCP per descrivere il rischio di base di un determinato strumento. La maggior parte dei client considera questi suggerimenti non attendibili, ma possono essere utilizzati per decidere quando inviare a un utente una richiesta di conferma.

Oltre alla stringa del titolo, sono definiti i seguenti suggerimenti booleani:

  • readOnlyHint: se è true, lo strumento non modifica il suo ambiente. Valore predefinito: false.
  • destructiveHint: se è true, lo strumento può eseguire azioni distruttive. Se il valore è false, lo strumento può eseguire solo azioni additive. Valore predefinito: true.
  • idempotentHint: se è true, chiamare ripetutamente lo strumento con gli stessi argomenti non avrà alcun effetto aggiuntivo sul suo ambiente. Valore predefinito: false.
  • openWorldHint: se è true, lo strumento può interagire con un "open world" di entità esterne. Se è false, lo strumento può interagire solo con le entità interne. Ad esempio, uno strumento di ricerca web sarebbe open world, mentre uno strumento di memoria no.

Suggerimento distruttivo: ❌ | Suggerimento idempotente: ✅ | Suggerimento di sola lettura: ✅ | Suggerimento open world: ❌