SQL Workspace

CH-UI provides a ClickHouse-first SQL workspace with explorer, completions, and query tooling.

Query Features

• Run SQL with timeout control
• Format SQL
• Explain and query plan
• Stream large query execution
• Sample query helper
• Query profile endpoint

Schema Operations

From UI sheets and context menus:

• Create/drop database
• Create/drop table
• Select cluster and engine
• Select data types from ClickHouse data type catalog

Explorer Endpoints

• Databases
• Tables
• Columns
• Data types
• Clusters

Saved Queries

Save, duplicate, update, and delete SQL snippets for team reuse.

Practical API Calls

# Run query
curl -X POST http://localhost:3488/api/query/run \
  -H "Content-Type: application/json" \
  -H "Cookie: chui_session=..." \
  -d '{"query":"SELECT * FROM system.tables LIMIT 20"}'

# List databases
curl http://localhost:3488/api/query/databases \
  -H "Cookie: chui_session=..."

# Create database
curl -X POST http://localhost:3488/api/query/schema/database \
  -H "Content-Type: application/json" \
  -H "Cookie: chui_session=..." \
  -d '{"name":"analytics","if_not_exists":true}'

Safety Defaults

• Brain-generated exploratory SQL starts with LIMIT 100.
• Schema-mutating operations require admin-level role checks in API handlers.