Table

import type { Table } from "https://googleapis.deno.dev/v1/bigtableadmin:v2.ts";

A collection of user data indexed by row, column, and timestamp. Each table is served using the resources of its parent cluster.

interface Table {

automatedBackupPolicy?: AutomatedBackupPolicy;

changeStreamConfig?: ChangeStreamConfig;

readonly clusterStates?: {

[key: string]: ClusterState;

};

columnFamilies?: {

[key: string]: ColumnFamily;

};

deletionProtection?: boolean;

granularity?: "TIMESTAMP_GRANULARITY_UNSPECIFIED" | "MILLIS";

name?: string;

readonly restoreInfo?: RestoreInfo;

readonly stats?: TableStats;

}

§Properties

automatedBackupPolicy?: AutomatedBackupPolicy

[src]

If specified, automated backups are enabled for this table. Otherwise, automated backups are disabled.

changeStreamConfig?: ChangeStreamConfig

[src]

If specified, enable the change stream on this table. Otherwise, the change stream is disabled and the change stream is not retained.

readonly clusterStates?: {

[key: string]: ClusterState;

}

[src]

Output only. Map from cluster ID to per-cluster table state. If it could not be determined whether or not the table has data in a particular cluster (for example, if its zone is unavailable), then there will be an entry for the cluster with UNKNOWN replication_status. Views: REPLICATION_VIEW, ENCRYPTION_VIEW, FULL

columnFamilies?: {

[key: string]: ColumnFamily;

}

[src]

The column families configured for this table, mapped by column family ID. Views: SCHEMA_VIEW, STATS_VIEW, FULL

deletionProtection?: boolean

[src]

Set to true to make the table protected against data loss. i.e. deleting the following resources through Admin APIs are prohibited: * The table. * The column families in the table. * The instance containing the table. Note one can still delete the data stored in the table through Data APIs.

granularity?: "TIMESTAMP_GRANULARITY_UNSPECIFIED" | "MILLIS"

[src]

Immutable. The granularity (i.e. MILLIS) at which timestamps are stored in this table. Timestamps not matching the granularity will be rejected. If unspecified at creation time, the value will be set to MILLIS. Views: SCHEMA_VIEW, FULL.

name?: string

[src]

The unique name of the table. Values are of the form projects/{project}/instances/{instance}/tables/_a-zA-Z0-9*. Views: NAME_ONLY, SCHEMA_VIEW, REPLICATION_VIEW, STATS_VIEW, FULL

readonly restoreInfo?: RestoreInfo

[src]

Output only. If this table was restored from another data source (e.g. a backup), this field will be populated with information about the restore.

readonly stats?: TableStats

[src]

Output only. Only available with STATS_VIEW, this includes summary statistics about the entire table contents. For statistics about a specific column family, see ColumnFamilyStats in the mapped ColumnFamily collection above.