the-wondersmith / sqlalchemy-paradox

A SQLAlchemy dialect for the Microsoft Paradox DB ODBC Driver
Other
0 stars 0 forks source link

SQLAlchemy-Paradox

A SQLAlchemy dialect for the Microsoft Paradox DB ODBC Driver

Objectives

This dialect is mainly intended to offer an easy way to access the Paradox DB flat-file databases of older or EOL'd application-specific softwares. It is designed for use with the ODBC driver included with most versions of Microsoft Windows, Microsoft Paradox Driver (*.db) ODBCJT32.DLL.

Pre-requisites

Co-requisites

This dialect requires SQLAlchemy and pyodbc. They are both specified as requirements so pip will install them if they are not already in place. To install separately, just:

pip install -U SQLAlchemy pyodbc

Installation

PyPI-published version:

pip install -U sqlalchemy-paradox

Absolute bleeding-edge (probably buggy):

pip install -U git+https://github.com/the-wondersmith/sqlalchemy-paradox

Getting Started

Create an ODBC DSN (Data Source Name) that points to the directory containing your Paradox table files.

Then, in your Python app, you can connect to the database via:

import sqlalchemy_paradox
from sqlalchemy import create_engine
from sqlalchemy.orm import sessionmaker

db = create_engine("paradox+pyodbc://@your_dsn", echo=False)
super_session = sessionmaker(bind=db)
super_session.configure(autoflush=True, autocommit=True, expire_on_commit=True)
session = super_session()

The SQLAlchemy Project

SQLAlchemy-Paradox is based on SQLAlchemy-access, which is part of the SQLAlchemy Project and tries to adhere to the same standards and conventions as the core project.

At the time of this writing, it's unlikely that SQLAlchemy-Paradox actually does comply with the aforementioned standards and conventions. That will be rectified (if and when) in a future release.

Development / Bug reporting / Pull requests

SQLAlchemy maintains a Community Guide detailing guidelines on coding and participating in that project.

While I'm aware that this project could desperately use the participation of anyone else who actually knows what they're doing, Paradox DB may be so esoteric and obscure (at the time of this writing) that I wouldn't reasonably expect anyone to actually want to. If I am mistaken in that belief, please God submit a pull request.

This library technically works, but it's far from feature-complete.

License

This library is derived almost in its entirety from the SQLAlchemy-Access library written by Gord Thompson. As such, and given that SQLAlchemy-access is distributed under the MIT license, this library is subject to the same licensure and grant of rights as its parent works SQLALchemy and SQLAlchemy-Access.