@core / db

1.0.0 ▾

1.0.0

verificadoMIT

GitHub

Postgres com Drizzle: cliente compartilhado, esquemas por módulo, transações e IDs ULID

Código8 arquivosContexto~547 tokensanálise aprovada

~547 tokens→ src/lib/db/AGENTS.md→ .cursor/rules/genpm-core-db.mdc

Isto é exatamente o que sua IA lê quando trabalha em src/lib/db. Nada mais é adicionado ao contexto dela.

@core/db — rules for AI agents

Purpose

Shared Postgres access for every module: one Drizzle client, per-module schemas, transactions, ULID ids and standard timestamps. It owns no tables itself. Not an ORM wrapper: use Drizzle's query builder directly.

Map

index.ts — public API: getDb, createDb, setDb, withTransaction, primaryId, timestamps, newId, ulid; types Db, Tx, Executor.
client.ts — lazy client from DATABASE_URL (postgres-js).
columns.ts — primaryId(prefix) and timestamps column helpers.
drizzle.config.ts — drizzle-kit config that collects src/lib/*/schema.ts.

Integration

Set DATABASE_URL (any Postgres: local, Neon, Supabase, RDS).
Install the npm deps if GenPM did not: drizzle-orm, postgres, and drizzle-kit as a dev dependency.
Add scripts to package.json: "db:generate": "drizzle-kit generate --config src/lib/db/drizzle.config.ts", "db:migrate": "drizzle-kit migrate --config src/lib/db/drizzle.config.ts".
Run db:generate then db:migrate after installing any module that has a schema.ts.

Query from app code:

import { getDb } from './lib/db/index.js';
const rows = await getDb().select().from(users);

Another driver (Neon serverless, PGlite in tests): build it with Drizzle and call setDb(db) once at startup.

Conventions

Each module defines its tables in its own src/lib/<module>/schema.ts. Never put tables in src/lib/db.
Table names are prefixed with the module when ambiguous (auth_sessions, not sessions).
Primary keys: id: primaryId('<3-4 letter prefix>'); spread ...timestamps in every table.
Functions that write accept an optional Executor (db or tx) so callers can compose them in withTransaction.
Money as integer minor units; times as timestamp with time zone.

Don't

Don't edit or reference another module's tables except through that module's exported functions.
Don't create a second client or connection pool; use getDb().
Don't log DATABASE_URL or query parameters that may hold secrets.
Don't use drizzle-kit push against production; generate and review migrations.

# @core/db — rules for AI agents

## Purpose
Shared Postgres access for every module: one Drizzle client, per-module schemas, transactions, ULID ids and standard
timestamps. It owns no tables itself. Not an ORM wrapper: use Drizzle's query builder directly.

## Map
- `index.ts` — public API: `getDb`, `createDb`, `setDb`, `withTransaction`, `primaryId`, `timestamps`, `newId`, `ulid`; types `Db`, `Tx`, `Executor`.
- `client.ts` — lazy client from `DATABASE_URL` (postgres-js).
- `columns.ts` — `primaryId(prefix)` and `timestamps` column helpers.
- `drizzle.config.ts` — drizzle-kit config that collects `src/lib/*/schema.ts`.

## Integration
1. Set `DATABASE_URL` (any Postgres: local, Neon, Supabase, RDS).
2. Install the npm deps if GenPM did not: `drizzle-orm`, `postgres`, and `drizzle-kit` as a dev dependency.
3. Add scripts to `package.json`:
   `"db:generate": "drizzle-kit generate --config src/lib/db/drizzle.config.ts"`,
   `"db:migrate": "drizzle-kit migrate --config src/lib/db/drizzle.config.ts"`.
4. Run `db:generate` then `db:migrate` after installing any module that has a `schema.ts`.
5. Query from app code:
   ```ts
   import { getDb } from './lib/db/index.js';
   const rows = await getDb().select().from(users);
   ```
6. Another driver (Neon serverless, PGlite in tests): build it with Drizzle and call `setDb(db)` once at startup.

## Conventions
- Each module defines its tables in its own `src/lib/<module>/schema.ts`. Never put tables in `src/lib/db`.
- Table names are prefixed with the module when ambiguous (`auth_sessions`, not `sessions`).
- Primary keys: `id: primaryId('<3-4 letter prefix>')`; spread `...timestamps` in every table.
- Functions that write accept an optional `Executor` (`db` or `tx`) so callers can compose them in `withTransaction`.
- Money as integer minor units; times as `timestamp with time zone`.

## Don't
- Don't edit or reference another module's tables except through that module's exported functions.
- Don't create a second client or connection pool; use `getDb()`.
- Don't log `DATABASE_URL` or query parameters that may hold secrets.
- Don't use `drizzle-kit push` against production; generate and review migrations.

A árvore exata que será injetada, após o .genpmignore. Fixada em

src/lib/db/LICENSEsomente leitura · 28d4b9f

MIT License

Copyright (c) 2026 GenPM

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.