Use SQLAlchemy ORMs to Access Cloudant Data in Python

Ready to get started?

Download a free trial of the Cloudant Connector to get started:

 Download Now

Learn more:

IBM Cloudant Icon Cloudant Python Connector

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

The CData Python Connector for Cloudant enables you to create Python applications and scripts that use SQLAlchemy Object-Relational Mappings of Cloudant data.

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

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

Connecting to Cloudant Data

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

Set the following connection properties to connect to Cloudant:

  • User: Set this to your username.
  • Password: Set this to your password.

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

You can now connect with a connection string. Use the create_engine function to create an Engine for working with Cloudant 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("cloudant:///?User=abc123& Password=abcdef")

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

Query Cloudant 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("cloudant:///?User=abc123& Password=abcdef") factory = sessionmaker(bind=engine) session = factory() for instance in session.query(Movies).filter_by(MovieRating="R"): print("MovieRuntime: ", instance.MovieRuntime) print("MovieRating: ", instance.MovieRating) 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

Movies_table = Movies.metadata.tables["Movies"] for instance in session.execute( == "R")): print("MovieRuntime: ", instance.MovieRuntime) print("MovieRating: ", instance.MovieRating) print("---------")

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

Insert Cloudant Data

To insert Cloudant 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 Cloudant.

new_rec = Movies(MovieRuntime="placeholder", MovieRating="R") session.add(new_rec) session.commit()

Update Cloudant Data

To update Cloudant 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 Cloudant.

updated_rec = session.query(Movies).filter_by(SOME_ID_COLUMN="SOME_ID_VALUE").first() updated_rec.MovieRating = "R" session.commit()

Delete Cloudant Data

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