- 3.59.0 (latest)
 - 3.58.0
 - 3.57.0
 - 3.56.0
 - 3.55.0
 - 3.54.0
 - 3.53.0
 - 3.52.0
 - 3.51.0
 - 3.50.1
 - 3.46.0
 - 3.45.0
 - 3.44.0
 - 3.43.0
 - 3.42.0
 - 3.41.0
 - 3.40.1
 - 3.39.0
 - 3.38.0
 - 3.37.0
 - 3.36.0
 - 3.35.1
 - 3.34.0
 - 3.33.0
 - 3.32.0
 - 3.31.0
 - 3.30.0
 - 3.29.0
 - 3.28.0
 - 3.27.1
 - 3.26.0
 - 3.25.0
 - 3.24.0
 - 3.23.0
 - 3.22.2
 - 3.21.0
 - 3.20.0
 - 3.19.0
 - 3.18.0
 - 3.17.0
 - 3.16.0
 - 3.15.1
 - 3.14.1
 - 3.13.0
 - 3.12.1
 - 3.11.1
 - 3.10.0
 - 3.9.0
 - 3.8.0
 - 3.7.0
 - 3.6.0
 - 3.5.0
 - 3.4.0
 - 3.3.0
 - 3.2.0
 - 3.1.0
 - 3.0.0
 - 2.1.1
 - 2.0.0
 - 1.19.3
 - 1.18.0
 - 1.17.1
 - 1.16.0
 - 1.15.1
 - 1.14.0
 - 1.13.0
 - 1.12.0
 - 1.11.0
 - 1.10.0
 
API documentation for spanner_v1 package.
Classes
AbstractSessionPool
Specifies required API for concrete session pool implementations.
BurstyPool
Concrete session pool implementation:
"Pings" existing sessions via
session.existsbefore returning them.Creates a new session, rather than blocking, when
getis called on an empty pool.Discards the returned session, rather than blocking, when
putis called on a full pool.
Client
Client for interacting with Cloud Spanner API.
FixedSizePool
Concrete session pool implementation:
Pre-allocates / creates a fixed number of sessions.
"Pings" existing sessions via
session.existsbefore returning them, and replaces expired sessions.Blocks, with a timeout, when
getis called on an empty pool. Raises after timing out.Raises when
putis called on a full pool. That error is never expected in normal practice, as users should be callinggetfollowed byputwhenever in need of a session.
KeyRange
Identify range of table rows via start / end points.
Specify either a start_open or start_closed key, or defaults to
start_closed = [].  Specify either an end_open or end_closed key,
or defaults to end_closed = [].  However, at least one key has to be
specified.  If no keys are specified, ValueError is raised.
KeySet
Identify table rows via keys / ranges.
PingingPool
Concrete session pool implementation:
Pre-allocates / creates a fixed number of sessions.
Sessions are used in "round-robin" order (LRU first).
"Pings" existing sessions in the background after a specified interval via an API call (
session.ping()).Blocks, with a timeout, when
getis called on an empty pool. Raises after timing out.Raises when
putis called on a full pool. That error is never expected in normal practice, as users should be callinggetfollowed byputwhenever in need of a session.
The application is responsible for calling ping at appropriate
times, e.g. from a background thread.
TransactionPingingPool
Concrete session pool implementation:
In addition to the features of PingingPool, this class
creates and begins a transaction for each of its sessions at startup.
When a session is returned to the pool, if its transaction has been
committed or rolled back, the pool creates a new transaction for the
session and pushes the transaction onto a separate queue of "transactions
to begin."  The application is responsible for flushing this queue
as appropriate via the pool's begin_pending_transactions method.
Modules
types
API documentation for spanner_v1.types module.
instance
User friendly container for Cloud Spanner Instance.
keyset
Wrap representation of Spanner keys / ranges.
session
Wrapper for Cloud Spanner Session objects.
pool
Pools managing shared Session objects.
snapshot
Model a set of read-only queries to a database as a snapshot.
streamed
Wrapper for streaming results.
transaction
Spanner read-write transaction support.