# istorm_db

> Simple database wrapper

Latest version **1.0.7** (published 2020-06-29) · ISC license · 0 weekly downloads

## Install

```sh
npm install istorm_db
pnpm add istorm_db
yarn add istorm_db
bun add istorm_db
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.7 |
| Published | 2020-06-29 |
| First published | 2019-08-17 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Unpacked size | 15.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Victor Iagnov |
| Maintainers | i--storm |
| Keywords | mysql |

## Links

- npm: https://www.npmjs.com/package/istorm_db
- Repository: https://github.com/i--storm/istorm_db
- Homepage: https://github.com/i--storm/istorm_db#readme
- Issues: https://github.com/i--storm/istorm_db/issues
- npm.io page: https://npm.io/package/istorm_db

## Dependencies (3)

- [mysql](https://npm.io/package/mysql.md) latest
- [dateformat](https://npm.io/package/dateformat.md) latest
- [istorm_logger](https://npm.io/package/istorm_logger.md) latest

## Recent versions

- 1.0.7 (latest) — 2020-06-29
- 1.0.6 — 2020-06-29
- 1.0.5 — 2019-08-17

## README

# MySQL Wrapper for NodeJs
Class provides automatic mysql connection management

- Simple config and start
- Automatic reconnect to MySQL on connection timeout
- SQL queries buffering while not connected to mysql

# Usage
## Configure
```
DB = require('istorm_db').getInstance({
    is_debug: false,
    db_config: {
      host     : 'localhost',
      user     : 'mysql_user',
      password : 'mysql_password',
      database : 'musql_db_name'
    }
});
```

## Functions
All functions divided into two types. First type begins with 'do' returns Promise object and should be used with `await` call. Second type uses callbacks. You may use most convinient for you.

### Async/Await functions

#### doDBConnect
used internally to connect to database in ASYNC mode

#### doDBDisconnect
used internally to disconnect from database in ASYNC mode

#### doDBSelect(table, where, order, limit)
performs SELECT request to database in ASYNC mode

#### doDBInsert(table, data_arr)
performs INSERT request to database in ASYNC mode

#### doDBUpdate(table, update, where)
performs UPDATE request to database in ASYNC mode

#### doDBQuery(sql)
performs SQL request passed in _sql_ param in ASYNC mode

### Callbck functions

#### connect(callback)
connects to database

#### disconnect(callback)
disconnects from database

#### insert(table, data_arr, callback)
performs INSERT request

#### select(table, where, order, limit, callback)
performs SELECT request

#### update(table, update, where, callback)
performs UPDATE request

#### query(sql, callback)
performs SQL request from string

### Service functions

####  dateStr()
returns current date in mysql format

#### escape(str)
escapes string

#### tsToDateStr(timestamp, is_utc)
converts timestamp to mysql date string

#### df(date, is_utc)
formats date to mysql string

# Important note
All code made for my personal use. I do not promise it will work well in your case. I will try to help if you encountered troubles. You may copy or modify code on your decision.

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