postgresql-table-design
Skill4 starsChanged 38 days agoMITView on GitHub
Use this skill when designing or reviewing a PostgreSQL-specific schema. Covers best-practices, data types, indexing, constraints, performance patterns, and advanced features
15 other projects use a version of this, 15 of them edited.
Adopted by
Most recently taken up by
- KPISTOLAS/claude-skillsedited, first seen Nov 16, 2026
- liushikuan63/Qoder-Optimizationedited, first seen Nov 1, 2026
- kitloomlk-stack/nextjs-supabase-kitedited, first seen Oct 15, 2026
- chidekina/aria-superpowersedited, first seen Oct 13, 2026
- Samueladewole/claude-skillsedited, first seen Oct 13, 2026
- BidingCC/BuildingAIedited, first seen Oct 8, 2026
Used with
Projects with it also use e2e-testing-patterns, nodejs-backend-patterns and 1 more.
Other files people use alongside this one.
Files found in the same public projects as a version of this one, more often than they turn up anywhere else. Each project counts once, large collections count for less, and this file's own repository is left out.
xfstudioSkille2e-testing-patterns
Master end-to-end testing with Playwright and Cypress to build reliable test suites that catch bugs, improve confidence, and enable fast deployment. Use when implementing E2E tests, debugging flaky tests, or establishing testing standards.
Also in 3 projects that use this
xfstudioSkillnodejs-backend-patterns
Build production-ready Node.js backend services with Express/Fastify, implementing middleware patterns, error handling, authentication, database integration, and API design best practices. Use when creating Node.js servers, REST APIs, GraphQL backends, or microservices architectures.
Also in 3 projects that use this
- +1 more from xfstudio
Other versions15 projects use a version of this.
Word for word · 0
None found.
Edited · 15
- BidingCC/BuildingAI★ 1.9k19% same
- chendongqi/OPB-Skills★ 12519% same
- Bbar0n234/learnflow-ai★ 3519% same
- nilecui/SkillsBase★ 2719% same
- HK-hub/AgentSkills★ 619% same
- GPTtang/skill-atlas★ 419% same
- chidekina/aria-superpowers★ 219% same
- CodeWithBehnam/cc-docs★ 219% same
- liushikuan63/Qoder-Optimization★ 219% same
- roshankodi/agent-skills★ 219% same
5 more not listed
Wrote their own version · 0
None found.
How matches are found. Word for word: the exact same text. Edited: shares passages with this file (“99% same” means 99% of its five-word phrases also appear here; 10% or more counts). Their own version: similar meaning, or, weakest, the same name. We can’t tell which project had it first. Projects are counted among the 200 most-starred candidates, and mentions are links to the repository we found, up to 50 per site, so both counts are a floor.
In this repository37 other files it gives its agents.
- AGENTS.mdAGENTS.md
- CLAUDE.mdCLAUDE.md
- ai-debt-detectorSkill
- airflow-dag-patternsSkill
- async-python-patternsSkill
- backtesting-frameworksSkill
- create-readmeSkill
- data-engineeringSkill
- data-quality-frameworksSkill
- dataset-curationSkill
- dbt-transformation-patternsSkill
- design-doc-mermaidSkill
- embedding-strategiesSkill
- eval-harness-firstSkill
- excalidraw-diagramSkill
- execution-algorithmsSkill
- external-diagram-mermaid-generateSkill
- frontend-designSkill
- hybrid-search-implementationSkill
- improve-codebase-architectureSkill
- llm-evaluationSkill
- market-regime-detectionSkill
- mcp-builderSkill
- mcp-registry-syndicationSkill
- mcprush-gateway-deploymentSkill
- mermaid-diagramsSkill
- ml-pipeline-workflowSkill
- orchestratorSkill
- prompt-engineering-patternsSkill
- python-testing-patternsSkill
- rag-implementationSkill
- regulatory-compliance-auditSkill
- risk-metrics-calculationSkill
- security-reviewSkill
- spark-optimizationSkill
- sql-optimization-patternsSkill
- vector-index-tuningSkill
The file
We split this skill into the rules it gives an agent
8 rules. 4 are common, 1 is distinctive, and 3 are very specific to this project.
4
Common
Most of the 15 edited versions we read keep these.
1
Distinctive
This author's own choices. Worth a look.
3
Very specific
Tied to their project's names, files or tools. Probably skip.
- Common
- Distinctive
- Very specific
- Common: line 23
Add NOT NULL everywhere it is semantically required.
- Common: line 24
Create indexes for access paths you actually query: PK/unique (auto), FK columns (manual!), frequent filters/sorts, and join keys.
- Very specific: line 25
Prefer TIMESTAMPTZ for event time.
- Very specific: line 34
Heap storage: no clustered PK by default.
- Very specific: line 69
B-tree: default for equality/range (=, <, >, BETWEEN, ORDER BY).
- Distinctive: line 79
Use for large tables (>100M rows) whose queries consistently filter on the partition key, or where maintenance (pruning, bulk replacement) …
- Common: line 82
Prefer declarative partitioning or hypertables.
- Common: line 83
Limitations: no global UNIQUE constraints—include the partition key in PK/UNIQUE.
“Common” is measured: kept by at least 6 in 10 of the 15 edited versions of this file we could read. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.
Files
PostgreSQL Table Design
When to Use
- Designing a new PostgreSQL schema, or reviewing one before it ships.
- Choosing column types, keys, constraints, or indexes for PostgreSQL specifically.
- Deciding whether and how to partition a large table, or how to store semi-structured data.
- Planning a schema change on a live database without downtime.
The rules and decision points for a PostgreSQL schema. The full data-type catalog, workload
patterns (update-heavy, insert-heavy, upsert, schema evolution), extensions, JSONB indexing,
and worked DDL examples are in references/details.md; open it when a section below points there.
Core Rules
- Define a PRIMARY KEY for reference tables (users, orders, etc.). Not always needed for time-series/event/log data. When used, prefer
BIGINT GENERATED ALWAYS AS IDENTITY; useUUIDonly when global uniqueness/opacity is needed. - Normalize first (to 3NF) to eliminate data redundancy and update anomalies; denormalize only for measured, high-ROI reads where join performance is proven problematic.
- Add NOT NULL everywhere it is semantically required; use DEFAULTs for common values.
- Create indexes for access paths you actually query: PK/unique (auto), FK columns (manual!), frequent filters/sorts, and join keys.
- Prefer TIMESTAMPTZ for event time; NUMERIC for money; TEXT for strings; BIGINT for integers; DOUBLE PRECISION for floats (or
NUMERICfor exact decimal arithmetic).
PostgreSQL Gotchas
- Identifiers: unquoted → lowercased. Avoid quoted/mixed-case names; use
snake_case. - Unique + NULLs: UNIQUE allows multiple NULLs. Use
UNIQUE NULLS NOT DISTINCT (...)(PG15+) to restrict to one NULL. - FK indexes: PostgreSQL does not auto-index FK columns. Add them.
- No silent coercions: length/precision overflows error out (no truncation). Inserting 999 into
NUMERIC(2,0)fails, unlike databases that silently truncate or round. - Sequences/identity have gaps (normal; don't "fix"). Rollbacks, crashes, and concurrent transactions leave gaps (1, 2, 5, 6...).
- Heap storage: no clustered PK by default;
CLUSTERis a one-off reorganization, not maintained on later inserts. - MVCC: updates/deletes leave dead tuples; vacuum handles them—design to avoid hot wide-row churn.
Data Types
- IDs:
BIGINT GENERATED ALWAYS AS IDENTITY;UUIDfor distributed or opaque IDs, generated withuuidv7()(PG18+) orgen_random_uuid(). - Numbers:
BIGINTunless storage is critical;DOUBLE PRECISIONoverREAL;NUMERIC(p,s)for money and exact decimals. - Strings:
TEXT, withCHECK (LENGTH(col) <= n)when a limit is needed;BYTEAfor binary. Case-insensitive lookups: expression index onLOWER(col), orCITEXTwhen a constraint must be case-insensitive. - Time:
TIMESTAMPTZ,DATE,INTERVAL.now()is transaction start;clock_timestamp()is wall clock. - Booleans:
BOOLEAN NOT NULLunless tri-state is required. - Enums:
CREATE TYPE ... AS ENUMonly for small, stable sets; evolving business values getTEXT+CHECKor a lookup table. - JSONB over JSON, indexed with GIN, for optional/semi-structured attributes only.
- Arrays, ranges, network, geometric, full-text, domain, composite, and vector types, plus TOAST storage and collation control: see
references/details.md.
Types to avoid
| Avoid | Use instead |
timestamp (without time zone) | timestamptz |
char(n), varchar(n) | text (+ CHECK on length if needed) |
money | numeric |
timetz | timestamptz |
timestamptz(0) or any precision | timestamptz |
serial | generated always as identity |
Constraints
- PK: implicit UNIQUE + NOT NULL; creates a B-tree index.
- FK: specify
ON DELETE/UPDATE(CASCADE,RESTRICT,SET NULL,SET DEFAULT). Index the referencing column. UseDEFERRABLE INITIALLY DEFERREDfor circular dependencies checked at commit. - UNIQUE: creates a B-tree index; allows multiple NULLs unless
NULLS NOT DISTINCT(PG15+). PreferNULLS NOT DISTINCTunless duplicate NULLs are wanted. - CHECK: row-local; NULL passes (three-valued logic). Combine with
NOT NULL:price NUMERIC NOT NULL CHECK (price > 0). - EXCLUDE: prevents overlaps with operators, e.g.
EXCLUDE USING gist (room_id WITH =, booking_period WITH &&)stops double-booking. Needs a GiST-capable type.
Indexing
- B-tree: default for equality/range (
=,<,>,BETWEEN,ORDER BY). - Composite: leftmost-prefix rule (
WHERE a = ? AND b > ?uses(a,b);WHERE b = ?does not). Most selective columns first. - Covering:
CREATE INDEX ON tbl (id) INCLUDE (name, email)for index-only scans. - Partial: hot subsets,
CREATE INDEX ON tbl (user_id) WHERE status = 'active'. - Expression:
CREATE INDEX ON tbl (LOWER(email)); the query must use the same expression. - GIN: JSONB containment/existence, arrays, full-text search. GiST: ranges, geometry, exclusion constraints.
- BRIN: large, naturally ordered data (time-series) at minimal storage cost; effective when disk order correlates with the indexed column.
Partitioning
- Use for large tables (>100M rows) whose queries consistently filter on the partition key, or where maintenance (pruning, bulk replacement) follows a key.
- RANGE for time-series (
PARTITION BY RANGE (created_at); TimescaleDB automates it with retention and compression), LIST for discrete values, HASH for even distribution without a natural key. - Constraint exclusion: the planner prunes partitions through their
CHECKconstraints; declarative partitioning (PG10+) creates them for you. - Prefer declarative partitioning or hypertables. Do NOT use table inheritance.
- Limitations: no global UNIQUE constraints—include the partition key in PK/UNIQUE. FKs from partitioned tables need PG11+, FKs referencing a partitioned table need PG12+; on older versions, use triggers.
Examples
CREATE TABLE users (
user_id BIGINT GENERATED ALWAYS AS IDENTITY PRIMARY KEY,
email TEXT NOT NULL UNIQUE,
name TEXT NOT NULL,
created_at TIMESTAMPTZ NOT NULL DEFAULT now()
);
CREATE UNIQUE INDEX ON users (LOWER(email));
CREATE INDEX ON users (created_at);CREATE TABLE orders (
order_id BIGINT GENERATED ALWAYS AS IDENTITY PRIMARY KEY,
user_id BIGINT NOT NULL REFERENCES users(user_id),
status TEXT NOT NULL DEFAULT 'PENDING' CHECK (status IN ('PENDING','PAID','CANCELED')),
total NUMERIC(10,2) NOT NULL CHECK (total > 0),
created_at TIMESTAMPTZ NOT NULL DEFAULT now()
);
CREATE INDEX ON orders (user_id);
CREATE INDEX ON orders (created_at);-- JSONB attributes with a generated, indexable scalar
CREATE TABLE profiles (
user_id BIGINT PRIMARY KEY REFERENCES users(user_id),
attrs JSONB NOT NULL DEFAULT '{}',
theme TEXT GENERATED ALWAYS AS (attrs->>'theme') STORED
);
CREATE INDEX profiles_attrs_gin ON profiles USING GIN (attrs);Going deeper
references/details.md holds the material this file only names:
- The full data-type catalog: TOAST storage, collations, arrays, ranges, network, geometric, text search, domains, composites, vectors.
- Table types (
TEMPORARY,UNLOGGED) and row-level security. - Constraint and index notes, and partitioning DDL for RANGE, LIST, and HASH.
- Workload patterns: update-heavy, insert-heavy, upsert design, safe schema evolution.
- Generated columns and extensions (
pg_trgm,citext,timescaledb,postgis,pgvector, and more). - JSONB indexing strategies, including
jsonb_path_opsand extracted B-tree columns.
Does it work?
Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.
No reviews yet
People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.
- It worked
- Partly
- It didn't
Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.
Your trail
Files you open will collect here, so you can find them again.
Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.
Now do this for your own.
Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

