tables

Get table detail

Changed on

Returns detailed table state, including per-node table metadata.

get/tables/{database}/{table}

Request

  • Base URL: /api/v1 (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/v1/tables/{database}/{table}
  • Auth: none declared

Path parameters

databasestring required
Example:movoor_dev

ClickHouse database name.

tablestring required
Example:test_generic_network_month_local

ClickHouse table name.

Response

Table detail.

Example response

{
  "collection": {
    "warnings": [
      {
        "code": "node_unreachable",
        "message": "clickhouse-shard2-replica2 did not respond before timeout",
        "nodeId": "shard2-replica2"
      }
    ]
  },
  "item": {
    "activeParts": "104",
    "rows": "104",
    "bytesOnDisk": "104",
    "nodes": [
      {
        "activeParts": "104",
        "rows": "104",
        "bytesOnDisk": "104",
        "replica": {
          "queueSize": "104",
          "absoluteDelaySeconds": "104",
          "totalReplicas": "104",
          "activeReplicas": "104"
        }
      }
    ],
    "conditions": [
      {
        "code": "replica_disk_mismatch"
      }
    ]
  }
}

Changes

    • breaking

      response property item/allOf[TableBase]/versionColumn list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      response property item/allOf[subschema #2]/maxPartition list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      response property item/allOf[subschema #2]/minPartition list-of-types was widened by adding types null to media type application/json of response 200

    • info

      endpoint added