gordthompson / sqlalchemy-access

A Microsoft Access dialect for SQLAlchemy.
MIT License
50 stars 9 forks source link

sqlalchemy-access

.. image:: https://img.shields.io/pypi/dm/sqlalchemy-access.svg :target: https://pypi.org/project/sqlalchemy-access/

A Microsoft Access dialect for SQLAlchemy on Windows.

The latest version of this dialect requires SQLAlchemy 2.0 or later. To work with earlier versions of SQLAlchemy, do::

pip install sqlalchemy-access<2.0.0

Objectives

This dialect is mainly intended to offer pandas users an easy way to save a DataFrame into an Access database via to_sql.

Pre-requisites

Special case: If you will be running 32-bit Python and you will only be working with .mdb files then you can use the older 32-bit Microsoft Access Driver (*.mdb) that ships with Windows.

Co-requisites

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

pip install sqlalchemy-access

Getting Started

Create an ODBC DSN (Data Source Name) that points to your Access database. (Tip: For best results, enable ExtendedAnsiSQL.) Then, in your Python app, you can connect to the database via::

from sqlalchemy import create_engine
engine = create_engine("access+pyodbc://@your_dsn")

For other ways of connecting see the Getting Connected_ page in the Wiki.

.. _ODBC DSN (Data Source Name): https://support.microsoft.com/en-ca/help/966849/what-is-a-dsn-data-source-name .. _ExtendedAnsiSQL: https://github.com/sqlalchemy/sqlalchemy-access/wiki/%5Btip%5D-use-ExtendedAnsiSQL .. _Getting Connected: https://github.com/sqlalchemy/sqlalchemy-access/wiki/Getting-Connected

The SQLAlchemy Project

SQLAlchemy-access is part of the SQLAlchemy Project <https://www.sqlalchemy.org>_ and adheres to the same standards and conventions as the core project.

Development / Bug reporting / Pull requests

Please refer to the SQLAlchemy Community Guide <https://www.sqlalchemy.org/develop.html>_ for guidelines on coding and participating in this project.

Code of Conduct


Above all, SQLAlchemy places great emphasis on polite, thoughtful, and constructive communication between users and developers. Please see our current Code of Conduct at Code of Conduct <https://www.sqlalchemy.org/codeofconduct.html>_.

License

SQLAlchemy-access is distributed under the MIT license <https://opensource.org/licenses/MIT>_.