Spanner Database

This table represents the Spanner Database resource from Google Cloud Platform.

gcp.spanner_database

Fields

TitleIDTypeData TypeDescription
_keycorestring
ancestorscorearray<string>
create_timecoretimestampOutput only. If exists, the time at which the database creation started.
database_dialectcorestringOutput only. The dialect of the Cloud Spanner Database. Possible values: ['DATABASE_DIALECT_UNSPECIFIED', 'GOOGLE_STANDARD_SQL', 'POSTGRESQL']. Values descriptions: ['Default value. This value will create a database with the GOOGLE_STANDARD_SQL dialect.', 'GoogleSQL supported SQL.', 'PostgreSQL supported SQL.']
datadog_display_namecorestring
default_leadercorestringOutput 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.
earliest_version_timecoretimestampOutput 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.
enable_drop_protectioncoreboolOptional. Whether drop protection is enabled for this database. Defaults to false, if not set. For more details, please see how to [prevent accidental database deletion](https://cloud.google.com/spanner/docs/prevent-database-deletion).
encryption_configcorejsonOutput 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_infocorejsonOutput 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. The `encryption_status` field inside of each `EncryptionInfo` 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.
labelscorearray<string>
namecorestringRequired. The name of the database. Values are of the form `projects//instances//databases/`, where `` is as specified in the `CREATE DATABASE` statement. This name can be passed to other API methods to identify the database.
organization_idcorestring
parentcorestring
project_idcorestring
project_numbercorestring
quorum_infocorejsonOutput only. Applicable only for databases that use dual-region instance configurations. Contains information about the quorum.
reconcilingcoreboolOutput only. If true, the database is being updated. If false, there are no ongoing update operations for the database.
resource_namecorestring
restore_infocorejsonOutput only. Applicable only for restored databases. Contains information about the restore source.
statecorestringOutput only. The current database state. Possible values: ['STATE_UNSPECIFIED', 'CREATING', 'READY', 'READY_OPTIMIZING']. Values descriptions: ['Not specified.', 'The database is still being created. Operations on the database may fail with `FAILED_PRECONDITION` in this state.', 'The database is fully created and ready for use.', '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.']
tagscorehstore
version_retention_periodcorestringOutput 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. Defaults to 1 hour, if not set.