@core / db

1.0.0 ▾

1.0.0

已验证MIT

GitHub

基于 Drizzle 的 Postgres：共享客户端、按模块划分的模式、事务和 ULID

代码8 个文件上下文约 547 个 token扫描通过

约 547 个 token→ src/lib/db/AGENTS.md→ .cursor/rules/genpm-core-db.mdc

这正是你的 AI 在 src/lib/db 中工作时读取的内容。不会向其上下文添加其他任何内容。

@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.

应用 .genpmignore 后将被注入的确切目录树。固定于

src/lib/db/client.ts只读 · 28d4b9f

// Cliente de base de datos. Un único `Db` para toda la app, creado perezosamente desde DATABASE_URL.
// El tipo es el `PgDatabase` genérico de Drizzle: cualquier driver Postgres (postgres-js, Neon, PGlite…) sirve.
import type { ExtractTablesWithRelations } from 'drizzle-orm';
import type { PgDatabase, PgQueryResultHKT, PgTransaction } from 'drizzle-orm/pg-core';
import { drizzle } from 'drizzle-orm/postgres-js';
import postgres from 'postgres';

export type Db = PgDatabase<PgQueryResultHKT, Record<string, never>>;
export type Tx = PgTransaction<PgQueryResultHKT, Record<string, never>, ExtractTablesWithRelations<Record<string, never>>>;
/** Cualquier cosa sobre la que se pueden lanzar consultas: la BD o una transacción en curso. */
export type Executor = Db | Tx;

let current: Db | null = null;

/** Crea un cliente Postgres. `max` bajo por defecto: pensado para serverless y desarrollo. */
export function createDb(url: string | undefined = process.env.DATABASE_URL, opts: { max?: number } = {}): Db {
  if (!url) throw new Error('DATABASE_URL is not set (see .env.example)');
  const sql = postgres(url, { max: opts.max ?? 5, prepare: false });
  return drizzle(sql) as unknown as Db;
}

/** El cliente compartido de la app. */
export function getDb(): Db {
  current ??= createDb();
  return current;
}

/** Sustituye el cliente compartido (tests, o un driver distinto como PGlite o Neon). */
export function setDb(db: Db): void {
  current = db;
}