diff options
| author | David Rowley <drowley@postgresql.org> | 2024-04-20 13:55:32 +1200 |
|---|---|---|
| committer | David Rowley <drowley@postgresql.org> | 2024-04-20 13:55:32 +1200 |
| commit | e4c76f5eca92c195abd65c838b1efbd67da0bc16 (patch) | |
| tree | fe800a71dee54e4e9ab93d5576acf6e3256e97ab | |
| parent | c6bfeab42ba203d0565a22612be8717c0b911e7e (diff) | |
| download | postgresql-e4c76f5eca92c195abd65c838b1efbd67da0bc16.tar.gz postgresql-e4c76f5eca92c195abd65c838b1efbd67da0bc16.zip | |
Doc: document cases where queryid is stable
The documents were clear that queryid should not be assumed to be stable
between major versions but said nothing about minor versions and left
the reader to guess if that was implied by the mention of the
instability of queryid between major versions.
Here we give minor versions an explicit mention to indicate queryid can
generally be assumed stable between minor versions.
Reviewed-by: Michael Paquier
Discussion: https://postgr.es/m/CAApHDvpYGE6h0cD9UO-eHySPynPj1L3J%3DHxT%2BA7Ud8_Yo6AuzA%40mail.gmail.com
Backpatch-through: 12
| -rw-r--r-- | doc/src/sgml/pgstatstatements.sgml | 24 |
1 files changed, 15 insertions, 9 deletions
diff --git a/doc/src/sgml/pgstatstatements.sgml b/doc/src/sgml/pgstatstatements.sgml index 2e04b8784d9..a436a84cb53 100644 --- a/doc/src/sgml/pgstatstatements.sgml +++ b/doc/src/sgml/pgstatstatements.sgml @@ -432,15 +432,21 @@ </para> <para> - As a rule of thumb, <structfield>queryid</structfield> values can be assumed to be - stable and comparable only so long as the underlying server version and - catalog metadata details stay exactly the same. Two servers - participating in replication based on physical WAL replay can be expected - to have identical <structfield>queryid</structfield> values for the same query. - However, logical replication schemes do not promise to keep replicas - identical in all relevant details, so <structfield>queryid</structfield> will - not be a useful identifier for accumulating costs across a set of logical - replicas. If in doubt, direct testing is recommended. + Two servers participating in replication based on physical WAL replay can + be expected to have identical <structfield>queryid</structfield> values for + the same query. However, logical replication schemes do not promise to + keep replicas identical in all relevant details, so + <structfield>queryid</structfield> will not be a useful identifier for + accumulating costs across a set of logical replicas. + If in doubt, direct testing is recommended. + </para> + + <para> + Generally, it can be assumed that <structfield>queryid</structfield> values + are stable between minor version releases of <productname>PostgreSQL</productname>, + providing that instances are running on the same machine architecture and + the catalog metadata details match. Compatibility will only be broken + between minor versions as a last resort. </para> <para> |