Skip to content

Commit f60e02c

Browse files
committed
doc: update README.md
1 parent 26fe64e commit f60e02c

File tree

1 file changed

+17
-16
lines changed

1 file changed

+17
-16
lines changed

README.md

Lines changed: 17 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -183,22 +183,9 @@ CLICKHOUSE_PASSWORD=clickhouse
183183

184184
The following environment variables are used to configure the ClickHouse and chDB connections:
185185

186-
#### chDB Variables
187-
188-
* `CHDB_ENABLED`: Enable/disable chDB functionality
189-
* Default: `"false"`
190-
* Set to `"true"` to enable chDB tools
191-
* `CHDB_DATA_PATH`: The path to the chDB data directory
192-
* Required when `CHDB_ENABLED=true`
193-
* Use `:memory:` for in-memory database (recommended for testing)
194-
* Use a file path for persistent storage (e.g., `/path/to/chdb/data`)
195-
* `CLICKHOUSE_ENABLED`: Enable/disable ClickHouse functionality
196-
* Default: `"true"`
197-
* Set to `"false"` to disable ClickHouse tools when using chDB only
198-
199186
#### ClickHouse Variables
200187

201-
#### Required Variables
188+
##### Required Variables
202189

203190
* `CLICKHOUSE_HOST`: The hostname of your ClickHouse server
204191
* `CLICKHOUSE_USER`: The username for authentication
@@ -207,7 +194,7 @@ The following environment variables are used to configure the ClickHouse and chD
207194
> [!CAUTION]
208195
> It is important to treat your MCP database user as you would any external client connecting to your database, granting only the minimum necessary privileges required for its operation. The use of default or administrative users should be strictly avoided at all times.
209196
210-
#### Optional Variables
197+
##### Optional Variables
211198

212199
* `CLICKHOUSE_PORT`: The port number of your ClickHouse server
213200
* Default: `8443` if HTTPS is enabled, `8123` if disabled
@@ -228,6 +215,19 @@ The following environment variables are used to configure the ClickHouse and chD
228215
* Default: None (uses server default)
229216
* Set this to automatically connect to a specific database
230217

218+
#### chDB Variables
219+
220+
* `CHDB_ENABLED`: Enable/disable chDB functionality
221+
* Default: `"false"`
222+
* Set to `"true"` to enable chDB tools
223+
* `CHDB_DATA_PATH`: The path to the chDB data directory
224+
* Required when `CHDB_ENABLED=true`
225+
* Use `:memory:` for in-memory database (recommended for testing)
226+
* Use a file path for persistent storage (e.g., `/path/to/chdb/data`)
227+
* `CLICKHOUSE_ENABLED`: Enable/disable ClickHouse functionality
228+
* Default: `"true"`
229+
* Set to `"false"` to disable ClickHouse tools when using chDB only
230+
231231
#### Example Configurations
232232

233233
For local development with Docker:
@@ -316,7 +316,8 @@ uv sync --all-extras --dev # install dev dependencies
316316
uv run ruff check . # run linting
317317

318318
docker compose up -d test_services # start ClickHouse
319-
uv run pytest tests
319+
uv run pytest tests/test_tool.py # ClickHouse only
320+
uv run pytest tests/test_chdb_tool.py # chDB only
320321
```
321322

322323
## YouTube Overview

0 commit comments

Comments
 (0)