clickhouse-list-databases Tool
A “clickhouse-list-databases” tool lists all databases in a ClickHouse instance.
less than a minute
About
A clickhouse-list-databases tool lists all available databases in a ClickHouse
instance.
This tool executes the SHOW DATABASES command and returns a list of all
databases accessible to the configured user, making it useful for database
discovery and exploration tasks.
Compatible Sources
This tool can be used with the following database sources:
| Source Name |
|---|
| ClickHouse Source |
Example
kind: tools
name: list_clickhouse_databases
type: clickhouse-list-databases
source: my-clickhouse-instance
description: List all available databases in the ClickHouse instance
Output Format
The tool returns an array of objects, where each object contains:
name: The name of the database
Example response:
[
{"name": "default"},
{"name": "system"},
{"name": "analytics"},
{"name": "user_data"}
]
Reference
| field | type | required | description |
|---|---|---|---|
| type | string | true | Must be “clickhouse-list-databases”. |
| source | string | true | Name of the ClickHouse source to list databases from. |
| description | string | true | Description of the tool that is passed to the LLM. |
| authRequired | array of string | false | Authentication services required to use this tool. |
| parameters | array of Parameter | false | Parameters for the tool (typically not used). |
Feedback
Was this page helpful?
Glad to hear it! Please tell us how we can improve.
Sorry to hear that. Please tell us how we can improve.