← Tools Reference

Google BigQuery

Google BigQuery integration (Data, Developer Tools). Imported from open-connector.

OAuth19 toolshttps://bigquery.googleapis.com/bigquery/v2
POST
google_bigquery_query
Run a BigQuery SQL query synchronously.

/projects/{projectId}/queries

9 parameters
ParamTypeRequiredDescription
projectIdstringrequiredThe Google Cloud project ID that owns the BigQuery resource.
querystringrequiredThe GoogleSQL query text to execute.
locationstringoptionalThe BigQuery job location, such as US or europe-west1.
maxResultsintegeroptionalThe maximum number of results to return.
dryRunbooleanoptionalWhether BigQuery should validate the query without running it.
useLegacySqlbooleanoptionalWhether to use legacy SQL instead of GoogleSQL.
timeoutMsintegeroptionalHow long BigQuery should wait for the query to complete, in milliseconds.
parameterModestringoptionalThe BigQuery parameter mode.
queryParametersarrayoptionalThe query parameters for parameterized SQL.
POST
google_bigquery_cancel_job
Cancel a BigQuery job.

/projects/{projectId}/jobs/{jobId}/cancel

3 parameters
ParamTypeRequiredDescription
projectIdstringrequiredThe Google Cloud project ID that owns the BigQuery resource.
jobIdstringrequiredThe BigQuery job ID.
locationstringoptionalThe BigQuery job location, such as US or europe-west1.
POST
google_bigquery_start_query_job
Start an asynchronous BigQuery query job.

/projects/{projectId}/jobs

15 parameters
ParamTypeRequiredDescription
projectIdstringrequiredThe Google Cloud project ID that owns the BigQuery resource.
querystringrequiredThe GoogleSQL query text to execute.
locationstringoptionalThe BigQuery job location, such as US or europe-west1.
jobIdstringoptionalThe optional client-provided BigQuery job ID.
dryRunbooleanoptionalWhether BigQuery should validate the query without running it.
useLegacySqlbooleanoptionalWhether to use legacy SQL instead of GoogleSQL.
destinationTableobjectoptionalThe raw BigQuery object returned by the API.
defaultDatasetobjectoptionalThe raw BigQuery object returned by the API.
writeDispositionstringoptional
createDispositionstringoptional
prioritystringoptional
maximumBytesBilledstringoptional
parameterModestringoptional
queryParametersarrayoptional
labelsobjectoptionalA BigQuery labels map.
POST
google_bigquery_start_load_job_from_gcs
Start a BigQuery load job from Cloud Storage.

/projects/{projectId}/jobs

22 parameters
ParamTypeRequiredDescription
projectIdstringrequiredThe Google Cloud project ID that owns the BigQuery resource.
sourceUrisarrayrequired
destinationTableobjectrequiredA BigQuery table reference.
locationstringoptionalThe BigQuery job location, such as US or europe-west1.
jobIdstringoptionalThe BigQuery job ID.
sourceFormatstringoptional
schemaobjectoptionalThe raw BigQuery object returned by the API.
writeDispositionstringoptional
createDispositionstringoptional
skipLeadingRowsintegeroptional
fieldDelimiterstringoptional
allowQuotedNewlinesbooleanoptional
allowJaggedRowsbooleanoptional
ignoreUnknownValuesbooleanoptional
maxBadRecordsintegeroptional
autodetectbooleanoptional
nullMarkerstringoptional
encodingstringoptional
timePartitioningobjectoptionalThe raw BigQuery object returned by the API.
rangePartitioningobjectoptionalThe raw BigQuery object returned by the API.
clusteringobjectoptionalThe raw BigQuery object returned by the API.
labelsobjectoptionalA BigQuery labels map.
POST
google_bigquery_start_extract_job_to_gcs
Start a BigQuery extract job to Cloud Storage.

/projects/{projectId}/jobs

11 parameters
ParamTypeRequiredDescription
projectIdstringrequiredThe Google Cloud project ID that owns the BigQuery resource.
sourceTableobjectrequiredA BigQuery table reference.
destinationUrisarrayrequired
locationstringoptionalThe BigQuery job location, such as US or europe-west1.
jobIdstringoptionalThe BigQuery job ID.
destinationFormatstringoptional
compressionstringoptional
fieldDelimiterstringoptional
printHeaderbooleanoptional
useAvroLogicalTypesbooleanoptional
labelsobjectoptionalA BigQuery labels map.
POST
google_bigquery_create_dataset
Create a BigQuery dataset.

