ulmerkott v1.0.17

Generate CRUD layer for postgresql

npm install --save ulmerkott
npm install dataloader@^2.0.0 pg@^8.5.1

yarn add ulmerkott
yarn add dataloader@^2.0.0 pg@^8.5.1

setup:

import { crudFactory, settings, sql, SQLStringFilter, SQLBoolFilter } from 'ulmerkott/pg';

const crud = crudFactory(settings({
  namespace: 'ulmerkott',
  createId: someFunction.createID,
  logQueries: (query, values) => {
    console.log(query, values);
  },
  db: (ctx: Ctx) => ctx.pg.somePgClient,
}));

configure:

// create an interface for the table
interface MyTable {
  id: string;
  title: string;
  someOtherColumn: number;
}
const tableConfig = {
  name: 'my_table'
  c: {
    title: 'title',
    someOtherColumn: 'some_other_column',
  },
};

const listOptions = { // optional
  filter: { title: { eq?: tableConfig.c.title } },
};

const myTable = makeCrud<typeof config.c, MyTable, {
  filter: { eq?: SQLStringFilter } ,
}>({ tableConfig, listOptions });

use:

// insert record => Promise<MyTable>
await myTable.crud.insertOne(ctx, {
  name: 'hello',
  someOtherColumn: 'world',
});

// find one record => Promise<MyTable | null>
await myTable.crud.findOne(ctx, 'some_id');

// find one record that excists => Promise<MyTable>
await myTable.crud.getOne(ctx, 'some_id');

// update record by id => Promise<MyTable>
await myTable.crud.updateOne(ctx, {
  id: 'some_id',
  name: 'hello',
  someOtherColumn: 'world',
});

// delete record by id => Promise<MyTable>
await myTable.crud.deleteOne(ctx, 'some_id');

// get all records => Promise<MyTable[]>
await myTable.crud.list(ctx);

// get all records, filter where title = hello => Promise<MyTable[]>
await myTable.crud.list(ctx, { title: { eq: 'hello });