https://github.com/matissjanis/knex-serverless-mysql
Knex.js dialect for serverless-mysql
https://github.com/matissjanis/knex-serverless-mysql
data-source knex mysql serverless serverless-mysql
Last synced: 7 months ago
JSON representation
Knex.js dialect for serverless-mysql
- Host: GitHub
- URL: https://github.com/matissjanis/knex-serverless-mysql
- Owner: MatissJanis
- License: mit
- Created: 2021-04-24T21:49:26.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2021-04-26T18:47:20.000Z (over 4 years ago)
- Last Synced: 2025-03-14T21:05:19.497Z (7 months ago)
- Topics: data-source, knex, mysql, serverless, serverless-mysql
- Language: JavaScript
- Homepage:
- Size: 6.84 KB
- Stars: 12
- Watchers: 3
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# knex-serverless-mysql
[](https://www.npmjs.com/package/knex-serverless-mysql)
[](https://www.npmjs.com/package/knex-serverless-mysql)
Minimalistic knex.js dialect for [serverless-mysql].
## Motivation
[serverless-mysql] persists database connections across multiple
AWS Lambda function execution contexts. This reduces the load on
the database. However, this client is not natively supported by
Knex. This library solves the problem.
## Getting Started
### Installation
```
yarn add knex-serverless-mysql
# or
npm install knex-serverless-mysql
```
### Simple Example
```js
const Knex = require('knex');
const knexServerlessMysql = require('knex-serverless-mysql');
const mysql = require('serverless-mysql')({
config: {
host : process.env.DB_HOST,
database : process.env.DB_DATABASE,
user : process.env.DB_USERNAME,
password : process.env.DB_PASSWORD,
},
});
const knex = Knex({
client: knexServerlessMysql,
mysql,
});
exports.run = function () {
return knex('table_name').where('id', 1);
}
```
### Usage with [datasource-sql]
```js
const Knex = require('knex');
const knexServerlessMysql = require('knex-serverless-mysql');
const { SQLDataSource } = require('datasource-sql');
const mysql = require('serverless-mysql')({
config: {
host : process.env.DB_HOST,
database : process.env.DB_DATABASE,
user : process.env.DB_USERNAME,
password : process.env.DB_PASSWORD,
},
});
const knex = Knex({
client: knexServerlessMysql,
mysql,
});
class TableNameDataSource extends SQLDataSource {
getRowById(id) {
return this.knex('table_name').where('id', id);
}
}
const dataSource = new TableNameDataSource(knex);
exports.run = function () {
return dataSource.getRowById(1);
}
```
## Contributing
All contributions are welcome!
Please open an issue or pull request.
[serverless-mysql]: https://github.com/jeremydaly/serverless-mysql
[datasource-sql]: https://github.com/cvburgess/SQLDataSource