\n\ndbManager provides seamless connection with database of your choice. By default it uses knex.js but you can use any tool that you want.\n\nAfter initialization your database connection is accessible under:\n```javascript\nmiddy((event, context) => {\n const { db } = context;\n});\n```\n\nMind that if you use knex you will also need driver of your choice ([check docs](http://knexjs.org/#Installation-node)), for PostgreSQL that would be:\n```\nyarn add pg\n// or\nnpm install pg\n```\n\n\n## Install\n\nTo install this middleware you can use NPM:\n\n```bash\nnpm install --save @middy/db-manager\n```\n\n\n## Options\n\n- `config`: configuration object passed as is to client (knex.js by default), for more details check [knex documentation](http://knexjs.org/#Installation-client)\n- `client` (optional): client that you want to use when connecting to database of your choice. By default knex.js is used but as long as your client is run as `client(config)` or you create wrapper to conform, you can use other tools. Due to node6 support in middy, knex is capped at version `0.17.3`. If you wish to use newer features, provide your own knex client here.\n- `secretsPath` (optional): if for any reason you want to pass credentials using context, pass path to secrets laying in context object - good example is combining this middleware with [ssm](#ssm)\n- `secretsParam` (optional): override the connection parameter when setting the password directly from ssm using `secretsPath` or with `rdsSigner`. This is ignored when passing an object in. Default: `password`.\n- `removeSecrets` (optional): By default is true. Works only in combination with `secretsPath`. Removes sensitive data from context once client is initialized.\n- `forceNewConnection` (optional): Creates new connection on every run and destroys it after. Database client needs to have `destroy` function in order to properly clean up connections.\n- `rdsSigner` (optional): Will use to create an IAM RDS Auth Token for the database connection using [RDS.Signer](https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/RDS/Signer.html). See AWS docs for required params, `region` is automatically pulled from the `hostname` unless overridden.\n\n## Sample usage\n\nMinimal configuration\n\n```javascript\nconst handler = middy(async (event, context) => {\n const { db } = context;\n const records = await db.select('*').from('my_table');\n console.log(records);\n});\nhandler.use(dbManager({\n config: {\n client: 'pg',\n connection: {\n host: '127.0.0.1',\n user: 'your_database_user',\n password: 'your_database_password',\n database: 'myapp_test'\n }\n },\n}));\n```\n\nCredentials as secrets object\n\n```javascript\nconst handler = middy(async (event, context) => {\n const { db } = context;\n const records = await db.select('*').from('my_table');\n console.log(records);\n});\nhandler.use(secretsManager({\n secrets: {\n [secretsField]: 'my_db_credentials' // { user: 'your_database_user', password: 'your_database_password' }\n },\n throwOnFailedCall: true\n}));\nhandler.use(dbManager({\n config: {\n client: 'pg',\n connection: {\n host : '127.0.0.1',\n database : 'myapp_test'\n }\n },\n secretsPath: secretsField\n}));\n```\n\nCustom knex (or any other) client and secrets\n\n```javascript\nconst knex = require('knex')\n\nconst handler = middy(async (event, context) => {\n const { db } = context;\n const records = await db.select('*').from('my_table');\n console.log(records);\n});\nhandler.use(secretsManager({\n secrets: {\n [secretsField]: 'my_db_credentials' // { user: 'your_database_user', password: 'your_database_password' }\n },\n throwOnFailedCall: true\n}));\nhandler.use(dbManager({\n client: knex,\n config: {\n client: 'pg',\n connection: {\n host : '127.0.0.1',\n database : 'myapp_test'\n }\n },\n secretsPath: secretsField\n}));\n```\n\nConnect to RDS using IAM Auth Tokens and TLS\n\n```javascript\nconst tls = require('tls')\nconst ca = require('fs').readFileSync(`${__dirname}/rds-ca-2019-root.pem`) // Download from https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL.html\n\nconst handler = middy(async (event, context) => {\n const { db } = context;\n const records = await db.select('*').from('my_table');\n console.log(records);\n});\nhandler.use(dbManager({\n rdsSigner:{\n region: 'us-east-1',\n hostname: '*****.******.{region}.rds.amazonaws.com',\n username: 'your_database_user_with_iam_role',\n database: 'myapp_test',\n port: '5432'\n },\n secretsPath: 'password',\n config: {\n client: 'pg',\n connection: {\n host: '*****.******.{region}.rds.amazonaws.com',\n user: 'your_database_user_with_iam_role',\n database: 'myapp_test',\n port: '5432',\n ssl: {\n rejectUnauthorized: true,\n ca,\n checkServerIdentity: (host, cert) => {\n const error = tls.checkServerIdentity(host, cert)\n if (error && !cert.subject.CN.endsWith('.rds.amazonaws.com')) {\n return error\n }\n }\n }\n }\n }\n}));\n```\n\n**Note:**\n\nIf you're lambda is timing out, likely your database connections are keeping the event loop open. Check out [do-not-wait-for-empty-event-loop](https://github.com/middyjs/middy/tree/master/packages/do-not-wait-for-empty-event-loop) middleware to resolve this.\n\nSee AWS Docs [Rotating Your SSL/TLS Certificate](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL-certificate-rotation.html) to ensure you're using the right certificate.\n\n## Middy documentation and examples\n\nFor more documentation and examples, refers to the main [Middy monorepo on GitHub](https://github.com/middyjs/middy) or [Middy official website](https://middy.js.org).\n\n\n## Contributing\n\nEveryone is very welcome to contribute to this repository. Feel free to [raise issues](https://github.com/middyjs/middy/issues) or to [submit Pull Requests](https://github.com/middyjs/middy/pulls).\n\n\n## License\n\nLicensed under [MIT License](LICENSE). Copyright (c) 2017-2018 Luciano Mammino and the [Middy team](https://github.com/middyjs/middy/graphs/contributors).\n\n\n \n\n","readmeFilename":"README.md"}
![\"Middy](\"https://raw.githubusercontent.com/middyjs/middy/master/img/middy-logo.png\"/){kind=logo}
\n![\"FOSSA](\"https://app.fossa.io/api/projects/git%2Bgithub.com%2Fmiddyjs%2Fmiddy.svg?type=large\")
\n\n","readmeFilename":"README.md"}![\"npm](\"https://badge.fury.io/js/%40middy%2Fdb-manager.svg\"){kind=icon}
\n ![\"Known](\"https://snyk.io/test/github/middyjs/middy/badge.svg\"){kind=icon}
\n ![\"Standard](\"https://img.shields.io/badge/code_style-standard-brightgreen.svg\"){kind=icon}
\n ![\"Greenkeeper](\"https://badges.greenkeeper.io/middyjs/middy.svg\")
\n ![\"Chat](\"https://badges.gitter.im/gitterHQ/gitter.svg\")
\n