Connect to MS SQL server
Available only in PyCharm Professional: download to try or compare editions
This functionality relies on the Database Tools and SQL plugin, which is bundled and enabled in PyCharm by default. If the relevant features aren't available, make sure that you didn't disable the plugin.
note
The Database Tools and SQL plugin is available only in PyCharm Professional.
Press CtrlAlt0S to open the IDE settings and then select Plugins.
Open the Installed tab, find the Database Tools and SQL plugin, and select the checkbox next to the plugin name.
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 gives you an example of how you can configure Microsoft SQL Server and create a connection to it from PyCharm. If you already have Microsoft SQL Server installed and configured, consider jumping to the section that describes a creation of a database connection in PyCharm.
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 port that you use is not closed by the Firewall.
If the SQL Server Browser is turned on, TCP/IP connection can also be established using the Microsoft SQL Server instance name.
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
.
note
If you changed any settings, restart the server. For most situations, the restart resolves connection problems.
The following section describes configuration of PyCharm on Windows, macOS, and Linux. Note that the Use Windows domain authentication checkbox is available only on Windows. To configure Windows domain authentication on macOS and Linux, refer to Connect by using Windows domain authentication.
In the Database tool window ( View | Tool Windows | Database), click the Data Source Properties icon
. Alternatively, press ShiftEnter.
In the Data Sources and Drivers dialog, click the Add icon (
) and select Microsoft SQL Server.
Click the Driver link and select Microsoft SQL Server (jTds).
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.
You can find the downloaded JDBC drivers in the PyCharm configuration directory.
The IDE does not include bundled drivers in order to have a smaller size of the installation package and to keep driver versions up-to-date for each IDE version.
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 Host, Instance, and Port fields, specify your connection details. If the server name (for example,
DESKTOP
) does not work, replace it with the server IP address.From the Authentication list, select User & Password.
In User and Password fields, specify your credentials.
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 the Database tool window (Alt01) .
For more information about the Database tool window, see the corresponding reference topic.
tip
To see more databases and schemas under your new data source node, click the N of M button and select the ones you need. PyCharm will introspect and show them.
For more information about working with database objects in PyCharm, 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.

If you run PyCharm on Windows in the same domain as the Microsoft SQL Server database, you can use the Single-Sign On (SSO).
In the Database tool window ( View | Tool Windows | Database), click the Data Source Properties icon
. Alternatively, press ShiftEnter.
In the Data Sources and Drivers dialog, click the Add icon (
) and select Microsoft SQL Server.
Click the Driver link and select Microsoft SQL Server (jTds).
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.
You can find the downloaded JDBC drivers in the PyCharm configuration directory.
The IDE does not include bundled drivers in order to have a smaller size of the installation package and to keep driver versions up-to-date for each IDE version.
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 Host, Instance, and Port fields, specify your connection details. If the server name (for example,
DESKTOP
) does not work, replace it with the server IP address.From the Authentication list, select Windows credentials.
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 the Database tool window (Alt01) .
For more information about the Database tool window, see the corresponding reference topic.
tip
To see more databases and schemas under your new data source node, click the N of M button and select the ones you need. PyCharm will introspect and show them.
For more information about working with database objects in PyCharm, 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.

In the Database tool window ( View | Tool Windows | Database), click the Data Source Properties icon
. Alternatively, press ShiftEnter.
In the Data Sources and Drivers dialog, click the Add icon (
) and select Microsoft SQL Server.
Click the Driver link and select Microsoft SQL Server (jTds).
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.
You can find the downloaded JDBC drivers in the PyCharm configuration directory.
The IDE does not include bundled drivers in order to have a smaller size of the installation package and to keep driver versions up-to-date for each IDE version.
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 Host, Instance, and Port fields, specify your connection details. If the server name (for example,
DESKTOP
) does not work, replace it with the server IP address.From the Authentication list, select Domain credentials.
In the Domain field, specify the domain (for example,
DEVELOPMENT
).In User and Password fields, specify your domain credentials. In the User field, type your domain user without the domain prefix (for example,
John.Smith
instead ofDOMAIN\John.Smith
).Alternatively, on the General tab, specify the connection string. Consider the following example of a full connection string:
jdbc:jtds:sqlserver://DESKTOP:1433;domain=DEVELOPMENT;instance=MSSQLSERVER;databaseName=guest;
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 the Database tool window (Alt01) .
For more information about the Database tool window, see the corresponding reference topic.
tip
To see more databases and schemas under your new data source node, click the N of M button and select the ones you need. PyCharm will introspect and show them.
For more information about working with database objects in PyCharm, 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.

In the Database tool window ( View | Tool Windows | Database), click the Data Source Properties icon
. Alternatively, press ShiftEnter.
In the Data Sources and Drivers dialog, click the Add icon (
) and select Microsoft SQL Server.
Click the Driver link and select Microsoft SQL Server (jTds).
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.
You can find the downloaded JDBC drivers in the PyCharm configuration directory.
The IDE does not include bundled drivers in order to have a smaller size of the installation package and to keep driver versions up-to-date for each IDE version.
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 Host, Instance, and Port fields, specify your connection details. If the server name (for example,
DESKTOP
) does not work, replace it with the server IP address.From the Authentication list, select User & Password.
In User and Password fields, specify your credentials.
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 project and dataset are database is schema is keyspace is namespace is introspected and available to work with. If you also want to work with other databases and schemas projects and datasets databases, schemas, and shared databases databases schemas keyspaces namespaces, in the Schemas tab, select them for the introspection.
Click OK to create the data source.
Find your new data source in the Database tool window (Alt01) .
For more information about the Database tool window, see the corresponding reference topic.
tip
To see more databases and schemas projects and datasets databases, schemas, and shared databases databases schemas keyspaces namespaces under your new data source node, click the N of M button and select the ones you need. PyCharm will introspect and show them.
For more information about working with database objects in PyCharm, 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.

In the Database tool window ( View | Tool Windows | Database), click the Data Source Properties icon
. Alternatively, press ShiftEnter.
In the Data Sources and Drivers dialog, click the Add icon (
) and select Microsoft SQL Server.
Click the Driver link and select Microsoft SQL Server (jTds).
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.
You can find the downloaded JDBC drivers in the PyCharm configuration directory.
The IDE does not include bundled drivers in order to have a smaller size of the installation package and to keep driver versions up-to-date for each IDE version.
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 Host, Instance, and Port fields, specify your connection details. If the server name (for example,
DESKTOP
) does not work, replace it with the server IP address.From the Authentication list, select Domain credentials.
In the Domain field, specify the domain (for example,
DEVELOPMENT
).In User and Password fields, specify your domain credentials. In the User field, type your domain user without the domain prefix (for example,
John.Smith
instead ofDOMAIN\John.Smith
).Alternatively, on the General tab, specify the connection string. Consider the following example of a full connection string:
jdbc:jtds:sqlserver://DESKTOP:1433;domain=DEVELOPMENT;instance=MSSQLSERVER;databaseName=guest;
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 project and dataset are database is schema is keyspace is namespace is introspected and available to work with. If you also want to work with other databases and schemas projects and datasets databases, schemas, and shared databases databases schemas keyspaces namespaces, in the Schemas tab, select them for the introspection.
Click OK to create the data source.
Find your new data source in the Database tool window (Alt01) .
For more information about the Database tool window, see the corresponding reference topic.
tip
To see more databases and schemas projects and datasets databases, schemas, and shared databases databases schemas keyspaces namespaces under your new data source node, click the N of M button and select the ones you need. PyCharm will introspect and show them.
For more information about working with database objects in PyCharm, 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.

Thanks for your feedback!