Skip to content
This repository was archived by the owner on Aug 19, 2025. It is now read-only.

Commit cea3a8a

Browse files
Update README
1 parent 522d665 commit cea3a8a

1 file changed

Lines changed: 11 additions & 3 deletions

File tree

README.md

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414

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

17-
It allows you to make queries using the powerful [SQLAlchemy Core](https://docs.sqlalchemy.org/en/latest/core/)
17+
It allows you to make queries using the powerful [SQLAlchemy Core][sqlalchemy-core]
1818
expression language, and provides support for PostgreSQL, MySQL, and SQLite.
1919

2020
**Requirements**: Python 3.6+
@@ -35,6 +35,8 @@ $ pip install databases[mysql]
3535
$ pip install databases[sqlite]
3636
```
3737

38+
Driver support is providing using one of [asyncpg][asyncpg], [aiomysql][aiomysql], or [aiosqlite][aiosqlite].
39+
3840
## Getting started
3941

4042
Declare your tables using SQLAlchemy:
@@ -60,7 +62,7 @@ custom column types.
6062

6163
## Queries
6264

63-
You can now use any [SQLAlchemy core](https://docs.sqlalchemy.org/en/latest/core/) queries:
65+
You can now use any [SQLAlchemy core][sqlalchemy-core] queries:
6466

6567
```python
6668
from databases import Database
@@ -195,7 +197,7 @@ $ alembic init migrations
195197
```
196198

197199
You'll want to set things up so that Alembic references the configured
198-
DATABASE_URL, and uses your table metadata.
200+
`DATABASE_URL`, and uses your table metadata.
199201

200202
In `alembic.ini` remove the following line:
201203

@@ -235,3 +237,9 @@ For MySQL you'll probably need to explicitly specify the
235237

236238
If you're using the `databases.DatabaseURL` datatype, you can obtain this using
237239
`DATABASE_URL.replace(dialect="pymysql")`
240+
241+
[sqlalchemy-core]: https://docs.sqlalchemy.org/en/latest/core/
242+
[alembic]: https://alembic.sqlalchemy.org/en/latest/
243+
[asyncpg]: https://github.com/MagicStack/asyncpg
244+
[aiomysql]: https://github.com/aio-libs/aiomysql
245+
[aiosqlite]: https://github.com/jreese/aiosqlite

0 commit comments

Comments
 (0)