Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/encode/databases
Async database support for Python. 🗄
https://github.com/encode/databases
asyncio mysql postgres sqlalchemy sqlite
Last synced: about 2 months ago
JSON representation
Async database support for Python. 🗄
- Host: GitHub
- URL: https://github.com/encode/databases
- Owner: encode
- License: bsd-3-clause
- Created: 2019-02-01T10:55:25.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2024-04-10T10:56:30.000Z (5 months ago)
- Last Synced: 2024-05-18T15:45:07.305Z (4 months ago)
- Topics: asyncio, mysql, postgres, sqlalchemy, sqlite
- Language: Python
- Homepage: https://www.encode.io/databases/
- Size: 848 KB
- Stars: 3,713
- Watchers: 52
- Forks: 259
- Open Issues: 130
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: docs/contributing.md
- License: LICENSE.md
Awesome Lists containing this project
- awesome-fastapi - Databases - Async SQL query builder that works on top of the [SQLAlchemy Core](https://docs.sqlalchemy.org/en/latest/core/) expression language. (Third-Party Extensions / Databases)
- awesome-asyncio - Databases - Async database access for SQLAlchemy core, with support for PostgreSQL, MySQL, and SQLite. (Database Drivers)
- best-of-python - GitHub - 39% open · ⏱️ 01.03.2024): (Database Clients)
- awesome-starts - encode/databases - Async database support for Python. 🗄 (Python)
- awesome-list - Databases - Async database support for Python (Data Management & Processing / Database & Cloud Management)
- awesome-asyncio - Databases - Async database access for SQLAlchemy core, with support for PostgreSQL, MySQL, and SQLite. (Database Drivers)
- awesome-fastapi - Databases - Async SQL query builder that works on top of the [SQLAlchemy Core](https://docs.sqlalchemy.org/en/latest/core/) expression language. (Third-Party Extensions / Databases)
- jimsghstars - encode/databases - Async database support for Python. 🗄 (Python)
README
# Databases
Databases gives you simple asyncio support for a range of databases.
It allows you to make queries using the powerful [SQLAlchemy Core][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][starlette],
[Sanic][sanic], [Responder][responder], [Quart][quart], [aiohttp][aiohttp], [Tornado][tornado], or [FastAPI][fastapi].
**Documentation**: [https://www.encode.io/databases/](https://www.encode.io/databases/)
**Requirements**: Python 3.8+
---
## Installation
```shell
$ pip install databases
```
Database drivers supported are:
* [asyncpg][asyncpg]
* [aiopg][aiopg]
* [aiomysql][aiomysql]
* [asyncmy][asyncmy]
* [aiosqlite][aiosqlite]
You can install the required database drivers with:
```shell
$ pip install databases[asyncpg]
$ pip install databases[aiopg]
$ pip install databases[aiomysql]
$ pip install databases[asyncmy]
$ pip install databases[aiosqlite]
```
Note that if you are using any synchronous SQLAlchemy functions such as `engine.create_all()` or [alembic][alembic] migrations then you still have to install a synchronous DB driver: [psycopg2][psycopg2] for PostgreSQL and [pymysql][pymysql] for MySQL.
---
## Quickstart
For this example we'll create a very simple SQLite database to run some
queries against.
```shell
$ pip install databases[aiosqlite]
$ 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.
```python
# Create a database instance, and connect to it.
from databases import Database
database = Database('sqlite+aiosqlite:///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](https://www.encode.io/databases/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.
[sqlalchemy-core]: https://docs.sqlalchemy.org/en/latest/core/
[sqlalchemy-core-tutorial]: https://docs.sqlalchemy.org/en/latest/core/tutorial.html
[alembic]: https://alembic.sqlalchemy.org/en/latest/
[psycopg2]: https://www.psycopg.org/
[pymysql]: https://github.com/PyMySQL/PyMySQL
[asyncpg]: https://github.com/MagicStack/asyncpg
[aiopg]: https://github.com/aio-libs/aiopg
[aiomysql]: https://github.com/aio-libs/aiomysql
[asyncmy]: https://github.com/long2ice/asyncmy
[aiosqlite]: https://github.com/omnilib/aiosqlite
[starlette]: https://github.com/encode/starlette
[sanic]: https://github.com/huge-success/sanic
[responder]: https://github.com/kennethreitz/responder
[quart]: https://gitlab.com/pgjones/quart
[aiohttp]: https://github.com/aio-libs/aiohttp
[tornado]: https://github.com/tornadoweb/tornado
[fastapi]: https://github.com/tiangolo/fastapi