JDBC driver reference
This reference covers the fields in the JDBC driver registration dialog, the URL template syntax, and a list of common third-party drivers.
Driver registration fields
| Field | Required | Description |
|---|---|---|
| ID | Yes | Unique identifier. Alphanumeric characters and underscores only. |
| Name | Yes | Unique display name for the driver. |
| Database type | Yes | The database type. Select a specific type (for example, mysql) to make the driver available in the dedicated connector node. Select default to make it available only in the generic DB Connector node. |
| Description | No | Optional free-text description. |
| URL template | Yes | JDBC connection URL format used by dedicated connector nodes. Pre-filled when a specific database type is selected. |
| Classpath | Yes | Path to the driver. Use Add file for a single .jar file, or Add directory for a folder of .jar files or native libraries. |
| Driver class | Yes | The JDBC driver class. Click Find driver classes to detect it automatically. |
URL template syntax
The URL template defines the JDBC connection URL format. Variables in the template are replaced with values from the connector node dialog at execution time.
Token types
| Token | Description |
|---|---|
<token> | Mandatory value. The referenced field must be non-empty. |
[token] | Optional value. The referenced field may be empty. |
[token=value?content] | Conditional. Includes content only when the token equals value. |
[token?content] | Conditional. Includes content only when the token is present (non-empty). |
Server-based database tokens
| Token | Source |
|---|---|
host | Hostname field in the Connection Settings tab. |
port | Port field in the Connection Settings tab. |
database | Database name field in the Connection Settings tab. |
File-based database tokens
| Token | Source |
|---|---|
location | Location choice: file (path selected) or in-memory. Use only in conditions. |
file | Path field. Valid only when location is file. |
database | In-memory field. Valid only when location is in-memory. |
URL template examples
Oracle thin driver:
text
jdbc:oracle:thin:@<host>:<port>/<database>File-based H2 database with in-memory fallback:
text
jdbc:h2:[location=in-memory?mem:<database>][location=file?<file>]Dynamic path parameter:
text
jdbc:mydb://<host>:<port>[database?/databaseName=<database>]This produces jdbc:mydb://localhost:10000/databaseName=db1 when a database name is provided, and jdbc:mydb://localhost:10000 when it is not.
Common third-party JDBC drivers
The following drivers are not bundled with KNIME and must be registered manually. Consult your database vendor for the current download location.
| Database | Driver download |
|---|---|
| Apache Derby | db.apache.org |
| Exasol | exasol.com |
| Google BigQuery | cloud.google.com |
| IBM DB2 / Informix | ibm.com |
| SAP HANA | support.sap.com |
Oracle, Microsoft SQL Server, and Amazon Redshift drivers are available as separate KNIME plug-ins due to licensing restrictions. See Install a third-party database driver plug-in.