Weerm
🧰 Tiny SQL toolkit for PG + Node (<200 LOC)
npm i weerm
Usage
Your database URL should be in DATABASE_URL
env var, e.g.
export DATABASE_URL=postgres://user:password@host/database:5432
Define your model, for example models/user
// models/user.jsconst db = const TableName = 'users' // model attribute to column mapping objectconst Columns = id: 'user_id' firstName: 'first_name' lastName: 'last_name' createdAt: 'created_at' const findOne = async { let conditionValues = db let row = await db return db} const find = async { let conditionValues = db let rows = await db return rows} // second optional argument is a current transaction// transactions are optional and only required when // you need to execute multiple SQL statements as a single unitconst create = async { let columnValues = db return await db} const update = async { let conditionValues = db let columnValues = db return await db} const del = async { let conditionValues = db return await db}
Use your model
const user = // find one (e.g. by ID)let user = await User// if no user is found, null will be returned // find multiple userslet users = await User// if no users were found, empty array will be returned // add a new userlet user = await User // update existing user// update a user by IDawait User // delete user// delete a user by IDawait User
Using inline SQL
// models/user.js const findByFirstNameWithLimit = async { const sql = `SELECT * from WHERE firstName = $1 order by ID DESC LIMIT $2` let rows = await db return rows}
Using transactions
// using transaction requires wrapping everything in a transaction and // passing the current transaction as the last parameterlet userAudit = await db// note that the return value from the callback will be returned by withTransaction function
If you want to execute certain actions after the transaction was rolled back, use the second function argument for this.
let { // cleanup external resources // e.g. // payment gateway rollback etc}await db
Unique index violation
// checking error type will tell you if it's a unique index violation try let user = await User catche ife instanceof dbUniqueIndexError console
MIT Licensed.
Copyright FingerprintJS Inc., 2020.