pg_integrity_checksums - Multi-Level Data Integrity Extension for PostgreSQL

CI Quality CodeQL codecov OpenSSF Scorecard OpenSSF Best Practices

Release CLI release PGXN PGEXT.CLOUD Docker image PostgreSQL 12-19 Docs License: MIT

Overview

pg_integrity_checksums provides cell, tuple, table, index and database checksums. Cell checksums are logical; tuple, table, index and database checksums support both physical and logical modes.

Logical checksums are canonical across endianness, VACUUM/REINDEX/physical movement and database OIDs. Physical checksums are for on-disk corruption in one specific cluster.

The default SQL API uses FNV-1a 32-bit and returns ordinary SQL integers:

SELECT pg_table_logical_checksum('public.orders'::regclass);
SELECT pg_table_physical_checksum('public.orders'::regclass, false);

When two copies of a table differ, the logical checksum can be split by key bucket (or, on a physical standby, by block range) to find the rows that differ; see Finding differing rows.

A generic API with an explicit algorithm (FNV-1a 32/64-bit, CRC-32C or XXH3-64) returns raw bytea digests, for a wider or faster checksum. It is described in the function reference.

Errors and skipped relations

Database-level checksums are strict by default (since 2.5): if a relation cannot be checksummed (an invalid index, a corrupt page, an unlogged table on a standby), the call fails and names the relation, instead of returning a value that silently leaves it out. SET pg_integrity_checksums.strict = off skips such relations with a warning; do not use that value for monitoring. See Strict mode.

Quick start

CREATE EXTENSION pg_integrity_checksums;
SELECT pg_table_logical_checksum('public.orders'::regclass);

Install it with any of these (details):

pgxn install pg_integrity_checksums                     # PGXN
sudo apt install postgresql-16-pg-integrity-checksums   # PIGSTY APT repository
docker run -e POSTGRES_PASSWORD=secret \
  ghcr.io/victornagibator/pg_integrity_checksums:pg16   # image with the extension

git clone https://github.com/VictorNagibator/pg_integrity_checksums.git
cd pg_integrity_checksums && make && sudo make install  # from source (PGXS)

The companion CLI captures baselines and verifies a database against them, with text, JSON and JUnit reports for CI. Download a release binary or use the ghcr.io/victornagibator/pg_integrity_checksums-cli image (see CLI installation), then:

pg_integrity_checksums capture --db "$DATABASE_URL" --output baseline.json
pg_integrity_checksums verify --db "$DATABASE_URL" --baseline baseline.json

The CLI uses the 32-bit v1 baseline format by default. Add --hash fnv64 to capture when you explicitly need a 64-bit v2 baseline.

Documentation

Compatibility

The 32-bit numeric SQL functions are the default and remain fully supported, as are v1 baselines. The optional generic API adds explicit fnv32/fnv64/crc32c/xxh3 digests and v2 baselines; see Functions and algorithms and Concepts for selection guidance.

Support