How to connect to SQL Server Data from IntelliJ

The CData JDBC Driver for SQL Server enables you to access SQL Server as a JDBC data source, providing integration with rapid development tools in IDEs. This article shows how to use the data source configuration wizard to connect to SQL Server data in IntelliJ.

Create a JBDC Data Source for SQL Server

Follow the steps below to add the driver JAR and define connection properties required to connect to SQL Server data.

1. In the Data Sources window, right-click and then click Add Data Source -> DB Data Source.

2. In the Data Source Properties dialog that appears, the following properties are required:

   • JDBC Driver Files: Click the button next to this menu to add the JDBC Driver file cdata.jdbc.sql.jar, located in the installation directory.
   • JDBC Driver Class: In this menu, select cdata.jdbc.sql.SQLDriver from the list.

   • Database URL: Enter the connection URL in the JDBC URL property. The URL must start with jdbc:sql: and includes connection properties separated with semicolons.

     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.

     

     A typical JDBC URL is the following:

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

Edit and Save SQL Server Data

To discover schema information, right-click the data source you just created and click Refresh Tables. To query a table, right-click it and then click Open Tables Editor. You can also modify records in the Table Editor.