Rename backup_label to recovery_control

From: David Steele <david(at)pgmasters(dot)net>
To: Pg Hackers <pgsql-hackers(at)postgresql(dot)org>
Subject: Rename backup_label to recovery_control
Date: 2023-10-14 18:19:42
Message-ID: eb3d1aae-1a75-bcd3-692a-38729423168f@pgmasters.net
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-hackers

Hackers,

I was recently discussing the complexities of dealing with pg_control
and backup_label with some hackers at PGConf NYC, when David Christensen
commented that backup_label was not a very good name since it gives the
impression of being informational and therefore something the user can
delete. In fact, we see this happen quite a lot, and there have been
some other discussions about it recently, see [1] and [2]. I bounced the
idea of a rename off various hackers at the conference and in general
people seemed to think it was a good idea.

Attached is a patch to rename backup_label to recovery_control. The
purpose is to make it more obvious that the file should not be deleted.
I'm open to other names, e.g. recovery.control. That makes the naming
distinct from tablespace_map, which is perhaps a good thing, but is also
more likely to be confused with recovery.signal.

I did a pretty straight-forward search and replace on comments and
documentation with only light editing. If this seems like a good idea
and we choose a final name, I'll do a more thorough pass through the
comments and docs to try and make the usage more consistent.

Note that there is one usage of backup label that remains, i.e. the text
that the user can set to describe the backup.

Regards,
-David

[1]
https://www.postgresql.org/message-id/1330cb48-4e47-03ca-f2fb-b144b49514d8%40pgmasters.net
[2]
https://www.postgresql.org/message-id/flat/CAM_vCudkSjr7NsNKSdjwtfAm9dbzepY6beZ5DP177POKy8%3D2aw%40mail.gmail.com#746e492bfcd2667635634f1477a61288

Attachment Content-Type Size
v01-rename-backup-label-to-recovery-control.patch text/plain 31.6 KB

Responses

Browse pgsql-hackers by date

  From Date Subject
Next Message John Morris 2023-10-14 18:54:28 Re: Where can I find the doxyfile?
Previous Message Tom Lane 2023-10-14 16:09:47 Re: PostgreSQL domains and NOT NULL constraint