- 3.46.0 (latest)
- 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
User-friendly container for Cloud Spanner Database.
Classes
BatchCheckout
BatchCheckout(database, request_options=None, max_commit_delay=None)
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.
Parameters | |
---|---|
Name | Description |
database |
Database
database to use |
request_options |
RequestOptions
(Optional) Common options for the commit request. If a dict is provided, it must be of the same form as the protobuf message RequestOptions. |
max_commit_delay |
(Optional) The amount of latency this request is willing to incur in order to improve throughput. |
BatchSnapshot
BatchSnapshot(
database,
read_timestamp=None,
exact_staleness=None,
session_id=None,
transaction_id=None,
)
Wrapper for generating and processing read / query batches.
Parameters | |
---|---|
Name | Description |
database |
Database
database to use |
read_timestamp |
Execute all reads at the given timestamp. |
exact_staleness |
Execute all reads at a timestamp that is |
Database
Database(
database_id,
instance,
ddl_statements=(),
pool=None,
logger=None,
encryption_config=None,
database_dialect=DatabaseDialect.DATABASE_DIALECT_UNSPECIFIED,
database_role=None,
enable_drop_protection=False,
)
Representation of a Cloud Spanner Database.
We can use a Database
to:
create
the databasereload
the databaseupdate
the databasedrop
the database
Parameters | |
---|---|
Name | Description |
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. |
logger |
(Optional) a custom logger that is used if |
encryption_config |
EncryptionConfig or RestoreDatabaseEncryptionConfig or
(Optional) Encryption configuration for the database. If a dict is provided, it must be of the same form as either of the protobuf messages EncryptionConfig or RestoreDatabaseEncryptionConfig |
database_dialect |
DatabaseDialect
(Optional) database dialect for the database |
database_role |
str or None
(Optional) user-assigned database_role for the session. |
enable_drop_protection |
boolean
(Optional) Represents whether the database has drop protection enabled or not. |
MutationGroupsCheckout
MutationGroupsCheckout(database)
Context manager for using mutation groups from a database.
Inside the context manager, checks out a session from the database, creates mutation groups from it, making the groups available.
Caller must not use the object to perform API requests outside the scope of the context manager.
Parameter | |
---|---|
Name | Description |
database |
Database
database to use |
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 | |
---|---|
Name | Description |
kw |
dict
Passed through to Snapshot constructor. |
database |
Database
database to use |