Get table distribution

Access Control - Policies

Operations

Access Control - Permissions

Operations

Access Control - Users

Operations

Access Control - Policy Groups

Operations

Connections

Operations

Databases

Operations

Jobs

Operations

Tables

Operations

Get tables

Request

Retrieves a list of tables according to database specified.

Security

ApiKeyAuth

Path

database_namestringrequired

database name

Example: Alpha

curl -i -X GET \
  https://api.treasuredata.com/v3/table/list/Alpha \
  -H 'Authorization: TD1 <YOUR_TOKEN_HERE>'

Responses

OK

Bodyapplication/json

databasestringrequired

database name

Example: "Alpha"

tablesArray of objects(Table)required

tables[].idinteger(TableId)required

Example: 11

tables[].countintegerrequired

Example: 1000

tables[].counter_updated_at(string or null) or DateTimeISO8601 (string)required

Any of:

string or null

tables[].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"

tables[].delete_protectedbooleanrequired

Example: true

tables[].estimated_storage_sizeintegerrequired

Example: 1073741824

tables[].expire_daysinteger or nullrequired

Example: 30

tables[].include_vbooleanrequired

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

tables[].last_log_timestampinteger or nullrequired

Example: 1356998400

tables[].namestringrequired

Example: "Bravo"

tables[].schemastringrequired

tables[].typestringrequired

Value"log"

Example: "log"

tables[].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"

Response

application/json

{
  "database": "Alpha",
  "tables": [
    { … }
  ]
}

Get table

Request

Shows a table according to specified database and table.

Security

ApiKeyAuth

Path

database_namestringrequired

database name

Example: Alpha

table_namestringrequired

Example: Bravo

curl -i -X GET \
  https://api.treasuredata.com/v3/table/show/Alpha/Bravo \
  -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

include_vbooleanrequired

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

last_log_timestampinteger or nullrequired

Example: 1356998400

namestringrequired

Example: "Bravo"

schemastringrequired

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"

Response

application/json

{
  "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",
  "schema": "string",
  "type": "log",
  "updated_at": "2020-12-31 11:22:33 UTC"
}

Delete table

Request

Deletes specified table.

Security

ApiKeyAuth

Path

database_namestringrequired

database name

Example: Alpha

table_namestringrequired

Example: Bravo

curl -i -X POST \
  https://api.treasuredata.com/v3/table/delete/Alpha/Bravo \
  -H 'Authorization: TD1 <YOUR_TOKEN_HERE>'

Responses

OK

Bodyapplication/json

databasestringrequired

database name

Example: "Alpha"

tablestringrequired

Example: "Bravo"

typestringrequired

Value"log"

Example: "log"

Response

application/json

{
  "database": "Alpha",
  "table": "Bravo",
  "type": "log"
}

Create table

Request

Creates a table.

Security

ApiKeyAuth

Path

database_namestringrequired

database name

Example: Alpha

table_namestringrequired

Example: Bravo

Query

idempotent_keystring(IdempotentKey)

curl -i -X POST \
  'https://api.treasuredata.com/v3/table/create/Alpha/Bravo?idempotent_key=string' \
  -H 'Authorization: TD1 <YOUR_TOKEN_HERE>'

Responses

OK

Bodyapplication/json

databasestringrequired

database name

Example: "Alpha"

tablestringrequired

Example: "Bravo"

typestringrequired

Value"log"

Example: "log"

Response

application/json

{
  "database": "Alpha",
  "table": "Bravo",
  "type": "log"
}

Update table

Request

Updates a table.

Security

ApiKeyAuth

Path

database_namestringrequired

database name

Example: Alpha

table_namestringrequired

Example: Bravo

Bodyapplication/x-www-form-urlencoded

detect_schemaboolean

Example: true

expire_daysinteger or null

Example: 30

include_vboolean

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

namestring

Example: "Bravo"

schemastring

ignore_duplicate_schemaboolean

Example: true

overwriteboolean

whether to override a possible existing table in case of updating the name

Example: false

curl -i -X POST \
  https://api.treasuredata.com/v3/table/update/Alpha/Bravo \
  -H 'Authorization: TD1 <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/x-www-form-urlencoded' \
  -d detect_schema=true \
  -d expire_days=30 \
  -d include_v=false \
  -d name=Bravo \
  -d schema=string \
  -d ignore_duplicate_schema=true \
  -d overwrite=false

Responses

OK

Bodyapplication/json

databasestringrequired

database name

Example: "Alpha"

tablestringrequired

Example: "Bravo"

typestringrequired

Value"log"

Example: "log"

Response

application/json

{
  "database": "Alpha",
  "table": "Bravo",
  "type": "log"
}

Rename table

Request

Renames a specified table.

Security

ApiKeyAuth

Path

database_namestringrequired

database name

Example: Alpha

current_table_namestringrequired

