mcpField
P
postgresql-best-practices

postgresql-best-practices

github.com/wimolivierData & databases5172 installsUpdated 27w ago
Repository

About postgresql-best-practices

A practical reference for PostgreSQL 18+ developers, covering database architecture, SQL conventions, migrations, testing, performance, and operations. Its guidance centers on schema separation, API functions, and security practices, with reference documents and executable migration scripts.

Key features

  1. 01Presents data, private, and api schema separation
  2. 02Covers functions, procedures, triggers, and naming
  3. 03Includes migration documentation and executable scripts
  4. 04Addresses testing, performance, security, and data patterns
  5. 05Lists PostgreSQL 18+ features and anti-patterns

Use cases

  1. 01Design an API layer for application database access
  2. 02Establish a versioned database migration process
  3. 03Review query performance and indexing strategies
  4. 04Implement tenant isolation, auditing, or vector search

Install

Copy the command and run it in a terminal.

$npx skills add https://github.com/wimolivier/postgresql-best-practices --skill postgresql-best-practices

After installing, type/postgresql-best-practicesin Claude Code to confirm it loaded.

Bundled files

References and scripts installed along with SKILL.md.

README.md
CLAUDE.md
references/
checklists-troubleshooting.md
anti-patterns.md
audit-logging.md
bulk-operations.md
backup-recovery.md
cicd-integration.md
analytical-queries.md
coding-standards-trivadis.md
data-types.md
indexes-constraints.md
full-text-search.md
encryption.md
event-sourcing.md
data-warehousing-medallion.md
migrations.md
oracle-migration-guide.md
jsonb-patterns.md
monitoring-observability.md
plpgsql-table-api.md
partitioning.md
performance-tuning.md
queue-patterns.md
postgis-patterns.md
replication-ha.md
quick-reference.md
schema-naming.md
row-level-security.md
schema-architecture.md

Details

From the project README

PostgreSQL Advanced Best Practices (PostgreSQL 18+)

Architecture at a Glance

                        ┌─── PostgreSQL Database ──────────────────────────────┐
                        │                                                      │
                        │  ┌──────────────────┐    ┌───────────────────────┐   │
                        │  │   api schema      │    │   private schema      │   │
  ┌─────────────┐       │  │──────────────────│    │───────────────────────│   │
  │ Application │─EXECUTE─▶│ get_customer()   │───▶│ set_updated_at()     │   │
  └─────────────┘       │  │ insert_order()   │    │ hash_password()      │   │
        │               │  └────────┬─────────┘    └──────────┬────────────┘   │
        │               │           │                         │                │
        │               │           │ SECURITY DEFINER        │ triggers       │
        │               │           ▼                         ▼                │
        │               │  ┌──────────────────────────────────────────────┐    │
        │               │  │              data schema                     │    │
     BLOCKED            │  │──────────────────────────────────────────────│    │
        │               │  │  customers    orders    ...                  │    │
        └ ─ ─ ─ ✕       │  └──────────────────────────────────────────────┘    │
                        │                                                      │
                        └──────────────────────────────────────────────────────┘

Skill Contents

🚀 Getting Started (Read These First)
DocumentPurpose
quick-reference.mdQUICK LOOKUP - Single-page cheat sheet (print this!)
schema-architecture.mdSTART HERE - Schema separation pattern (data/private/api)
coding-standards-trivadis.mdCoding standards & naming conventions (l_, g_, co_)
📚 Core Reference (Use Daily)
DocumentPurpose
plpgsql-table-api.mdTable API functions, procedures, triggers
schema-naming.mdNaming conventions for all objects
data-types.mdData type selection (UUIDv7, text, timestamptz)
indexes-constraints.mdIndex types, strategies, constraints
migrations.mdNative migration system documentation
anti-patterns.mdCommon mistakes to avoid
checklists-troubleshooting.mdProject checklists & problem solutions
🔧 Advanced Topics (When Needed)
DocumentPurpose
testing-patterns.mdpgTAP unit testing, test factories
performance-tuning.mdEXPLAIN ANALYZE, query optimization, JIT
row-level-security.mdRLS patterns, multi-tenant isolation
jsonb-patterns.mdJSONB indexing, queries, validation
audit-logging.mdGeneric audit triggers, change tracking
bulk-operations.mdCOPY, batch inserts, upserts
session-management.mdSession variables, connection pooling
transaction-patterns.mdIsolation levels, locking, deadlock prevention
full-text-search.mdtsvector, tsquery, ranking, multi-language
partitioning.mdRange, list, hash partitioning strategies
window-functions.mdFrames, ranking, running calculations
time-series.mdTime-series data patterns, BRIN indexes
event-sourcing.mdEvent store, projections, CQRS
queue-patterns.mdJob queues, SKIP LOCKED, LISTEN/NOTIFY
encryption.mdpgcrypto, column encryption, TLS
vector-search.mdpgvector, embeddings, similarity search
postgis-patterns.mdSpatial data, geographic queries
🚀 DevOps & Migration
DocumentPurpose
oracle-migration-guide.mdPL/SQL to PL/pgSQL conversion
cicd-integration.mdGitHub Actions, GitLab CI, Docker
monitoring-observability.mdpg_stat_statements, metrics, alerting
backup-recovery.mdpg_dump, pg_basebackup, PITR
replication-ha.mdStreaming/logical replication, failover
📊 Data Warehousing
DocumentPurpose
data-warehousing-medallion.mdMedallion Architecture - Bronze/Silver/Gold, data lineage, ETL
analytical-queries.mdAnalytical query patterns, OLAP optimization, GROUPING SETS
Executable Scripts
ScriptPurpose
001_install_migration_system.sqlInstall migration system (core functions)
002_migration_runner_helpers.sqlHelper procedures (run_versioned, run_repeatable)
003_example_migrations.sqlExample migration patterns
999_uninstall_migration_system.sqlClean removal of migration system

