Frequently Asked Questions
Does asyncpg support DB-API?
No. DB-API is a synchronous API, while asyncpg is based around an asynchronous I/O model. Thus, full drop-in compatibility with DB-API is not possible and we decided to design asyncpg API in a way that is better aligned with PostgreSQL architecture and terminology. We will release a synchronous DB-API-compatible version of asyncpg at some point in the future.
Can I use asyncpg with SQLAlchemy ORM?
Yes. SQLAlchemy version 1.4 and later supports the asyncpg dialect natively. Please refer to its documentation for details. Older SQLAlchemy versions may be used in tandem with a third-party adapter such as asyncpgsa or databases.
Can I use dot-notation with
asyncpg.Record? It looks cleaner.
We decided against making
asyncpg.Record a named tuple
because we want to keep the
Record method namespace separate
from the column namespace. That said, you can provide a custom
class that implements dot-notation via the
record_class argument to
connect() or any of the Record-returning
class MyRecord(asyncpg.Record): def __getattr__(self, name): return self[name]
Cursors created by a call to
cannot be used outside of a transaction. Any such attempt will result in
To create a cursor usable outside of a transaction, use the
DECLARE ... CURSOR WITH HOLD SQL statement directly.
Why am I getting prepared statement errors?
If you are getting intermittent
prepared statement "__asyncpg_stmt_xx__"
does not exist or
prepared statement “__asyncpg_stmt_xx__”
already exists errors, you are most likely not connecting to the
PostgreSQL server directly, but via
pgbouncer. pgbouncer, when
"statement" pooling mode, does not support
prepared statements. You have several options:
if you are using pgbouncer only to reduce the cost of new connections (as opposed to using pgbouncer for connection pooling from a large number of clients in the interest of better scalability), switch to the connection pool functionality provided by asyncpg, it is a much better option for this purpose;
Why do I get
PostgresSyntaxError when using
expression IN $1?
expression IN $1 is not a valid PostgreSQL syntax. To check
a value against a sequence use
expression = any($1::mytype),
mytype is the array element type.