Skip to main content

Convenient Wrapper around AioSQL and a Database Connection

Project description

AnoDB

Convenient Wrapper around aiosql and a Database Connection.

Tests Coverage Python Databases Drivers Version Badges License

Description

This class creates a persistent database connection and imports SQL queries from a file as simple Python functions.

If the connection is broken, a new connection is attempted.

Compared to aiosql, the point is not to need to pass a connection as an argument on each call: The DB class embeds both connection and query methods.

For concurrent programming (threads, greenlets…), a relevant setup should also consider thread-locals and pooling issues at some higher level.

Example

Install the module with pip install anodb or whatever method you like. Once available:

import anodb
# parameters: driver, connection string, SQL file
db = anodb.DB('sqlite3', 'test.db', 'test.sql')

db.do_some_insert(key=1, val='hello')
db.do_some_update(key=1, val='world')
print("data", db.do_some_select(key=1))
db.commit()

db.close()

With file test.sql containing something like:

-- name: do_some_select
SELECT * FROM Stuff WHERE key = :key;

-- name: do_some_insert!
INSERT INTO Stuff(key, val) VALUES (:key, :val);

-- name: do_some_update!
UPDATE Stuff SET val = :val WHERE key = :key;

Versions

Sources are available on GitHub.

6.0 on later

Make connection string parameter optional, as some drivers do not need it. Add support for MySQL drivers: pymysql, mysqlclient, mysql-connector. Add support for Postgres drivers: pygresql, pg8000. Improved documentation. Improved tests.

5.0 on 2022-07-10

Improve Makefile. Get aiosql version. Simplify code. Sync driver support with aiosql 4.0. Require 100% coverage.

4.2.1 on 2022-01-16

Just fix doc date.

4.2.0 on 2022-01-16

Put back __version__ automatic extraction from package. Add __version__ attribute to DB class. Refactor tests.

4.1.0 on 2021-12-12

Add untested support for MySQL through aiosql_mysql. Temporary work around an issue between pkg_resources, typing_extensions and aiosql.

4.0.2 on 2021-12-12

Add type hint for mypy.

4.0.1 on 2021-12-11

Add package __version__. Minor update for pytest_postgresql 4.0.0.

4.0 on 2021-10-14

Add psycopg 3 support, and make it the default for Postgres.

3.0 on 2021-04-20

Package as a simple module. Use simpler setup.cfg packaging. Include tests in package. Add coverage test and make test coverage reach 100%.

2.2 on 2021-02-20

Setup explicit logger instead of relying on default.

2.1 on 2021-02-14

Make cursor() reconnect if needed.

Add automatic reconnection tests.

2.0 on 2021-02-13

Swith from AnoSQL to AioSQL.

1.3 on 2020-08-02

Make options accept different types.

Make queries optional, and allow to load from files or strings.

1.2 on 2020-07-31

Add options string parameter to constructor.

1.1 on 2020-07-28

Add **conn_options parameter to constructor.

Add cursor() method.

1.0 on 2020-07-27

Initial release.

TODO

  • sync drivers with aiosql?
  • add something about caching?
  • sync version numbering with aiosql?
  • add tests with pg8000 and pygresql?

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

anodb-6.0.tar.gz (8.7 kB view hashes)

Uploaded Source

Built Distribution

anodb-6.0-py3-none-any.whl (5.8 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