psycopg/psycopg2
1
1
Fork 0
mirror of https://github.com/psycopg/psycopg2.git synced 2024-11-22 17:06:33 +03:00
Code Issues Packages Projects Releases Wiki Activity

Improve docs

Browse Source
This commit is contained in:
Alexander Kukushkin 2019-05-06 15:42:37 +02:00
parent f827e49f55
commit 5eec11f232
1 changed files with 14 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
doc/src/extras.rst
View File

@ -345,6 +345,9 @@ The individual messages in the replication stream are represented by
`read_message()` in case of :ref:`asynchronous connection `read_message()` in case of :ref:`asynchronous connection
<async-support>`. <async-support>`.
.. versionchanged:: 2.8.3
added the *status_interval* parameter.
.. |START_REPLICATION| replace:: :sql:`START_REPLICATION` .. |START_REPLICATION| replace:: :sql:`START_REPLICATION`
.. _START_REPLICATION: https://www.postgresql.org/docs/current/static/protocol-replication.html .. _START_REPLICATION: https://www.postgresql.org/docs/current/static/protocol-replication.html
@ -359,6 +362,9 @@ The individual messages in the replication stream are represented by
performed on messages received from the server. performed on messages received from the server.
:param status_interval: time between feedback packets sent to the server :param status_interval: time between feedback packets sent to the server
.. versionchanged:: 2.8.3
added the *status_interval* parameter.
.. method:: consume_stream(consume, keepalive_interval=None) .. method:: consume_stream(consume, keepalive_interval=None)
@ -417,6 +423,9 @@ The individual messages in the replication stream are represented by
retains all the WAL segments that might be needed to stream the retains all the WAL segments that might be needed to stream the
changes via all of the currently open replication slots. changes via all of the currently open replication slots.
.. versionchanged:: 2.8.3
changed the default value of the *keepalive_interval* parameter to `!None`.
.. method:: send_feedback(write_lsn=0, flush_lsn=0, apply_lsn=0, reply=False, force=False) .. method:: send_feedback(write_lsn=0, flush_lsn=0, apply_lsn=0, reply=False, force=False)
:param write_lsn: a LSN position up to which the client has written the data locally :param write_lsn: a LSN position up to which the client has written the data locally
@ -438,6 +447,9 @@ The individual messages in the replication stream are represented by
to the server. The library sends feedback message automatically to the server. The library sends feedback message automatically
when *status_interval* timeout is reached. when *status_interval* timeout is reached.
.. versionchanged:: 2.8.3
added the *force* parameter.
Low-level replication cursor methods for :ref:`asynchronous connection Low-level replication cursor methods for :ref:`asynchronous connection
<async-support>` operation. <async-support>` operation.
@ -493,6 +505,8 @@ The individual messages in the replication stream are represented by
A `~datetime` object representing the timestamp at the moment when A `~datetime` object representing the timestamp at the moment when
the last feedback message sent to the server. the last feedback message sent to the server.
.. versionadded:: 2.8.3
.. attribute:: wal_end .. attribute:: wal_end
LSN position of the current end of WAL on the server at the LSN position of the current end of WAL on the server at the