## Description
npm install @liangwp/simple-mysqlA thin wrapper around the official MySql8 XDevAPI connector, exposing some common use-cases with a simple promise-based api.
* Depends on @mysql/xdevapi v8.0.22
* [x] Connection pooling
* [x] Easy api to test for db connection
* [x] SQL queries (using SQL statements instead of chainable api)
* [ ] Transactions (WIP)
* [ ] Collections (only supports chainable api)
* [ ] Expose underlying mysqlx.client object
Additional features and notes
* Init Promise:
* Wait for database connection to be up before resolving (useful for running in docker, esp in dev)
* Dropped connections:
* If connection to DB drops, queries will fail and throw an error.
* When connection to DB comes back, queries will be successful again without needing to re-initialize the client.
``
npm install --save @liangwp/simple-mysql
const simpleMySQL = require('@liangwp/simple-mysql');var connection_config = {
user: 'test_user',
password: 'test_pswd',
host: 'mysql8-sample',
port: 33060,
schema: 'test_db'
};
var connection_options = {
pooling: { enabled: true, maxIdleTime: 30000, maxSize: 25, queueTimeout: 10000 }
}
var mysql = simpleMySQL(connection_config, connection_options);
var retry_params = {
retries: 10,
factor: 2,
minTimeout: 1000,
randomise: true
};
wait for connection
mysql.awaitDbInit(retry_params) # if retry_params not supplied, defaults to the above
.then(() => {
// connection is ready
})
$3
mysql.inspect()
.then(data => {
// do your stuff
// data {
// pooling: true,
// auth: 'PLAIN',
// schema: 'test_db',
// ssl: true,
// user: 'test_user',
// host: 'mysql8-sample',
// port: 33060,
// dbUser: 'test_user',
// socket: undefined
// }
});
$3
mysql.query('SELECT col1, col2 FROM some_table WHERE col3 = ?', [col3_binding])
.then(data => {
// do your stuff
});
$3
mysql.close()
.then(() => {
// connection closed
});
$3
Promise.resolve()
.then(() => {
return mysql.startTransaction()
})
.then(mysqlTrans => {
return mysqlTrans.query('SELECT col1, col2 FROM some_table WHERE col3 = ?', [col3_binding])
.then(data => {
// do some stuff
var col3_binding = 'abcde';
return mysqlTrans.query('SELECT col1, col2 FROM other_table WHERE col3 = ?', [col3_binding]);
})
.then(data => {
// do more stuff
})
.then(() => {
return mysqlTrans.commit()
})
.catch(err => {
return mysqlTrans.rollback()
});
})
.catch(err => {
// transaction failed to start
// OR rollback failure
})
.then(() => {
// transaction ok
// OR rollback successful
});
Run example (in docker)
cd dev
docker-compose -f docker-compose-example.yml up --build
Run tests (in docker)
cd dev
docker-compose -f docker-compose-mocha.yml up --build
Changelog
| Date | Version | Description |
| ---- | ------------------|---------------------------------------------------------------------------------------- |
| 2021.04.04 | v1.0.3 | Comment out the console.log in