# rs-mysql

> ## Create connection ```js const mysql = require('rs-mysql');

Latest version **0.1.4** (published 2018-01-10) · ISC license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

```sh
npm install rs-mysql
pnpm add rs-mysql
yarn add rs-mysql
bun add rs-mysql
```

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 0.1.4 |
| Published | 2018-01-10 |
| First published | 2017-12-22 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Yauheni Kiryienkau |
| Maintainers | yauhenko |

## Links

- npm: https://www.npmjs.com/package/rs-mysql
- npm.io page: https://npm.io/package/rs-mysql

## Dependencies (1)

- [promise-mysql](https://npm.io/package/promise-mysql.md) 3.1.5

## Recent versions

- 0.1.4 (latest) — 2018-01-10
- 0.1.3 — 2018-01-10
- 0.1.2 — 2018-01-10
- 0.1.0 — 2018-01-10
- 0.0.14 — 2018-01-09
- 0.0.13 — 2018-01-08
- 0.0.12 — 2018-01-04
- 0.0.11 — 2018-01-01
- 0.0.10 — 2018-01-01
- 0.0.9 — 2018-01-01
- 0.0.8 — 2018-01-01
- 0.0.7 — 2018-01-01
- 0.0.6 — 2018-01-01
- 0.0.5 — 2018-01-01
- 0.0.4 — 2017-12-22
- … 3 more at https://npm.io/package/rs-mysql/versions

## README

# Basic usages

## Create connection
```js
const mysql = require('rs-mysql');

async function app() {

	let db = await mysql.getInstance({
		host: 'localhost',
		user: 'root',
		password: '',
		database: 'test',
		verbose: true
	});

	// do other things...

}

app();
```

## Query
`query(sql[, values])`
```js
let res = await db.query('SELECT * FROM `users` WHERE `role` = ?', ['admin']);
console.log(res);
```
or
```js
let res = await db.query('SELECT * FROM `users` WHERE `role` = {role}', {
	role: 'admin'
});
console.log(res);
```

## Insert
`insert(table, data, { ignore = false })`
```js
let id = await db.insert('users', {
	username: 'admin',
	password: 'superpasswordhash',
	name: 'John Doe'
});
console.log(id); // inserted id
```

## Update
`update(table, id, data, { pk = 'id', ignore = false })`
```js
let updated = await db.update('users', 123, {
	name: 'John Doe',
	active: true
});
console.log(updated); // updated
```
or
```js
let updated = await db.update('users', 'admin', {
	name: 'John Doe',
	active: true
}, { pk: 'username' });
console.log(updated); // updated
```

## Get
`get(table, id, { fields = ['*'], pk = 'id' })`
```js
let user = await db.get('users', 123);
console.log(user); // user with id=123
```
or
```js
let user = await db.get('users', 'admin', {
	pk: 'username',
	fields: ['id','email','name']
});
console.log(user); // get id,email,name of user with username=admin
```

## Delete
`delete(table, id, { pk = 'id' })`
```js
let affected = await db.delete('users', 123);
console.log(affected); // affected rows
```

---
_Source: https://npm.io/package/rs-mysql · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._