Using the CData ODBC Driver for Rootly 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 Rootly 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 Rootly 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 Rootly
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.
Using API Key Authentication
To authenticate using an API key, you will need to obtain your API key from your Rootly account settings.
To get your API key:
- Log in to your Rootly account
- Navigate to Settings > API & Integrations
- Click on "API Tokens"
- Copy the generated token
After setting the following connection properties, you are ready to connect:
- AuthScheme: Set this to APIKey.
- APIKey: Set this to your Rootly API token.
Example Connection String
Profile=Rootly.apip;Authscheme=APIKey;ProfileSettings="APIKey=your_apikey";
Below is the syntax for a DSN:
[CData API Source] Driver = CData ODBC Driver for Rootly Description = My Description Profile = Rootly.apip Authscheme = APIKey ProfileSettings = "APIKey = your_apikey"
Execute SQL to Rootly
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 = Rootly.apip;Authscheme = APIKey;ProfileSettings = "APIKey = your_apikey";')
cursor = cnxn.cursor()
cursor.execute("SELECT , FROM Incidents WHERE Status = 'started'")
rows = cursor.fetchall()
for row in rows:
print(row., row.)
After connecting to Rootly in PyCharm using the CData ODBC Driver, you will be able to build Python apps with access to Rootly 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].