Index JSONB Columns with GIN for Fast Lookups
Create a GIN index on the JSONB path so queries like data->>'type' = 'x' use the index instead of a sequential scan.
Task
Apply CREATE INDEX idx_data_gin ON events USING GIN (data jsonb_path_ops); so the schema change is safe, reversible, and does not lock the table during peak traffic.
When to use this
A migration deploys CREATE INDEX idx_data_gin ON events USING GIN (data jsonb_path_ops); during peak hours, takes a 40-second lock, and causes a connection pool exhaustion.
Prerequisites
- A database with migration tooling configured
- A staging environment mirroring production schema
Steps
1. Configure CREATE INDEX idx_data_gin ON events USING GIN (data jsonb_path_ops); in the project configuration file with the recommended defaults.
CREATE INDEX idx_data_gin ON events USING GIN (data jsonb_path_ops);
Expected output: The configuration is accepted and CREATE INDEX idx_data_gin ON events USING GIN (data jsonb_path_ops); runs without errors on the first invocation.
2. Run the check locally to verify CREATE INDEX idx_data_gin ON events USING GIN (data jsonb_path_ops); produces the expected result before pushing.
pnpm test
Expected output: Local run matches CI behavior; no surprises after push.
3. Add the gate to the CI pipeline so CREATE INDEX idx_data_gin ON events USING GIN (data jsonb_path_ops); blocks merge on failure.
- name: Run add jsonb index gin
run: pnpm test
Expected output: Pull requests with failing CREATE INDEX idx_data_gin ON events USING GIN (data jsonb_path_ops); are blocked from merging.
Troubleshooting
Problem
The check passes locally but fails in CI
Solution
Pin dependency versions and the runtime to match CI exactly; reproduce with the same Docker image or act.
Problem
Configuration is rejected with a schema error
Solution
Check the tool version matches the config schema; older versions may not support newer fields.
Limitations
- The gate only runs on events that trigger the workflow; locally pushed commits bypass it.
- Configuration drift is possible if someone edits settings outside version control.
Make migrations safe
Start by measuring the problem. Create a GIN index on the JSONB path so queries like data->>‘type’ = ‘x’ use the index instead of a sequential scan. The most common mistake is adding the gate without first confirming it catches the issue you care about. Run CREATE INDEX idx_data_gin ON events USING GIN (data jsonb_path_ops); against the current codebase and inspect the output before wiring it into CI.
CREATE INDEX idx_data_gin ON events USING GIN (data jsonb_path_ops);Verify and roll back
Once the gate is in place, make failures actionable. A failing CREATE INDEX idx_data_gin ON events USING GIN (data jsonb_path_ops); should point to the exact file and line, not a generic error. Pin the tool version in the lockfile so a upstream release does not silently change behavior. Review the gate output in every pull request just like a test result.