Re: pg_dump/pg_dumpall help synopses and terminology
Peter Eisentraut <peter@eisentraut.org>
From: Peter Eisentraut <peter@eisentraut.org>
To: Ashutosh Bapat <ashutosh.bapat.oss@gmail.com>
Cc: pgsql-hackers <pgsql-hackers@postgresql.org>
Date: 2025-06-17T07:32:27Z
Lists: pgsql-hackers
On 10.06.25 13:51, Ashutosh Bapat wrote: > Since we are using "a PostgreSQL database" and "a PostgreSQL cluster" > with pg_dump and pg_dumpall respectively, it makes sense to use the same > wording for pg_restore. Th description at [1] already does that, except > it needs small tweaks like below: > > pg_restore - restore a PostgreSQL database or a PostgreSQL cluster from > an archive created by > pg_dump or pg_dumpall respectively. > > [1] https://www.postgresql.org/docs/18/app-pgrestore.html <https:// > www.postgresql.org/docs/18/app-pgrestore.html> I think this is too long and too complex for a synopsis. I also don't think that the "respectively" aspect is correct like that. You could use pg_restore to restore less than all of the archive, so you could restore just one database from an archive created by pg_dumpall. The proposed phrasing "restore PostgreSQL databases" leaves it open how many databases you want to restore. I think the most important thing for the pg_restore synopsis is that it mentions the relationship with pg_dump and pg_dumpall. Once you see that, and you have heard about pg_dump/pg_dumpall before, you should be able to get the overall picture. The rest should go into the description.
Commits
-
Improve pg_dump/pg_dumpall help synopses and terminology
- dec6643487bb 18.0 landed
-
doc: Avoid too prominent use of "backup" on pg_dump man page
- 4f29394ea941 18.0 cited