Ready to get started?

Download a free trial of the Zoho Creator Connector to get started:

 Download Now

Learn more:

Zoho Creator Icon Zoho Creator Python Connector

Python Connector Libraries for Zoho Creator Data Connectivity. Integrate Zoho Creator with popular Python tools like Pandas, SQLAlchemy, Dash & petl.

How to use SQLAlchemy ORM to access Zoho Creator Data in Python

Create Python applications and scripts that use SQLAlchemy Object-Relational Mappings of Zoho Creator data.

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

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

Connecting to Zoho Creator Data

Connecting to Zoho Creator 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.

The connector is already registered with Zoho Creator as an OAuth application.

If you would prefer to use your own custom OAuth app, see the Help documentation.

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

You can now connect with a connection string. Use the create_engine function to create an Engine for working with Zoho Creator 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("zohocreator:///?AccountsServer=AccountsServer&InitiateOAuth=GETANDREFRESH&OAuthSettingsLocation=/PATH/TO/OAuthSettings.txt")

Declare a Mapping Class for Zoho Creator 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 Leave_Types 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 Leave_Types(base): __tablename__ = "Leave_Types" ID = Column(String,primary_key=True) Leave_Type = Column(String) ...

Query Zoho Creator 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("zohocreator:///?AccountsServer=AccountsServer&InitiateOAuth=GETANDREFRESH&OAuthSettingsLocation=/PATH/TO/OAuthSettings.txt") factory = sessionmaker(bind=engine) session = factory() for instance in session.query(Leave_Types).filter_by(Leave_Type="Sick"): print("ID: ", instance.ID) print("Leave_Type: ", instance.Leave_Type) 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

Leave_Types_table = Leave_Types.metadata.tables["Leave_Types"] for instance in session.execute( == "Sick")): print("ID: ", instance.ID) print("Leave_Type: ", instance.Leave_Type) print("---------")

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

Insert Zoho Creator Data

To insert Zoho Creator 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 Zoho Creator.

new_rec = Leave_Types(ID="placeholder", Leave_Type="Sick") session.add(new_rec) session.commit()

Update Zoho Creator Data

To update Zoho Creator 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 Zoho Creator.

updated_rec = session.query(Leave_Types).filter_by(SOME_ID_COLUMN="SOME_ID_VALUE").first() updated_rec.Leave_Type = "Sick" session.commit()

Delete Zoho Creator Data

To delete Zoho Creator 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(Leave_Types).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 Zoho Creator to start building Python apps and scripts with connectivity to Zoho Creator data. Reach out to our Support Team if you have any questions.