Re: The pg_stop_backup will return one row with three values.

From: Michael Paquier <michael(at)paquier(dot)xyz>
To: Dave Cramer <davecramer(at)postgres(dot)rocks>
Cc: Laurenz Albe <laurenz(dot)albe(at)cybertec(dot)at>, Pg Docs <pgsql-docs(at)lists(dot)postgresql(dot)org>
Subject: Re: The pg_stop_backup will return one row with three values.
Date: 2021-12-20 12:47:14
Message-ID: YcB7UiwHj0Zk5BhN@paquier.xyz
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-docs

On Mon, Dec 20, 2021 at 07:19:32AM -0500, Dave Cramer wrote:
> The docs say it returns 3 values ?

They do. Here is the relevant part:
https://www.postgresql.org/docs/devel/functions-admin.html#FUNCTIONS-ADMIN-BACKUP
"The result of the function is a single record. The lsn column holds
the backup's ending write-ahead log location (which again can be
ignored). The second and third columns are NULL when ending an
exclusive backup; after a non-exclusive backup they hold the desired
contents of the label and tablespace map files."

For exclusive backups, where pg_stop_backup() is used without an
argument, 1 row is returned with the LSN marking the end of the
backup. When pg_stop_backup(true) is used, you would get one row with
three attributes: the end LSN, the label file as NULL and a tablespace
map as NULL.

For non-exclusive backups, pg_stop_backup(false) returns those three
fields, all of them being not NULL. pg_stop_backup() without an
argument cannot be used for non-exclusive backups.
--
Michael

In response to

Browse pgsql-docs by date

  From Date Subject
Next Message Julien Rouhaud 2021-12-20 13:12:39 Re: The pg_stop_backup will return one row with three values.
Previous Message Dave Cramer 2021-12-20 12:19:32 Re: The pg_stop_backup will return one row with three values.