requireConcurrentIndexCreation¶

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

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

Description¶

Creating indexes non-concurrently can lock the table for writes.

When creating an index on an existing table, using CREATE INDEX without CONCURRENTLY will lock the table against writes for the duration of the index build. This can cause downtime in production systems. Use CREATE INDEX CONCURRENTLY to build the index without blocking concurrent operations.

Examples¶

Invalid¶

CREATE INDEX users_email_idx ON users (email);

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

  ! Creating an index non-concurrently blocks writes to the table.

  > 1 │ CREATE INDEX users_email_idx ON users (email);
      │ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
    2 │ 

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

Valid¶

CREATE INDEX CONCURRENTLY users_email_idx ON users (email);

How to configure¶

{
  "linter": {
    "rules": {
      "requireConcurrentIndexCreation": "error"
    }
  }
}

How to suppress¶

Suppress this diagnostic with a comment:

-- pgls-ignore requireConcurrentIndexCreation