/projects/{projectId}/datasets

9 parameters
ParamTypeRequiredDescription
projectIdstringrequiredThe Google Cloud project ID that owns the BigQuery resource.
datasetIdstringrequiredThe BigQuery dataset ID.
locationstringoptionalThe BigQuery job location, such as US or europe-west1.
friendlyNamestringoptional
descriptionstringoptional
labelsobjectoptionalA BigQuery labels map.
defaultTableExpirationMsstringoptional
defaultPartitionExpirationMsstringoptional
updateModestringoptional
PATCH
google_bigquery_patch_dataset
Patch BigQuery dataset metadata.

/projects/{projectId}/datasets/{datasetId}

9 parameters
ParamTypeRequiredDescription
projectIdstringrequiredThe Google Cloud project ID that owns the BigQuery resource.
datasetIdstringrequiredThe BigQuery dataset ID.
locationstringoptionalThe BigQuery job location, such as US or europe-west1.
friendlyNamestringoptional
descriptionstringoptional
labelsobjectoptionalA BigQuery labels map.
defaultTableExpirationMsstringoptional
defaultPartitionExpirationMsstringoptional
updateModestringoptional
PUT
google_bigquery_update_dataset
Replace BigQuery dataset metadata.

/projects/{projectId}/datasets/{datasetId}

9 parameters
ParamTypeRequiredDescription
projectIdstringrequiredThe Google Cloud project ID that owns the BigQuery resource.
datasetIdstringrequiredThe BigQuery dataset ID.
locationstringoptionalThe BigQuery job location, such as US or europe-west1.
friendlyNamestringoptional
descriptionstringoptional
labelsobjectoptionalA BigQuery labels map.
defaultTableExpirationMsstringoptional
defaultPartitionExpirationMsstringoptional
updateModestringoptional
DELETE
google_bigquery_delete_dataset
Delete a BigQuery dataset.

/projects/{projectId}/datasets/{datasetId}

3 parameters
ParamTypeRequiredDescription
projectIdstringrequiredThe Google Cloud project ID that owns the BigQuery resource.
datasetIdstringrequiredThe BigQuery dataset ID.
deleteContentsbooleanoptionalWhether to delete all tables in the dataset.
POST
google_bigquery_create_table
Create a BigQuery table.

/projects/{projectId}/datasets/{datasetId}/tables

14 parameters
ParamTypeRequiredDescription
projectIdstringrequiredThe Google Cloud project ID that owns the BigQuery resource.
datasetIdstringrequiredThe BigQuery dataset ID.
tableIdstringrequiredThe BigQuery table ID.
schemaobjectoptionalThe raw BigQuery object returned by the API.
friendlyNamestringoptional
descriptionstringoptional
labelsobjectoptionalA BigQuery labels map.
timePartitioningobjectoptionalThe raw BigQuery object returned by the API.
rangePartitioningobjectoptionalThe raw BigQuery object returned by the API.
clusteringobjectoptionalThe raw BigQuery object returned by the API.
viewobjectoptionalThe raw BigQuery object returned by the API.
materializedViewobjectoptionalThe raw BigQuery object returned by the API.
externalDataConfigurationobjectoptionalThe raw BigQuery object returned by the API.
encryptionConfigurationobjectoptionalThe raw BigQuery object returned by the API.
PATCH
google_bigquery_patch_table
Patch BigQuery table metadata.

/projects/{projectId}/datasets/{datasetId}/tables/{tableId}

14 parameters
ParamTypeRequiredDescription
projectIdstringrequiredThe Google Cloud project ID that owns the BigQuery resource.
datasetIdstringrequiredThe BigQuery dataset ID.
tableIdstringrequiredThe BigQuery table ID.
schemaobjectoptionalThe raw BigQuery object returned by the API.
friendlyNamestringoptional
descriptionstringoptional
labelsobjectoptionalA BigQuery labels map.
timePartitioningobjectoptionalThe raw BigQuery object returned by the API.
rangePartitioningobjectoptionalThe raw BigQuery object returned by the API.
clusteringobjectoptionalThe raw BigQuery object returned by the API.
viewobjectoptionalThe raw BigQuery object returned by the API.
materializedViewobjectoptionalThe raw BigQuery object returned by the API.
externalDataConfigurationobjectoptionalThe raw BigQuery object returned by the API.
encryptionConfigurationobjectoptionalThe raw BigQuery object returned by the API.
PUT
google_bigquery_update_table
Replace BigQuery table metadata.

