# @bringittocode/mop-js

> This is a mysql library to create long live connection between your application and mysql, this is not mysql pool.

Latest version **1.0.7** (published 2022-07-05) · MIT license · 0 weekly downloads

## Install

```sh
npm install @bringittocode/mop-js
pnpm add @bringittocode/mop-js
yarn add @bringittocode/mop-js
bun add @bringittocode/mop-js
```

## Health

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

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.7 |
| Published | 2022-07-05 |
| First published | 2022-02-05 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 1 |
| Unpacked size | 9.1 KB |
| Known vulnerabilities | 0 (+7 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 2 |
| Maintainers | hazeezet |
| Keywords | mysql, mysql2, nodejs, pool |

## Links

- npm: https://www.npmjs.com/package/@bringittocode/mop-js
- Repository: https://github.com/Bringittocode/mop-js
- Homepage: https://github.com/Bringittocode/mop-js#readme
- Issues: https://github.com/Bringittocode/mop-js/issues
- npm.io page: https://npm.io/package/@bringittocode/mop-js

## Dependencies (1)

- [mysql2](https://npm.io/package/mysql2.md) ^2.3.3

## Recent versions

- 1.0.7 (latest) — 2022-07-05
- 1.0.6 — 2022-04-02
- 1.0.5 — 2022-02-08
- 1.0.4 — 2022-02-06
- 1.0.3 — 2022-02-05
- 1.0.2 — 2022-02-05
- 1.0.1 — 2022-02-05
- 1.0.0 — 2022-02-05

## README

# mop-js
create a long live connection between your application and mysql in a javascript server ( NODEJS ). this is not mysql pool.

this package helps you to manage auto reconnection.

you still have the complete features of mysql in nodejs except for mysql pool

## INSTALLATION
> npm i @bringittocode/mop-js@latest

## FEATURES

* One library rule them all... i.e you can use any mysql module with this library to manage connection.
* Auto reconnection if connection timeout or an error occured
* You still have all the method of any MYSQL module you use except for pool.
* You have an event to listen on if connection failed or successful

## Advantages

* Mysql concurrent connections remain the same
* No down time
* No slow query because connection is alive so no need of creating connection again and again
* Traffic on mysql database reduces because is only getting connection once.

## USAGE

### import the module
```js
import mop from "@bringittocode/mop-js";
// Import any mysql module you wish to use
import mysql from "mysql";

//OR
const mop = require('@bringittocode/mop-js');
// Import any mysql module you wish to use
const mysql2 = require("mysql2");

//OR
const {default: mop} = import("@bringittocode/mop-js") //dynamic import
// Import any mysql module you wish to use
const mysql2 = require("mysql2");
```

### Register the module
```js
mop.register({
    DATABASE_INFO: {
        host: "",
        user: "",
        password: "",
        database: "",
    },
    WAIT_TIME: 2000,
    MODULE: mysql //mysql2
});
```

> DATABASE_INFO => your database detailes... you can also put any valid MYSQL initialization option.

> WAIT_TIME => how many miliseconds to wait before reconnecting if there is any disconnection.. DEFAULT 5 seconds

> MODULE => Any MYSQL module you wish to use.. DEFAULT [MYSQL2](https://www.npmjs.com/package/mysql2)

After registering you can now import mysql instance in all of your application

what you have to do is to focus on your query as you would if no package is used

> CURRENTLY SUPPORTED MODULE.

* [MYSQL](https://www.npmjs.com/package/mysql)
* [MYSQL2](https://www.npmjs.com/package/mysql2)

```js
    const query = "SELECT * FROM your_table where ?";
    mop.DB.query(query, ["user"], function (err, result) {
        try {
            if (err) throw err;
            //manage result
        }
        catch(err)
        {
            //manage error
        }
    });
```
> NOTE :: do not disconnect after you finish... your connection is meant to stay alive so you can query your database at anytime

## Event

```js
    // listen for connection and reconnection
    // status => boolean
    mop.DB_INFO.on("connect",(status)=>{
        console.log('database connected');
    });

    // listen for reconnection error
    // code => error code
    // message => error message
    mop.DB_INFO.on("reconnect_error", (code,message) => {
        console.log(code, message);
    });

    // listen for disconnection ...this can be for many reason
    mop.DB_INFO.on("disconnect", (code) => {
        console.log(code);
    });
```

That all you need.
We are finding who can add typescript to this package

feel free to pull request and contribute....

any issue feel free as well.

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