ch-flow

Web service for visualizing ClickHouse data flows. Primarily designed for development environments, it helps developers quickly understand and explore data dependencies and transformation paths in their local or dev setups.

• Renders a directed acyclic graph of tables, views, and materialized views.
• Supports export to PDF and SVG formats
• Supports multiple database configurations

Note

This is an unofficial tool and is not affiliated with or endorsed by ClickHouse Inc.

"ClickHouse" is a registered trademark of ClickHouse Inc. — clickhouse.com

Quick Setup

bash:

docker run -d -p 3000:3000 \
  -e CHF_DB_URL="http://clickhouse:8123" \
  -e CHF_DB_USERNAME="developer" \
  -e CHF_DB_PASSWORD="developer" \
  -e CHF_DB_NAME="my_db" \
  mikeamputer/ch-flow:latest

PowerShell:

docker run -d -p 3000:3000 `
  -e CHF_DB_URL="http://clickhouse:8123" `
  -e CHF_DB_USERNAME="developer" `
  -e CHF_DB_PASSWORD="developer" `
  -e CHF_DB_NAME="my_db" `
  mikeamputer/ch-flow:latest

Docker Compose:

services:
  ch-flow:
    image: mikeamputer/ch-flow:latest
    environment:
      CHF_DB_URL: "http://clickhouse:8123"
      CHF_DB_USERNAME: "developer"
      CHF_DB_PASSWORD: "developer"
      CHF_DB_NAME: "my_db"
    ports:
      - "3000:3000"

You can customize behavior using environment variables or mounting a custom config file.

Image is also available at GHCR: ghcr.io/mikeamputer/ch-flow:latest

Demo

Try it instantly in your browser using GitHub Codespaces:

1. Click the link above to create a new Codespace
2. Wait a few minutes for the Codespace to initialize
3. Open Ports tab: Ctrl+Shift+P > View: Toggle Ports
4. Locate the forwarded port 3000 and open it in a new browser tab