Core Architecture

Schema Separation Pattern
Application → api schema → data schema
                ↓
            private schema (triggers, helpers)
SchemaContainsAccessPurpose
dataTables, indexesNoneData storage
privateTriggers, helpersNoneInternal logic
apiFunctions, proceduresApplicationsExternal interface
app_auditAudit tablesAdminsChange tracking
app_migrationMigration trackingAdminsSchema versioning
Security Model

All api functions MUST have:

SECURITY DEFINER
SET search_path = data, private, pg_temp

Quick Reference

Create Table Pattern
CREATE TABLE data.{table_name} (
    id              uuid PRIMARY KEY DEFAULT uuidv7(),
    -- columns...
    created_at      timestamptz NOT NULL DEFAULT now(),
    updated_at      timestamptz NOT NULL DEFAULT now()
);

CREATE TRIGGER {table}_bu_updated_trg
    BEFORE UPDATE ON data.{table_name}
    FOR EACH ROW EXECUTE FUNCTION private.set_updated_at();
API Function Pattern
CREATE FUNCTION api.{action}_{entity}(in_param type)
RETURNS TABLE (col1 type, col2 type)
LANGUAGE sql STABLE
SECURITY DEFINER
SET search_path = data, private, pg_temp
AS $$
    SELECT col1, col2 FROM data.{table} WHERE ...;
$$;
API Procedure Pattern
CREATE PROCEDURE api.{action}_{entity}(
    in_param type,
    INOUT io_id uuid DEFAULT NULL
)
LANGUAGE plpgsql
SECURITY DEFINER
SET search_path = data, private, pg_temp
AS $$
BEGIN
    INSERT INTO data.{table} (...) VALUES (...) RETURNING id INTO io_id;
END;
$$;
Migration Pattern
SELECT app_migration.acquire_lock();

CALL app_migration.run_versioned(
    in_version := '001',
    in_description := 'Description',
    in_sql := $mig$ ... $mig$,
    in_rollback_sql := '...'
);

SELECT app_migration.release_lock();

Naming Conventions

Trivadis-Style Variable Prefixes
PrefixTypeExample
l_Local variablel_customer_count
g_Session/global variableg_current_user_id
co_Constantco_max_retries
in_IN parameterin_customer_id
out_OUT parameter (functions only)out_total
io_INOUT parameter (procedures)io_id
c_Cursorc_active_orders
r_Recordr_customer
t_Array/tablet_order_ids
e_Exceptione_not_found

Note: PostgreSQL procedures only support INOUT parameters, not OUT. Use io_ prefix for all procedure output parameters.

Database Objects
ObjectPatternExample
Tablesnake_case, pluralorders, order_items
Columnsnake_casecustomer_id, created_at
Primary Keyidid
Foreign Key{table_singular}_idcustomer_id
Index{table}_{cols}_idxorders_customer_id_idx
Unique{table}_{cols}_keyusers_email_key
Function{action}_{entity}get_customer, select_orders
Procedure{action}_{entity}insert_order, update_status
Trigger{table}_{timing}{event}_trgorders_bu_trg

Data Type Recommendations

UseInstead Of
textchar(n), varchar(n)
numeric(p,s)money, float
timestamptztimestamp
booleaninteger flags
uuidv7()serial, uuid_generate_v4()
GENERATED ALWAYS AS IDENTITYserial, bigserial
jsonbjson, EAV pattern

Critical Anti-Patterns

  1. ❌ Direct table access from applications
  2. ❌ RETURNS SETOF table (exposes all columns)
  3. ❌ Missing SET search_path with SECURITY DEFINER
  4. ❌ timestamp without timezone
  5. ❌ NOT IN with subqueries (use NOT EXISTS)
  6. ❌ BETWEEN with timestamps (use >= AND <)
  7. ❌ Missing indexes on foreign keys
  8. ❌ serial/bigserial (use IDENTITY)
  9. ❌ varchar(n) arbitrary limits (use text)
  10. ❌ SELECT FOR UPDATE without NOWAIT/SKIP LOCKED

PostgreSQL 18+ Features

FeatureUsage
uuidv7()id uuid DEFAULT uuidv7() - timestamp-ordered UUIDs
Virtual generated columnscol type GENERATED ALWAYS AS (expr) - computed at query time
OLD/NEW in RETURNINGUPDATE ... RETURNING OLD.col, NEW.col
Temporal constraintsPRIMARY KEY (id) WITHOUT OVERLAPS
NOT VALID constraintsAdd constraints without full table scan

File Organization

db/
├── migrations/
│   ├── V001__create_schemas.sql
│   ├── V002__create_tables.sql
│   └── repeatable/
│       ├── R__private_triggers.sql
│       └── R__api_functions.sql
├── schemas/
│   ├── data/           # Table definitions
│   ├── private/        # Internal functions
│   └── api/            # External interface
└── seeds/              # Reference data

Comments

Markdown supported