Menu Close
v0.35.0 / Developers Guide Drivers

Community-built database drivers

As of Metabase 0.32, we now support community-built database drivers!

Several folks have already started to build drivers for database integrations that Metabase doesn’t natively support. While we don’t specifically endorse any of these drivers, we thought it would be helpful to have a central place to list them.

Want to build your own driver? Take a look at the driver development section below.

How to use a community-built driver

In order to install a community driver, you would typically download the latest jar file from the relevant repository release page and copy it into the plugins directory.

All Metabase plugins live in the plugins directory, which defaults to ./plugins in the same directory as metabase.jar. The plugins directory can be changed by setting the env var MB_PLUGINS_DIR.

Note: You install these at your own risk. The plugins will run as part of your Metabase instance and, as such, will have access to anything it does.

These are the currently known 3rd-party database drivers for Metabase.

Database GitHub Stars Last release (if available)
Amazon Athena GitHub stars GitHub (Pre-)Release Date
ClickHouse GitHub stars GitHub (Pre-)Release Date
CSV GitHub stars  
Cube.js GitHub stars GitHub (Pre-)Release Date
Datomic GitHub stars  
DB2 GitHub stars  
Firebird GitHub stars GitHub (Pre-)Release Date
Materialize GitHub stars GitHub (Pre-)Release Date
Teradata GitHub stars GitHub (Pre-)Release Date
Spark Databricks GitHub stars GitHub (Pre-)Release Date

If you don’t see a driver for your database, then try looking in the comments of the issue related to the database. You might also find more by searching on GitHub.

If you are having problems with installing or using a community driver, your best bet is to contact the author of the driver.

Driver development

If the driver you’re looking for isn’t available, take a look at the Writing a Driver wiki page. It’s still a work in progress, but should give you a good start. A few things to keep in mind:

  • If your database has a JDBC driver, you’ll be able to make use of some common classes that already exist in Metabase.
  • We’re still working on providing an independent test framework for drivers, but you can copy or symlink your driver into a local copy of the Metabase source code in order to utilize pre-existing tests. Take a look at Test Extension Basics on the wiki.
  • If you have questions related to driver development, feel free to post on our driver development forum.

Driver development announcements

Occasionally, we may make changes to Metabase that impact database drivers. We’ll try to give folks as much of a heads up as possible. For notifications regarding this, please use the form below to subscribe to the Metabase Community Authors mailing list. This will be a low-volume email list that we will only use to notify you of important annoucements related to driver development.