How do I use peewee-async with FastAPI?

Integrate it by setting up the async database instance in FastAPI's lifespan events, using await for queries in route handlers, and ensuring the event loop is managed properly—examples in the documentation show this pattern.

Is peewee-async better than SQLAlchemy async for my project?

Choose peewee-async if you're already using peewee and want minimal changes; SQLAlchemy async (via asyncio extension) offers broader database support and more features but requires a steeper learning curve for new users.

Can I run migrations async with peewee-async?

No, peewee-async does not support async migrations out-of-the-box; you'll need to use sync migration tools or handle them separately, as async operations are limited to query execution.

What async drivers are required for PostgreSQL?

You can use either aiopg or psycopg3, installed via pip extras like peewee-async[postgresql] or peewee-async[psycopg], but note that psycopg3 is newer and may offer better performance.

Does peewee-async work with SQLite?

No, it only supports PostgreSQL and MySQL; for SQLite, you'd need to stick with sync peewee or use alternative async solutions, as SQLite's async drivers are not integrated.

How to handle connection pooling in peewee-async?

Use the provided pooled database classes like PooledPostgresqlDatabase, which manage connections efficiently in async contexts, but configure pool size and timeouts based on your application's load.

Are there any performance trade-offs with peewee-async?

Yes, while async operations improve concurrency, the overhead of async drivers and potential blocking in sync code mixed with async can impact performance if not managed carefully—benchmark for your use case.

Open-Awesome

peewee-async

MITPythonv2.0.0

An asynchronous interface for the peewee ORM, enabling async database operations with asyncio for PostgreSQL and MySQL.

Visit Website GitHub

766 stars98 forks0 contributors

What is peewee-async?

peewee-async is an asynchronous interface for the peewee ORM, enabling developers to perform database operations using Python's asyncio. It provides async versions of peewee's methods, allowing seamless integration of async queries into applications that use peewee for PostgreSQL and MySQL databases.

Target Audience

Python developers using the peewee ORM who want to incorporate asynchronous database operations into their asyncio-based applications, particularly those working with PostgreSQL or MySQL backends.

Value Proposition

It extends the familiar peewee ORM with async capabilities without requiring a rewrite of existing models, offering a smooth transition to async workflows with support for transactions and pooled connections.

Overview

Asynchronous interface for peewee ORM powered by asyncio

Use Cases

Best For

Adding async database queries to existing peewee-based applications
Building asyncio web services that need async ORM support
Migrating sync peewee codebases to async without major refactoring
Developing high-performance async applications with PostgreSQL or MySQL
Integrating peewee with async frameworks like FastAPI or aiohttp
Handling concurrent database operations in async Python projects

Not Ideal For

Projects using ORMs other than peewee, like SQLAlchemy or Django ORM
Applications that rely on synchronous database access without asyncio integration
Developers needing support for databases beyond PostgreSQL and MySQL, such as SQLite or Oracle
Teams requiring advanced ORM features not yet fully async in peewee-async, like complex joins or aggregations

Pros & Cons

Pros

Async Method Prefixes

Provides asynchronous versions of peewee methods with 'aio_' prefix, such as aio_create and aio_execute, enabling direct async calls without altering sync code, as shown in the Quickstart example.

Drop-in Compatibility

Allows seamless integration with existing peewee models; sync operations remain unchanged, and async can be enabled selectively, reducing refactoring effort.

Transaction Support

Includes asynchronous transactions, supporting complex async workflows with database consistency, which is essential for production applications.

Pooled Connections

Offers pooled database connections via classes like PooledPostgresqlDatabase, improving performance in high-concurrency async environments.

Cons

Limited Database Support

Only compatible with PostgreSQL and MySQL via specific async drivers (aiopg, psycopg3, aiomysql), excluding other databases peewee supports, such as SQLite.

Basic Async Features

The README admits 'basic operations are supported,' implying not all peewee features have async equivalents, which may restrict advanced querying or migrations.

Dependency Complexity

Requires installing specific async backends (e.g., peewee-async[postgresql]), adding dependencies and potential version conflicts, especially with evolving driver libraries.

Documentation Fragmentation

Has a deprecated documentation link, and reliance on external docs for drivers can make setup and troubleshooting more challenging for new users.

Frequently Asked Questions

Related Projects

Redis Python client

PyMongo - the Official MongoDB Python driver

Stars4,341

Forks1,141

Last commit5 days ago

Databases

Async database support for Python. 🗄

Stars4,006

Forks261

Last commit1 year ago

Prisma Client Python

Prisma Client Python is an auto-generated and fully type-safe database client designed for ease of use

Stars2,106

Forks94