mgilbir / metabase-clickhouse-driver

Metabase driver for the ClickHouse database

metabase-clickhouse-driver

ClickHouse (github) database driver for the Metabase (github) business intelligence front-end

Installation

Download Metabase Jar and Run

1. Download a fairly recent Metabase binary release (jar file) from the Metabase distribution page.
2. Download the ClickHouse driver jar from this repository's "Releases" page
3. Create a directory and copy the metabase.jar to it.
4. In that directory create a sub-directory called plugins.
5. Copy the ClickHouse driver jar to the plugins directory.
6. Make sure you are the in the directory where your metabase.jar lives.
7. Run MB_PLUGINS_DIR=./plugins; java -jar metabase.jar.

Choosing the Right Version

Metabase Release	Driver Version
0.33.x	0.6
0.34.x	0.7.0
0.35.x	0.7.1
0.37.3	0.7.3
0.38.1+	0.7.5

Building from Source

Please refer to the extensive documentation available in the Metabase Wiki: Writing A Driver

1. Clone metabase repository
2. Clone this repository, and follow the instructions for building the driver. Alternatively, download a pre-release jar.
3. Copy clickhouse.metabase-driver.jar into your Metabase plugins directory
4. Start Metabase, e.g. by invoking lein run in your Metabase directory.

If you want to develop simply create a symbolic link from the Metabase modules/drivers directory to the root of the driver directory.

Do the Docker Dance

Mount plugins directory

This is the recommended way, according to the fine manual:

  docker run -d -p 3000:3000 \
  --mount type=bind,source=/path/to/plugins,destination=/plugins \
  --name metabase metabase/metabase

Roll your own

In an empty directory, create your Dockerfile, e.g. Dockerfile-clickhouse

FROM metabase/metabase:latest
ADD https://github.com/enqueue/metabase-clickhouse-driver/releases/download/0.7.5/clickhouse.metabase-driver.jar /plugins/
RUN chmod 744 /plugins/clickhouse.metabase-driver.jar

Assemble

docker build -f Dockerfile-clickhouse -t foo/metabase-with-clickhouse .

Run

docker run --rm -d=false -p 3000:3000 --name metabase foo/metabase-with-clickhouse

Please refer to the fine Metabase operations manual to find out how to operate a dockerized Metabase with a regular database.

Operations

The driver should work fine for many use cases. Please consider the following items when running a Metabase instance with this driver:

• Create a dedicated user for Metabase, whose profile has readonly set to 2.
• Consider running the Metabase instance in the same time zone as your ClickHouse database; the more time zones involved the more issues.
• Compare the results of the queries with the results returned by clickhouse-client.
• Metabase is a good tool for organizing questions, dashboards etc. and to give non-technical users a good way to explore the data and share their results. The driver cannot support all the cool special features of ClickHouse, e.g. array functions. You are free to use native queries, of course.

Contributing

• Report any issues you encounter during operations
• Create a pull request, preferably with a test or five
• See the very useful documentation by the Metabase team: Writing A Driver

License

The contents of this repository are made available under the GNU Affero General Public License v3.0 (AGPL), see LICENSE. Unless explicitly stated differently in the respective file, all files are Copyright 2018-2021 the metabase-clickhouse-driver contributors.