🎉 Initial release of the package

Author: MatissJanis

.editorconfig

@@ -0,0 +1,11 @@
+# http://editorconfig.org
+
+root = true
+
+[*]
+charset = utf-8
+indent_style = space
+indent_size = 2
+end_of_line = lf
+insert_final_newline = true
+trim_trailing_whitespace = true

.github/workflows/deploy.yaml

@@ -0,0 +1,25 @@
+name: Release
+on:
+  release:
+    types: [created]
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout 🛎️
+        uses: actions/checkout@v2
+      # Setup .npmrc file to publish to npm
+      - uses: actions/setup-node@v1
+        with:
+          node-version: '12.x'
+          registry-url: 'https://registry.npmjs.org'
+          # Defaults to the user or organization that owns the workflow file
+          scope: '@octocat'
+      - name: Install ⚙️
+        run: yarn install
+      - name: Build 🔧
+        run: yarn build
+      - name: Deploy 🚀
+        run: yarn publish
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

.gitignore

@@ -0,0 +1,3 @@
+node_modules/
+lib/
+yarn.lock

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 Matiss Janis Aboltins
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,85 @@
+# knex-serverless-mysql
+
+[![npm](https://img.shields.io/npm/v/knex-serverless-mysql.svg)](https://www.npmjs.com/package/knex-serverless-mysql)
+[![npm](https://img.shields.io/npm/l/knex-serverless-mysql.svg)](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.
+
+## 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);
+}
+```
+
+## Installation
+
+```
+yarn add knex-serverless-mysql
+
+# or
+
+npm install knex-serverless-mysql
+```
+
+[serverless-mysql]: https://github.com/jeremydaly/serverless-mysql
+[datasource-sql]: https://github.com/cvburgess/SQLDataSource

babel.config.json

@@ -0,0 +1,12 @@
+{
+  "presets": [
+    [
+      "@babel/env",
+      {
+        "targets": {
+          "node": "10"
+        }
+      }
+    ]
+  ]
+}

index.js

@@ -0,0 +1 @@
+module.exports = require('./lib/client').default;

package.json

@@ -0,0 +1,23 @@
+{
+  "name": "knex-serverless-mysql",
+  "version": "1.0.0",
+  "description": "Knex.js dialect for serverless-mysql",
+  "repository": "git@github.com:MatissJanis/knex-serverless-mysql.git",
+  "author": "Matiss Janis Aboltins <matiss@mja.lv>",
+  "license": "MIT",
+  "main": "index.js",
+  "scripts": {
+    "build": "babel -D src/ --out-dir lib/"
+  },
+  "devDependencies": {
+    "@babel/cli": "^7.13.16",
+    "@babel/core": "^7.13.16",
+    "@babel/preset-env": "^7.13.15"
+  },
+  "peerDependencies": {
+    "knex": ">=0.11.4"
+  },
+  "dependencies": {
+    "knex": "^0.95.4"
+  }
+}

src/client.js

@@ -0,0 +1,24 @@
+import MysqlClient from 'knex/lib/dialects/mysql';
+
+export default class ServerlessMysqlClient extends MysqlClient {
+  constructor(config) {
+    super(config);
+
+    this.mysql = config.mysql;
+  }
+
+  get dialect() {
+    return 'serverlessMysql';
+  }
+  get driverName() {
+    return 'serverlessMysql';
+  }
+
+  acquireConnection() {
+    return Promise.resolve(this.mysql);
+  }
+
+  releaseConnection() {
+    return this.mysql.end();
+  }
+}