Struct DatabaseClientBuilder 

pub struct DatabaseClientBuilder { /* private fields */ }

A builder for DatabaseClient.

Implementations

impl DatabaseClientBuilder

pub fn with_database_role(self, role: impl Into<String>) -> Self

Sets the database role for the client.

Example

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

Database roles are used for Fine-Grained Access Control (FGAC). You can assign a database role to a session, and that role determines the permissions for that session. For more information, see Access with FGAC.

pub fn with_request_options(self, options: RequestOptions) -> Self

Sets the request options that will be used when creating the multiplexed session for the client.

Example

    let spanner = Spanner::builder().build().await?;
    let mut options = RequestOptions::default();
    options.set_attempt_timeout(Duration::from_secs(60));
    let database_client = spanner
        .database_client("projects/my-project/instances/my-instance/databases/my-db")
        .with_request_options(options)
        .build()
        .await?;

pub fn with_leader_aware_routing(self, enabled: bool) -> Self

Sets whether Leader-Aware Routing (LAR) is enabled for read/write transactions.

Example

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

When LAR is enabled, modifying operations (Read-Write, Write-Only, and Partitioned DML transactions) automatically route requests directly to the Spanner leader replica. This eliminates internal forwarding hops between replicas and reduces overall transaction latency.

Enabled by default.

See also: https://docs.cloud.google.com/spanner/docs/leader-aware-routing

pub async fn build(self) -> Result<DatabaseClient>

Builds the DatabaseClient and creates a single multiplexed session that will be used for all operations on the database.