Database

import type { Database } from "https://googleapis.deno.dev/v1/spanner:v1.ts";

A Cloud Spanner database.

interface Database {

readonly createTime?: Date;

readonly databaseDialect?: "DATABASE_DIALECT_UNSPECIFIED" | "GOOGLE_STANDARD_SQL" | "POSTGRESQL";

readonly defaultLeader?: string;

readonly earliestVersionTime?: Date;

enableDropProtection?: boolean;

readonly encryptionConfig?: EncryptionConfig;

readonly encryptionInfo?: EncryptionInfo[];

name?: string;

readonly reconciling?: boolean;

readonly restoreInfo?: RestoreInfo;

readonly state?:

| "STATE_UNSPECIFIED"

| "CREATING"

| "READY"

| "READY_OPTIMIZING";

readonly versionRetentionPeriod?: string;

}

§Properties

readonly createTime?: Date

[src]

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

readonly databaseDialect?: "DATABASE_DIALECT_UNSPECIFIED" | "GOOGLE_STANDARD_SQL" | "POSTGRESQL"

[src]

Output only. The dialect of the Cloud Spanner Database.

readonly defaultLeader?: string

[src]

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.

readonly earliestVersionTime?: Date

[src]

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.

enableDropProtection?: boolean

[src]

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.

readonly encryptionConfig?: EncryptionConfig

[src]

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.

readonly encryptionInfo?: EncryptionInfo[]

[src]

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.

name?: string

[src]

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.

readonly reconciling?: boolean

[src]

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

readonly restoreInfo?: RestoreInfo

[src]

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

readonly state?: "STATE_UNSPECIFIED" | "CREATING" | "READY" | "READY_OPTIMIZING"

[src]

Output only. The current database state.

readonly versionRetentionPeriod?: string

[src]

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.