Typeorm Pg

TypeORM (PostgreSQL)

Load alongside typeorm. Covers Postgres decisions only; the portable rules live in the typeorm skill.

Identifiers

• Tables and columns are snake_case: @Entity('user_profile'), @Column('varchar', { name: 'email', length: 50 }). Postgres folds unquoted identifiers to lowercase, so snake_case keeps migrations, psql, and \d output free of mandatory quoting.
• Any name outside snake_case requires quoting in every hand-written migration and query, so it is always explicit.
• FK columns are named <entity>_id (e.g. created_by_user_id).
• Constraint and index names are lowercase (Postgres folds them anyway).

Primary keys

• uuid with a mandatory database default: @PrimaryGeneratedColumn('uuid') on the entity and DEFAULT gen_random_uuid() in the migration column. Postgres has no application-side uuid generation, so without the DEFAULT an insert hits the NOT NULL. gen_random_uuid() is built in since PG 13; on older servers enable the pgcrypto extension first.

Logical columns

• Timestamps: @Column('timestamptz', { name: 'created_at', default: () => 'now()' }) (also updated_at). All timestamps are UTC.
• Soft delete: @Column('boolean', { name: 'deleted', default: false }) plus deleted_at and optional deleted_by.
• When existing entities already use @CreateDateColumn / @UpdateDateColumn / @DeleteDateColumn, keep that style; do not introduce them where they are not already present. The migration files stay the source of truth either way.

Indexes

• Partial indexes match the SQL exactly: @Index('uq_player_email', ['email'], { unique: true, where: 'email IS NOT NULL AND has_verified_email AND NOT deleted' }).