Example: Bravo

new_table_namestringrequired

Example: Bravo

curl -i -X POST \
  https://api.treasuredata.com/v3/table/rename/Alpha/Bravo/Bravo \
  -H 'Authorization: TD1 <YOUR_TOKEN_HERE>'

Responses

OK

Bodyapplication/json

databasestringrequired

database name

Example: "Alpha"

tablestringrequired

Example: "Bravo"

typestringrequired

Value"log"

Example: "log"

Response

application/json

{
  "database": "Alpha",
  "table": "Bravo",
  "type": "log"
}

Swap tables

Request

Swaps specified tables.

Security

ApiKeyAuth

Path

database_namestringrequired

database name

Example: Alpha

table_name_1stringrequired

Example: Bravo

table_name_2stringrequired

Example: Bravo

curl -i -X POST \
  https://api.treasuredata.com/v3/table/swap/Alpha/Bravo/Bravo \
  -H 'Authorization: TD1 <YOUR_TOKEN_HERE>'

Responses

OK

Bodyapplication/json

databasestringrequired

database name

Example: "Alpha"

table1stringrequired

Example: "Bravo"

table2stringrequired

Example: "Bravo"

Response

application/json

{
  "database": "Alpha",
  "table1": "Bravo",
  "table2": "Bravo"
}

Tail table

Request

Shows the last record in a table.

Security

ApiKeyAuth

Path

database_namestringrequired

database name

Example: Alpha

table_namestringrequired

Example: Bravo

path_formatstringrequired

Enum"json""msgpack"

Query

formatstring

Enum"json""msgpack"

curl -i -X GET \
  'https://api.treasuredata.com/v3/table/tail/Alpha/Bravo{path_format}?format=json' \
  -H 'Authorization: TD1 <YOUR_TOKEN_HERE>'

Responses

OK

Body

Array [

Any of:

Can be any value, including null.

string or null

Can be any value, including null.

]

Response

[
  "string"
]

Get table distribution

Request

Retrieve a table distribution.

Security

ApiKeyAuth

Path

database_namestringrequired

database name

Example: Alpha

table_namestringrequired

Example: Bravo

curl -i -X GET \
  https://api.treasuredata.com/v3/table/distribution/Alpha/Bravo \
  -H 'Authorization: TD1 <YOUR_TOKEN_HERE>'

Responses

OK

Bodyapplication/json

bucket_countintegerrequired

Example: 50

partition_functionstringrequired

Example: "hash"

columnsArray of objects(ColumnSchema)required

columns[].keystringrequired

Example: "age"

columns[].typestringrequired

Example: "integer"

columns[].namestringrequired

Example: "age"

Response

application/json

{
  "bucket_count": 50,
  "partition_function": "hash",
  "columns": [
    { … }
  ]
}

Change database

Request

Changes to the specified table database.

Security

ApiKeyAuth

Path

database_namestringrequired

database name

Example: Alpha

table_namestringrequired

Example: Bravo

Bodyapplication/x-www-form-urlencoded

dest_database_namestringrequired

database name

Example: "Alpha"

curl -i -X POST \
  https://api.treasuredata.com/v3/table/change_database/Alpha/Bravo \
  -H 'Authorization: TD1 <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/x-www-form-urlencoded' \
  -d dest_database_name=Alpha

Responses

OK

Bodyapplication/json

databasestringrequired

database name

Example: "Alpha"

tablestringrequired

Example: "Bravo"

typestringrequired

Value"log"

Example: "log"

Response

application/json

{
  "database": "Alpha",
  "table": "Bravo",
  "type": "log"
}

Transfer table to a different account

Request

Transfer the specified table to a different account. (Limited Access)

Security

ApiKeyAuth

Path

database_namestringrequired

database name

Example: Alpha

table_namestringrequired

Example: Bravo

Headers

Secondary-Authorizationstring^TD1 [0-9a-f/]+$

TD1 Authorization Header

Example: TD1 123/456789xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

Bodyapplication/x-www-form-urlencoded

dest_database_namestringrequired

database name

Example: "Alpha"

dest_table_namestringrequired

Example: "Bravo"

idempotent_keystring(IdempotentKey)

curl -i -X POST \
  https://api.treasuredata.com/v3/table/transfer/Alpha/Bravo \
  -H 'Authorization: TD1 <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/x-www-form-urlencoded' \
  -H 'Secondary-Authorization: TD1 123/456789xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx' \
  -d dest_database_name=Alpha \
  -d dest_table_name=Bravo \
  -d idempotent_key=string

Responses

OK

Bodyapplication/json

database_namestring

table_namestring

Response

application/json

{
  "database_name": "string",
  "table_name": "string"
}

Append table schema

Request

Appends the specified table schema.

Security

ApiKeyAuth

Path

database_namestringrequired

database name

Example: Alpha

table_namestringrequired

