List
|
|||||
|
|
||||
Lists all tables in the specified dataset. Requires the READER dataset role
Authorization
To use this building block you will have to grant access to at least one of the following scopes:
- View and manage your data in Google BigQuery
- View and manage your data across Google Cloud Platform services
- View your data across Google Cloud Platform services
Input
This building block consumes 4 input parameters
| Name | Format | Description |
|---|---|---|
projectId Required |
STRING |
Project ID of the tables to list |
datasetId Required |
STRING |
Dataset ID of the tables to list |
pageToken |
STRING |
Page token, returned by a previous call, to request the next page of results |
maxResults |
INTEGER |
Maximum number of results to return |
= Parameter name
= Format
|
projectId STRING Required Project ID of the tables to list |
|
datasetId STRING Required Dataset ID of the tables to list |
|
pageToken STRING Page token, returned by a previous call, to request the next page of results |
|
maxResults INTEGER Maximum number of results to return |
Output
This building block provides 26 output parameters
| Name | Format | Description |
|---|---|---|
nextPageToken |
STRING |
A token to request the next page of results |
totalItems |
INTEGER |
The total number of tables in the dataset |
kind |
STRING |
The type of list |
tables[] |
OBJECT |
|
tables[].id |
STRING |
An opaque ID of the table |
tables[].expirationTime |
INTEGER |
[Optional] The time when this table expires, in milliseconds since the epoch. If not present, the table will persist indefinitely. Expired tables will be deleted and their storage reclaimed |
tables[].tableReference |
OBJECT |
|
tables[].tableReference.tableId |
STRING |
[Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters |
tables[].tableReference.projectId |
STRING |
[Required] The ID of the project containing this table |
tables[].tableReference.datasetId |
STRING |
[Required] The ID of the dataset containing this table |
tables[].friendlyName |
STRING |
The user-friendly name for this table |
tables[].timePartitioning |
OBJECT |
|
tables[].timePartitioning.field |
STRING |
[Beta] [Optional] If not set, the table is partitioned by pseudo column, referenced via either '_PARTITIONTIME' as TIMESTAMP type, or '_PARTITIONDATE' as DATE type. If field is specified, the table is instead partitioned by this field. The field must be a top-level TIMESTAMP or DATE field. Its mode must be NULLABLE or REQUIRED |
tables[].timePartitioning.expirationMs |
INTEGER |
[Optional] Number of milliseconds for which to keep the storage for partitions in the table. The storage in a partition will have an expiration time of its partition time plus this value |
tables[].timePartitioning.type |
STRING |
[Required] The only type supported is DAY, which will generate one partition per day |
tables[].timePartitioning.requirePartitionFilter |
BOOLEAN |
|
tables[].kind |
STRING |
The resource type |
tables[].view |
OBJECT |
Additional details for a view |
tables[].view.useLegacySql |
BOOLEAN |
True if view is defined in legacy SQL dialect, false if in standard SQL |
tables[].creationTime |
INTEGER |
The time when this table was created, in milliseconds since the epoch |
tables[].labels |
OBJECT |
The labels associated with this table. You can use these to organize and group your tables |
tables[].labels.customKey.value |
STRING |
The labels associated with this table. You can use these to organize and group your tables |
tables[].type |
STRING |
The type of table. Possible values are: TABLE, VIEW |
tables[].clustering |
OBJECT |
|
tables[].clustering.fields[] |
STRING |
|
etag |
STRING |
A hash of this page of results |
= Parameter name
= Format
|
nextPageToken STRING A token to request the next page of results |
|
totalItems INTEGER The total number of tables in the dataset |
|
kind STRING The type of list |
|
tables[] OBJECT |
|
tables[].id STRING An opaque ID of the table |
|
tables[].expirationTime INTEGER [Optional] The time when this table expires, in milliseconds since the epoch. If not present, the table will persist indefinitely. Expired tables will be deleted and their storage reclaimed |
|
tables[].tableReference OBJECT |
|
tables[].tableReference.tableId STRING [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters |
|
tables[].tableReference.projectId STRING [Required] The ID of the project containing this table |
|
tables[].tableReference.datasetId STRING [Required] The ID of the dataset containing this table |
|
tables[].friendlyName STRING The user-friendly name for this table |
|
tables[].timePartitioning OBJECT |
|
tables[].timePartitioning.field STRING [Beta] [Optional] If not set, the table is partitioned by pseudo column, referenced via either '_PARTITIONTIME' as TIMESTAMP type, or '_PARTITIONDATE' as DATE type. If field is specified, the table is instead partitioned by this field. The field must be a top-level TIMESTAMP or DATE field. Its mode must be NULLABLE or REQUIRED |
|
tables[].timePartitioning.expirationMs INTEGER [Optional] Number of milliseconds for which to keep the storage for partitions in the table. The storage in a partition will have an expiration time of its partition time plus this value |
|
tables[].timePartitioning.type STRING [Required] The only type supported is DAY, which will generate one partition per day |
|
tables[].timePartitioning.requirePartitionFilter BOOLEAN |
|
tables[].kind STRING The resource type |
|
tables[].view OBJECT Additional details for a view |
|
tables[].view.useLegacySql BOOLEAN True if view is defined in legacy SQL dialect, false if in standard SQL |
|
tables[].creationTime INTEGER The time when this table was created, in milliseconds since the epoch |
|
tables[].labels OBJECT The labels associated with this table. You can use these to organize and group your tables |
|
tables[].labels.customKey.value STRING The labels associated with this table. You can use these to organize and group your tables |
|
tables[].type STRING The type of table. Possible values are: TABLE, VIEW |
|
tables[].clustering OBJECT |
|
tables[].clustering.fields[] STRING |
|
etag STRING A hash of this page of results |