KNIME Documentation

Register a JDBC driver ​

When KNIME Analytics Platform does not include a built-in driver for your database, you must register a vendor-specific JDBC driver manually. This makes the driver available for selection in the DB Connector node and dedicated connector nodes.

Before you begin ​

  • Obtain the JDBC driver from your database vendor. The driver must be JDBC 4.1 or later compliant.
  • The driver is typically provided as a .jar file. If provided as a .zip archive, extract it to a folder first.
  • If the driver requires native libraries (for example, DLLs), place all of them in a single folder alongside the .jar file.

For a list of common JDBC drivers, see JDBC driver reference.

Register the driver ​

Register the driver in the KNIME preferences to make it available in the connector nodes.

  1. In KNIME Analytics Platform, go to File → Preferences → KNIME → Databases.
  2. Click Add to open the new database driver dialog.
  3. Fill in the required fields:
    • ID — a unique identifier using only alphanumeric characters and underscores.
    • Name — a unique display name for the driver.
    • Description — a short description of the driver.
    • Database type — select the matching database type if it appears in the list. If your database is not listed, select default. Drivers registered as default are only available in the generic DB Connector node.
    • URL template — the JDBC connection URL format. If you selected a specific database type, a default template is pre-filled. Click the question mark icon for syntax guidance and examples.
    • Classpath — click Add file to select a single .jar file, or Add directory to select a folder containing multiple .jar files. If the driver requires native libraries, also add the folder containing them.
  4. Click Find driver classes to auto-detect the driver class. Select the correct class from the list.
  5. Click OK to save the driver.

TIP

Select a specific Database type when one is available. Drivers registered as default cannot be used with dedicated connector nodes — only with the generic DB Connector node.

Distribute drivers to Hub or Server executors ​

To make drivers available on KNIME Hub or KNIME Server executors, use a customization profile instead of registering manually on each machine. See Set up JDBC drivers on KNIME Hub and KNIME Server.

Next steps ​