Installation

pnpm add drizzle-repository-generator

How to use

basic

import { Repository } from 'drizzle-repository-generator'
const repo = Repository(db, user);

// find
await repo.find({ id }).returnFirst();
// find with select
const repo = Repository(db, user, { local });
repo.select({ id: user.id }).find({ id }).returnFirst();
repo.select({ count: count() }).find({ id }).returnFirst();
// insert
await repo.insert(data);
// upsert
await repo.insert(data, { onConflict: 'update' });
// update
await repo.update(data).where({ id: 1 });
// delete
await repo.delete(where);

complex query

Finding

const repo = Repository(db, user, { local });
await repo.with('local').find({ id }).returnFirst();
await repo.with('local').find(['id', '=', 2]).returnFirst();
await repo.with('local').find(eq(/** ... */)).returnFirst();
await repo.with('local').find([
    ['name', 'like', '%john%'],
    ['age', '>', 20],
    // ...
]).returnMany();

// orderBy
await repo.with('local').find({ id }).returnMany({
    offset: 0,
    limit: 100,
    
    orderBy: ['id', 'desc'],
    // or
    orderBy: [
        ['id', 'desc'],
        ['name', 'asc'],
    ],
    // or
    orderBy: [asc(...)]
});

Mutations

// update
await repo.update(data).where({
    id: 1,
    name: 'john',
});
// delete
await repo.delete([
    'id', '=', 1,
    'name', '=', 'john',
]);

Transaction

await db.transaction((tx) => {
    const userRepo = Repository(tx, user);
    const sessionRepo = Repository(tx, session);
    await userRepo.insert(user);
    await sessionRepo.insert(session);
})

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

• [ ] Update query should to unavailable execute without where
• [x] Support selecting specific columns when returning (through select() chain)
• [ ] Allow choosing whether to return data or not
• [ ] Remove explicit record type from returning promise
• [ ] deprecate types object

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