Discover how a bimodal integration strategy can address the major data management challenges facing your organization today.
Get the Report →How to use SQLAlchemy ORM to access HubSpot Data in Python
Create Python applications and scripts that use SQLAlchemy Object-Relational Mappings of HubSpot data.
The rich ecosystem of Python modules lets you get to work quickly and integrate your systems effectively. With the CData Python Connector for HubSpot and the SQLAlchemy toolkit, you can build HubSpot-connected Python applications and scripts. This article shows how to use SQLAlchemy to connect to HubSpot data to query, update, delete, and insert HubSpot data.
With built-in optimized data processing, the CData Python Connector offers unmatched performance for interacting with live HubSpot data in Python. When you issue complex SQL queries from HubSpot, the CData Connector pushes supported SQL operations, like filters and aggregations, directly to HubSpot and utilizes the embedded SQL engine to process unsupported operations client-side (often SQL functions and JOIN operations).
About HubSpot Data Integration
CData provides the easiest way to access and integrate live data from HubSpot. Customers use CData connectivity to:
- Access HubSpot without worrying about API updates or changes..
- Access custom objects and fields in HubSpot with no extra configuration steps involved.
- Use SQL stored procedures to perform functional operations like uploading or downloading attachments, inserting engagements, and creating or deleting custom objects or fields.
Users frequently integrate HubSpot with analytics tools such as Tableau, Power BI, and Excel, and leverage our tools to replicate Workday data to databases or data warehouses.
To learn about how other customers are using CData's HubSpot solutions, check out our blog: Drivers in Focus: Simplified HubSpot Connectivity.
Getting Started
Connecting to HubSpot Data
Connecting to HubSpot 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.
HubSpot uses the OAuth authentication standard. You can use the embedded OAuthClientId, OAuthClientSecret, and CallbackURL or you can obtain your own by registering an app.
See the Getting Started chapter of the help documentation for a guide to using OAuth.
Follow the procedure below to install SQLAlchemy and start accessing HubSpot 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 HubSpot Data in Python
You can now connect with a connection string. Use the create_engine function to create an Engine for working with HubSpot 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("hubspot:///?InitiateOAuth=GETANDREFRESH&OAuthSettingsLocation=/PATH/TO/OAuthSettings.txt")
Declare a Mapping Class for HubSpot 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 Prospects 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 Prospects(base):
__tablename__ = "Prospects"
Slug = Column(String,primary_key=True)
PageViews = Column(String)
...
Query HubSpot 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("hubspot:///?InitiateOAuth=GETANDREFRESH&OAuthSettingsLocation=/PATH/TO/OAuthSettings.txt")
factory = sessionmaker(bind=engine)
session = factory()
for instance in session.query(Prospects).filter_by(Region="ONTARIO"):
print("Slug: ", instance.Slug)
print("PageViews: ", instance.PageViews)
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
Prospects_table = Prospects.metadata.tables["Prospects"]
for instance in session.execute(Prospects_table.select().where(Prospects_table.c.Region == "ONTARIO")):
print("Slug: ", instance.Slug)
print("PageViews: ", instance.PageViews)
print("---------")
For examples of more complex querying, including JOINs, aggregations, limits, and more, refer to the Help documentation for the extension.
Insert HubSpot Data
To insert HubSpot data, define an instance of the mapped class and add it to the active session. Call the commit function on the session to push all added instances to HubSpot.
new_rec = Prospects(Slug="placeholder", Region="ONTARIO")
session.add(new_rec)
session.commit()
Update HubSpot Data
To update HubSpot data, fetch the desired record(s) with a filter query. Then, modify the values of the fields and call the commit function on the session to push the modified record to HubSpot.
updated_rec = session.query(Prospects).filter_by(SOME_ID_COLUMN="SOME_ID_VALUE").first()
updated_rec.Region = "ONTARIO"
session.commit()
Delete HubSpot Data
To delete HubSpot data, fetch the desired record(s) with a filter query. Then delete the record with the active session and call the commit function on the session to perform the delete operation on the provided records (rows).
deleted_rec = session.query(Prospects).filter_by(SOME_ID_COLUMN="SOME_ID_VALUE").first()
session.delete(deleted_rec)
session.commit()
Free Trial & More Information
Download a free, 30-day trial of the CData Python Connector for HubSpot to start building Python apps and scripts with connectivity to HubSpot data. Reach out to our Support Team if you have any questions.