Struct SpannerDatabase 

pub struct SpannerDatabase;

Implementations

impl SpannerDatabase

pub async fn connect(database: &str) -> Result<DatabaseConnection, DbErr>

Connect to an existing Spanner database

Automatically detects the environment:

• If SPANNER_EMULATOR_HOST is set, connects without authentication
• Otherwise, uses Application Default Credentials (ADC) for authentication

ADC discovers credentials from (in order):

1. GOOGLE_APPLICATION_CREDENTIALS environment variable (service account JSON)
2. gcloud auth application-default login (local development)
3. GCE/GKE metadata server (when running on Google Cloud)

pub async fn connect_with_config( database: &str, config: ClientConfig, ) -> Result<DatabaseConnection, DbErr>

Connect to an existing Spanner database with custom configuration

pub async fn connect_with_emulator( database: &str, ) -> Result<DatabaseConnection, DbErr>

Connect to Spanner using the local emulator

pub async fn connect_with_emulator_host( database: &str, emulator_host: &str, ) -> Result<DatabaseConnection, DbErr>

Connect to Spanner using a custom emulator host

pub async fn connect_or_create_with_emulator( database: &str, options: CreateOptions, ) -> Result<DatabaseConnection, DbErr>

Connect to Spanner emulator, creating instance and/or database if they don’t exist

Note: This function only works with the Spanner emulator (localhost:9010). It will fail if SPANNER_EMULATOR_HOST is not set.

Example

use sea_orm_spanner::{SpannerDatabase, CreateOptions};

// Create database if not exists (default behavior)
let db = SpannerDatabase::connect_or_create_with_emulator(
    "projects/test/instances/test/databases/test",
    CreateOptions::default(),
).await?;

// Also create instance if not exists
let db = SpannerDatabase::connect_or_create_with_emulator(
    "projects/test/instances/test/databases/test",
    CreateOptions::new().with_instance_creation(),
).await?;

pub async fn connect_or_create_with_emulator_host( database: &str, emulator_host: &str, options: CreateOptions, ) -> Result<DatabaseConnection, DbErr>

Connect to Spanner emulator at custom host, creating instance/database if needed

Note: This function only works with the Spanner emulator.