Using the CData ODBC Driver for SQL Server in PyCharm

Ready to get started?

Download for a free trial:

Download Now

Learn more:

SQL Server ODBC Driver

Connect to Microsoft SQL Server-compatible databases from any applications that support ODBC connectivity.

The ODBC Driver offers Direct Mode access to SQL Server through standard Java Database Connectivity, providing extensive compatibility with current and legacy MS SQL versions. Supports secure SQL connectivity and authentication via SSL, Kerberos, Integrated Security, etc.



Connect to SQL Server as an ODBC data source in PyCharm using the CData ODBC Driver for SQL Server.

The CData ODBC Drivers can be used in any environment that supports loading an ODBC Driver. In this tutorial we will explore using the CData ODBC Driver for SQL Server from within PyCharm. Included are steps for adding the CData ODBC Driver as a data source, as well as basic PyCharm code to query the data source and display results.

To begin, this tutorial will assume that you have already installed the CData ODBC Driver for SQL Server as well as PyCharm.

Add Pyodbc to the Project

Follow the steps below to add the pyodbc module to your project.

  1. Click File -> Settings to open the project settings window.
  2. Click Project Interpreter from the Project: YourProjectName menu.
  3. To add pyodbc, click the + button and enter pyodbc.
  4. Click Install Package to install pyodbc.

Connect to SQL Server

You can now connect with an ODBC connection string or a DSN. See the Getting Started section in the CData driver documentation for a guide to creating a DSN on your OS.

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.

Below is the syntax for a DSN:

[CData SQL Source] Driver = CData ODBC Driver for SQL Server Description = My Description User = myUser Password = myPassword Database = NorthWind Server = myServer Port = 1433

Execute SQL to SQL Server

Instantiate a Cursor and use the execute method of the Cursor class to execute any SQL statement.

import pyodbc cnxn = pyodbc.connect('DRIVER={CData ODBC Driver for SQL};User = myUser;Password = myPassword;Database = NorthWind;Server = myServer;Port = 1433;') cursor = cnxn.cursor() cursor.execute("SELECT ShipName, Freight FROM Orders WHERE ShipCountry = 'USA'") rows = cursor.fetchall() for row in rows: print(row.ShipName, row.Freight)

After connecting to SQL Server in PyCharm using the CData ODBC Driver, you will be able to build Python apps with access to SQL Server data as if it were a standard database. If you have any questions, comments, or feedback regarding this tutorial, please contact us at support@cdata.com.