Skip to content

Commit

Permalink
Add basic Psycopg3Connector docs
Browse files Browse the repository at this point in the history
  • Loading branch information
aleksandr-shtaub committed Nov 26, 2023
1 parent d183e62 commit 005c7f2
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 0 deletions.
2 changes: 2 additions & 0 deletions docs/howto/connector.rst
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,7 @@ You can use other `aiopg connection arguments`_ (which are the same as

.. _`aiopg connection arguments`: https://aiopg.readthedocs.io/en/stable/core.html#aiopg.connect
.. _`psycopg2 connection arguments`: http://initd.org/psycopg/docs/module.html#psycopg2.connect
.. _`psycopg3 connection arguments`: https://www.psycopg.org/psycopg3/docs/api/pool.html#psycopg_pool.AsyncConnectionPool

Other arguments
---------------
Expand All @@ -61,3 +62,4 @@ Procrastinate currently provides 2 connectors:
- `Psycopg2Connector`: This connector is specialized for synchronous calls only, and
should only be used to configure your app for synchronous multi-threaded applications
that need to :term:`defer` tasks synchronously (see `discussion-sync-defer`).
- `Psycopg3Connector`: Asynchronous connector based on the next generation of psycopg.
2 changes: 2 additions & 0 deletions docs/reference.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,8 @@ Connectors

.. autoclass:: procrastinate.Psycopg2Connector

.. autoclass:: procrastinate.Psycopg3Connector

.. autoclass:: procrastinate.testing.InMemoryConnector
:members: reset

Expand Down

0 comments on commit 005c7f2

Please sign in to comment.