Skip to content

Commit af50b6d

Browse files
author
Antonin Houska
committed
README: fixed information on how the identity index is determined.
#69
1 parent 7fd1d35 commit af50b6d

File tree

1 file changed

+11
-7
lines changed

1 file changed

+11
-7
lines changed

README.md

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -50,9 +50,12 @@ the upgrade will fail.*
5050

5151
# Register table for regular processing
5252

53-
First, make sure that your table has either primary key or unique constraint.
54-
This is necessary to process changes other transactions might do while
55-
`pg_squeeze` is doing its work.
53+
First, make sure that your table has an identity index - this is necessary to
54+
process changes other transactions might do while `pg_squeeze` is doing its
55+
work. If the replica identity of the table is DEFAULT or FULL, primary key
56+
constraint provides the identity index. If your table has no primary key, you
57+
need to set the identity index explicitly using the [ALTER COMMAND ... REPLICA
58+
IDENTITY USING INDEX ...][7] command.
5659

5760
To make the `pg_squeeze` extension aware of the table, you need to insert a
5861
record into `squeeze.tables` table. Once added, statistics of the table are
@@ -374,8 +377,9 @@ tables and indexes to be squeezed is 1GB, an additional 2GB of disk space is
374377
required.
375378

376379
[1]: https://reorg.github.io/pg_repack/
377-
[2]: https://www.postgresql.org/docs/13/static/sql-cluster.html
378-
[3]: https://www.postgresql.org/docs/13/static/bgworker.html
379-
[4]: https://www.postgresql.org/docs/13/static/logicaldecoding.html
380-
[5]: https://www.postgresql.org/docs/13/static/mvcc-caveats.html
380+
[2]: https://www.postgresql.org/docs/17/static/sql-cluster.html
381+
[3]: https://www.postgresql.org/docs/17/static/bgworker.html
382+
[4]: https://www.postgresql.org/docs/17/static/logicaldecoding.html
383+
[5]: https://www.postgresql.org/docs/17/static/mvcc-caveats.html
381384
[6]: https://www.freebsd.org/cgi/man.cgi?query=crontab&sektion=5&apropos=0&manpath=FreeBSD+12.1-RELEASE+and+Ports
385+
[7]: https://www.postgresql.org/docs/17/sql-altertable.html

0 commit comments

Comments
 (0)