Skip to content

Commit 7eaa988

Browse files
Documentation : the wait timeout flag (#188)
* Documentation : the wait timeout flag I ran into a situation where the timeout was reached at the very beginning of the operations (because I use -D and there was an autovacuum running), and I was confused by the documentation. The details section of the documentation states clearly that the ACCESS EXCLUSIVE locks are needed at the beginning and at the end of the repack, but I propose to make the `--wait-timeout`flag documentation a little clearer on this. Thank you for this amazing tool btw ! --------- Co-authored-by: Andreas Scherbaum <[email protected]>
1 parent 652b10c commit 7eaa988

File tree

1 file changed

+8
-7
lines changed

1 file changed

+8
-7
lines changed

doc/pg_repack.rst

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -197,13 +197,14 @@ Reorg Options
197197
with the ``--table`` or ``--parent-table`` options.
198198

199199
``-T SECS``, ``--wait-timeout=SECS``
200-
pg_repack needs to take an exclusive lock at the end of the
201-
reorganization. This setting controls how many seconds pg_repack will
202-
wait to acquire this lock. If the lock cannot be taken after this duration
203-
and ``--no-kill-backend`` option is not specified, pg_repack will forcibly
204-
cancel the conflicting queries. If you are using PostgreSQL version 8.4
205-
or newer, pg_repack will fall back to using pg_terminate_backend() to
206-
disconnect any remaining backends after twice this timeout has passed.
200+
pg_repack needs to take one exclusive lock at the beginning and and one
201+
exclusive lock at the end of the reorganization. This setting controls
202+
how many seconds pg_repack will wait to acquire this lock. If the lock
203+
cannot be taken after this duration and ``--no-kill-backend`` option is
204+
not specified, pg_repack will forcibly cancel the conflicting queries.
205+
If you are using PostgreSQL version 8.4 or newer, pg_repack will fall
206+
back to using pg_terminate_backend() to disconnect any remaining
207+
backends after twice this timeout has passed.
207208
The default is 60 seconds.
208209

209210
``-D``, ``--no-kill-backend``

0 commit comments

Comments
 (0)