Installation

pnpm add drizzle-repository-generator

How to use

basic

1import { Repository } from 'drizzle-repository-generator'
2const repo = Repository(db, user);
3// find
4await repo.find({ id }).returnFirst();
5// insert
6await repo.insert(data);
7// upsert
8await repo.insert(data, { onConflict: 'update' });
9// update
10await repo.update(data).where({ id: 1 });
11// delete
12await repo.delete(where);

complex query

Finding

1const repo = Repository(db, user, { local });
2await repo.with('local').find({ id }).returnFirst();
3await repo.with('local').find(['id', '=', 2]).returnFirst();
4await repo.with('local').find(eq(/** ... */)).returnFirst();
5await repo.with('local').find([
6    ['name', 'like', '%john%'],
7    ['age', '>', 20],
8    // ...
9]).returnMany();
10
11// orderBy
12await repo.with('local').find({ id }).returnMany({
13    offset: 0,
14    limit: 100,
15    
16    orderBy: ['id', 'desc'],
17    // or
18    orderBy: [
19        ['id', 'desc'],
20        ['name', 'asc'],
21    ],
22    // or
23    orderBy: [asc(...)]
24});

Mutations

1// update
2await repo.update(data).where({
3    id: 1,
4    name: 'john',
5});
6// delete
7await repo.delete([
8    'id', '=', 1,
9    'name', '=', 'john',
10]);

Transaction

1await db.transaction((tx) => {
2    const userRepo = Repository(tx, user);
3    const sessionRepo = Repository(tx, session);
4    await userRepo.insert(user);
5    await sessionRepo.insert(session);
6})

compatible

• postgres implemented only
• sqlite considering

Warn

• primary key have to fixed to be id yet. cause every table mapped by this.
• tests are not enough. please open issue whenever finding bugs for appreciate.

TODO

• Support selecting specific columns when returning (through select() chain)
• Allow choosing whether to return data or not
• Remove explicit record type from returning promise

understanding how to work

deepwiki link (thx to regenrek)

contributing

docker compose prerequired

1. copy .env.example -> .env
2. docker compose up (for execute pg server)
3. test your feature with test script