Re: DOCS: pg_createsubscriber wrong link?

From: vignesh C <vignesh21(at)gmail(dot)com>
To: Peter Smith <smithpb2250(at)gmail(dot)com>
Cc: PostgreSQL Hackers <pgsql-hackers(at)lists(dot)postgresql(dot)org>
Subject: Re: DOCS: pg_createsubscriber wrong link?
Date: 2024-12-13 09:31:34
Message-ID: CALDaNm3P69h4SqcZaPF7Swmw21=NPLEuqnxd8wmAaya0kR86fw@mail.gmail.com
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-hackers

On Fri, 13 Dec 2024 at 10:58, Peter Smith <smithpb2250(at)gmail(dot)com> wrote:
>
> Hi,
>
> While reviewing the pg_createsubscriber [1] docs I found a potentially
> wrong linkend.
>
> This sentence:
> "For smaller databases, initial data synchronization is recommended."
>
> links to [2] ("29.4.5. Initial Data Synchronization").
>
> This seems to have been deliberately changed (commit [3])
>
> FROM: <link linkend="logical-replication">initial data synchronization</link>
>
> TO: <link linkend="logical-replication-row-filter-initial-data-sync">initial
> data synchronization</link>
>
> Although the title "Initial Data Synchronization" seems at face value
> to be relevant, this particular link target is a sub-section of "Row
> Filters", so I don't see why this would be the intended link from the
> pg_createsubscriber. AFAICT, the original discussion and commit
> message does not explain.

I also felt that the link was directed to the wrong page.

> Here is a new patch giving an alternate link which IMO might be more
> appropriate.

How about we change the below:
more the time when the logical replica will be available. For smaller
- databases, <link linkend="logical-replication-row-filter-initial-data-sync">
- initial data synchronization</link> is recommended.
+ databases, initial data synchronization is recommended. For details, see the
+ <command>CREATE SUBSCRIPTION</command> <link
linkend="sql-createsubscription-params-with-copy-data">
+ <literal>copy_data</literal></link> option.
+
to:
For smaller databases, it is recommended to set up <link
linkend="logical-replication">logical replication</link> with <link
linkend="sql-createsubscription-params-with-copy-data">initial data
synchronization</link>.

Regards,
Vignesh

In response to

Responses

Browse pgsql-hackers by date

  From Date Subject
Next Message Thomas Munro 2024-12-13 09:44:06 Re: Remaining dependency on setlocale()
Previous Message Bertrand Drouvot 2024-12-13 09:20:13 Re: per backend I/O statistics