Example: Bravo

Bodyapplication/x-www-form-urlencoded

schemaArray of TableSchemaAsArray (strings) or TableSchemaAsString (string)required

One of:

Array [

string

curl -i -X POST \
  https://api.treasuredata.com/v3/table/append-schema/Alpha/Bravo \
  -H 'Authorization: TD1 <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/x-www-form-urlencoded' \
  -d 'schema[0]=name' \
  -d 'schema[0]=string' \
  -d 'schema[0]=first_name' \
  -d 'schema[1]=creation_date' \
  -d 'schema[1]=long'

Responses

OK

Bodyapplication/json

databasestringrequired

database name

Example: "Alpha"

tablestringrequired

Example: "Bravo"

typestringrequired

Value"log"

Example: "log"

Response

application/json

{
  "database": "Alpha",
  "table": "Bravo",
  "type": "log"
}

Update table schema

Request

Updates the specified table schema.

Security

ApiKeyAuth

Path

database_namestringrequired

database name

Example: Alpha

table_namestringrequired

Example: Bravo

Bodyapplication/x-www-form-urlencoded

namestring

Example: "table1_new_name"

schemaArray of TableSchemaAsArray (strings) or TableSchemaAsString (string)required

One of:

Array [

string

ignore_duplicate_schemaboolean

Example: true

detect_schemaboolean

Example: true

include_vboolean

Example: true

expire_daysinteger

Example: 1

overwriteboolean

Example: true

curl -i -X POST \
  https://api.treasuredata.com/v3/table/update-schema/Alpha/Bravo \
  -H 'Authorization: TD1 <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/x-www-form-urlencoded' \
  -d name=table1_new_name \
  -d 'schema[0]=name' \
  -d 'schema[0]=string' \
  -d 'schema[0]=first_name' \
  -d 'schema[1]=creation_date' \
  -d 'schema[1]=long' \
  -d ignore_duplicate_schema=true \
  -d detect_schema=true \
  -d include_v=true \
  -d expire_days=1 \
  -d overwrite=true

Responses

OK

Bodyapplication/json

databasestringrequired

database name

Example: "Alpha"

tablestringrequired

Example: "Bravo"

typestringrequired

Value"log"

Example: "log"

Response

application/json

{
  "database": "Alpha",
  "table": "Bravo",
  "type": "log"
}

Create partial delete jobDeprecated

Request

Creates a partial delete job.

Security

ApiKeyAuth

Path

database_namestringrequired

database name

Example: Alpha

table_namestringrequired

Example: Bravo

Bodyapplication/x-www-form-urlencoded

domain_keystring(DomainKey)

Example: "domain_key_123"

fromTimestamp (integer) or DateTimeAsString (string) or DateTimeISO8601 (string)

Any of:

integer(Timestamp)

pool_namestring

Example: "pool_1"

toTimestamp (integer) or DateTimeAsString (string) or DateTimeISO8601 (string)

Any of:

integer(Timestamp)

curl -i -X POST \
  https://api.treasuredata.com/v3/table/partialdelete/Alpha/Bravo \
  -H 'Authorization: TD1 <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/x-www-form-urlencoded' \
  -d domain_key=domain_key_123 \
  -d from=1356998400 \
  -d pool_name=pool_1 \
  -d to=1356998400

Responses

OK

Bodyapplication/json

job_idinteger(JobId)required

unique identifier of job

Example: 19

databasestringrequired

database name

Example: "Alpha"

tablestringrequired

Example: "Bravo"

frominteger(Timestamp)required

Example: 1356998400

tointeger(Timestamp)required

Example: 1356998400

Response

application/json

{
  "job_id": 19,
  "database": "Alpha",
  "table": "Bravo",
  "from": 1356998400,
  "to": 1356998400
}

Policy Group Tags

Operations

Schedules

Operations

Users

Operations

Treasure Data API (3)

Access Control - Policies

Access Control - Permissions

Access Control - Users

Access Control - Policy Groups

Connections

Databases

Jobs

Tables

Get tables

Request

Responses

Was this helpful?

Get table

Request

Responses

Was this helpful?

Delete table

Request

Responses

Was this helpful?

Create table

Request

Responses

Was this helpful?

Update table

Request

Responses

Was this helpful?

Rename table

Request

Responses

Was this helpful?

Swap tables

Request

Responses

Was this helpful?

Tail table

Request

Responses

Was this helpful?

Get table distribution

Request

Responses

Was this helpful?

Change database

Request

Responses

Was this helpful?

Transfer table to a different account

Request

Responses

Was this helpful?

Append table schema

RequestExpand all

Responses

Was this helpful?

Update table schema

RequestExpand all

Responses

Was this helpful?

Create partial delete jobDeprecated

RequestExpand all

Responses

Was this helpful?

Policy Group Tags

Schedules

Users

Request

Request

Request