api-job: BigQuery job: retrieve metadata
In bigrquery: An Interface to Google's 'BigQuery' 'API'

api-job

R Documentation

BigQuery job: retrieve metadata

Description

To perform a job, see api-perform. These functions all retrieve metadata (in various forms) about an existing job.

Usage

bq_job_meta(x, fields = NULL)

bq_job_status(x)

bq_job_show_statistics(x)

bq_job_wait(
  x,
  quiet = getOption("bigrquery.quiet"),
  pause = 0.5,
  call = caller_env()
)

Arguments

`x`	A bq_job
`fields`	An optional field specification for partial response
`quiet`	If `FALSE`, displays progress bar; if `TRUE` is silent; if `NA` picks based on whether or not you're in an interactive context.
`pause`	amount of time to wait between status requests
`call`	The execution environment of a currently running function, e.g. `caller_env()`. The function will be mentioned in error messages as the source of the error. See the `call` argument of `abort()` for more information.

Google BigQuery API documentation

Examples


jobs <- bq_project_jobs(bq_test_project())
jobs[[1]]

# Show statistics about job
bq_job_show_statistics(jobs[[1]])

# Wait for job to complete
bq_job_wait(jobs[[1]])

bigrquery documentation built on Sept. 9, 2025, 5:28 p.m.