Re: Logical replication - initial data synchronization - Mailing list pgsql-docs

From Peter Smith
Subject Re: Logical replication - initial data synchronization
Date
Msg-id CAHut+Pvk5ZCS2iDoF_HRkKJKYiT08mOixGzrJgxsCbp_pqFZvw@mail.gmail.com
Whole thread Raw
In response to Re: Logical replication - initial data synchronization  (Bruce Momjian <bruce@momjian.us>)
Responses Re: Logical replication - initial data synchronization
List pgsql-docs
On Fri, Nov 22, 2024 at 9:15 AM Bruce Momjian <bruce@momjian.us> wrote:
>
> On Thu, Oct 31, 2024 at 06:52:34PM -0400, Bruce Momjian wrote:
> > On Fri, Nov  1, 2024 at 09:07:38AM +1100, Peter Smith wrote:
> > > On Fri, Nov 1, 2024 at 2:16 AM Bruce Momjian <bruce@momjian.us> wrote:
> > > >
> > > > On Fri, Oct 25, 2024 at 11:48:16PM +0200, Koen De Groote wrote:
> > > > > Number 2 would be perfect, I think. It leaves no doubt at all.
> > > >
> > > > I went with even more direct wording, patch attached.  Glad we could
> > > > improve this together --- the feedback from everyone was helpful.
> > > >
> > >
> > > One small nit -- I think "PostgreSQL" typically would have SGML markup:
> > >
> > > <productname>PostgreSQL</productname>
> >
> > Yes, I thought so too, but if you look at the SGML, it uses PostgreSQL
> > with no markup in many places close to this sentence, e.g. "PostgreSQL
> > supports both  mechanisms concurrently".
>
> Patch applied to master.  :-)
>

Sorry for the late nit, but when I read the re-worded text that was
pushed [1], I felt the word "typically" was misplaced.

Maybe it is a personal opinion, but OTOH Chat-GPT has the same opinion as me:

------
Me:
Is "typically" in the correct place below?
When logical replication of a table typically starts, PostgreSQL takes
a snapshot of the table's data on the publisher database and copies it
to the subscriber.

ChatGPT said:
The placement of "typically" in your sentence is grammatically
correct, but it may cause slight confusion about what "typically" is
modifying. It seems to suggest that the timing of when logical
replication starts varies, which might not be the intended meaning.

If you mean that it is the process of taking a snapshot that typically
happens (not the timing of when replication starts), then "typically"
would be better placed after "PostgreSQL." Here's a revised version
for clarity:

"When logical replication of a table starts, PostgreSQL typically
takes a snapshot of the table's data on the publisher database and
copies it to the subscriber."

This makes it clear that "typically" refers to the snapshot-taking
process, not the timing of replication's start.
------

======
[1] https://github.com/postgres/postgres/commit/4c4aaa19a6fed39e0eb0247625331c3df34d8211

Kind Regards,
Peter Smith.
Fujitsu Australia



pgsql-docs by date:

Previous
From: PG Doc comments form
Date:
Subject: Clarification Needed on VARIADIC Keyword Explanation
Next
From: PG Doc comments form
Date:
Subject: Creation of extensions and Backend C/C++ functions.