Re: pg_dump/pg_dumpall help synopses and terminology

From: Ashutosh Bapat <ashutosh(dot)bapat(dot)oss(at)gmail(dot)com>
To: Peter Eisentraut <peter(at)eisentraut(dot)org>
Cc: pgsql-hackers <pgsql-hackers(at)postgresql(dot)org>
Subject: Re: pg_dump/pg_dumpall help synopses and terminology
Date: 2025-06-10 11:51:35
Message-ID: CAExHW5um8FYYo_qeHsgwrAFiBq+FaE7Ry+1MeTv8hx8==CDKCQ@mail.gmail.com
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-hackers

Hi Peter,

On Tue, Jun 10, 2025 at 12:29 PM Peter Eisentraut <peter(at)eisentraut(dot)org>
wrote:

> How about this to bring it all together:
>
> pg_dump --help:
> pg_dump exports a PostgreSQL database as an SQL script or to other formats.
>
> pg_dumpall --help:
> pg_dumpall exports a PostgreSQL database cluster as an SQL script or to
> other formats.
>
> (Note: Uses the verb "export", to align with commit 4f29394ea94.)
>
> pg_restore --help: [unchanged]
> pg_restore restores PostgreSQL databases from archives created by
> pg_dump or pg_dumpall.
>
> man pages:
> pg_dump - export a PostgreSQL database as an SQL script or to other formats
> pg_dumpall - export a PostgreSQL database cluster as an SQL script or to
> other formats
>
> pg_restore - restore PostgreSQL databases from archives created by
> pg_dump or pg_dumpall
>

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

--
Best Wishes,
Ashutosh Bapat

In response to

Browse pgsql-hackers by date

  From Date Subject
Next Message Jim Jones 2025-06-10 12:51:16 Re: Feature: psql - display current search_path in prompt
Previous Message Florents Tselai 2025-06-10 11:36:53 Re: Feature: psql - display current search_path in prompt