Proton driver for Metabase

This repo is a forked from https://github.com/ClickHouse/metabase-clickhouse-driver with necessary revisions to better fit Proton.

Install

If you are about to use metabase for the first time, install the proper JVM and start it with java -jar metabase.jar to start it for the first time. This will create a plugins folder. Stop the Java process, put the proton.metabase-driver.jar in the plugins folder and start it again.

Add database

1. Once you've started up Metabase, open http://localhost:3000 , go to "Admin settings" (top-right), then "Databases" tab and add a database and select "Timeplus Proton".
2. You'll need to provide the Host/Port. Default localhost and 8123 just work.

Run Query

Please note, with port 8123, by default Proton's query behavior is batch SQL, looking for the past data.

Build from source

The build process is largely based on https://github.com/databendcloud/metabase-databend-driver. (IMHO, Leiningen provides much better compiling error message than the built-in clojure -X:build:drivers:build/driver)

Prerequisites

• Leiningen

Steps

1. Clone and build metabase dependency jar.

   git clone https://github.com/metabase/metabase
   cd metabase
   clojure -X:deps prep
   cd modules/drivers
   clojure -X:deps prep
   cd ../..
   ./bin/build.sh

2. Clone metabase-proton-driver repo

   cd modules/drivers
   git clone https://github.com/timeplus-io/metabase-proton-driver

3. Prepare metabase dependencies

   cp ../../target/uberjar/metabase.jar metabase-proton-driver/
   cd metabase-proton-driver
   mkdir repo
   lein pom
   mvn deploy:deploy-file -Durl=file:repo -DgroupId=metabase-core -DartifactId=metabase-core -Dversion=1.40 -Dpackaging=jar -Dfile=metabase.jar

4. Build the jar (key steps to compile *.clj source code)

   LEIN_SNAPSHOTS_IN_RELEASE=true DEBUG=1 lein uberjar

5. Let's assume we download metabase.jar from the Metabase jar to ~/metabase/ and we built the project above. Copy the built jar(target/uberjar/proton.metabase-driver.jar) to the Metabase plugins folder and run Metabase from there!

   cd ~/metabase/
   java -jar metabase.jar

You should see a message on startup similar to:

2023-11-18 09:55:37,102 DEBUG plugins.lazy-loaded-driver :: Registering lazy loading driver :proton...
2023-11-18 09:55:37,102 INFO driver.impl :: Registered driver :proton (parents: [:sql-jdbc]) 🚚