diff options
| author | Tatsuo Ishii <ishii@postgresql.org> | 2021-02-07 13:43:50 +0900 |
|---|---|---|
| committer | Tatsuo Ishii <ishii@postgresql.org> | 2021-02-07 13:43:50 +0900 |
| commit | 04fd3eeba5be52369fa296fb001d1e52af6e166d (patch) | |
| tree | bbecea69c4c7165cecb5e4e07d65352ba85d01c7 | |
| parent | ed290896335414c6c069b9ccae1f3dcdd2fac6ba (diff) | |
| download | postgresql-04fd3eeba5be52369fa296fb001d1e52af6e166d.tar.gz postgresql-04fd3eeba5be52369fa296fb001d1e52af6e166d.zip | |
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
| -rw-r--r-- | doc/src/sgml/func.sgml | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/doc/src/sgml/func.sgml b/doc/src/sgml/func.sgml index b7150510aba..1ab31a90561 100644 --- a/doc/src/sgml/func.sgml +++ b/doc/src/sgml/func.sgml @@ -25102,11 +25102,11 @@ SELECT collation for ('foo' COLLATE "de_DE"); <indexterm> <primary>pg_wal_lsn_diff</primary> </indexterm> - <function>pg_wal_lsn_diff</function> ( <parameter>lsn</parameter> <type>pg_lsn</type>, <parameter>lsn</parameter> <type>pg_lsn</type> ) + <function>pg_wal_lsn_diff</function> ( <parameter>lsn1</parameter> <type>pg_lsn</type>, <parameter>lsn2</parameter> <type>pg_lsn</type> ) <returnvalue>numeric</returnvalue> </para> <para> - Calculates the difference in bytes between two write-ahead log + Calculates the difference in bytes (<parameter>lsn1</parameter> - <parameter>lsn2</parameter>) between two write-ahead log locations. This can be used with <structname>pg_stat_replication</structname> or some of the functions shown in <xref linkend="functions-admin-backup-table"/> to |