diff --git a/docs/administration-guide/01-managing-databases.md b/docs/administration-guide/01-managing-databases.md index f09c2fbc6056063f81aa9c122dd79b83496788b2..13b5d3f96931a2312906517856eb888835e6274a 100644 --- a/docs/administration-guide/01-managing-databases.md +++ b/docs/administration-guide/01-managing-databases.md @@ -20,7 +20,7 @@ Now you’ll see a list of your databases. To connect another database to Metaba * SQL Server * Driud * Crate -* Oracle +* [Oracle](databases/oracle.md) To add a database, you'll need its connection information. diff --git a/docs/administration-guide/databases/oracle.md b/docs/administration-guide/databases/oracle.md new file mode 100644 index 0000000000000000000000000000000000000000..0640ff57257e1729f48ca49116955b20dfb2c7bb --- /dev/null +++ b/docs/administration-guide/databases/oracle.md @@ -0,0 +1,38 @@ +## Working with Oracle in Metabase + +Starting in v0.20.0, Metabase provides a driver for connecting to Oracle databases. Under the hood, Metabase uses to Oracle's JDBC driver; due to licensing restrictions, we can't +include ship it as part of Metabase. Luckily, downloading it yourself and making it available to Metabase is straightforward and only takes a few minutes. + +### Downloading the Oracle JDBC Driver JAR + +You can download the JDBC driver from [Oracle's JDBC driver downloads page](http://www.oracle.com/technetwork/database/features/jdbc/default-2280470.html). +Head to this page, accept the license agreement, and download `ojdbc7.jar`: + + + +Before downloading this JAR you may need to sign up for a free account with Oracle. + + +### Adding the Oracle JDBC Driver JAR to the Metabase Plugins Directory + +Metabase will automatically make the Oracle driver available if it finds the Oracle JDBC driver JAR in the Metabase plugins directory when it starts up. +All you need to do is create the directory and move the JAR you just downloaded into it. + +By default, the plugins directory is called `plugins`, and lives in the same directory as the Metabase JAR. + +For example, if you're running Metabase from a directory called `/app/`, you should move the Oracle JDBC driver JAR to `/app/plugins/`: + +```bash +# example directory structure for running Metabase with Oracle support +/app/metabase.jar +/app/plugins/ojdbc7.jar +``` + +If you're running Metabase from the Mac App, the plugins directory defaults to `~/Library/Application Support/Metabase/Plugins/`: + +```bash +# example directory structure for running Metabase Mac App with Oracle support +/Users/camsaul/Library/Application Support/Metabase/Plugins/ojdbc7.jar +``` + +Finally, you can choose a custom plugins directory if the default doesn't suit your needs by setting the environment variable `MB_PLUGINS_DIR`. diff --git a/docs/administration-guide/images/oracle_jdbc_download.png b/docs/administration-guide/images/oracle_jdbc_download.png new file mode 100644 index 0000000000000000000000000000000000000000..cd73c2104929381e4923ce1fdf5d71259ad18376 Binary files /dev/null and b/docs/administration-guide/images/oracle_jdbc_download.png differ