Class Database

A Cloud Spanner database.

Inheritance

object

Database

Implements

IDirectResponseSchema

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Google.Apis.Spanner.v1.Data

Assembly: Google.Apis.Spanner.v1.dll

Syntax

public class Database : IDirectResponseSchema

Properties

CreateTime

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

Declaration

[JsonProperty("createTime")]
public virtual object CreateTime { get; set; }

Property Value

Type	Description
object

DatabaseDialect

Output only. The dialect of the Cloud Spanner Database.

Declaration

[JsonProperty("databaseDialect")]
public virtual string DatabaseDialect { get; set; }

Property Value

Type	Description
string

DefaultLeader

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.

Declaration

[JsonProperty("defaultLeader")]
public virtual string DefaultLeader { get; set; }

Property Value

Type	Description
string

EarliestVersionTime

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.

Declaration

[JsonProperty("earliestVersionTime")]
public virtual object EarliestVersionTime { get; set; }

Property Value

Type	Description
object

EnableDropProtection

Whether drop protection is enabled for this database. Defaults to false, if not set.

Declaration

[JsonProperty("enableDropProtection")]
public virtual bool? EnableDropProtection { get; set; }

Property Value

Type	Description
bool?

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.

Declaration

[JsonProperty("encryptionConfig")]
public virtual EncryptionConfig EncryptionConfig { get; set; }

Property Value

Type	Description
EncryptionConfig

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

Declaration

[JsonProperty("encryptionInfo")]
public virtual IList<EncryptionInfo> EncryptionInfo { get; set; }

Property Value

Type	Description
IList<EncryptionInfo>

ETag

The ETag of the item.

Declaration

public virtual string ETag { get; set; }

Property Value

Type	Description
string

Name

Required. 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.

Declaration

[JsonProperty("name")]
public virtual string Name { get; set; }

Property Value

Type	Description
string

Reconciling

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

Declaration

[JsonProperty("reconciling")]
public virtual bool? Reconciling { get; set; }

Property Value

Type	Description
bool?

RestoreInfo

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

Declaration

[JsonProperty("restoreInfo")]
public virtual RestoreInfo RestoreInfo { get; set; }

Property Value

Type	Description
RestoreInfo

State

Output only. The current database state.

Declaration

[JsonProperty("state")]
public virtual string State { get; set; }

Property Value

Type	Description
string

VersionRetentionPeriod

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.

Declaration

[JsonProperty("versionRetentionPeriod")]
public virtual string VersionRetentionPeriod { get; set; }

Property Value

Type	Description
string

Implements

IDirectResponseSchema