Using the CData ODBC Driver for GraphQL in PyCharm

Ready to get started?

Download for a free trial:

Download Now

Learn more:

GraphQL ODBC Driver

The GraphQL ODBC Driver is a powerful tool that allows you to connect with live data from GraphQL, directly from any applications that support ODBC connectivity.

Access GraphQL data like you would a database through a standard ODBC Driver interface.



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

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

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.

You must specify the URL of the GraphQL service. The driver supports two types of authentication:

  • Basic: Set AuthScheme to Basic. You must specify the User and Password of the GraphQL service.
  • OAuth 1.0 & 2.0: Take a look at the OAuth section in the Help documentation for detailed instructions.

Below is the syntax for a DSN:

[CData GraphQL Source] Driver = CData ODBC Driver for GraphQL Description = My Description AuthScheme = Basic User = username Password = password URL = https://mysite.com

Execute SQL to GraphQL

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 GraphQL};AuthScheme = Basic;User = username;Password = password;URL = https://mysite.com;') cursor = cnxn.cursor() cursor.execute("SELECT Name, Email FROM Users WHERE UserLogin = 'admin'") rows = cursor.fetchall() for row in rows: print(row.Name, row.Email)

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