Using the CData ODBC Driver for EnterpriseDB 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 EnterpriseDB 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 EnterpriseDB 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 EnterpriseDB

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 following connection properties are required in order to connect to data.

• Server: The host name or IP of the server hosting the EnterpriseDB database.
• Port: The port of the server hosting the EnterpriseDB database.

You can also optionally set the following:

• Database: The default database to connect to when connecting to the EnterpriseDB Server. If this is not set, the user's default database will be used.

Connect Using Standard Authentication

To authenticate using standard authentication, set the following:

• User: The user which will be used to authenticate with the EnterpriseDB server.
• Password: The password which will be used to authenticate with the EnterpriseDB server.

Connect Using SSL Authentication

You can leverage SSL authentication to connect to EnterpriseDB data via a secure session. Configure the following connection properties to connect to data:

• SSLClientCert: Set this to the name of the certificate store for the client certificate. Used in the case of 2-way SSL, where truststore and keystore are kept on both the client and server machines.
• SSLClientCertPassword: If a client certificate store is password-protected, set this value to the store's password.
• SSLClientCertSubject: The subject of the TLS/SSL client certificate. Used to locate the certificate in the store.
• SSLClientCertType: The certificate type of the client store.
• SSLServerCert: The certificate to be accepted from the server.

Below is the syntax for a DSN:

[CData EnterpriseDB Source]
Driver = CData ODBC Driver for EnterpriseDB
Description = My Description
User = postgres
Password = admin
Database = postgres
Server = 127.0.0.1
Port = 5444

Execute SQL to EnterpriseDB

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 EnterpriseDB};User = postgres;Password = admin;Database = postgres;Server = 127.0.0.1;Port = 5444')
cursor = cnxn.cursor()
cursor.execute("SELECT ShipName, ShipCity FROM Orders WHERE ShipCountry = 'USA'")
rows = cursor.fetchall()
for row in rows:
 print(row.ShipName, row.ShipCity)

After connecting to EnterpriseDB in PyCharm using the CData ODBC Driver, you will be able to build Python apps with access to EnterpriseDB 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].