Skip to main content

A generalised and simple database interface library.

Project description

Documentation Status Static Badge Static Badge Static Badge

A generalised and simple database interface library

The dbilib project is a mid-level CPython database interface library which is designed to fit between sqlalchemy and your database interface library.

The interface exposes methods for easily accessing the database engine, executing SQL statements and calling stored procedures - with minimal setup.

As of this release, the following database engines are supported:

  • MySQL / MariaDB
  • Oracle
  • SQLite3
  • SQL Server (coming soon)

Installation

Installing the library is as easy as:

pip install dbilib

This will install the library's required dependencies (e.g. sqlalchemy, etc.). However, it will not install the database-specific libraries, (e.g. cx_Oracle, mysql-connector-python, etc). This design feature helps to not bloat your environment with unneeded packages and keeps cross-platform capability and flexibility.

Using the Library

The documentation suite contains usage examples and detailed explanation for each of the library's importable modules. Please refer to the Library API Documentation section of the documentation.

Database Support

Our currently supported databases are listed in the overview section on this page. However, for further detail regarding the databases supported by the SQLAlchemy library, please refer to their documentation, specifically their Included Dialects page, which lists the supported database dialects and their version(s).

Connection Strings

For convenience, we have provided a link to the connection string (or database URL) templates for each database dialect supported by sqlalchemy. Generally, the database URLs follow this convention:

dialect+driver://username:password@host:port/database

For example, the MySQL / MariaDB specific database URL using the mysql-connector-python driver, is:

mysql+mysqlconnector://<user>:<pwd>@<host>:<port>/<database>

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

dbilib-0.4.0rc1.tar.gz (3.2 MB view hashes)

Uploaded Source

Built Distribution

dbilib-0.4.0rc1-py3-none-any.whl (17.9 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page