calemy / mysql-commands

a promised based mysql wrapper in nodejs

mysql-commands

a promised based mysql wrapper in nodejs!
some updates still expected

How to use it

Create the wrapper

const mysql = require('mysql-commands')

const database = mysql.createConnection({
    host: host,
    user: username,
    password: password,
    database: db
})

Select

You can select single or multiple records from the database with ease!

/* 
    Optional
    values: the values you want to recieve - default: *
    condition: what condition has to be applied to return the result
    sort: what you want to sort by
    limit: how many rows to return - default: Infinite (only available on multi search)
    offset: offset result by x amount - default: 0 (only available on multi search)
*/

const values = ["id", "username"]
const condition = "id = 1"
const sort = ["id DESC"]

//Search for multiple records, sort by id decreasing and limit results to 50
const users = await database.select("users", { values, sort, limit: 50 })

//Search for single record
const user = await database.selectOne("users", { values, condition })

Insert

You can also insert records with pretty much no effort!
There is also an updateOnDuplicate option that can be selected.

let user = {
    id: 1,
    username: "Nanoo",
    rank: "Admin"
}

await database.insert("users", { object: user })

//Update on duplicate

user.username = "Lemres"

await database.insert("users", { object: user, updateOnDuplicate: true})

Update

Even updating does not require a lot of work!

let user = {
    id: 1,
    username: "Nanoo",
    rank: "Admin"
}

await database.update("users", { object: user, condition: "id = 1"})

Tips

If you can't find the function that you require or a bug then feel free to use your own query with the request function.
You don't need to worry about database timeouts since this module does handle connections automatically for you!
And also try to add the issue to the Repository so it can get into this module.

await database.request(`your own query`)

Contribute

We would love to extend our functionality with you as contributer.
If you got any ideas open a pull request and we see how we can implement it!

mysql-commands's Issues

is it possible to use this with sqlite3?

just wondering