Integrate SQL Server Data in Pentaho Data Integration

The CData JDBC Driver for SQL Server enables access to live data from data pipelines. Pentaho Data Integration is an Extraction, Transformation, and Loading (ETL) engine that data, cleanses the data, and stores data using a uniform format that is accessible.This article shows how to connect to SQL Server data as a JDBC data source and build jobs and transformations based on SQL Server data in Pentaho Data Integration.

Configure to SQL Server Connectivity

Connecting to Microsoft SQL Server

Connect to Microsoft SQL Server using the following properties:

• Server: The name of the server running SQL Server.
• User: The username provided for authentication with SQL Server.
• Password: The password associated with the authenticating user.
• Database: The name of the SQL Server database.

Connecting to Azure SQL Server and Azure Data Warehouse

You can authenticate to Azure SQL Server or Azure Data Warehouse by setting the following connection properties:

• Server: The server running Azure. You can find this by logging into the Azure portal and navigating to "SQL databases" (or "SQL data warehouses") -> "Select your database" -> "Overview" -> "Server name."
• User: The name of the user authenticating to Azure.
• Password: The password associated with the authenticating user.
• Database: The name of the database, as seen in the Azure portal on the SQL databases (or SQL warehouses) page.

SSH Connectivity for SQL Server

You can use SSH (Secure Shell) to authenticate with SQL Server, whether the instance is hosted on-premises or in supported cloud environments. SSH authentication ensures that access is encrypted (as compared to direct network connections).

SSH Connections to SQL Server in Password Auth Mode

To connect to SQL Server via SSH in Password Auth mode, set the following connection properties:

• User: SQL Server User name
• Password: SQL Server Password
• Database: SQL Server database name
• Server: SQL Server Server name
• Port: SQL Server port number like 3306
• UserSSH: "true"
• SSHAuthMode: "Password"
• SSHPort: SSH Port number
• SSHServer: SSH Server name
• SSHUser: SSH User name
• SSHPassword: SSH Password

SSH Connections to SQL Server in Public Key Auth Mode

To connect to SQL Server via SSH in Password Auth mode, set the following connection properties:

• User: SQL Server User name
• Password: SQL Server Password
• Database: SQL Server database name
• Server: SQL Server Server name
• Port: SQL Server port number like 3306
• UserSSH: "true"
• SSHAuthMode: "Public_Key"
• SSHPort: SSH Port number
• SSHServer: SSH Server name
• SSHUser: SSH User name
• SSHClientCret: the path for the public key certificate file

Built-in Connection String Designer

For assistance in constructing the JDBC URL, use the connection string designer built into the SQL Server JDBC Driver. Either double-click the JAR file or execute the jar file from the command-line.

java -jar cdata.jdbc.sql.jar

Fill in the connection properties and copy the connection string to the clipboard.

👁 Using the built-in connection string designer to generate a JDBC URL (Salesforce is shown.)

When you configure the JDBC URL, you may also want to set the Max Rows connection property. This will limit the number of rows returned, which is especially helpful for improving performance when designing reports and visualizations.

Below is a typical JDBC URL:

jdbc:sql:User=myUser;Password=myPassword;Database=NorthWind;Server=myServer;Port=1433;

Save your connection string for use in Pentaho Data Integration.

Connect to SQL Server from Pentaho DI

Open Pentaho Data Integration and select "Database Connection" to configure a connection to the CData JDBC Driver for SQL Server

1. Click "General"
2. Set Connection name (e.g. SQL Server Connection)
3. Set Connection type to "Generic database"
4. Set Access to "Native (JDBC)"
5. Set Custom connection URL to your SQL Server connection string (e.g.
   

   jdbc:sql:User=myUser;Password=myPassword;Database=NorthWind;Server=myServer;Port=1433;

6. Set Custom driver class name to "cdata.jdbc.sql.SQLDriver" 👁 Configuring the JDBC Driver connection.
   
7. Test the connection and click "OK" to save. 👁 Saving the connection.
   

Create a Data Pipeline for SQL Server

Once the connection to SQL Server is configured using the CData JDBC Driver, you are ready to create a new transformation or job.

1. Click "File" >> "New" >> "Transformation/job"
2. Drag a "Table input" object into the workflow panel and select your SQL Server connection. 👁 Configuring the Table input object
   
3. Click "Get SQL select statement" and use the Database Explorer to view the available tables and views. 👁 Selecting data (QuickBooks Online is shown).
   
4. Select a table and optionally preview the data for verification. 👁 Previewing the data (QuickBooks Online is shown).
   

At this point, you can continue your transformation or jb by selecting a suitable destination and adding any transformations to modify, filter, or otherwise alter the data during replication.

👁 A completed transformation/job.

Free Trial & More Information

Download a free, 30-day trial of the CData JDBC Driver for SQL Server and start working with your live SQL Server data in Pentaho Data Integration today.