README: added a note about the squeeze_table() function.

cybertec-postgresql · Jun 26, 2024 · db15da0 · db15da0
1 parent 1bba703
commit db15da0
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -197,6 +197,11 @@ Sample execution:
 SELECT squeeze.squeeze_table('public', 'pgbench_accounts');
 ```
 
+Note that the function is not transactional: it only starts a background
+worker, tells it which table it should process and exits. Rollback of the
+transaction the function was called in does not revert the changes done by the
+worker.
+
 # Enable / disable table processing
 
 To enable processing of bloated tables, run this statement as superuser: