summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDaniele Varrazzo <daniele.varrazzo@gmail.com>2017-05-10 01:55:01 +0100
committerDaniele Varrazzo <daniele.varrazzo@gmail.com>2017-05-10 01:55:01 +0100
commit165449c724fe880a1b6ef3ffbe39d65a8e5a43aa (patch)
tree880d4d58954ceec75079fd14e6325903ea328475
parent6e5abf33f257954e23127ae22befdbd51d94750c (diff)
downloadpsycopg2-165449c724fe880a1b6ef3ffbe39d65a8e5a43aa.tar.gz
Added doc link to replication commands
-rw-r--r--doc/src/extras.rst7
1 files changed, 5 insertions, 2 deletions
diff --git a/doc/src/extras.rst b/doc/src/extras.rst
index f162bf1..7e0fd19 100644
--- a/doc/src/extras.rst
+++ b/doc/src/extras.rst
@@ -337,7 +337,7 @@ The individual messages in the replication stream are represented by
*This parameter should not be set with physical replication or with
logical replication plugins that produce binary output.*
- This function constructs a ``START_REPLICATION`` command and calls
+ This function constructs a |START_REPLICATION|_ command and calls
`start_replication_expert()` internally.
After starting the replication, to actually consume the incoming
@@ -345,10 +345,13 @@ The individual messages in the replication stream are represented by
`read_message()` in case of :ref:`asynchronous connection
<async-support>`.
+ .. |START_REPLICATION| replace:: :sql:`START_REPLICATION`
+ .. _START_REPLICATION: https://www.postgresql.org/docs/current/static/protocol-replication.html
+
.. method:: start_replication_expert(command, decode=False)
Start replication on the connection using provided
- ``START_REPLICATION`` command. See `start_replication()` for
+ |START_REPLICATION|_ command. See `start_replication()` for
description of *decode* parameter.
.. method:: consume_stream(consume, keepalive_interval=10)