How to use SQLAlchemy ORM to access Workable 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 Workable-connected Python applications and scripts. This article shows how to use SQLAlchemy to connect to Workable data to query Workable data.

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

Connecting to Workable Data

Connecting to Workable 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.

Using API Key Authentication

Workable uses API key authentication to control access to the API. To obtain an API Key:

1. Log in to your Workable account.
2. Navigate to Settings > Integrations > API Access Tokens.
3. Click "Generate API Token".
4. Copy the generated token.

After obtaining your API Key, set the following connection properties:

• AuthScheme: Set this to APIKey.

Set the following in the ProfileSettings connection property:

• APIKey: Set this to your Workable API Key.
• Subdomain: Set this to your Workable account subdomain. For example, if your Workable URL is acmeinc.workable.com, then the Subdomain is 'acmeinc'.

Example Connection String

Profile=C:\profiles\Workable.apip;ProfileSettings='AuthScheme=APIKey;APIKey=my_api_key;Subdomain=acmeinc';

Follow the procedure below to install SQLAlchemy and start accessing Workable 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 Workable Data in Python

You can now connect with a connection string. Use the create_engine function to create an Engine for working with Workable 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\Workable.apip&ProfileSettings='AuthScheme=APIKey&APIKey=my_api_key&Subdomain=acmeinc'")

Declare a Mapping Class for Workable 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 Accounts 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 Accounts(base):
	__tablename__ = "Accounts"
	 = Column(String,primary_key=True)
	 = Column(String)
	...

Query Workable 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\Workable.apip&ProfileSettings='AuthScheme=APIKey&APIKey=my_api_key&Subdomain=acmeinc'")
factory = sessionmaker(bind=engine)
session = factory()
for instance in session.query(Accounts).filter_by(=""):
	print(": ", instance.)
	print(": ", instance.)
	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

Accounts_table = Accounts.metadata.tables["Accounts"]
for instance in session.execute(Accounts_table.select().where(Accounts_table.c. == "")):
	print(": ", instance.)
	print(": ", instance.)
	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 Workable data. Reach out to our Support Team if you have any questions.