Using the CData ODBC Driver for MySQL in PyCharm

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 MySQL 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 MySQL 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.

👁 Image

Connect to MySQL

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.

The CData Provider supports connecting to on-premises and cloud-hosted versions of MySQL such as Amazon RDS for MySQL, Google Cloud SQL for MySQL, Azure Database for MySQL, or Oracle MySQL HeatWave. The Server and Port properties must be set to a MySQL server. If IntegratedSecurity is set to false, then User and Password must be set to valid user credentials. Optionally, Database can be set to connect to a specific database. If not set, tables from all databases will be returned.

SSH Connectivity for MySQL

You can use SSH (Secure Shell) to authenticate with MySQL, 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 MySQL in Password Auth Mode

To connect to MySQL via SSH in Password Auth mode, set the following connection properties:

• User: MySQL User name
• Password: MySQL Password
• Database: MySQL database name
• Server: MySQL Server name
• Port: MySQL 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 MySQL in Public Key Auth Mode

To connect to MySQL via SSH in Password Auth mode, set the following connection properties:

• User: MySQL User name
• Password: MySQL Password
• Database: MySQL database name
• Server: MySQL Server name
• Port: MySQL 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

Below is the syntax for a DSN:

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

Execute SQL to MySQL

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 MySQL};User = myUser;Password = myPassword;Database = NorthWind;Server = myServer;Port = 3306;')
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 MySQL in PyCharm using the CData ODBC Driver, you will be able to build Python apps with access to MySQL data as if it were a standard database. If you have any questions, comments, or feedback regarding this tutorial, please contact us at [email protected].