Skip to content
/
Get table

Get table

Request

Shows a table according to specified database and table.

Security
ApiKeyAuth
Path
database_namestring(name)required

database name

Example:Alpha
table_namestring(name)required
Example:Bravo
Query
include_descriptionsboolean

When true, includes table descriptions and column descriptions in the schema field

Default:false
curl -i -X GET \
  'https://api.treasuredata.com/v3/table/show/Alpha/Bravo?include_descriptions=false' \
  -H 'Authorization: TD1 <YOUR_TOKEN_HERE>'

Responses

OK

Bodyapplication/json
idinteger(TableId)required
Example:11
countintegerrequired
Example:1000
counter_updated_at(string or null) or DateTimeISO8601 (string)required
Any of:
string or null
created_atstring(DateTimeAsString)\d{4}-\d{2}-\d{2}\s\d{2}:\d{2}:\d{2}\s(([+-]\...required

Datetime in custom format (2020-12-31 11:22:33 -0500 or 2020-12-31 11:22:33 UTC for UTC)

Example:"2020-12-31 11:22:33 UTC"
delete_protectedbooleanrequired
Example:true
estimated_storage_sizeintegerrequired
Example:1073741824
expire_daysinteger or nullrequired
Example:30
last_log_timestampinteger or nullrequired
Example:1356998400
namestringrequired
Example:"Bravo"
descriptionstring or null

user-provided description of the table

Example:"Click events."
schemastringrequired

JSON-encoded table schema. When include_descriptions=true, contains column descriptions in format [[name, type, alias, description], ...]

typestringrequired
Value:"log"
Example:"log"
updated_atstring(DateTimeAsString)\d{4}-\d{2}-\d{2}\s\d{2}:\d{2}:\d{2}\s(([+-]\...required

Datetime in custom format (2020-12-31 11:22:33 -0500 or 2020-12-31 11:22:33 UTC for UTC)

Example:"2020-12-31 11:22:33 UTC"
include_vbooleanrequireddeprecated

when true, Hive queries can access a virtual column "v" which contains a map of every data column's name to its value (represented as a string). Prefer to set a schema on the table instead of using "v".

Example:false
Response
{
  "id": 11,
  "count": 1000,
  "counter_updated_at": "string",
  "created_at": "2020-12-31 11:22:33 UTC",
  "delete_protected": true,
  "estimated_storage_size": 1073741824,
  "expire_days": 30,
  "include_v": false,
  "last_log_timestamp": 1356998400,
  "name": "Bravo",
  "description": "Click events.",
  "schema": "string",
  "type": "log",
  "updated_at": "2020-12-31 11:22:33 UTC"
}