Skip to main content

Quart-DB is a Quart extension that provides managed connection(s) to database(s).

Project description

Build Status docs pypi python license

Quart-DB is a Quart extension that provides managed connection(s) to postgresql or sqlite database(s).

Quickstart

Quart-DB is used by associating it with an app and a DB (via a URL) and then utilising the g.connection connection,

from quart import g, Quart, websocket
from quart_db import QuartDB

app = Quart(__name__)
db = QuartDB(app, url="postgresql://user:pass@localhost:5432/db_name")

@app.get("/<int:id>")
async def get_count(id: int):
    result = await g.connection.fetch_val(
        "SELECT COUNT(*) FROM tbl WHERE id = :id",
        {"id": id},
    )
    return {"count": result}

@app.post("/")
async def set_with_transaction():
    async with g.connection.transaction():
        await db.execute("UPDATE tbl SET done = :done", {"done": True})
        ...
    return {}

@app.get("/explicit")
async def explicit_usage():
     async with db.connection() as connection:
         ...

Contributing

Quart-DB is developed on GitHub. If you come across an issue, or have a feature request please open an issue. If you want to contribute a fix or the feature-implementation please do (typo fixes welcome), by proposing a merge request.

Testing

The best way to test Quart-DB is with Tox,

$ pip install tox
$ tox

this will check the code style and run the tests.

Help

The Quart-DB documentation is the best places to start, after that try searching stack overflow or ask for help on gitter. If you still can’t find an answer please open an issue.

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

quart_db-0.8.3.tar.gz (11.6 kB view details)

Uploaded Source

Built Distribution

quart_db-0.8.3-py3-none-any.whl (13.3 kB view details)

Uploaded Python 3

File details

Details for the file quart_db-0.8.3.tar.gz.

File metadata

  • Download URL: quart_db-0.8.3.tar.gz
  • Upload date:
  • Size: 11.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.0 CPython/3.12.5

File hashes

Hashes for quart_db-0.8.3.tar.gz
Algorithm Hash digest
SHA256 3993d6903aa06ec8a95f71442c387c5256bbdaa0a3882c88fef70a8845f6547d
MD5 a1fd07c6579e806215c57f84366a558b
BLAKE2b-256 0c351741723fbfb3837cdf7f6aa73bae8e253f3332045597c73fedb3c22c5853

See more details on using hashes here.

File details

Details for the file quart_db-0.8.3-py3-none-any.whl.

File metadata

  • Download URL: quart_db-0.8.3-py3-none-any.whl
  • Upload date:
  • Size: 13.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.0 CPython/3.12.5

File hashes

Hashes for quart_db-0.8.3-py3-none-any.whl
Algorithm Hash digest
SHA256 9439906af25c403d23218c3242978c18ac833b10ed6c773a1878e428fa2d1c67
MD5 249b1fb72015cbac766c94f734d197d9
BLAKE2b-256 4c7a2ed63b51dba4007619f6fb055fbfe16e9622b36af6d8fc21e5ea9359b165

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