Class Database (3.33.0)

Database(mapping=None, *, ignore_unknown_fields=False, **kwargs)

A Cloud Spanner database.

Attributes

NameDescription
name str
Required. The name of the database. Values are of the form projects/, where is as specified in the CREATE DATABASE statement. This name can be passed to other API methods to identify the database.
state google.cloud.spanner_admin_database_v1.types.Database.State
Output only. The current database state.
create_time google.protobuf.timestamp_pb2.Timestamp
Output only. If exists, the time at which the database creation started.
restore_info google.cloud.spanner_admin_database_v1.types.RestoreInfo
Output only. Applicable only for restored databases. Contains information about the restore source.
encryption_config google.cloud.spanner_admin_database_v1.types.EncryptionConfig
Output only. For databases that are using customer managed encryption, this field contains the encryption configuration for the database. For databases that are using Google default or other types of encryption, this field is empty.
encryption_info MutableSequence[google.cloud.spanner_admin_database_v1.types.EncryptionInfo]
Output only. For databases that are using customer managed encryption, this field contains the encryption information for the database, such as encryption state and the Cloud KMS key versions that are in use. For databases that are using Google default or other types of encryption, this field is empty. This field is propagated lazily from the backend. There might be a delay from when a key version is being used and when it appears in this field.
version_retention_period str
Output only. The period in which Cloud Spanner retains all versions of data for the database. This is the same as the value of version_retention_period database option set using UpdateDatabaseDdl][google.spanner.admin.database.v1.DatabaseAdmin.UpdateDatabaseDdl]. Defaults to 1 hour, if not set.
earliest_version_time google.protobuf.timestamp_pb2.Timestamp
Output only. Earliest timestamp at which older versions of the data can be read. This value is continuously updated by Cloud Spanner and becomes stale the moment it is queried. If you are using this value to recover data, make sure to account for the time from the moment when the value is queried to the moment when you initiate the recovery.
default_leader str
Output only. The read-write region which contains the database's leader replicas. This is the same as the value of default_leader database option set using DatabaseAdmin.CreateDatabase or DatabaseAdmin.UpdateDatabaseDdl. If not explicitly set, this is empty.
database_dialect google.cloud.spanner_admin_database_v1.types.DatabaseDialect
Output only. The dialect of the Cloud Spanner Database.

Classes

State

State(value)

Indicates the current state of the database.

Values: STATE_UNSPECIFIED (0): Not specified. CREATING (1): The database is still being created. Operations on the database may fail with FAILED_PRECONDITION in this state. READY (2): The database is fully created and ready for use. READY_OPTIMIZING (3): The database is fully created and ready for use, but is still being optimized for performance and cannot handle full load.

    In this state, the database still references the backup it
    was restore from, preventing the backup from being deleted.
    When optimizations are complete, the full performance of the
    database will be restored, and the database will transition
    to `READY` state.