koa2-mysql-wrapper/README.md

Koa2 middleware for wrap Mysql2

#Koa2-mysql-wrapper

Koa2 middleware for wrap Mysql2

This middleware is just wrap Mysql2 project into koa context

Koa2-mysql-wrapper requires node v7.6.0 or higher for ES2015 and async function support.

# Install Koa2-mysql-wrapper
```
npm install --save koa2-mysql-wrapper
```
# Install Koa2-mysql-wrapper for earlier node v7.6.0 supported
```
npm install --save koa2-mysql-wrapper@1
```

#mysql(connectionString, [options])
* `connectionString`: Mysql2 connection string, e.g. `{host:'localhost', user: 'root', password: 'test', database: 'test'}`
* `options`: **Object**, You can overwrite method to call this wrapper method, default you will call like `ctx.myPool().query`, overwrite by pass `{ method: 'mysql' }`, so you can call `ctx.mysql.query()`

##query(queryString, argument, options)
* `queryString`: select * from user.
* `argument`: Default = [], replace value on ? prefix, select * from user where active=?, [true]
* `options`: **Object**, if you need column name then you can pass option { field: true }. Default { field: false }

##Usage
```
import Koa from 'koa'
import mysql from 'koa2-mysql-wrapper'

const app = new Koa()

app.use(mysql({host:'localhost', user: 'root', password: 'test', database: 'test'}))

app.use(async (ctx, next) => {
  let query = await ctx.myPool().query('SELECT * FROM `table` WHERE `name` = ? AND `dead` = ?', ['James', 0])
  await next()
})
```

###Supported
* `Array values`: ctx.myPool().query('SELECT * FROM `table` WHERE `name` in (?) AND `dead` = ?', [['James', 'Collyer'], 0]), notice that its support only 1 nested array.



Thanks to supported me, If you find any issue or need any special modules please report me to improve and maintenance for better module.

## License

MIT