Skip to content

Latest commit

 

History

History
85 lines (56 loc) · 7.46 KB

partner-and-community-drivers.md

File metadata and controls

85 lines (56 loc) · 7.46 KB
title redirect_from
Partner and community drivers
/docs/latest/developers-guide-drivers

Partner and community drivers

In addition to our Officially supported drivers, many people build and maintain drivers for database integrations.

We have two types of third-party drivers:

How to use a third-party driver

Self-hosted

To use a Partner or Community driver on a self-hosted Metabase:

  1. Download the latest jar file from the driver's repository (see the repo's Releases section for the JAR files).
  2. Copy the JAR file into the plugins directory in your Metabase directory (the directory where you run the Metabase JAR).

You can change the location of the plugins directory by setting the environment variable MB_PLUGINS_DIR.

Metabase Cloud

Partner drivers, like officially supported drivers, are available out-of-the-box on Metabase cloud. No action needed.

Community drivers are not supported on Metabase Cloud.

Partner drivers

Partner drivers are available both on Metabase Cloud and on self-hosted Metabases.

To qualify as a partner driver, the driver must:

  • Have a sponsor (usually the database's vendor) who has committed to maintaining the driver for future releases.
  • Pass the Metabase test suite and a code review by our team.
  • Have a permissive license.

Current partner drivers:

Partner drivers are available to Cloud customers out-of-the-box.

If you have interest in becoming a partner, please fill the partner form and we will get in touch.

Community drivers

You install these drivers at your own risk. The plugins run as part of your Metabase and will have access to anything your Metabase does. And since we can’t vet for them, we don’t make them available on Metabase Cloud.

Anyone can build a community driver. These are the currently known third-party database drivers for Metabase.

Database GitHub Stars Last release (if available)
CSV GitHub stars GitHub (Pre-)Release Date
Databend GitHub stars GitHub (Pre-)Release Date
DB2 GitHub stars Github (Pre-)Release Date
Dremio GitHub stars GitHub (Pre-)Release Date
Firebird GitHub stars GitHub (Pre-)Release Date
GreptimeDB GitHub stars GitHub (Pre-)Release Date
Hydra Hydra connections use the official Postgres driver. Not applicable.
Impala GitHub stars GitHub (Pre-)Release Date
Neo4j GitHub stars GitHub (Pre-)Release Date
Netsuite SuiteAnalytics Connect GitHub stars GitHub (Pre-)Release Date
Peaka GitHub stars GitHub (Pre-)Release Date
Teradata GitHub stars GitHub (Pre-)Release Date

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

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

Metabase Cloud doesn't support community drivers, meaning that (for now) you can only use Metabase Cloud with the officially supported drivers, and the partner drivers listed above.

Write your own driver

Check out Guide to writing a Metabase driver.