public sealed class Database : IMessage<Database>, IEquatable<Database>, IDeepCloneable<Database>, IBufferMessage, IMessageReference documentation and code samples for the Google Cloud Spanner Database Administration v1 API class Database.
A Cloud Spanner database.
Namespace
Google.Cloud.Spanner.Admin.Database.V1Assembly
Google.Cloud.Spanner.Admin.Database.V1.dll
Constructors
Database()
public Database()Database(Database)
public Database(Database other)| Parameter | |
|---|---|
| Name | Description |
other | Database |
Properties
CreateTime
public Timestamp CreateTime { get; set; }Output only. If exists, the time at which the database creation started.
| Property Value | |
|---|---|
| Type | Description |
Timestamp | |
DatabaseDialect
public DatabaseDialect DatabaseDialect { get; set; }Output only. The dialect of the Cloud Spanner Database.
| Property Value | |
|---|---|
| Type | Description |
DatabaseDialect | |
DatabaseName
public DatabaseName DatabaseName { get; set; }Google.Cloud.Spanner.Common.V1.DatabaseName-typed view over the Name resource name property.
| Property Value | |
|---|---|
| Type | Description |
Google.Cloud.Spanner.Common.V1.DatabaseName | |
DefaultLeader
public string DefaultLeader { get; set; }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.
| Property Value | |
|---|---|
| Type | Description |
string | |
EarliestVersionTime
public Timestamp EarliestVersionTime { get; set; }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.
| Property Value | |
|---|---|
| Type | Description |
Timestamp | |
EnableDropProtection
public bool EnableDropProtection { get; set; }Whether drop protection is enabled for this database. Defaults to false, if not set.
| Property Value | |
|---|---|
| Type | Description |
bool | |
EncryptionConfig
public EncryptionConfig EncryptionConfig { get; set; }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.
| Property Value | |
|---|---|
| Type | Description |
EncryptionConfig | |
EncryptionInfo
public RepeatedField<EncryptionInfo> EncryptionInfo { get; }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.
| Property Value | |
|---|---|
| Type | Description |
RepeatedFieldEncryptionInfo | |
Name
public string Name { get; set; }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.
| Property Value | |
|---|---|
| Type | Description |
string | |
Reconciling
public bool Reconciling { get; set; }Output only. If true, the database is being updated. If false, there are no ongoing update operations for the database.
| Property Value | |
|---|---|
| Type | Description |
bool | |
RestoreInfo
public RestoreInfo RestoreInfo { get; set; }Output only. Applicable only for restored databases. Contains information about the restore source.
| Property Value | |
|---|---|
| Type | Description |
RestoreInfo | |
State
public Database.Types.State State { get; set; }Output only. The current database state.
| Property Value | |
|---|---|
| Type | Description |
DatabaseTypesState | |
VersionRetentionPeriod
public string VersionRetentionPeriod { get; set; }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.
| Property Value | |
|---|---|
| Type | Description |
string | |