Ready to get started?

Learn more about the CData Python Connector for MariaDB or download a free trial:

Download Now

Use SQLAlchemy ORMs to Access MariaDB Data in Python

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

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

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

Connecting to MariaDB Data

Connecting to MariaDB 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 Server and Port properties must be set to a MariaDB server. If IntegratedSecurity is set to false, then User and Password must be set to valid user credentials. Optionally, Database can be set to connect to a specific database. If not set, the tables from all databases are reported.

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

Install Required Modules

Use the pip utility to install the SQLAlchemy toolkit:

pip install sqlalchemy

Be sure to import the module with the following:

import sqlalchemy

Model MariaDB Data in Python

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

engine = create_engine("mariadb///?User=myUser&Password=myPassword&Database=NorthWind&Server=myServer&Port=3306")

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

Query MariaDB 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("mariadb///?User=myUser&Password=myPassword&Database=NorthWind&Server=myServer&Port=3306")
factory = sessionmaker(bind=engine)
session = factory()
for instance in session.query(Orders).filter_by(ShipCountry="USA"):
	print("ShipName: ", instance.ShipName)
	print("ShipCity: ", instance.ShipCity)
	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

Orders_table = Orders.metadata.tables["Orders"]
for instance in session.execute(Orders_table.select().where(Orders_table.c.ShipCountry == "USA")):
	print("ShipName: ", instance.ShipName)
	print("ShipCity: ", instance.ShipCity)
	print("---------")

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

Insert MariaDB Data

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

new_rec = Orders(ShipName="placeholder", ShipCountry="USA")
session.add(new_rec)
session.commit()

Update MariaDB Data

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

updated_rec = session.query(Orders).filter_by(SOME_ID_COLUMN="SOME_ID_VALUE").first()
updated_rec.ShipCountry = "USA"
session.commit()

Delete MariaDB Data

To delete MariaDB 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 recoreds (rows).

deleted_rec = session.query(Orders).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 MariaDB Python Connector to start building Python apps and scripts with connectivity to MariaDB data. Reach out to our Support Team if you have any questions.