requireConcurrentIndexDeletion¶

Group safety · Migrations only · Since 0.15.0
Diagnostic lint/requireConcurrentIndexDeletion

Sources: inspired by squawk/require-concurrent-index-deletion

Description¶

Dropping indexes non-concurrently can lock the table for reads.

When dropping an index, using DROP INDEX without CONCURRENTLY will lock the table preventing reads and writes for the duration of the drop. This can cause downtime in production systems. Use DROP INDEX CONCURRENTLY to drop the index without blocking concurrent operations.

Examples¶

Invalid¶

DROP INDEX IF EXISTS users_email_idx;

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

  ! Dropping an index non-concurrently blocks reads and writes to the table.

  > 1 │ DROP INDEX IF EXISTS users_email_idx;
      │ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
    2 │ 

  i Use DROP INDEX CONCURRENTLY to avoid blocking concurrent operations on the table.

Valid¶

DROP INDEX CONCURRENTLY IF EXISTS users_email_idx;

How to configure¶

{
  "linter": {
    "rules": {
      "requireConcurrentIndexDeletion": "error"
    }
  }
}

How to suppress¶

Suppress this diagnostic with a comment:

-- pgls-ignore requireConcurrentIndexDeletion