Ready to get started?

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

 Download Now

Learn more:

xBase-Compatible Databases Icon xBase Python Connector

Python Connector Libraries for xBase-Compatible Databases Data Connectivity. Integrate xBase-Compatible Databases with popular Python tools like Pandas, SQLAlchemy, Dash & petl.

How to use SQLAlchemy ORM to access xBase Data in Python

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

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

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

Connecting to xBase Data

Connecting to xBase 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 DataSource property must be set to the name of the folder that contains the .dbf files. Specify the IncludeFiles property to work with xBase table files having extensions that differ from .dbf. Specify multiple extensions in a comma-separated list.

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

You can now connect with a connection string. Use the create_engine function to create an Engine for working with xBase 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("xbase:///?DataSource=MyDBFFilesFolder")

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

Query xBase 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("xbase:///?DataSource=MyDBFFilesFolder") factory = sessionmaker(bind=engine) session = factory() for instance in session.query(Invoices).filter_by(Class="ASSET"): print("Company: ", instance.Company) print("Total: ", instance.Total) 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

Invoices_table = Invoices.metadata.tables["Invoices"] for instance in session.execute( == "ASSET")): print("Company: ", instance.Company) print("Total: ", instance.Total) 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 Python Connector for xBase to start building Python apps and scripts with connectivity to xBase data. Reach out to our Support Team if you have any questions.