Config File

To override the default configuration, you can mount your own config.json into the container using a Docker volume:

docker run -v $(pwd)/config.json:/app/config/config.json mikeamputer/ch-flow:latest

Partial config is acceptable.

Example

{
  "databaseConfigs": [
    {
      "name": "flow_test",
      "config": {
        "connectionSettings": {
          "url": "http://localhost:8123",
          "username": "developer",
          "password": "developer"
        },
        "targetDatabases": ["flow_test"],
        "presentationDatabase": "flow_test",
        "respectJoins": true
      }
    }
  ],
  "exportConfig": {
    "format": "PDF",
    "padding": 20
  },
  "canvasConfig": {
    "snapToGrid": true,
    "gridSize": 15,
    "backgroundColor": "#e0e0dc",
    "autoFitView": true
  },
  "materializedViewsConfig":
  {
    "renderMode": "AS_SELECT"
  }
}

Overview

databaseConfigs

An array of configurations for database connections.

• name: A unique logical name used to identify the config. This value will appear in the database selection dropdown.
• config
  • connectionSettings: Includes ClickHouse url, username, and password.
  • targetDatabases: An array of database names (each ClickHouse database is effectively a schema) to include in the flow chart.
  • presentationDatabase: The main database of the flow chart.
  • respectJoins: Treat joined tables as an additional data source when calculating edges.

exportConfig

• format: Export format, either "PDF" or "SVG".
• padding: Padding (in pixels) around the exported content.

canvasConfig

• snapToGrid: Enables or disables snapping elements to a grid.
• gridSize: Size of the snapping grid in pixels.
• backgroundColor: Hex color for canvas background (e.g., #e0e0dc).
• autoFitView: Fit view of flow chart on database selection.

materializedViewsConfig

• renderMode: Determines how a materialized view is displayed. Possible values:
  • ROWS — Display materialized view output as regular table rows stated in DDL (legacy behavior).
  • AS_SELECT — Display the materialized view using its SELECT query.
  • CREATE_COMMAND — Display the full CREATE statement.