Using the CData ODBC Driver for Gong 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 Gong 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 Gong as well as PyCharm.
Add Pyodbc to the Project
Follow the steps below to add the pyodbc module to your project.
- Click File -> Settings to open the project settings window.
- Click Project Interpreter from the Project: YourProjectName menu.
- To add pyodbc, click the + button and enter pyodbc.
- Click Install Package to install pyodbc.
Connect to Gong
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.
To authenticate to Gong, you can use API Key authentication with your Gong API Key and API Secret.
Authentication
To authenticate to Gong, you must provide your Gong API Key and API Secret, along with your tenant Domain. These credentials are combined and Base64-encoded to form the Basic authentication header used for all API requests.
Using API Key Authentication
To authenticate using an API Key, you need to obtain your API Key and API Secret from your Gong account settings.
You can then connect by setting the AuthScheme to APIKey and providing your credentials:
- AuthScheme: Set this to APIKey.
- APIKey: Set this to your Gong API Key.
- APISecret: Set this to your Gong API Secret.
- Domain: Set this to your Gong tenant domain (e.g., us-36533.api.gong.io).
Example connection string
Profile=C:\profiles\Gong.apip;AuthScheme=APIKey;ProfileSettings='APIKey=your_api_key;APISecret=your_api_secret;Domain=your-tenant.api.gong.io';
Below is the syntax for a DSN:
[CData API Source] Driver = CData ODBC Driver for Gong Description = My Description Profile = C:\profiles\Gong.apip AuthScheme = APIKey ProfileSettings = 'APIKey = your_api_key APISecret = your_api_secret Domain = your-tenant.api.gong.io'
Execute SQL to Gong
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 API};Profile = C:\profiles\Gong.apip;AuthScheme = APIKey;ProfileSettings = 'APIKey = your_api_key;APISecret = your_api_secret;Domain = your-tenant.api.gong.io';')
cursor = cnxn.cursor()
cursor.execute("SELECT , FROM AnsweredScorecards WHERE = ''")
rows = cursor.fetchall()
for row in rows:
print(row., row.)
After connecting to Gong in PyCharm using the CData ODBC Driver, you will be able to build Python apps with access to Gong 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].