Re: pg_dump shared locks documentation

From: Alvaro Herrera <alvherre(at)alvh(dot)no-ip(dot)org>
To: Florin Irion <irionr(at)gmail(dot)com>
Cc: pgsql-docs(at)lists(dot)postgresql(dot)org
Subject: Re: pg_dump shared locks documentation
Date: 2022-03-15 15:06:57
Message-ID: 202203151506.55cjea5lmp2l@alvherre.pgsql
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-docs

On 2022-Mar-15, Florin Irion wrote:

> In the `pg_dump` documentation we talk about "shared locks", but IIUC,
> we actually take `AccessShareLock`s. This might be misunderstood with
> the `ShareLock`.

This might be a bit excessive to have in the main text. What about
adding a footnote to point out the exact lock level that is meant, with
a link to the server doc page that explains each lock level?
Something like this:

> Requesting exclusive locks on database objects while running a parallel dump could
> cause the dump to fail. The reason is that the <application>pg_dump</application> leader process
> - requests shared locks on the objects that the worker processes are going to dump later
> + requests shared locks<footnote>The precise lock level used is <literal>ACCESS SHARE</literal>.
> + See <xref ... /> for more information.</footnote> on the objects that the worker processes are
> going to dump later

...

> @@ -870,7 +870,7 @@ PostgreSQL documentation
> <term><option>--lock-wait-timeout=<replaceable class="parameter">timeout</replaceable></option></term>
> <listitem>
> <para>
> - Do not wait forever to acquire shared table locks at the beginning of

Same here.

--
Álvaro Herrera

In response to

Responses

Browse pgsql-docs by date

  From Date Subject
Next Message Tom Lane 2022-03-15 15:55:09 Re: pg_dump shared locks documentation
Previous Message Florin Irion 2022-03-15 14:19:47 pg_dump shared locks documentation