Struct ConfigBuilder

pub struct ConfigBuilder { /* private fields */ }

Builder for Config.

Implementations

impl ConfigBuilder

pub fn endpoint<VALUE: Into<String>>(self, value: VALUE) -> Self

Set the URI to use to reach the Spanner API. Leave unspecified to use Cloud Spanner.

pub fn tls_config(self, value: ClientTlsConfig) -> Self

Set custom client-side TLS settings.

pub fn project<VALUE: Into<String>>(self, value: VALUE) -> Self

Specify the GCP project where the Cloud Spanner instance exists.

This may be left unspecified, in which case, the project will be extracted from the credentials. Note that this only works when authenticating using service accounts.

pub fn instance<VALUE: Into<String>>(self, value: VALUE) -> Self

Set the Cloud Spanner instance ID.

pub fn database<VALUE: Into<String>>(self, value: VALUE) -> Self

Set the Cloud Spanner database name.

pub fn credentials_file<VALUE: Into<String>>(self, value: VALUE) -> Self

Programatically specify the credentials file to use during authentication.

When this is specified, it is used in favor of the GOOGLE_APPLICATION_CREDENTIALS environment variable.

pub fn session_pool_config(self, value: SessionPoolConfig) -> Self

Configuration for the embedded session pool.

pub fn build(self) -> Result<Config, Error>

Builds a new Config.

Errors

If a required field has not been initialized.

impl ConfigBuilder

pub fn disable_tls(self) -> Self

Disable TLS when connecting to Spanner. This usually only makes sense when using the emulator. Note that this also disables authentication to prevent sending secrets in plain text.

pub fn with_emulator_host(self, endpoint: String) -> Self

Configure the client to connect to a Spanner emulator, e.g.: http://localhost:9092 This disables TLS.

pub fn with_emulator_grpc_port(self, port: u16) -> Self

Configure the client to connect to a Spanner emulator running on localhost and using the specified port. This disables TLS.

pub async fn connect(self) -> Result<Client, Error>

See Config::connect

Trait Implementations

impl Default for ConfigBuilder

fn default() -> Self

Returns the “default value” for a type.