pgrowlocks columns do not match docs: "modes" instead of "lock_type"

From: PG Doc comments form <noreply(at)postgresql(dot)org>
To: pgsql-docs(at)lists(dot)postgresql(dot)org
Cc: chris+postgresql(at)qwirx(dot)com
Subject: pgrowlocks columns do not match docs: "modes" instead of "lock_type"
Date: 2018-10-01 09:42:08
Message-ID: 153838692816.2950.12001142346234155699@wrigleys.postgresql.org
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-docs

The following documentation comment has been logged on the website:

Page: https://www.postgresql.org/docs/10/static/pgrowlocks.html
Description:

Hi,

The description of the pgrowlocks extension says that the function returns a
column called "lock_type". However this column is really called "modes", as
shown in contrib/pgrowlocks/pgrowlocks--1.2.sql:

CREATE FUNCTION pgrowlocks(IN relname text,
OUT locked_row TID, -- row TID
OUT locker XID, -- locking XID
OUT multi bool, -- multi XID?
OUT xids xid[], -- multi XIDs
OUT modes text[], -- multi XID statuses
OUT pids INTEGER[]) -- locker's process id
RETURNS SETOF record
AS 'MODULE_PATHNAME', 'pgrowlocks'
LANGUAGE C STRICT PARALLEL SAFE;

Thanks, Chris.

Responses

Browse pgsql-docs by date

  From Date Subject
Next Message Michael Paquier 2018-10-02 07:41:52 Re: pgrowlocks columns do not match docs: "modes" instead of "lock_type"
Previous Message Martín Marqués 2018-09-28 01:26:04 Re: Incorrect description of autovacuum_vacuum_threshold and autovacuum_vacuum_scale_factor