Skip to main content

asyncio db query generator

Project description

aql

Simple, async query library for modern Python

build status code coverage version license code style

Highlights

aql is a simple, modern, and composable query builder, with support for asynchronous execution of queries against multiple database backends using a unified API. aql uses modern, type annotated data structures for both table definitions and queries.

aql is still in early alpha. Not all features are available or finalized.

Define tables:

@table("objects")
class Object:
    id: PrimaryKey[AutoIncrement[int]]
    name: Unique[str]
    description: text
    created: datetime

Build queries:

query = (
    Object.select()
    .where(Object.id >= 25)
    .order_by(Object.name)
    .limit(5)
)

sql, params = SqlEngine.prepare(query)
# "select * from `objects` where `id` >= ? order by `name` asc limit 5", (25)

Execute queries:

async with connect(...) as db:
    cursor = db.execute(Object.select().where(Object.id < 100))
    async for row in cursor:
        print(f"{row.id} {row.name} {row.description}")

Simple actions:

async with connect(...) as db:
    rows = await db.get(Object, Object.id == 100)
    rows[0].description += "updated"

    await db.modify(Object, rows)

License

aql is copyright Amethyst Reese, and licensed under the MIT license. I am providing code in this repository to you under an open source license. This is my personal repository; the license you receive to my code is from me and not from my employer. See the LICENSE file for details.

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

aql-0.5.0.tar.gz (27.0 kB view details)

Uploaded Source

Built Distribution

aql-0.5.0-py3-none-any.whl (28.9 kB view details)

Uploaded Python 3

File details

Details for the file aql-0.5.0.tar.gz.

File metadata

  • Download URL: aql-0.5.0.tar.gz
  • Upload date:
  • Size: 27.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: python-requests/2.31.0

File hashes

Hashes for aql-0.5.0.tar.gz
Algorithm Hash digest
SHA256 8ae30b4be985dee7d79128fec42d4ce440e7ac8d28f6beb8d8358bfb48886adb
MD5 14d4b1793984c07defe625c648c04bff
BLAKE2b-256 a49a15254abbf411388e993aa08238f2daba69c375af36873b69f2f01ab6359f

See more details on using hashes here.

File details

Details for the file aql-0.5.0-py3-none-any.whl.

File metadata

  • Download URL: aql-0.5.0-py3-none-any.whl
  • Upload date:
  • Size: 28.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: python-requests/2.31.0

File hashes

Hashes for aql-0.5.0-py3-none-any.whl
Algorithm Hash digest
SHA256 6e3f632b6167bb9e1c6114a38b7884c79ff71fd66ceaef946279888430e3abdd
MD5 cd0e1a5eb0ba464312bd721b1d3e274a
BLAKE2b-256 1a156bece658b235beac805413291c1d47dec683f190748b4d73e365cfdfe009

See more details on using hashes here.

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