Cloud Spanner Database Admin V1 API - Class Google::Cloud::Spanner::Admin::Database::V1::Database (v0.18.0)

Reference documentation and code samples for the Cloud Spanner Database Admin V1 API class Google::Cloud::Spanner::Admin::Database::V1::Database.

A Cloud Spanner database.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#create_time

def create_time() -> ::Google::Protobuf::Timestamp
Returns

#database_dialect

def database_dialect() -> ::Google::Cloud::Spanner::Admin::Database::V1::DatabaseDialect
Returns

#default_leader

def default_leader() -> ::String
Returns
  • (::String) — 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.

#earliest_version_time

def earliest_version_time() -> ::Google::Protobuf::Timestamp
Returns
  • (::Google::Protobuf::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.

#enable_drop_protection

def enable_drop_protection() -> ::Boolean
Returns
  • (::Boolean) — Whether drop protection is enabled for this database. Defaults to false, if not set.

#enable_drop_protection=

def enable_drop_protection=(value) -> ::Boolean
Parameter
  • value (::Boolean) — Whether drop protection is enabled for this database. Defaults to false, if not set.
Returns
  • (::Boolean) — Whether drop protection is enabled for this database. Defaults to false, if not set.

#encryption_config

def encryption_config() -> ::Google::Cloud::Spanner::Admin::Database::V1::EncryptionConfig
Returns

#encryption_info

def encryption_info() -> ::Array<::Google::Cloud::Spanner::Admin::Database::V1::EncryptionInfo>
Returns
  • (::Array<::Google::Cloud::Spanner::Admin::Database::V1::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.

#name

def name() -> ::String
Returns
  • (::String) — Required. The name of the database. Values are of the form projects/<project>/instances/<instance>/databases/<database>, where <database> is as specified in the CREATE DATABASE statement. This name can be passed to other API methods to identify the database.

#name=

def name=(value) -> ::String
Parameter
  • value (::String) — Required. The name of the database. Values are of the form projects/<project>/instances/<instance>/databases/<database>, where <database> is as specified in the CREATE DATABASE statement. This name can be passed to other API methods to identify the database.
Returns
  • (::String) — Required. The name of the database. Values are of the form projects/<project>/instances/<instance>/databases/<database>, where <database> is as specified in the CREATE DATABASE statement. This name can be passed to other API methods to identify the database.

#reconciling

def reconciling() -> ::Boolean
Returns
  • (::Boolean) — Output only. If true, the database is being updated. If false, there are no ongoing update operations for the database.

#restore_info

def restore_info() -> ::Google::Cloud::Spanner::Admin::Database::V1::RestoreInfo
Returns

#state

def state() -> ::Google::Cloud::Spanner::Admin::Database::V1::Database::State
Returns

#version_retention_period

def version_retention_period() -> ::String
Returns
  • (::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 version_retention_period database option set using UpdateDatabaseDdl. Defaults to 1 hour, if not set.