Skip to content

Add custom database drivers ​

In Knime, most database connector nodes include a built-in JDBC driver, so workflows can connect without extra setup. For the list of databases with dedicated connector nodes, see Connect to a database using a dedicated connector node.

Sometimes you need a different driver, for example a specific driver version, or a driver for a database that Knime doesn't include. In that case, add a custom driver to the environment. Every workflow that runs in the environment can then use the driver. This works on managed and sovereign environments.

Add a driver to an environment ​

You can add multiple drivers to an environment. To add a database driver:

  1. Under Global administration, open the Environments page.
  2. On the tile of the environment, click the three dots and select Edit.
  3. Select Database drivers, and click Add driver.
  4. Enter an ID and a Name for the driver. Both fields are mandatory.
  5. Optional: Enter a Description.
  6. Select a Database type. If none of the types match your database, select Default.
  7. Upload the driver .jar file.
  8. Go back to the environment, and click Save changes.

Use the driver in a workflow ​

After you add a driver, workflows that run in the environment can use it in a connector node. The database type you selected decides which nodes show the driver:

  • Specific type: The driver appears in the matching dedicated connector node and in the generic DB Connector node. For example, a driver with the type Postgres appears in the PostgreSQL Connector node.
  • Type Default: The driver appears only in the generic DB Connector node.

To use the driver in a connector node:

  1. Open the configuration dialog of the connector node.
  2. Click Show advanced settings.
  3. Clear the Use latest driver version available checkbox.
  4. Select your custom driver from the drop-down menu.