tables

List table columns

Changed on

Returns schema detail per node because schema drift can occur during failed or partial DDL.

get/tables/{database}/{table}/columns

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}/columns
  • Auth: none declared

Path parameters

databasestring required
Example:movoor_dev

ClickHouse database name.

tablestring required
Example:test_generic_network_month_local

ClickHouse table name.

Query parameters

nodeIdstring
Example:shard1-replica1

Filter by movoor configured node id.

kindstring
Example:ordinary

Filter columns by ClickHouse column kind. Known values include ordinary, materialized, alias, default, and ephemeral. This is an open string.

namestring
Example:event_date

Filter by object name.

Response

Column definitions by node.

databasestring required
tablestring required

Example response

{
  "collection": {
    "warnings": [
      {
        "code": "node_unreachable",
        "message": "clickhouse-shard2-replica2 did not respond before timeout",
        "nodeId": "shard2-replica2"
      }
    ]
  },
  "items": [
    {
      "nodeId": "shard1-replica1",
      "shard": "shard1",
      "replica": "replica1",
      "conditions": [
        {
          "code": "replica_disk_mismatch"
        }
      ]
    }
  ],
  "conditions": [
    {
      "code": "replica_disk_mismatch"
    }
  ]
}

Changes

    • breaking

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

    • breaking

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

    • breaking

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

    • breaking

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

    • info

      endpoint added