Ready to get started?

Learn more about the CData ODBC Driver for Phoenix or download a free trial:

Download Now

Using the CData ODBC Driver for Phoenix in PyCharm

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

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 Phoenix 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 Phoenix 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 Phoenix

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.

Connect to Apache Phoenix via the Phoenix Query Server. Set the Server and Port (if different from the default port) properties to connect to Apache Phoenix. The Server property will typically be the host name or IP address of the server hosting Apache Phoenix.

Authenticating to Apache Phoenix

By default, no authentication will be used (plain). If authentication is configured for your server, set AuthScheme to NEGOTIATE and set the User and Password properties (if necessary) to authenticate through Kerberos.

Below is the syntax for a DSN:

[CData ApachePhoenix Source] Driver = CData ODBC Driver for Phoenix Description = My Description Server = localhost Port = 8765

Execute SQL to Phoenix

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 ApachePhoenix};Server = localhost;Port = 8765;') cursor = cnxn.cursor() cursor.execute("SELECT Id, Column1 FROM MyTable WHERE Id = '123456'") rows = cursor.fetchall() for row in rows: print(row.Id, row.Column1)

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