Microsoft SQL Server Connector

This node creates a connection to a Microsoft SQL Server, an Azure SQL Database or Azure Synapse SQL pool via its JDBC driver. You need to provide the server's hostname (or IP address), the port, and a database name. Login credentials can either be provided directly in the configuration, via credential variables or via the dynamic input port. Please see the KNIME Database Extension Guide for detailed setup examples.

In order to use the official driver from Microsoft you either need to install the KNIME Microsoft JDBC Driver For SQL Server extension or manually register it due to license restrictions.

This node uses the selected driver's JDBC URL template to create the concrete database URL. Field validation in the dialog depends on whether the (included) tokens referencing them are mandatory or optional in the template.

Options

Connection settings

Database Dialect
Choose the registered database dialect here.
Database Driver

Choose the JDBC driver to connect to the database here. If you select "Use latest driver version available" upon execution the node will automatically use the driver with the latest (highest) driver version that is available for the current database type. This has the advantage that you do not need to touch the workflow after a driver update. However, the workflow might break in the rare case that the behavior of the driver e.g. type mapping changes with the newer version.

If this option is not enabled, you can select a specific version of the registered drivers via the drop-down list. Additional drivers can be registered via KNIME's preference page "KNIME -> Databases". For more details on how to register a new driver see the database documentation.

Hostname
The hostname (or IP address) of a Microsoft SQL Server. The corresponding driver URL template variable is host.
Port
The port on which the Microsoft SQL Server is listening. The default port is 1,433. The corresponding driver URL template variable is port.
Database name
The name of the database you want to connect to. The corresponding driver URL template variable is database.
None/native authentication

If checked the node uses Windows native authentication to connect to the Microsoft SQL Server.

To use this mode with the provided Official driver for Microsoft SQL Server KNIME Analytics Platform needs to run on a Windows machine and you need to be logged in a Windows domain that is accepted by the Microsoft SQL Server you are connecting to. In addition you need to specify the following entry in the JDBC Parameters tab: integratedSecurity with valuetrue.
For more details see the Microsoft documentation.

If you are using the provided jTDS for Microsoft SQL Server driver and KNIME Analytics Platform runs on a Windows machine that is logged into a Windows domain that is accepted by the Microsoft SQL Server you are connecting to you do not need to specify any JDBC parameters.
If KNIME Analytics Platform runs on a non-Windows machine you need to provide the user name and password of the Windows domain user you want to use for authentication. To do so please select either the "Credentials" option or the "Username & password" option. In addition you need to specify the following entry in the JDBC Parameters tab: domain with the Windows domain name as value.
For more details see the description of the domain property in the jTDS FAQ or see the README.sso.

All necessary files such as the sqljdbc_auth.dll or the ntlmauth.dll are part of the provided drivers. However if you want to use your own driver you need to copy all required native libraries e.g. DLLs into a single folder and then register this folder via the Add directory button in addition to the JDBC driver jar file in the driver settings dialog.
For more details see the database documentation.

Credentials
If checked, the credentials (user and password) are used as defined on the workflow. The credential name links to the specified user and password.
Username & password
Your log-in user name and password for the database. Note that the password is encrypted before storage and decrypted afterwards for being used internally.
Kerberos
Uses an existing Kerberos ticket for authentication. For more details on how to configure and use Kerberos in KNIME Analytics Platform see the Kerberos User Guide.
For the official Microsoft driver you need to specify the following entries in the JDBC Parameters tab:
  • integratedSecurity with value true
  • authenticationScheme with value JavaKerberos
For more details on the additional parameters see the Microsoft documentation.

JDBC Parameters

This tab allows you to define JDBC driver connection parameter. The value of a parameter can be a constant, variable, credential user, credential password or KNIME URL. Please see the KNIME Database Extension Guide for detailed setup examples.

JDBC Parameters
For more information about the supported driver properties see the Microsoft SQL Server documentation.

Advanced

This tab allows you to define KNIME framework properties such as connection handling, advanced SQL dialect settings or logging options. If you want to connect to a serverless SQL pool in Azure Synapse Analytics you have to disable the transaction support. To do so uncheck the Enable option in the Transaction section.

Advanced Parameters
For more information about the supported parameters see the KNIME Database Extension Guide.

Input Type Mapping

This tab allows you to define rules to map from database types to KNIME types.

Mapping by Name
Columns that match the given name (or regular expression) and database type will be mapped to the specified KNIME type.
Mapping by Type
Columns that match the given database type will be mapped to the specified KNIME type.

Output Type Mapping

This tab allows you to define rules to map from KNIME types to database types.

Mapping by Name
Columns that match the given name (or regular expression) and KNIME type will be mapped to the specified database type.
Mapping by Type
Columns that match the given KNIME type will be mapped to the specified database type.

Input Ports

Icon…
When available the node will set the accessToken JDBC parameter automatically based on the information from the connected Microsoft Authenticator node. Depending on your database setup you might need to specify additional JDBC parameters which are described in the Microsoft documentation.

Output Ports

Icon
Microsoft SQL Server DB Connection.

Popular Predecessors

Popular Successors

Views

This node has no views

Workflows

Links

Developers

You want to see the source code for this node? Click the following button and we’ll use our super-powers to find it for you.

Installation

To use this node in KNIME, install the extension KNIME Database from the below update site following our NodePit Product and Node Installation Guide:

v5.4

A zipped version of the software site can be downloaded here.

Plugin provider: KNIME AG, Zurich, Switzerland
Plugin version: 5.4.0.v202411070937
On NodePit since: 2024-12-06
Last update: 2024-12-17
KNIME versions: Since v3.7

Deploy, schedule, execute, and monitor your KNIME workflows locally, in the cloud or on-premises – with our brand new NodePit Runner.

Try NodePit Runner!