Struct Spanner 

pub struct Spanner { /* private fields */ }

A client for the Spanner API.

Use this client to interact with the Spanner service.

Implementations

impl Spanner

pub fn builder() -> ClientBuilder

Returns a builder for the Spanner client.

Example

let spanner = Spanner::builder().build().await?;

let db_client = spanner
    .database_client("projects/my-project/instances/my-instance/databases/my-db")
    .build()
    .await?;

let tx = db_client.single_use().build();
let mut rs = tx.execute_query("SELECT 1").await?;

while let Some(row) = rs.next().await {
    let row = row?;
    let val: i64 = row.get(0);
    assert_eq!(val, 1);
}

The returned builder is pre-configured with standard defaults. It automatically detects and connects to the Spanner emulator if the SPANNER_EMULATOR_HOST environment variable is set.

pub fn database_admin_builder(&self) -> DatabaseAdminBuilder

Returns a builder for the DatabaseAdmin client.

This builder is automatically pre-configured with the same endpoints, credentials, and routing configurations as this Spanner instance. If configured to use the Emulator (via SPANNER_EMULATOR_HOST), it maps the gRPC endpoint port (9010) to the REST admin port (9020).

pub fn instance_admin_builder(&self) -> InstanceAdminBuilder

Returns a builder for the InstanceAdmin client.

This builder is automatically pre-configured with the same endpoints, credentials, and routing configurations as this Spanner instance. If configured to use the Emulator (via SPANNER_EMULATOR_HOST), it maps the gRPC endpoint port (9010) to the REST admin port (9020).

pub fn database_client( &self, database: impl Into<String>, ) -> DatabaseClientBuilder

Returns a new DatabaseClientBuilder for interacting with a specific database.

Example

    let spanner = Spanner::builder().build().await?;
    let database_client = spanner
        .database_client("projects/my-project/instances/my-instance/databases/my-db")
        .build()
        .await?;

The returned DatabaseClient is intended to be a long-lived object and should be reused for all operations on the database.

pub fn from_stub<T>(stub: T) -> Self

where T: Spanner + 'static,

Creates a new client from the provided stub.

The most common case for calling this function is in tests mocking the client’s behavior.

Trait Implementations

impl Clone for Spanner

fn clone(&self) -> Spanner

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Spanner

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

Formats the value using the given formatter.