ClickHouse

To add a database connection, click on the gear icon in the top right, and navigate to Admin settings > Databases > Add a database.

You can edit these settings at any time. Just remember to save your changes.

Connection and Sync

After connecting to a database, you’ll see the “Connection and sync” section that displays the current connection status and options to manage your database connection.

Here you can sync the database schema and rescan field values, and edit connection details.

Edit connection details

To access or modify your database connection settings, click the Edit connection details button.

Display name

The display name for the database in the Metabase interface.

Host

Your database’s IP address (e.g., 98.137.149.56) or its domain name (e.g., name.database.com).

Port

The database port (e.g., 8123).

Username

The database username for the account that you want to use to connect to your database. You can set up multiple connections to the same database using different user accounts to connect to the same database, each with different sets of privileges.

Password

The password for the username that you use to connect to the database.

Databases

Include all of the database you want to be able to query in Metabase. Separate databases with the space character, e.g., db1 db2 db3.

Scan all databases

Scan all tables from all available ClickHouse databases except the system ones.

Use a secure connection (SSL)

See SSL certificates.

Use an SSH-tunnel

If a direct connection to your database isn’t possible, you may want to use an SSH tunnel. See SSH tunneling.

Disable system wide proxy settings

System-wide proxy settings are disabled by default. You can disable them with this toggle.

ClickHouse settings (comma-separated)

Here you can add a string to specify additional ClickHouse settings. Separate settings with a comma, like so:

allow_experimental_analyzer=1,max_result_rows=100

Max open HTTP connections in the JDBC driver (default: 100)

You can limit the number of HTTP connections in the JDBC driver used to connect Metabase to ClickHouse.

Additional JDBC connection string options

You can append options to the JDBC connection string. Separate options with &, like so:

connection_timeout=1000&socket_timeout=300000

Re-run queries for simple explorations

Turn this option OFF if people want to click Run (the play button) before applying any Summarize or filter selections.

By default, Metabase will execute a query as soon as you choose an grouping option from the Summarize menu or a filter condition from the drill-through menu. If your database is slow, you may want to disable re-running to avoid loading data on each click.

Choose when syncs and scans happen

See syncs and scans.

Periodically refingerprint tables

Periodic refingerprinting will increase the load on your database.

Turn this option ON to scan a sample of values every time Metabase runs a sync.

A fingerprinting query examines the first 10,000 rows from each column and uses that data to guesstimate how many unique values each column has, what the minimum and maximum values are for numeric and timestamp columns, and so on. If you leave this option OFF, Metabase will only fingerprint your columns once during setup.

Model features

There aren’t (yet) any model features for ClickHouse.

Danger zone

See Danger zone.