Re: Doc: clarify pg_locks descriptions of classid/objid/objsubid

From: Fujii Masao <masao(dot)fujii(at)gmail(dot)com>
To: Hiroki Takamatsu <hiroki(dot)takamatsu(dot)my(at)gmail(dot)com>
Cc: pgsql-docs(at)postgresql(dot)org
Subject: Re: Doc: clarify pg_locks descriptions of classid/objid/objsubid
Date: 2026-08-10 03:33:25
Message-ID: CAHGQGwHWpbo1ETjPAL80QYTmLW9+KEB=Zs7sSZVeH7zjzJ5uPQ@mail.gmail.com
Views: Whole Thread | Raw Message | Download mbox | Resend email
Thread:
Lists: pgsql-docs

On Mon, Mar 30, 2026 at 5:48 PM Hiroki Takamatsu
<hiroki(dot)takamatsu(dot)my(at)gmail(dot)com> wrote:
> The attached patch:
>
> 1. rewrites each column description to scope it to the general database
> object case, instead of making a false claim about NULL behavior for
> all other lock types;
> 2. adds a pointer to the detailed per-lock-type prose below; and
> 3. documents that apply transaction locks show the subscription OID in
> objid.

Thanks for the patch! I agree with the direction.

I made a few additional tweaks in the attached version:

- Scoped the "references ..." notes for classid and objid to the
general database object case as well.
- Changed "see below" to point explicitly to the descriptions of the
specific lock types below.
- Updated the introductory paragraph to mention speculative insertion
locks and apply transaction locks.
- Linked the subscription OID shown for apply transaction locks to
pg_subscription.oid.

> I chose not to enumerate all non-object lock types in the column
> descriptions, since that seemed easy to let drift again as new lock
> types are added.

Agreed. The updated patch also avoids enumerating them in the column
descriptions and keeps those details in the per-lock-type descriptions.

Regards,

--
Fujii Masao

Attachment Content-Type Size
v2-0001-doc-clarify-pg_locks-object-identifier-columns.patch application/octet-stream 4.7 KB

In response to

Browse pgsql-docs by date

  From Date Subject
Next Message jian he 2026-08-12 04:39:13 slightly confusing "contents of views"
Previous Message Oli Sennhauser 2026-08-06 08:12:27 Re: References/Links missing