Microsoft SQL Server
Official documentation and software
For full information about Microsoft SQL Server, refer to the official documentation.
To download Microsoft SQL Server database software, refer to the official software downloads.
This topic presents a general procedure on how you can create a data source for the connection to your Microsoft SQL Server database in DataGrip, and run a test connection. It is assumed that you already have the necessary prerequisites and the database is up and running. For example, if you want to run a database on your machine and connect to that database, the corresponding DBMS software must be installed on the machine first.
For more information about Windows domain authentication and user permissions, refer to Create a Microsoft SQL Server data source.
For more information about connecting to LocalDB, refer to Microsoft SQL Server LocalDB.
Required settings
Microsoft SQL Server accepts TCP/IP connections on a dedicated port. By default, it is port 1433 and it is closed by the Microsoft Windows Firewall. When connecting via port, make sure that the Firewall does not close the port that you use.
If the SQL Server Browser is turned on, TCP/IP connection can also be established using the Microsoft SQL Server instance name.
Enable and configure the TCP/IP connection
Follow the official instructions to enable the protocol, check and assign a port number. Verify that other running applications do not use the same port.
Name of the Microsoft SQL Server instance is MSSQLSERVER. By default, the port is
1433.
Connect to a Microsoft SQL Server database
To connect to the database, create a data source that will store your connection details. You can do this using one of the following ways:
In the main menu, go to and select Microsoft SQL Server.
In the Database Explorer ( ) , click the New icon (
) in the toolbar. Navigate to Data Source and select Microsoft SQL Server.
Check if there is a Download missing driver files link at the bottom of the connection settings area. Click this link to download drivers that are required to interact with a database. For a direct download link, refer to the JetBrains JDBC drivers page.
Location for the downloaded JDBC drivers is the DataGrip configuration directory.
You can also use your drivers for the database instead of the provided ones. For more information about connecting to a database with your driver, refer to Add a user driver to an existing connection.
If there is no Download missing driver files link, then you already have the required drivers.
In the General tab of Data Sources and Drivers dialog right pane, specify the driver and connection type.
From the Driver list, select the JDBC driver for your connection.
For Microsoft SQL Server, the supported drivers are Microsoft SQL Server and Microsoft SQL Server (jTds).
From the Connection type list, select the connection type depending on the connection details that you have:
default: connect by using Host, Port, Database, and URL.
URL only: connect by using only the URL.
For the URL only connection type, the JDBC URL that you enter is used and as is, including the database credentials.
For the other connection types, the JDBC URL is broken down into connection details. You can either specify them separately and use the automatically generated URL, or you can enter the URL directly in the corresponding field.
Specify the database connection details. Alternatively, paste the JDBC URL in the URL field.
In the Host field, type your server address.
In the Port field, type the port of Microsoft SQL Server. The default port is 1433.
Select the instance that you want to connect to from fhe Instance list.
From the Authentication list, select the authentication method that you want to use to authenticate the connection. The following options are available:
User & Password: by using your login and password.
Kerberos: use Kerberos for authentication. Requires a Kerberos server and authentication with
kinit.No auth: authentication is not required.
Domain credentials: use Windows domain authentication for the connection (Domain, User, and Password). For more information about Windows domain authentication, refer to the Microsoft SQL Server data source tutorial.
In the User and Password fields, type your user credentials.
To use no password, leave the Password field empty.
To delete a once entered password, right-click the Password field and select Set Empty.
In the Database field, type the database name to which you want to connect.
In the URL field, DataGrip generates the JDBC URL automatically using the values of other connection settings.
If you need to use a JDBC URL with certain additional settings, paste it in the URL field. The general URL to use is as follows:
Format:
jdbc:sqlserver://<host_address>\<instance_name>:<port_number>;database=<database_name>Example:
jdbc:sqlserver://127.0.0.1\MYINSTANCE:1433;database=myDatabase
For more information about the URL format, refer to the Microsoft SQL Server official documentation.
From the Authentication list, select the authentication method that you want to use to authenticate the connection. The following options are available:
User & Password: by using your login and password.
Kerberos: use Kerberos for authentication. Requires a Kerberos server and authentication with
kinit.No auth: authentication is not required.
Domain credentials: use Windows domain authentication for the connection (Domain, User, and Password). For more information about Windows domain authentication, refer to the Microsoft SQL Server data source tutorial.
In the User and Password fields, type your user credentials.
To use no password, leave the Password field empty.
To delete a once entered password, right-click the Password field and select Set Empty.
In the URL field, DataGrip generates the JDBC URL automatically using the values of other connection settings.
If you need to use a JDBC URL with certain additional settings, paste it in the URL field.
For more information about the URL format, refer to the Microsoft SQL Server official documentation.
For the reference information about connection settings and properties on the General and other tabs of Data Sources and Drivers dialog (Ctrl+Alt+Shift+S) , see Connection settings and DBMS-specific properties.
Ensure that the connection to the database can be established using the provided details. To do that, click the Test Connection link at the bottom of the connection details area.
In case of any connection issues, refer to the Cannot connect to a database page.
(Optional) By default, only the default database and schema are introspected and available to work with. If you also want to work with other databases and schemas, in the Schemas tab, select them for the introspection.
Click OK to create the data source.
Find your new data source in Database Explorer (⌘ 1) .
For more information about Database Explorer, see the corresponding reference topic.
For more information about working with database objects in DataGrip, refer to Database objects.
To write and run queries, open the default query console by clicking the data source and pressing F4.
To view and edit data of a database object, open Data editor and viewer by double-clicking the object.
Connection settings and DBMS-specific properties
Connection settings
For the reference information about connection settings (for example, Host, Port, and so on) on the General and other tabs of Data Sources and Drivers dialog (Ctrl+Alt+Shift+S) , see Data Sources.
DBMS-specific properties
General tab
Item | Description | Connection type |
|---|---|---|
Instance | The list of instances available to connect to. For more information about instances, refer to MS SQL Server official documentation. | default |