Skip to main content

Explore Tables

This endpoint provides you basic information about your tables in ClickHouse.

Explore the ClickHouse tables

Note that "table" and "engine" are both optional parameters that are especially helpful when wanting to focus the query. When generalizing, we might as well not use them.

curl -X 'GET' \
'https://api.gigapipe.com/v1/clusters/<your_cluster_slug>/explore/tables?table=<your_table_name>&engine=<your_engine>' \
-H 'accept: application/json' \
-H 'Authorization: Bearer <your_access_token>'
# Payload response ::Dictionary
{
"database": "default",
"name": "downloads",
"engine": "Distributed",
"columns": [
{
"name": "date",
"type": "DateTime"
},
{
"name": "user_id",
"type": "UInt32"
},
{
"name": "bytes",
"type": "Float64"
}
],
"rows": 50330160
}

Parameters

Attributes


table_name  ::Optional[String]

The table you want to get the info from


engine  ::Optional[String]

The engine you want to get the info from


Response

Attributes


database  ::String

The database name


name  ::String

The table name which you requested details from


engine  ::Integer

The engine which you requested details from


columns  ::Dictionary

The database columns

name  ::String

The column name

type  ::String

The column type

The total space (in bytes)