Skip to content

Xeograph/metabase-ocient-driver

Repository files navigation

Metabase Ocient Driver

💥Note: This project is under active development

Installation

There are a few options to installing a Metabase community driver. The simplest is to copy the JAR file into the plugins directory in your Metabase directory (the directory where you run the Metabase JAR). Additionally, you can change the location of the plugins directory by setting the environment variable MB_PLUGINS_DIR.

Docker

Use the Dockerfile to build an image of Metabase with the Ocient driver pre-installed:

git clone [email protected]:Xeograph/metabase-ocient-driver.git
cd metabase-ocient-driver
git submodule update --init
make docker-build

Use custom Metabase JAR

If you already have a Metabase binary release (see Metabase distribution page):

  1. Download the Ocient driver jar from this repository's "Releases" page.
  2. Create a directory and copy the metabase.jar to it.
  3. In that directory create a sub-directory called plugins and copy the Ocient driver jar into it.
  4. From the directory created in step 2, run java -jar metabase.jar.

Contributing

Prerequisites

Build from source

The Ocient driver, can be built using Clouure Tools:

# Outputs jar to `metabase/plugins/ocient.metabase-driver.jar`. Should be run from the project's root directory, NOT the metabase subrepo
make build

Run a local Metabase instance

To run a local instance of Metabase, run the following from the project root:

make run

For the front-end, you also should use whatever node version was LTS at the time of whatever metabase version is being used.

For the front-end: yarn build-hot (hot reloading enabled). This will run on localhost port 3000. If this results in a white screen with the console showing resources failing to load, you may need to run yarn build first.

Run unit tests

To run the unit tests against the Ocient driver, run:

make run-unit-test