IN PROGRESS
Seriously, it's in progress. But it's a nice start.
The orm
package is an async ORM for Python, with support for Postgres,
MySQL, and SQLite. ORM is built with:
- SQLAlchemy core for query building.
databases
for cross-database async support.typesystem
for data validation.
Because ORM is built on SQLAlchemy core, you can use Alembic to provide database migrations.
Note: Use ipython
to try this from the console, since it supports await
.
import databases import orm import sqlalchemy database = databases.Database("sqlite:///db.sqlite") metadata = sqlalchemy.MetaData() class Note(orm.Model): __tablename__ = "notes" __database__ = database __metadata__ = metadata id = orm.Integer(primary_key=True) text = orm.String(max_length=100) completed = orm.Boolean(default=False) # Create the database engine = sqlalchemy.create_engine(str(database.url)) metadata.create_all(engine) # .create() await Note.objects.create(text="Buy the groceries.", completed=False) await Note.objects.create(text="Call Mum.", completed=True) await Note.objects.create(text="Send invoices.", completed=True) # .all() notes = await Note.objects.all() # .filter() notes = await Note.objects.filter(completed=True).all() # exact, iexact, contains, icontains, lt, lte, gt, gte, in notes = await Note.objects.filter(text__icontains="mum").all() # .get() note = await Note.objects.get(id=1) # .update() await note.update(completed=True) # .delete() await note.delete() # 'pk' always refers to the primary key note = await Note.objects.get(pk=2) note.pk # 2