Validates that Postgres tables include required columns.

Examples

With rules: [[only: [schema: "public"], columns: ["tenant_id"]]], before:

CREATE TABLE invoices (
  id uuid PRIMARY KEY,
  amount numeric NOT NULL
);

Tables without the project-standard scope column are easy to query or mutate without tenant filtering.

After, add the required column:

CREATE TABLE invoices (
  id uuid PRIMARY KEY,
  tenant_id uuid NOT NULL,
  amount numeric NOT NULL
);

The table can participate in the same scoping, authorization, and cleanup patterns as the rest of the schema.

Notes

The check only verifies column presence. It does not validate type, nullability, indexes, or constraints for required columns.

Options

Use rules: [...] to require columns for scoped groups of tables. A rule applies when a table matches any matcher in only; keys inside one matcher are combined. Matching rules accumulate, so the same table can be validated by more than one rule.

{Bylaw.Db.Adapters.Postgres.Checks.RequiredColumns,
 rules: [
   [
     columns: ["inserted_at", "updated_at"],
     except: [[table: "schema_migrations"]]
   ],
   [
     only: [
       [schema: "audit"],
       [schema: "billing", table: ~r/^invoice_/]
     ],
     columns: ["tenant_id"]
   ]
 ]}

Use rule-level except: [...] for exclusions.

Usage

Add this module to the checks passed to Bylaw.Db.Adapters.Postgres.validate/2. See the README usage section for the full ExUnit setup.