pg.ddx.io  pgsql-docs@postgresql.org mailing list archive  
help / color / mirror / Atom feed
Not clear sentence
4+ messages / 4 participants
[nested] [flat]

* Not clear sentence
@ 2022-01-20 19:46  PG Doc comments form <noreply@postgresql.org>
  0 siblings, 1 reply; 4+ messages in thread

From: PG Doc comments form @ 2022-01-20 19:46 UTC (permalink / raw)
  To: pgsql-docs@lists.postgresql.org; +Cc: smeka@purestorage.com

The following documentation comment has been logged on the website:

Page: https://www.postgresql.org/docs/14/backup-dump.html
Description:

URL: https://www.postgresql.org/docs/current/backup-dump.html


Text: This is necessary to fully backup the cluster if running the pg_dump
command on individual databases.

Please provide an explanation or re-write the same, thanks.


^ permalink  raw  reply  [nested|flat] 4+ messages in thread

* Re: Not clear sentence
@ 2022-01-21 12:35  Laurenz Albe <laurenz.albe@cybertec.at>
  parent: PG Doc comments form <noreply@postgresql.org>
  0 siblings, 1 reply; 4+ messages in thread

From: Laurenz Albe @ 2022-01-21 12:35 UTC (permalink / raw)
  To: smeka@purestorage.com; pgsql-docs@lists.postgresql.org

On Thu, 2022-01-20 at 19:46 +0000, PG Doc comments form wrote:
> Page: https://www.postgresql.org/docs/14/backup-dump.html
> Description:
> 
> Text: This is necessary to fully backup the cluster if running the pg_dump
> command on individual databases.
> 
> Please provide an explanation or re-write the same, thanks.

Hm, yes, that could be improved.  Perhaps:

  This is required for a full backup of the cluster that is performed
  by pg_dump on the individual databases.

Yours,
Laurenz Albe






^ permalink  raw  reply  [nested|flat] 4+ messages in thread

* Re: Not clear sentence
@ 2022-01-21 15:05  David G. Johnston <david.g.johnston@gmail.com>
  parent: Laurenz Albe <laurenz.albe@cybertec.at>
  0 siblings, 1 reply; 4+ messages in thread

From: David G. Johnston @ 2022-01-21 15:05 UTC (permalink / raw)
  To: Laurenz Albe <laurenz.albe@cybertec.at>; +Cc: smeka@purestorage.com, Pg Docs <pgsql-docs@lists.postgresql.org>

On Fri, Jan 21, 2022 at 5:37 AM Laurenz Albe <laurenz.albe@cybertec.at>
wrote:

> On Thu, 2022-01-20 at 19:46 +0000, PG Doc comments form wrote:
> > Page: https://www.postgresql.org/docs/14/backup-dump.html
> > Description:
> >
> > Text: This is necessary to fully backup the cluster if running the
> pg_dump
> > command on individual databases.
> >
> > Please provide an explanation or re-write the same, thanks.
>
> Hm, yes, that could be improved.  Perhaps:
>
>   This is required for a full backup of the cluster that is performed
>   by pg_dump on the individual databases.
>
>
I don't see a problem with the existing wording.  And as the OP hasn't
really described what is confusing them it is difficult to contemplate a
rewrite that would remove that confusion.

The sentence means that one must run pg_dumpall --globals-only (that is
what "this" is referring to without doubt) and add the result to their
backup (implied by the wording "necessary to fully backup"; this data is
missing...) if their backup routine consists of backing up individual
databases using the pg_dump command (exact wording).

If anything, whether one chooses to backup all databases in a cluster
individually using pg_dump is immaterial.  Any single database backed up
using pg_dump is incomplete if it is restored into an empty cluster.  One
must also restore the globals into that cluster first to produce a valid
restoration of that database.  The existing wording implies as much (and we
rightly assume restoration into a freshly initialized cluster) so still no
word-smithing seems needed here.

But hopefully the OP is less confused now.

David J.

^ permalink  raw  reply  [nested|flat] 4+ messages in thread

* Re: Not clear sentence
@ 2022-01-21 17:25  Srinivasa Meka (he/him/his) <smeka@purestorage.com>
  parent: David G. Johnston <david.g.johnston@gmail.com>
  0 siblings, 0 replies; 4+ messages in thread

From: Srinivasa Meka (he/him/his) @ 2022-01-21 17:25 UTC (permalink / raw)
  To: David G. Johnston <david.g.johnston@gmail.com>; +Cc: Laurenz Albe <laurenz.albe@cybertec.at>; Pg Docs <pgsql-docs@lists.postgresql.org>

Thanks David for the explanation - balancing between TLDR and simplistic.
Those two sentences (from David) make easier to read and understand. 




with regards,
Srinivasa Meka (he)   | DevOps Solutions Architect 
smeka@purestorage.com <mailto:smeka@purestorage.com> 
==========





> On Jan 21, 2022, at 10:05 AM, David G. Johnston <david.g.johnston@gmail.com> wrote:
> 
> On Fri, Jan 21, 2022 at 5:37 AM Laurenz Albe <laurenz.albe@cybertec.at <mailto:laurenz.albe@cybertec.at>> wrote:
> On Thu, 2022-01-20 at 19:46 +0000, PG Doc comments form wrote:
> > Page: https://www.postgresql.org/docs/14/backup-dump.html <https://www.postgresql.org/docs/14/backup-dump.html;
> > Description:
> > 
> > Text: This is necessary to fully backup the cluster if running the pg_dump
> > command on individual databases.
> > 
> > Please provide an explanation or re-write the same, thanks.
> 
> Hm, yes, that could be improved.  Perhaps:
> 
>   This is required for a full backup of the cluster that is performed
>   by pg_dump on the individual databases.
> 
> 
> I don't see a problem with the existing wording.  And as the OP hasn't really described what is confusing them it is difficult to contemplate a rewrite that would remove that confusion.
> 
> The sentence means that one must run pg_dumpall --globals-only (that is what "this" is referring to without doubt) and add the result to their backup (implied by the wording "necessary to fully backup"; this data is missing...) if their backup routine consists of backing up individual databases using the pg_dump command (exact wording).
> 
> If anything, whether one chooses to backup all databases in a cluster individually using pg_dump is immaterial.  Any single database backed up using pg_dump is incomplete if it is restored into an empty cluster.  One must also restore the globals into that cluster first to produce a valid restoration of that database.  The existing wording implies as much (and we rightly assume restoration into a freshly initialized cluster) so still no word-smithing seems needed here.
> 
> But hopefully the OP is less confused now.
> 
> David J.

^ permalink  raw  reply  [nested|flat] 4+ messages in thread


end of thread, other threads:[~2022-01-21 17:25 UTC | newest]

Thread overview: 4+ messages (download: mbox mbox.gz follow: Atom feed)
-- links below jump to the message on this page --
2022-01-20 19:46 Not clear sentence PG Doc comments form <noreply@postgresql.org>
2022-01-21 12:35 ` Laurenz Albe <laurenz.albe@cybertec.at>
2022-01-21 15:05   ` David G. Johnston <david.g.johnston@gmail.com>
2022-01-21 17:25     ` Srinivasa Meka (he/him/his) <smeka@purestorage.com>

This inbox is served by DDX for PostgreSQL; see mirroring instructions
for how to clone and mirror all data and code used for this inbox