Struct Query 

pub struct Query { /* private fields */ }

A handle representing a running or completed SQL query execution.

Query::send() returns a Query.

To obtain the final result set, call until_done(), which waits for the query execution to complete and returns a CompleteQuery.

Example

let query_handle = client
    .query("SELECT 42 AS answer")
    .send()
    .await?;

// Poll until execution completes.
let completed = query_handle.until_done().await?;

Implementations

impl Query

pub fn metadata(&self) -> &QueryMetadata

Returns the initial metadata from query execution.

Depending on how the query was executed, the metadata contains:

• job_reference: The reference to the BigQuery job, if one was created.
• query_id: The unique ID of the query if executed without creating a job.
• job_creation_reason: The reason why a job was created (controlled via set_job_creation_mode).
• job_complete: Whether the query completed immediately without requiring polling.

To wait for the query to finish and retrieve full results and final metadata, call until_done.

pub fn get_job(&self) -> Option<GetJob>

Build a request to fetch full Job execution metadata from the service for this query.

Returns None if the query was executed without creating a job (for example, when using JobCreationMode::JobCreationOptional, or when the query was a dry run).

Example

let query = client
    .query("SELECT 1")
    .set_job_creation_mode(JobCreationMode::JobCreationRequired) // Forces a job to be created
    .send()
    .await?;

match query.get_job() {
    Some(req) => {
        let job_info = req.send().await?;
        println!("Executed by user: {}", job_info.user_email);
    }
    None => {
        println!(
            "Query was run without creating a job. Query ID: {}",
            query.metadata().query_id
        );
    }
}

pub async fn until_done(self) -> Result<CompleteQuery, QueryError>

Waits for query execution to complete.

If the query completed immediately, this method returns a CompleteQuery without making additional network calls. Otherwise, it polls the service until the query finishes.

Errors

Returns QueryError::DryRun if the query was configured as a dry run.

Returns an error if a remote service or network failure happens during polling, or if the BigQuery job fails due to runtime execution errors.

Example

let query_handle = client
    .query("SELECT 1 + 1 AS result")
    .send()
    .await?;

let complete = query_handle.until_done().await?;

Trait Implementations

impl Clone for Query

fn clone(&self) -> Query

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Query

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

Formats the value using the given formatter.