string

Required. The name of the database. Values are of the formprojects/<project>/instances/<instance>/databases/<database>, where<database> is as specified in theCREATE DATABASE statement. This name can be passed to other API methods to identify the database.

enum (State)

Output only. The current database state.

string (Timestamp format)

Output only. If exists, the time at which the database creation started.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples:"2014-10-02T15:01:23Z","2014-10-02T15:01:23.045123456Z" or"2014-10-02T15:01:23+05:30".

object (RestoreInfo)

Output only. Applicable only for restored databases. Contains information about the restore source.

object (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.

object (EncryptionInfo)

Output only. For databases that are using customer managed encryption, this field contains the encryption information for the database, such as all Cloud KMS key versions that are in use. TheencryptionStatus field inside of eachEncryptionInfo is not populated.

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.

string

Output only. The period in which Cloud Spanner retains all versions of data for the database. This is the same as the value of versionRetentionPeriod database option set usingdatabases.updateDdl. Defaults to 1 hour, if not set.

string (Timestamp format)

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.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples:"2014-10-02T15:01:23Z","2014-10-02T15:01:23.045123456Z" or"2014-10-02T15:01:23+05:30".

string

Output only. The read-write region which contains the database's leader replicas.

This is the same as the value of defaultLeader database option set using DatabaseAdmin.CreateDatabase or DatabaseAdmin.UpdateDatabaseDdl. If not explicitly set, this is empty.

enum (DatabaseDialect)

Output only. The dialect of the Cloud Spanner Database.

boolean

Optional. Whether drop protection is enabled for this database. Defaults to false, if not set. For more details, please see how toprevent accidental database deletion.

boolean

Output only. If true, the database is being updated. If false, there are no ongoing update operations for the database.

object (QuorumInfo)

Output only. Applicable only for databases that use dual-region instance configurations. Contains information about the quorum.

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 toREADY state.

enum (RestoreSourceType)

The type of the restore source.

object (BackupInfo)

Information about the backup used to restore the database. The backup may no longer exist.

string

Name of the backup.

string (Timestamp format)

The backup contains an externally consistent copy ofsourceDatabase at the timestamp specified byversionTime. If thebackups.create request did not specifyversionTime, theversionTime of the backup is equivalent to thecreateTime.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples:"2014-10-02T15:01:23Z","2014-10-02T15:01:23.045123456Z" or"2014-10-02T15:01:23+05:30".

string (Timestamp format)

The time thebackups.create request was received.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples:"2014-10-02T15:01:23Z","2014-10-02T15:01:23.045123456Z" or"2014-10-02T15:01:23+05:30".

string

Name of the database the backup was created from.

string

The Cloud KMS key to be used for encrypting and decrypting the database. Values are of the formprojects/<project>/locations/<location>/keyRings/<key_ring>/cryptoKeys/<kmsKeyName>.

string

Specifies the KMS configuration for one or more keys used to encrypt the database. Values are of the formprojects/<project>/locations/<location>/keyRings/<key_ring>/cryptoKeys/<kmsKeyName>.

The keys referenced bykmsKeyNames must fully cover all regions of the database's instance configuration. Some examples:

• For regional (single-region) instance configurations, specify a regional location KMS key.
• For multi-region instance configurations of typeGOOGLE_MANAGED, either specify a multi-region location KMS key or multiple regional location KMS keys that cover all regions in the instance configuration.
• For an instance configuration of typeUSER_MANAGED, specify only regional location KMS keys to cover each region in the instance configuration. Multi-region location KMS keys aren't supported forUSER_MANAGED type instance configurations.

object (QuorumType)

Output only. The type of this quorum. SeeQuorumType for more information about quorum type specifications.

enum (Initiator)

Output only. Whether thisdatabases.changequorum is Google or User initiated.

string (Timestamp format)

Output only. The timestamp when the request was triggered.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples:"2014-10-02T15:01:23Z","2014-10-02T15:01:23.045123456Z" or"2014-10-02T15:01:23+05:30".

string

Output only. The etag is used for optimistic concurrency control as a way to help prevent simultaneousdatabases.changequorum requests that might create a race condition.

object (SingleRegionQuorum)

Single-region quorum type.

object (DualRegionQuorum)

Dual-region quorum type.

string

Required. The location of the serving region, for example, "us-central1". The location must be one of the regions within the dual-region instance configuration of your database. The list of valid locations is available using the [instanceConfigs.get][InstanceAdmin.GetInstanceConfig] API.

This should only be used if you plan to change quorum to the single-region quorum type.