REST Resource: projects.instances.tables

Resource: Table

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

JSON representation
{
  "name": string,
  "clusterStates": {
    string: {
      object(ClusterState)
    },
    ...
  },
  "columnFamilies": {
    string: {
      object(ColumnFamily)
    },
    ...
  },
  "granularity": enum (TimestampGranularity),
  "restoreInfo": {
    object (RestoreInfo)
  }
}
Fields
name

string

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

clusterStates

map (key: string, value: object (ClusterState))

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, FULL

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

columnFamilies

map (key: string, value: object (ColumnFamily))

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

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

granularity

enum (TimestampGranularity)

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.

restoreInfo

object (RestoreInfo)

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.

TimestampGranularity

Possible timestamp granularities to use when keeping multiple versions of data in a table.

Enums
TIMESTAMP_GRANULARITY_UNSPECIFIED The user did not specify a granularity. Should not be returned. When specified during table creation, MILLIS will be used.
MILLIS The table keeps data versioned at a granularity of 1ms.

RestoreInfo

Information about a table restore.

JSON representation
{
  "sourceType": enum (RestoreSourceType),
  "backupInfo": {
    object (BackupInfo)
  }
}
Fields
sourceType

enum (RestoreSourceType)

The type of the restore source.

backupInfo

object (BackupInfo)

Information about the backup used to restore the table. The backup may no longer exist.

RestoreSourceType

Indicates the type of the restore source.

Enums
RESTORE_SOURCE_TYPE_UNSPECIFIED No restore associated.
BACKUP A backup was used as the source of the restore.

BackupInfo

Information about a backup.

JSON representation
{
  "backup": string,
  "startTime": string,
  "endTime": string,
  "sourceTable": string
}
Fields
backup

string

Output only. Name of the backup.

startTime

string (Timestamp format)

Output only. The time that the backup was started. Row data in the backup will be no older than this timestamp.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

endTime

string (Timestamp format)

Output only. This time that the backup was finished. Row data in the backup will be no newer than this timestamp.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

sourceTable

string

Output only. Name of the table the backup was created from.

Methods

checkConsistency

Checks replication consistency based on a consistency token, that is, if replication has caught up based on the conditions specified in the token and the check request.

create

Creates a new table in the specified instance.

delete

Permanently deletes a specified table and all of its data.

dropRowRange

Permanently drop/delete a row range from a specified table.

generateConsistencyToken

Generates a consistency token for a Table, which can be used in CheckConsistency to check whether mutations to the table that finished before this call started have been replicated.

get

Gets metadata information about the specified table.

getIamPolicy

Gets the access control policy for a Table resource.

list

Lists all tables served from a specified instance.

modifyColumnFamilies

Performs a series of column family modifications on the specified table.

restore

Create a new table by restoring from a completed backup.

setIamPolicy

Sets the access control policy on a Table resource.

testIamPermissions

Returns permissions that the caller has on the specified table resource.