Skip to main content

Async database support for Python.

Project description

Databases

Test Suite Package version

Databases gives you simple asyncio support for a range of databases.

It allows you to make queries using the powerful SQLAlchemy Core expression language, and provides support for PostgreSQL, MySQL, and SQLite.

Databases is suitable for integrating against any async Web framework, such as Starlette, Sanic, Responder, Quart, aiohttp, Tornado, or FastAPI.

Documentation: https://www.encode.io/databases/

Requirements: Python 3.6+


Installation

$ pip install databases

You can install the required database drivers with:

$ pip install databases[postgresql]
$ pip install databases[mysql]
$ pip install databases[sqlite]

Default driver support is provided using one of asyncpg, aiomysql, or aiosqlite.

You can also use other database drivers supported by databases:

$ pip install databases[postgresql+aiopg]
$ pip install databases[mysql+asyncmy]

Note that if you are using any synchronous SQLAlchemy functions such as engine.create_all() or alembic migrations then you still have to install a synchronous DB driver: psycopg2 for PostgreSQL and pymysql for MySQL.


Quickstart

For this example we'll create a very simple SQLite database to run some queries against.

$ pip install databases[sqlite]
$ pip install ipython

We can now run a simple example from the console.

Note that we want to use ipython here, because it supports using await expressions directly from the console.

# Create a database instance, and connect to it.
from databases import Database
database = Database('sqlite:///example.db')
await database.connect()

# Create a table.
query = """CREATE TABLE HighScores (id INTEGER PRIMARY KEY, name VARCHAR(100), score INTEGER)"""
await database.execute(query=query)

# Insert some data.
query = "INSERT INTO HighScores(name, score) VALUES (:name, :score)"
values = [
    {"name": "Daisy", "score": 92},
    {"name": "Neil", "score": 87},
    {"name": "Carol", "score": 43},
]
await database.execute_many(query=query, values=values)

# Run a database query.
query = "SELECT * FROM HighScores"
rows = await database.fetch_all(query=query)
print('High Scores:', rows)

Check out the documentation on making database queries for examples of how to start using databases together with SQLAlchemy core expressions.

— ⭐️ —

Databases is BSD licensed code. Designed & built in Brighton, England.

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

databases-0.5.4.tar.gz (15.1 kB view details)

Uploaded Source

Built Distribution

databases-0.5.4-py3-none-any.whl (21.9 kB view details)

Uploaded Python 3

File details

Details for the file databases-0.5.4.tar.gz.

File metadata

  • Download URL: databases-0.5.4.tar.gz
  • Upload date:
  • Size: 15.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.7.1 importlib_metadata/4.10.0 pkginfo/1.8.2 requests/2.27.1 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.7.12

File hashes

Hashes for databases-0.5.4.tar.gz
Algorithm Hash digest
SHA256 04a3294d053bd8d9f4162fc4975ab11a3e9ad01ae37992adce84440725957fec
MD5 f8ede1e57442200dff8c66cf3346a2c0
BLAKE2b-256 e8c5acfd686e1354028506f5e90a88d7830e6ac0e1fad0eb555ce95481123911

See more details on using hashes here.

File details

Details for the file databases-0.5.4-py3-none-any.whl.

File metadata

  • Download URL: databases-0.5.4-py3-none-any.whl
  • Upload date:
  • Size: 21.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.7.1 importlib_metadata/4.10.0 pkginfo/1.8.2 requests/2.27.1 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.7.12

File hashes

Hashes for databases-0.5.4-py3-none-any.whl
Algorithm Hash digest
SHA256 85a6b0dd92e4bc95205c08141baf1e192c8aedb2159ce03bee39bb4117cfed83
MD5 315f68b06865cab5243d32f8d3ae57f5
BLAKE2b-256 d76def83708b34a963a3ea5354f2cf7dbbd925fe426fcd48c8b71acac57c3a87

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