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 ( |
Fields | |
---|---|
name |
The unique name of the table. Values are of the form |
clusterStates |
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 An object containing a list of |
columnFamilies |
The column families configured for this table, mapped by column family ID. Views: An object containing a list of |
granularity |
Immutable. The granularity (i.e. |
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. |
changeStreamConfig |
If specified, enable the change stream on this table. Otherwise, the change stream is disabled and the change stream is not retained. |
deletionProtection |
Set to true to make the table protected against data loss. i.e. deleting the following resources through Admin APIs are prohibited:
Note one can still delete the data stored in the table through Data APIs. |
stats |
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. |
ClusterState
The state of a table's data in a particular cluster.
JSON representation |
---|
{ "replicationState": enum ( |
Fields | |
---|---|
replicationState |
Output only. The state of replication for the table in this cluster. |
encryptionInfo[] |
Output only. The encryption information for the table in this cluster. If the encryption key protecting this resource is customer managed, then its version can be rotated in Cloud Key Management Service (Cloud KMS). The primary version of the key and its status will be reflected here when changes propagate from Cloud KMS. |
ReplicationState
Table replication states.
Enums | |
---|---|
STATE_NOT_KNOWN |
The replication state of the table is unknown in this cluster. |
INITIALIZING |
The cluster was recently created, and the table must finish copying over pre-existing data from other clusters before it can begin receiving live replication updates and serving Data API requests. |
PLANNED_MAINTENANCE |
The table is temporarily unable to serve Data API requests from this cluster due to planned internal maintenance. |
UNPLANNED_MAINTENANCE |
The table is temporarily unable to serve Data API requests from this cluster due to unplanned or emergency maintenance. |
READY |
The table can serve Data API requests from this cluster. Depending on replication delay, reads may not immediately reflect the state of the table in other clusters. |
READY_OPTIMIZING |
The table is fully created and ready for use after a restore, and is being optimized for performance. When optimizations are complete, the table will transition to READY state. |
ColumnFamily
A set of columns within a table which share a common configuration.
JSON representation |
---|
{ "gcRule": { object ( |
Fields | |
---|---|
gcRule |
Garbage collection rule specified as a protobuf. Must serialize to at most 500 bytes. NOTE: Garbage collection executes opportunistically in the background, and so it's possible for reads to return a cell even if it matches the active GC expression for its family. |
stats |
Output only. Only available with STATS_VIEW, this includes summary statistics about column family contents. For statistics over an entire table, see TableStats above. |
GcRule
Rule for determining which cells to delete during garbage collection.
JSON representation |
---|
{ // Union field |
Fields | |
---|---|
Union field rule . Garbage collection rules. rule can be only one of the following: |
|
maxNumVersions |
Delete all cells in a column except the most recent N. |
maxAge |
Delete cells in a column older than the given age. Values must be at least one millisecond, and will be truncated to microsecond granularity. A duration in seconds with up to nine fractional digits, ending with ' |
intersection |
Delete cells that would be deleted by every nested rule. |
union |
Delete cells that would be deleted by any nested rule. |
Intersection
A GcRule which deletes cells matching all of the given rules.
JSON representation |
---|
{
"rules": [
{
object ( |
Fields | |
---|---|
rules[] |
Only delete cells which would be deleted by every element of |
Union
A GcRule which deletes cells matching any of the given rules.
JSON representation |
---|
{
"rules": [
{
object ( |
Fields | |
---|---|
rules[] |
Delete cells which would be deleted by any element of |
ColumnFamilyStats
Approximate statistics related to a single column family within a table. This information may change rapidly, interpreting these values at a point in time may already preset out-of-date information.
Everything below is approximate, unless otherwise specified.
JSON representation |
---|
{ "averageColumnsPerRow": number, "averageCellsPerColumn": number, "logicalDataBytes": string } |
Fields | |
---|---|
averageColumnsPerRow |
How many column qualifiers are present in this column family, averaged over all rows in the table. e.g. For column family "family" in a table with 3 rows:
would report (1 + 2 + 0)/3 = 1.5 in this field. |
averageCellsPerColumn |
How many cells are present per column qualifier in this column family, averaged over all rows containing any column in the column family. e.g. For column family "family" in a table with 3 rows:
would report (3 + 8 + 0)/(1 + 2 + 0) = 3.66 in this field. |
logicalDataBytes |
How much space the data in the column family occupies. This is roughly how many bytes would be needed to read the contents of the entire column family (e.g. by streaming all contents out). |
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 ( |
Fields | |
---|---|
sourceType |
The type of the restore source. |
Union field source_info . Information about the source used to restore the table. source_info can be only one of the following: |
|
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, "sourceBackup": string } |
Fields | |
---|---|
backup |
Output only. Name of the backup. |
startTime |
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: |
endTime |
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: |
sourceTable |
Output only. Name of the table the backup was created from. |
sourceBackup |
Output only. Name of the backup from which this backup was copied. If a backup is not created by copying a backup, this field will be empty. Values are of the form: projects/ |
ChangeStreamConfig
Change stream configuration.
JSON representation |
---|
{ "retentionPeriod": string } |
Fields | |
---|---|
retentionPeriod |
How long the change stream should be retained. Change stream data older than the retention period will not be returned when reading the change stream from the table. Values must be at least 1 day and at most 7 days, and will be truncated to microsecond granularity. A duration in seconds with up to nine fractional digits, ending with ' |
TableStats
Approximate statistics related to a table.
These statistics are calculated infrequently, while simultaneously, data in the table can change rapidly. Thus the values reported here (e.g. row count) are very likely out-of date, even the instant they are received in this API. Thus, only treat these values as approximate.
IMPORTANT: Everything below is approximate, unless otherwise specified.
JSON representation |
---|
{ "rowCount": string, "averageColumnsPerRow": number, "averageCellsPerColumn": number, "logicalDataBytes": string } |
Fields | |
---|---|
rowCount |
How many rows are in the table. |
averageColumnsPerRow |
How many (column family, column qualifier) combinations are present per row in the table, averaged over all rows in the table. e.g. A table with 2 rows:
would report (2 + 3)/2 = 2.5 in this field. |
averageCellsPerColumn |
How many cells are present per column (column family, column qualifier) combinations, averaged over all columns in all rows in the table. e.g. A table with 2 rows:
would report (4 + 15)/(2 + 3) = 3.8 in this field. |
logicalDataBytes |
This is roughly how many bytes would be needed to read the entire table (e.g. by streaming all contents out). |
Methods |
|
---|---|
|
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. |
|
Creates a new table in the specified instance. |
|
Permanently deletes a specified table and all of its data. |
|
Permanently drop/delete a row range from a specified table. |
|
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. |
|
Gets metadata information about the specified table. |
|
Gets the access control policy for a Table or Backup resource. |
|
Lists all tables served from a specified instance. |
|
Performs a series of column family modifications on the specified table. |
|
Updates a specified table. |
|
Create a new table by restoring from a completed backup. |
|
Sets the access control policy on a Table or Backup resource. |
|
Returns permissions that the caller has on the specified Table or Backup resource. |
|
Restores a specified table which was accidentally deleted. |