How to connect to SQL Server Data in DBVisualizer

The CData JDBC Driver for SQL Server implements JDBC standards to provide connectivity to SQL Server data in applications ranging from business intelligence tools to IDEs. This article shows how to establish a connection to SQL Server data in DBVisualizer and use the table editor to edit and save SQL Server data.

Create a New Driver Definition for SQL Server Data

Follow the steps below to use the Driver Manager to provide connectivity to SQL Server data from DBVisualizer tools.

1. In DBVisualizer, click Tools -> Driver Manager.
2. Click the plus sign "" to create a new driver.
3. Select "Custom" as the template.
4. On the Driver Settings tab:
   • Set Name to a user-friendly name (e.g. "CData SQL Server Driver")
   • Set URL Format to jdbc:sql: 👁 Setting the Driver Settings (Salesforce is shown).
     
   • In Driver artifacts and jar files (jars are loaded in order from top):
     1. Click the plus sign "" -> "Add Files"
     2. Navigate to the "lib" folder in the installation directory (C:\Program Files\CData JDBC Driver for SQL Server XXXX\)
     3. Select the JAR file (cdata.jdbc.SQL.jar) and click "Open"
     👁 Loading the driver JAR file.
     
5. The Driver Class should populate automatically. If not, select class (cdata.jdbc.sql.SQLDriver).

👁 The configured JDBC driver. (Salesforce is shown.)

Define the Connection to the JDBC Data Source

Close the "Driver Manager" and follow the steps below to save connection properties in the JDBC URL.

1. In the "Databases" tab, click the plus sign "" and select the driver you just created.

2. In the "Connection" section, set the following options:

   • Database Type: If you selected the wizard option, the database type is automatically detected. If you selected the "No Wizard" option, select the Generic or Auto Detect option in the Database Type menu.
   • Driver Type: Select the driver you just created.

   • Database URL: Enter the full JDBC URL. The syntax of the JDBC URL is jdbc:sql: followed by the connection properties in a semicolon-separated list of name-value pairs.

     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.

     A typical connection string is below:

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

   • NOTE: Database Userid and Database Password correspond with the User and Password properties for SQL Server.
3. On the Connection tab, click Connect. 👁 A newly configured Database Connection. (Salesforce is shown.)
   

To browse through tables exposed by the SQL Server JDBC Driver, right-click a table and click "Open in New Tab."

To execute SQL queries, use the SQL Commander tool: Click SQL Commander -> New SQL Commander. Select the Database Connection, Database, and Schema from the available menus.

See the "Supported SQL" chapter in the help documentation for more information on the supported SQL. See the "Data Model" chapter for table-specific information.

👁 The results of a query in DBVisualizer. (Salesforce is shown.)

More Information & Free Trial

Download a free, 30-day trial of the CData JDBC Driver for SQL Server and start working with your live SQL Server data in DbVisualizer. Join the CData Community or reach out to our Support Team if you have any questions.