Location via proxy:   [ UP ]  
[Report a bug]   [Manage cookies]                
Skip to content

Commit 9c89c4b

Browse files
committed
Docs: fix pg_wal_lsn_diff manual.
The manual did not mention whether its return value is (first arg - second arg) or (second arg - first arg). The order matters because the return value could have a sign. Fix the manual so that it mentions the function returns (first arg - second arg). Patch reviewed by Tom Lane. Back-patch through v13. Older version's doc format is difficult to add more description. Discussion: https://postgr.es/m/flat/20210206.151125.960423226279810864.t-ishii%40sraoss.co.jp
1 parent 7393751 commit 9c89c4b

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

doc/src/sgml/func.sgml

+2-2
Original file line numberDiff line numberDiff line change
@@ -24403,11 +24403,11 @@ SELECT collation for ('foo' COLLATE "de_DE");
2440324403
<indexterm>
2440424404
<primary>pg_wal_lsn_diff</primary>
2440524405
</indexterm>
24406-
<function>pg_wal_lsn_diff</function> ( <parameter>lsn</parameter> <type>pg_lsn</type>, <parameter>lsn</parameter> <type>pg_lsn</type> )
24406+
<function>pg_wal_lsn_diff</function> ( <parameter>lsn1</parameter> <type>pg_lsn</type>, <parameter>lsn2</parameter> <type>pg_lsn</type> )
2440724407
<returnvalue>numeric</returnvalue>
2440824408
</para>
2440924409
<para>
24410-
Calculates the difference in bytes between two write-ahead log
24410+
Calculates the difference in bytes (<parameter>lsn1</parameter> - <parameter>lsn2</parameter>) between two write-ahead log
2441124411
locations. This can be used
2441224412
with <structname>pg_stat_replication</structname> or some of the
2441324413
functions shown in <xref linkend="functions-admin-backup-table"/> to

0 commit comments

Comments
 (0)