ClickHouse

ClickHouse is a fast open-source column-oriented database management system that enables real-time analytical reporting using SQL. ClickHouse exposes multiple interfaces - an HTTP interface for SQL queries, native TCP, MySQL and PostgreSQL wire-compatible interfaces, and a gRPC interface - and the ClickHouse Cloud management plane offers a public OpenAPI-described REST API for provisioning and managing services, organizations, members, API keys, backups, and private endpoints.

6 APIs 0 Features

AnalyticsCloud DatabaseColumn-OrientedDatabaseOLAPOpen SourceReal-TimeSQL

APIs

ClickHouse HTTP Interface

HTTP interface (default port 8123, HTTPS 8443) for executing SQL queries against ClickHouse. Supports SELECT via GET, mutations via POST, multiple output formats (JSON, CSV, XML...

ClickHouse Cloud API

OpenAPI 3.1-described REST API for managing ClickHouse Cloud organizations, services, API keys, members, backups, private endpoints, and ClickHouse settings. Endpoints under /v1...

ClickHouse Native TCP Interface

Native binary TCP protocol used by ClickHouse client libraries for maximum throughput between client and server (default port 9000).

ClickHouse MySQL Interface

MySQL wire protocol compatibility allowing existing MySQL clients and BI tools to query ClickHouse without driver changes.

ClickHouse PostgreSQL Interface

PostgreSQL wire protocol compatibility for connecting psql, JDBC and other PostgreSQL clients to ClickHouse.

ClickHouse gRPC Interface

gRPC interface defined by clickhouse_grpc.proto for efficient binary communication.

Collections

ClickHouse HTTP Interface

OPEN

Pricing Plans

Clickhouse Plans Pricing

3 plans

PLANS

Rate Limits

Clickhouse Rate Limits

5 limits

RATE LIMITS

FinOps

Clickhouse Finops

FINOPS

Event Specifications

ClickHouse Kafka Table Engine (Consumer-Side Streaming)

AsyncAPI description of the documented streaming surface that ClickHouse offers through the Kafka table engine. ClickHouse itself does NOT publish a public WebSocket, Server-Sen...

ASYNCAPI

Semantic Vocabularies

Clickhouse Context

0 classes · 5 properties

JSON-LD

API Governance Rules

ClickHouse API Rules

9 rules · 4 errors 5 warnings

SPECTRAL

Resources

Sources

opencollection: 1.0.0
info:
  name: ClickHouse HTTP Interface
  version: 1.0.0
request:
  auth:
    type: basic
    username: '{{username}}'
    password: '{{password}}'
items:
- info:
    name: Health check or execute query
    type: http
  http:
    method: GET
    url: http://localhost:8123/
    params:
    - name: query
      value: ''
      type: query
      description: SQL statement to execute
    - name: database
      value: ''
      type: query
      description: Default database
    - name: default_format
      value: ''
      type: query
      description: Output format (TabSeparated, JSON, CSV, Pretty, etc.)
    - name: session_id
      value: ''
      type: query
    - name: session_timeout
      value: ''
      type: query
    - name: compress
      value: ''
      type: query
  docs: 'With no parameters returns "Ok." When a `query` parameter is supplied,

    executes the SQL statement and returns the result in the configured

    format.

    '
- info:
    name: Execute query or insert data
    type: http
  http:
    method: POST
    url: http://localhost:8123/
    params:
    - name: query
      value: ''
      type: query
      description: SQL statement to execute
    - name: database
      value: ''
      type: query
      description: Default database
    - name: default_format
      value: ''
      type: query
      description: Output format (TabSeparated, JSON, CSV, Pretty, etc.)
    - name: decompress
      value: ''
      type: query
  docs: 'Submit a SQL query in the request body, or stream data for INSERT with

    the partial query in the URL (e.g. `?query=INSERT INTO table FORMAT

    JSONEachRow`).

    '
- info:
    name: Ping the server
    type: http
  http:
    method: GET
    url: http://localhost:8123/ping
  docs: Returns "Ok." when the server is healthy.
- info:
    name: Get replica status
    type: http
  http:
    method: GET
    url: http://localhost:8123/replicas_status
  docs: Returns replica delay information across the cluster.
- info:
    name: Web UI
    type: http
  http:
    method: GET
    url: http://localhost:8123/play
  docs: Returns the embedded ClickHouse Play web UI.
bundled: true