Skip to main content

Async SQL + Redis wrapper with Mongo-like interface, fire-and-forget SQL background updates.

Project description

asyncsqlpy

asyncsqlpy is an ultra-fast, asynchronous SQL layer that mimics MongoDB-style operations with full Redis caching and background write queue support.
Itโ€™s designed for high-performance systems that need MongoDB-like flexibility over PostgreSQL.


๐Ÿš€ Features

  • โšก Async I/O โ€“ Fully asynchronous using aiopg and aioredis
  • ๐Ÿง  MongoDB-like syntax โ€“ Use familiar methods like find_one, insert_one, update_many, etc.
  • ๐Ÿ” Redis caching โ€“ Automatic query caching with TTL
  • ๐Ÿงฉ Background SQL Worker Queue โ€“ Batched inserts/updates/deletes to reduce I/O overhead
  • ๐Ÿ”Ž Pub/Sub Watcher โ€“ Real-time change streaming via Redis channels
  • ๐Ÿ’ฅ Automatic Retry + Reconnect โ€“ Fault-tolerant retry for transient SQL/Redis errors
  • ๐Ÿงฐ Dynamic Collections โ€“ Access collections as attributes or subscripts (e.g. db.users or db["users"])
  • ๐Ÿงน Safe Shutdown โ€“ Waits for all pending operations before closing

๐Ÿง‘โ€๐Ÿ’ป Installation

pip install asyncsqlpy

โš™๏ธ Quick Start

import asyncio
from asyncsqlpy import AsyncSqlDB

DSN = "postgres://user:password@hostname:port/dbname?sslmode=require"
REDIS_URL = "redis://localhost:6379"

async def main():
    db = AsyncSqlDB(DSN, REDIS_URL)
    await db.connect()

    users = db["users"]

    # Insert
    await users.insert_one({"name": "Alice", "age": 25})

    # Find
    user = await users.find_one({"name": "Alice"})
    print(user)

    # Update
    await users.update_many({"name": "Alice"}, {"$set": {"age": 26}})

    # Delete
    await users.delete_one({"name": "Alice"})

    # Close safely (waits for background queue to finish)
    await db.close()

asyncio.run(main())

๐Ÿ”„ Watcher (Real-Time Stream)

import asyncio

async def listener(data):
    print("Database change detected:", data)

async def watch_changes():
    db = AsyncSqlDB(DSN, REDIS_URL)
    await db.connect()
    users = db["users"]
    await users.watch(listener)

asyncio.run(watch_changes())

๐Ÿงฎ API Reference

AsyncSqlDB

Method Description
connect() Initialize PostgreSQL + Redis connection
close() Gracefully close and flush all background tasks
__getitem__ / __getattr__ Access collection dynamically

AsyncMongoLikeCollection

Method Description
find_one(filter) Fetch one document
find(filter) Return list of matching documents
insert_one(doc) Insert a new document
insert_many(docs) Insert multiple documents
update_one(filter, update) Update a single document
update_many(filter, update) Update multiple documents
delete_one(filter) Delete a single document
delete_many(filter) Delete multiple documents
count_documents(filter) Count matching documents
watch(callback) Listen for real-time change events via Redis

๐Ÿงฑ Background Worker Queue

All write operations (insert/update/delete) are queued and flushed in batches to PostgreSQL, improving throughput dramatically under high load.

await db.close()  # ensures all batched operations are written before shutdown

โš ๏ธ Error Handling

  • Automatic retries with exponential backoff for SQL and Redis operations
  • Transparent reconnects for transient connection failures
  • Warnings are logged via Pythonโ€™s logging module

๐Ÿงฐ Example Architecture

         โ”Œโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”
         โ”‚   Your App     โ”‚
         โ””โ”€โ”€โ”€โ”€โ”€โ”€โ”ฌโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”˜
                โ”‚
        Async API Calls
                โ”‚
         โ”Œโ”€โ”€โ”€โ”€โ”€โ”€โ–ผโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”
         โ”‚  asyncsqlpy    โ”‚
         โ”‚  (Mongo-like)  โ”‚
         โ””โ”€โ”€โ”€โ”€โ”€โ”€โ”ฌโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”˜
                โ”‚
     โ”Œโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ดโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”
     โ”‚                      โ”‚
โ”Œโ”€โ”€โ”€โ”€โ–ผโ”€โ”€โ”€โ”€โ”€โ”           โ”Œโ”€โ”€โ”€โ”€โ–ผโ”€โ”€โ”€โ”€โ”
โ”‚PostgreSQLโ”‚           โ”‚ Redis   โ”‚
โ”‚(storage) โ”‚           โ”‚(cache + โ”‚
โ”‚          โ”‚           โ”‚ pub/sub)โ”‚
โ””โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”˜           โ””โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”˜

๐Ÿงพ License

MIT License ยฉ 2025 Sathishzus


๐Ÿ’ฌ Author

Sathishzus โ€“ Open Source Systems & Cloud Performance Tools
๐Ÿ”— GitHub | ๐ŸŒ Website

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

asyncsqlpy-0.1.0.tar.gz (3.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

asyncsqlpy-0.1.0-py3-none-any.whl (3.0 kB view details)

Uploaded Python 3

File details

Details for the file asyncsqlpy-0.1.0.tar.gz.

File metadata

  • Download URL: asyncsqlpy-0.1.0.tar.gz
  • Upload date:
  • Size: 3.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.1

File hashes

Hashes for asyncsqlpy-0.1.0.tar.gz
Algorithm Hash digest
SHA256 452c911981a157a8dd4f7ffeac1163145554fc04f0ee9a8a8a760bc520214e54
MD5 c75d8d02a54a55c4e61ad6603df3a75c
BLAKE2b-256 1b4fdb8e4a794d730d94ee275664ab236343c5ede5ff99e979254db7d6194a8f

See more details on using hashes here.

File details

Details for the file asyncsqlpy-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: asyncsqlpy-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 3.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.1

File hashes

Hashes for asyncsqlpy-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 a3ddd205be7013c5a9a79da30bd83894c875b9aa7cca6f8e17688aaa8b147039
MD5 235bed949db8db16bc2dbbe3af2bbe2b
BLAKE2b-256 389f15b2ecedcae09f6c2a097570f280f1fca8c3640895ed7bb729054913b028

See more details on using hashes here.

Supported by

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