- 1.104.0 (latest)
- 1.103.0
- 1.102.0
- 1.101.0
- 1.100.0
- 1.98.0
- 1.97.0
- 1.96.0
- 1.95.0
- 1.94.0
- 1.93.1
- 1.92.1
- 1.91.0
- 1.90.0
- 1.89.0
- 1.88.0
- 1.87.0
- 1.86.0
- 1.85.0
- 1.84.0
- 1.83.0
- 1.82.0
- 1.81.0
- 1.80.0
- 1.79.0
- 1.78.0
- 1.77.0
- 1.76.1
- 1.68.0
- 1.67.0
- 1.66.0
- 1.65.0
- 1.64.0
- 1.63.2
- 1.62.1
- 1.61.0
- 1.60.0
- 1.59.0
- 1.58.4
- 1.57.0
- 1.56.0
- 1.55.0
- 1.54.2
Reference documentation and code samples for the Cloud Spanner V1 Client class Database.
A Cloud Spanner database.
Generated from protobuf message google.spanner.admin.database.v1.Database
Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ name
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.
↳ state
int
Output only. The current database state.
↳ create_time
↳ restore_info
Google\Cloud\Spanner\Admin\Database\V1\RestoreInfo
Output only. Applicable only for restored databases. Contains information about the restore source.
↳ encryption_config
Google\Cloud\Spanner\Admin\Database\V1\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
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.
↳ version_retention_period
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.
↳ earliest_version_time
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.
↳ default_leader
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.
↳ database_dialect
int
Output only. The dialect of the Cloud Spanner Database.
↳ enable_drop_protection
bool
Whether drop protection is enabled for this database. Defaults to false, if not set.
↳ reconciling
bool
Output only. If true, the database is being updated. If false, there are no ongoing update operations for the database.
getName
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.
string
setName
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.
var
string
$this
getState
Output only. The current database state.
int
setState
Output only. The current database state.
var
int
$this
getCreateTime
Output only. If exists, the time at which the database creation started.
hasCreateTime
clearCreateTime
setCreateTime
Output only. If exists, the time at which the database creation started.
$this
getRestoreInfo
Output only. Applicable only for restored databases. Contains information about the restore source.
hasRestoreInfo
clearRestoreInfo
setRestoreInfo
Output only. Applicable only for restored databases. Contains information about the restore source.
$this
getEncryptionConfig
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.
hasEncryptionConfig
clearEncryptionConfig
setEncryptionConfig
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.
$this
getEncryptionInfo
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.
setEncryptionInfo
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.
$this
getVersionRetentionPeriod
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.
string
setVersionRetentionPeriod
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.
var
string
$this
getEarliestVersionTime
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.
hasEarliestVersionTime
clearEarliestVersionTime
setEarliestVersionTime
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.
$this
getDefaultLeader
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.
string
setDefaultLeader
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.
var
string
$this
getDatabaseDialect
Output only. The dialect of the Cloud Spanner Database.
int
setDatabaseDialect
Output only. The dialect of the Cloud Spanner Database.
var
int
$this
getEnableDropProtection
Whether drop protection is enabled for this database. Defaults to false, if not set.
bool
setEnableDropProtection
Whether drop protection is enabled for this database. Defaults to false, if not set.
var
bool
$this
getReconciling
Output only. If true, the database is being updated. If false, there are no ongoing update operations for the database.
bool
setReconciling
Output only. If true, the database is being updated. If false, there are no ongoing update operations for the database.
var
bool
$this
