psycopg2

mirror of https://github.com/psycopg/psycopg2.git synced 2024-11-25 18:33:44 +03:00

History

Alexander Kukushkin 6cff5a3e08 Smart replication feedback This commit makes psycopg2 responsible for sending the status update (feedback) messages to the server regardless of whether a synchronous or asynchronous connection is used. Feedback is sent every status_update (default value is 10) seconds, which could be configured by passing a corresponding parameter to the `start_replication()` or `start_replication_expert()` methods. The actual feedback message is sent by the `pq_read_replication_message()` when the status_update timeout is reached. The default behavior of the `send_feedback()` method is changed. It doesn't send a feedback message on every call anymore but just updates internal structures. There is still a way to force sending a message if force or reply parameters are set. The new approach has certain advantages: 1. The client can simply call the `send_feedback()` for every processed message and the library will take care of not overwhelming the server. Actually, in the synchronous mode it is even mandatory to confirm every processed message. 2. The library tracks internally the pointer of the last received message which is not keepalive. If the client confirmed the last message and after that server sends only keepalives with increasing wal_end, the library can safely move forward flush position to the wal_end and later automatically report it to the server. Reporting of the wal_end received from keepalive messages is very important. Not doing so casing: 1. Excessive disk usage, because the replication slot prevents from WAL being cleaned up. 2. The smart and fast shutdown of the server could last indefinitely because walsender waits until the client report flush position equal to the wal_end. This implementation is only extending the existing API and therefore should not break any of the existing code.		2019-05-06 10:27:44 +02:00
..
src	Smart replication feedback	2019-05-06 10:27:44 +02:00
.gitignore	Added table of sqlstate exceptions in the docs	2019-02-17 01:55:14 +01:00
COPYING.LESSER	Trim trailing whitespace from all files throughout project	2017-12-01 21:42:14 -08:00
Makefile	Allow building docs with Python 3	2019-02-17 01:36:36 +00:00
pep-0249.txt	Trim trailing whitespace from all files throughout project	2017-12-01 21:42:14 -08:00
README.rst	Dropped text docs generation	2019-02-17 00:58:27 +00:00
release.rst	Update all pypi.python.org URLs to pypi.org	2018-05-20 17:22:37 +01:00
requirements.txt	Sphinx version do build docs updated to 1.6	2017-10-18 21:56:48 +01:00
SUCCESS	Trim trailing whitespace from all files throughout project	2017-12-01 21:42:14 -08:00

README.rst

How to build psycopg documentation
----------------------------------

Building the documentation usually requires building the library too for
introspection, so you will need the same prerequisites_.  The only extra
prerequisite is virtualenv_: the packages needed to build the docs will be
installed when building the env.

.. _prerequisites: http://initd.org/psycopg/docs/install.html#install-from-source
.. _virtualenv: https://virtualenv.pypa.io/en/latest/

Build the env once with::

    make env

Then you can build the documentation with::

    make

You should find the rendered documentation in the ``html`` directory.