Struct BigQuery 

pub struct BigQuery { /* private fields */ }

A high-level BigQuery client for executing queries and managing jobs.

Configuration

To configure a BigQuery client, use the with_* methods on the ClientBuilder returned by BigQuery::builder(). The default configuration uses Application Default Credentials (ADC) and connects to the global default endpoint, which works for most applications.

Common configuration customizations include:

• with_project_id(): Sets the default Google Cloud project ID for the client.
• with_endpoint(): Overrides the default API endpoint (https://bigquery.googleapis.com). Useful when testing against mock servers or running in restricted network environments (for example, with VPC Service Controls).
• with_credentials(): Overrides the default Application Default Credentials with explicit or custom authentication credentials.

Pooling and Cloning

BigQuery holds an internal gRPC/HTTP client and connection pool wrapped in an Arc. You should create a single BigQuery client instance upon application initialization and reuse it across multiple tasks or requests. Cloning a BigQuery instance is cheap and does not duplicate underlying connections or thread pools, so you do not need to wrap BigQuery in an additional Arc.

Example: Basic Setup and Query Execution

let client = BigQuery::builder().build().await?;
let mut rows = client
    .query("SELECT name, count FROM `bigquery-public-data.usa_names.usa_1910_2013` WHERE state = 'WA' ORDER BY count DESC LIMIT 5")
    .with_project_id("my-project-id")
    .until_done()
    .await?
    .read();

while let Some(row) = rows.next().await.transpose()? {
    let name: String = row.get("name");
    let count: i64 = row.get("count");
    println!("{name}: {count}");
}

Implementations

impl BigQuery

pub fn builder() -> ClientBuilder

Returns a new ClientBuilder for configuring and instantiating a BigQuery client.

Example

let client = BigQuery::builder()
    .with_endpoint("https://bigquery.googleapis.com")
    .build()
    .await?;

pub fn query<S: Into<String>>(&self, sql: S) -> Query

Creates a request builder to configure and execute a SQL query.

This method returns a Query builder used to set parameters, specify options, and execute the query.

If you configured a default project ID on the client via ClientBuilder::with_project_id, the returned query builder inherits it automatically.

Call Query::send() to start query execution, or Query::until_done() to start execution and wait for results.

Example

use google_cloud_bigquery::client::BigQuery;

let client = BigQuery::builder().build().await?;

// Execute a query and read the resulting rows.
let mut rows = client
    .query("SELECT name, count FROM `my-project.my_dataset.stats` LIMIT 50")
    .with_project_id("my-project-id")
    .set_location("US")
    .until_done()
    .await?
    .read();

while let Some(row) = rows.next().await.transpose()? {
    let name: String = row.get("name");
    let count: i64 = row.get("count");
    println!("{name}: {count}");
}

pub async fn attach_job( &self, job_ref: JobReference, ) -> Result<QueryHandle, QueryError>

Binds an existing out-of-process query job reference to a high-level Query handle.

Fetches the job metadata via JobService::get_job and initializes a Query handle. If job_ref.project_id is empty, it defaults to the client’s billing project ID.

Arguments

• job_ref - A JobReference identifying the job to attach to.

Example

let job_ref = JobReference::new()
    .set_project_id("my-project")
    .set_job_id("my_job_id")
    .set_location("us-central1");
let query = client.attach_job(job_ref).await?;
let mut results = query.until_done().await?.read();
while let Some(row) = results.next().await {
    let row = row?;
    // process row
}

Trait Implementations

impl Clone for BigQuery

fn clone(&self) -> BigQuery

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for BigQuery

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.