Rules when working with PostgreSQL database in Gram
Comprehensive guidelines when working with PostgreSQL database to build Gram which include rules for schema design, database migration and application logic. All rules are kept in a rules folder with names of each rule outlined below (e.g. rules/<rule-name>.md).
Reference these guidelines when:
Code Formatting and Comments:
pgformatter or similar.-- a comment); do not add a space for commented-out code (--raise notice).Naming Conventions:
snake_case for identifiers (e.g., user_id, customer_name).customers, products).Data Integrity and Data Types:
INTEGER, VARCHAR, TIMESTAMP).NOT NULL, UNIQUE, CHECK, FOREIGN KEY) to enforce data integrity.ON DELETE SET NULL clause.Indexing:
WHERE clauses and JOIN conditions.B-tree, Hash, GIN, GiST) based on the data and query requirements.Schema evolution:
mise db:diff <migration-name> after making schema changes to generate a migration file. Replace <migration-name> with a clear snake-case migration id such as users-add-email-column.mise run db:reset 2. mise run db:migrate to re-run all migrations from the beginning.mise run db:diff <name-of-migrations>: Create a database migrationmise run db:reset: Drop the database and re-create it. No migrations applied at this point.mise run db:migrate: Run all pending database migrations. If you have just reset the database, this will run all migrations from the beginning.When creating any tables, add a non-nullable column named project_id of type uuid with a foreign key constraint to the projects table. If appropriate to the nature and usage patterns of the table also include organization_id TEXT NOT NULL column.
All tables should have created_at and updated_at columns:
create table if not exists example (
-- ...
created_at timestamptz not null default clock_timestamp(),
updated_at timestamptz not null default clock_timestamp() on update clock_timestamp(),
-- ...
);
A nullable deleted_at column may be added to tables to perform soft deletes:
create table if not exists example (
-- ...
deleted_at timestamptz,
deleted boolean not null generated always as (deleted_at is not null) stored,
-- ...
);
Deleting rows with DELETE FROM table is not strongly discouraged. Instead,