iceddev / breadfruit

So much bread so much fruit

breadfruit

Not really bread. Not really fruit. Just like this package. Some simple helpers on top of knex.

create an instance of breadfruit

const config = {
  client: 'postgresql',
  connection: 'postgres://postgres@localhost:5432/someDatabase',
  pool: { min: 1, max: 7 }
};

const bread = require('breadfruit')(config);

Browse, Read, Edit, Add, Delete, Raw

const {browse, read, edit, add, del, raw} = require('breadfruit')(config);

//get an array of users, by table, columns, and a filter
const users = await browse('users', ['username', 'user_id'], {active: true});


//get a single user by table, columns, and a filter
const user = await read('users', ['username', 'first_name'], {user_id: 1337});


//edit a user by table, returned columns, updated values, and a filter
const updatedUser = await edit('users', ['username', 'first_name'], {first_name: 'Howard'}, {user_id: 1337});


//add a new user by table, returned columns, and user data
const newUser = await add('users', ['user_id'], {first_name: 'Howard', username: 'howitzer'});


//delete a user by table and a filter
const deleteCount = await del('users', {user_id: 1337});


//perform a raw query
const rows = await raw('select * from users');

breadfruit's Issues

a count() method with a query

just a number of records matching a query without fetching the records

need ability to sort on multiple columns

sqlite3 does not support returning.

sqlite3 does not support returning and apparently under some circumstances it is skipped, but sometimes it receives an error.

Steps to reproduce

1. npm run tests

Possible Resolutions

I think t he best solution is to check the connector. I've done a little bit more research and it looks like MySQL also doesn't support a returning quality. I think it would behoove us to actual put this at a high emphasis for a fix.

this repo needs a logo

like a cartoonish cool duck eating a cartoonish cool breadfruit

res.rows is not a constant return on raw

under some circumstances res.rows will not be the default response.

can only have one db connection

fixing this will be a breaking change

right now we have a let knex at the top which is a singleton instance.

connect() should probably be the main export which gives us a new instance of the API. So our apps will likely have a bread.js file with returns the instance instead of calling breadfruit module directly in all the other files.

Throw better error message if method is invoked w/ improper signature

If a method is invoked with an incorrect signature, it would be helpful if an error was raised.

I was calling edit with too few params (3 instead of 4), and the only message I got was: TypeError: The operator "undefined" is not permitted

Sure, I should RTFM, but still! 🤪

Hey.