/projects/{projectId}/datasets/{datasetId}/tables/{tableId}

14 parameters
ParamTypeRequiredDescription
projectIdstringrequiredThe Google Cloud project ID that owns the BigQuery resource.
datasetIdstringrequiredThe BigQuery dataset ID.
tableIdstringrequiredThe BigQuery table ID.
schemaobjectoptionalThe raw BigQuery object returned by the API.
friendlyNamestringoptional
descriptionstringoptional
labelsobjectoptionalA BigQuery labels map.
timePartitioningobjectoptionalThe raw BigQuery object returned by the API.
rangePartitioningobjectoptionalThe raw BigQuery object returned by the API.
clusteringobjectoptionalThe raw BigQuery object returned by the API.
viewobjectoptionalThe raw BigQuery object returned by the API.
materializedViewobjectoptionalThe raw BigQuery object returned by the API.
externalDataConfigurationobjectoptionalThe raw BigQuery object returned by the API.
encryptionConfigurationobjectoptionalThe raw BigQuery object returned by the API.
DELETE
google_bigquery_delete_table
Delete a BigQuery table.

/projects/{projectId}/datasets/{datasetId}/tables/{tableId}

3 parameters
ParamTypeRequiredDescription
projectIdstringrequiredThe Google Cloud project ID that owns the BigQuery resource.
datasetIdstringrequiredThe BigQuery dataset ID.
tableIdstringrequiredThe BigQuery table ID.
POST
google_bigquery_insert_all
Insert a small batch of rows into a BigQuery table.

/projects/{projectId}/datasets/{datasetId}/tables/{tableId}/insertAll

7 parameters
ParamTypeRequiredDescription
projectIdstringrequiredThe Google Cloud project ID that owns the BigQuery resource.
datasetIdstringrequiredThe BigQuery dataset ID.
tableIdstringrequiredThe BigQuery table ID.
rowsarrayrequired
skipInvalidRowsbooleanoptional
ignoreUnknownValuesbooleanoptional
templateSuffixstringoptional
POST
google_bigquery_create_routine
Create a BigQuery routine.

/projects/{projectId}/datasets/{datasetId}/routines

11 parameters
ParamTypeRequiredDescription
projectIdstringrequiredThe Google Cloud project ID that owns the BigQuery resource.
datasetIdstringrequiredThe BigQuery dataset ID.
routineIdstringrequired
routineTypestringrequired
languagestringoptional
definitionBodystringrequired
descriptionstringoptional
argumentsarrayoptional
returnTypeobjectoptionalThe raw BigQuery object returned by the API.
importedLibrariesarrayoptional
determinismLevelstringoptional
PUT
google_bigquery_update_routine
Replace BigQuery routine metadata.

/projects/{projectId}/datasets/{datasetId}/routines/{routineId}

11 parameters
ParamTypeRequiredDescription
projectIdstringrequiredThe Google Cloud project ID that owns the BigQuery resource.
datasetIdstringrequiredThe BigQuery dataset ID.
routineIdstringrequired
routineTypestringrequired
languagestringoptional
definitionBodystringrequired
descriptionstringoptional
argumentsarrayoptional
returnTypeobjectoptionalThe raw BigQuery object returned by the API.
importedLibrariesarrayoptional
determinismLevelstringoptional
DELETE
google_bigquery_delete_routine
Delete a BigQuery routine.

/projects/{projectId}/datasets/{datasetId}/routines/{routineId}

3 parameters
ParamTypeRequiredDescription
projectIdstringrequiredThe Google Cloud project ID that owns the BigQuery resource.
datasetIdstringrequiredThe BigQuery dataset ID.
routineIdstringrequired
PATCH
google_bigquery_patch_model
Patch BigQuery model metadata.

/projects/{projectId}/datasets/{datasetId}/models/{modelId}

6 parameters
ParamTypeRequiredDescription
projectIdstringrequiredThe Google Cloud project ID that owns the BigQuery resource.
datasetIdstringrequiredThe BigQuery dataset ID.
modelIdstringrequired
friendlyNamestringoptional
descriptionstringoptional
labelsobjectoptionalA BigQuery labels map.
DELETE
google_bigquery_delete_model
Delete a BigQuery model.

/projects/{projectId}/datasets/{datasetId}/models/{modelId}

3 parameters
ParamTypeRequiredDescription
projectIdstringrequiredThe Google Cloud project ID that owns the BigQuery resource.
datasetIdstringrequiredThe BigQuery dataset ID.
modelIdstringrequired