How to use SQLAlchemy ORM to access Pingdom Data in Python

The rich ecosystem of Python modules lets you get to work quickly and integrate your systems effectively. With the CData API Driver for Python and the SQLAlchemy toolkit, you can build Pingdom-connected Python applications and scripts. This article shows how to use SQLAlchemy to connect to Pingdom data to query Pingdom data.

With built-in optimized data processing, the CData Python Connector offers unmatched performance for interacting with live Pingdom data in Python. When you issue complex SQL queries from Pingdom, the CData Connector pushes supported SQL operations, like filters and aggregations, directly to Pingdom and utilizes the embedded SQL engine to process unsupported operations client-side (often SQL functions and JOIN operations).

Connecting to Pingdom Data

Connecting to Pingdom data looks just like connecting to any relational data source. Create a connection string using the required connection properties. For this article, you will pass the connection string as a parameter to the create_engine function.

Start by setting the Profile connection property to the location of the Pingdom Profile on disk (e.g. C:\profiles\Pingdom.apip). Next, set the ProfileSettings connection property to the connection string for Pingdom (see below).

Pingdom API Profile Settings

In your Pingdom account, navigate to Integrations > The Pingdom API and create a new API Token to use as your API key.

Follow the procedure below to install SQLAlchemy and start accessing Pingdom through Python objects.

Install Required Modules

Use the pip utility to install the SQLAlchemy toolkit and SQLAlchemy ORM package:

pip install sqlalchemy
pip install sqlalchemy.orm

Be sure to import the appropriate modules:

from sqlalchemy import create_engine, String, Column
from sqlalchemy.ext.declarative import declarative_base
from sqlalchemy.orm import sessionmaker

Model Pingdom Data in Python

You can now connect with a connection string. Use the create_engine function to create an Engine for working with Pingdom data.

NOTE: Users should URL encode the any connection string properties that include special characters. For more information, refer to the SQL Alchemy documentation.

engine = create_engine("api:///?Profile=C:\profiles\Pingdom.apip&ProfileSettings='APIKey=your_api_token'")

Declare a Mapping Class for Pingdom Data

After establishing the connection, declare a mapping class for the table you wish to model in the ORM (in this article, we will model the Actions table). Use the sqlalchemy.ext.declarative.declarative_base function and create a new class with some or all of the fields (columns) defined.

base = declarative_base()
class Actions(base):
	__tablename__ = "Actions"
	UserId = Column(String,primary_key=True)
	Username = Column(String)
	...

Query Pingdom Data

With the mapping class prepared, you can use a session object to query the data source. After binding the Engine to the session, provide the mapping class to the session query method.

Using the query Method

engine = create_engine("api:///?Profile=C:\profiles\Pingdom.apip&ProfileSettings='APIKey=your_api_token'")
factory = sessionmaker(bind=engine)
session = factory()
for instance in session.query(Actions).filter_by(Status="delivered"):
	print("UserId: ", instance.UserId)
	print("Username: ", instance.Username)
	print("---------")

Alternatively, you can use the execute method with the appropriate table object. The code below works with an active session.

Using the execute Method

Actions_table = Actions.metadata.tables["Actions"]
for instance in session.execute(Actions_table.select().where(Actions_table.c.Status == "delivered")):
	print("UserId: ", instance.UserId)
	print("Username: ", instance.Username)
	print("---------")

For examples of more complex querying, including JOINs, aggregations, limits, and more, refer to the Help documentation for the extension.

Free Trial & More Information

Download a free, 30-day trial of the CData API Driver for Python to start building Python apps and scripts with connectivity to Pingdom data. Reach out to our Support Team if you have any questions.