db.jdbc_class

Background

This parameter specifies the database JDBC driver class which should be used to connect to the database. The value should be a fully qualified class name, which must have been installed as described below.

Installing JDBC drivers

Most JDBC drivers ship as a .jar (java archive) file. Funnelback is configured to automatically make all .jar files installed in certain locations available to the database gathering components.

To install a JDBC driver, simply copy the .jar file to the following directory (where [INSTALL_ROOT] is the directory that Funnelback has been installed in):

[INSTALL_ROOT]/lib/java/dbgather/

When installing drivers be careful to install only one version of any particular driver to avoid any Java errors relating to duplicate class definitions.

Common drivers

  • MySQL - com.mysql.jdbc.Driver, see: Connector/J

  • Oracle - oracle.jdbc.OracleDriver, see: Oracle JDBC

  • PostgreSQL - org.postgresql.Driver, see: Postgres JDBC (included with Funnelback)

  • SQLite - org.sqlite.JDBC, see: SQLite JDBC (included with Funnelback)

  • SQL Server - com.microsoft.sqlserver.jdbc.SQLServerDriver, see: SQL Server JDBC

  • IBM DB2 - com.ibm.db2.jcc.DB2Driver, see: IBM

Testing the driver

This feature is only available to administrators with back end server access.

The database gatherer includes a --test_connection command line option:

$SEARCH_HOME/bin/dbgather.pl /path/to/collection.cfg --test_connection

Setting the key

Set this configuration key in the search package or data source configuration.

Use the configuration key editor to add or edit the db.jdbc_class key, and set the value. This can be set to any valid String value.

Default value

(none)

Examples

db.jdbc_class=oracle.jdbc.OracleDriver