banVacuumFull¶

Group safety · Recommended · Migrations only · Since 0.25.0
Diagnostic lint/banVacuumFull

Sources: inspired by pgfence/vacuum-full

Description¶

VACUUM FULL rewrites the entire table and acquires an ACCESS EXCLUSIVE lock.

This blocks all reads and writes for the duration of the operation, which can take a very long time on large tables. Use regular VACUUM or pg_repack instead for online table maintenance.

Examples¶

Invalid¶

vacuum full my_table;

code-block.sql:1:1 lint/banVacuumFull ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

  × VACUUM FULL rewrites the entire table and blocks all access.

  > 1 │ vacuum full my_table;
      │ ^^^^^^^^^^^^^^^^^^^^^
    2 │ 

  i Use regular VACUUM or pg_repack for online table maintenance without blocking reads and writes.

Valid¶

vacuum my_table;

How to configure¶

{
  "linter": {
    "rules": {
      "banVacuumFull": "error"
    }
  }
}

How to suppress¶

Suppress this diagnostic with a comment:

-- pgls-ignore banVacuumFull