Skip to main content

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

Project description

Build Status docs pypi python license

Quart-DB is a Quart extension that provides managed connection(s) to postgresql 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 = $1", [True])
        ...
    return {}

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

Parameters can be defined via positional $1 or keyword :id binds.

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.3.0.tar.gz (9.2 kB view details)

Uploaded Source

Built Distribution

quart_db-0.3.0-py3-none-any.whl (8.5 kB view details)

Uploaded Python 3

File details

Details for the file quart-db-0.3.0.tar.gz.

File metadata

  • Download URL: quart-db-0.3.0.tar.gz
  • Upload date:
  • Size: 9.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.14 CPython/3.8.2 Linux/5.4.0-1083-aws

File hashes

Hashes for quart-db-0.3.0.tar.gz
Algorithm Hash digest
SHA256 b08d072d15bedcc43f526e6c1b9225335b5ed2dc9b6423d8d1bc26f99d265cba
MD5 5d31fb25fa0a2077aeaf454d5baf75d7
BLAKE2b-256 60425d629cdd24c3956874f779379b6577c66db566716393453a97da0c3ac9bf

See more details on using hashes here.

File details

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

File metadata

  • Download URL: quart_db-0.3.0-py3-none-any.whl
  • Upload date:
  • Size: 8.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.14 CPython/3.8.2 Linux/5.4.0-1083-aws

File hashes

Hashes for quart_db-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 febcb0bf7eeb80969bc6ec7e84a6906d73f0788fb37ee46843b9f669043dfab2
MD5 ac68ac341413137c1b4cbbe21ed53742
BLAKE2b-256 a3206bccde033279e6bffec811c1da9bec222409785dcf907dc529c9ddde5df3

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