latestOpenAPI 3.0.12026-08-218193199.7 KB

a753ea35d9dd

Tables

Get table

Shows a table according to specified database and table.

get/table/show/{database_name}/{table_name}

Path parameters

database_nameName required— unresolved $ref
table_nameName required— unresolved $ref

Query parameters

include_descriptionsboolean

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

Response

OK

idinteger required
countinteger required
created_atstring required

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

delete_protectedboolean required
estimated_storage_sizeinteger required
expire_daysinteger nullable required
include_vboolean required

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".

last_log_timestampinteger nullable required
namestring required
descriptionstring nullable

user-provided description of the table

schemastring required

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

type'log' required
updated_atstring required

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

Example response

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