Module database (1.16.0)

User friendly container for Cloud Spanner Database.

Classes

BatchCheckout

BatchCheckout(database)

Context manager for using a batch from a database.

Inside the context manager, checks out a session from the database, creates a batch from it, making the batch available.

Caller must not use the batch to perform API requests outside the scope of the context manager.

Parameter
NameDescription
database Database

database to use

BatchSnapshot

BatchSnapshot(database, read_timestamp=None, exact_staleness=None)

Wrapper for generating and processing read / query batches.

Parameters
NameDescription
database Database

database to use

read_timestamp datetime.datetime

Execute all reads at the given timestamp.

exact_staleness datetime.timedelta

Execute all reads at a timestamp that is exact_staleness old.

Database

Database(database_id, instance, ddl_statements=(), pool=None)

Representation of a Cloud Spanner Database.

We can use a Database to:

  • create the database
  • reload the database
  • update the database
  • drop the database
Parameters
NameDescription
database_id str

The ID of the database.

instance Instance

The instance that owns the database.

ddl_statements list of string

(Optional) DDL statements, excluding the CREATE DATABASE statement.

pool concrete subclass of AbstractSessionPool.

(Optional) session pool to be used by database. If not passed, the database will construct an instance of BurstyPool.

SnapshotCheckout

SnapshotCheckout(database, **kw)

Context manager for using a snapshot from a database.

Inside the context manager, checks out a session from the database, creates a snapshot from it, making the snapshot available.

Caller must not use the snapshot to perform API requests outside the scope of the context manager.

Parameters
NameDescription
kw dict

Passed through to Snapshot constructor.

database Database

database to use