\n\nRDS provides seamless connection with database of your choice.\n\nAfter initialization your database connection is accessible under:\n\n```javascript\nmiddy((event, context) => {\n const { sql } = 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\n```\nyarn add {pg,postgres}\n// or\nnpm install {pg,postgres}\n```\n\n## Install\n\nTo install this middleware you can use NPM:\n\n```bash\nnpm install --save middy-rds\nnpm install --save-dev @aws-sdk/rds-signer\n```\n\nRequires: @middy/core:>=4.0.0\n\n## Options\n\n- `client` (function) (required): client that you want to use when connecting to database of your choice. Designed to be used by knex.js. However, as long as your client is run as client(config), you can use other tools.\n- `config` (object) (required): configuration object passed as is to client (knex.js recommended), for more details check [knex documentation](http://knexjs.org/#Installation-client)\n- `forceConnection` (boolean) (default `false`): After creating the database client call `SELECT 1` to for a connection to be opened\n- `internalData` (object) (optional): Pull values from middy internal storage into `config.connection` object.\n- `cacheKey` (string) (default `rds`): Cache key for the fetched data responses. Must be unique across all middleware.\n- `cachePasswordKey` (string) (default `rds`):Cache key for the fetched data response related to the password. Must match the `cacheKey` for the middleware that stores it.\n- `cacheExpiry` (number) (default `-1`): How long fetch data responses should be cached for. `-1`: cache forever, `0`: never cache, `n`: cache for n ms.\n\n**Note:**\n\n- `config.connection` defaults to:\n\n```javascript\n{\n ssl: {\n rejectUnauthorized: true,\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\nIf your 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\n## Sample usage\n\nMinimal configuration\n\n### pg\n\n```javascript\nimport rdsMiddleware from 'middy-rds/pg'\nimport ca from 'middy-rds/ca'\n\nimport capturePostgres from 'aws-xray-sdk-postgres'\nimport pgClient from 'pg'\n\nconst pg = capturePostgres(pgClient)\n\nconst handler = middy(async (event, context) => {\n const { sql } = context\n const records = await sql.select('*').from('my_table')\n console.log(records)\n}).use(\n rdsMiddleware({\n client: pg.Pool,\n config: {\n host: '*.ca-central-1.rds.amazonaws.com',\n user: 'iam_role',\n database: 'postgres',\n application_name: process.env.AWS_LAMBDA_FUNCTION_NAME,\n // loads the cert from process.env.NODE_EXTRA_CA_CERTS, can be set to /var/task/node_modules/middy-rds/certificates/us-east-1.pem\n ssl: { ca: ca() }\n }\n })\n)\n```\n\n### knex\n\n```javascript\nimport rdsMiddleware from 'middy-rds/knex'\nimport ca from 'middy-rds/certificates/ca-central-1'\nimport knex from 'knex'\n\nimport capturePostgres from 'aws-xray-sdk-postgres'\nimport pgClient from 'pg'\n\nconst pg = capturePostgres(pgClient)\n\nconst handler = middy(async (event, context) => {\n const { sql } = context\n const records = await sql.select('*').from('my_table')\n console.log(records)\n}).use(\n rdsMiddleware({\n client: knex,\n config: {\n client: 'pg',\n connection: {\n host: '*.ca-central-1.rds.amazonaws.com',\n user: 'iam_role',\n database: 'postgres',\n port: 5432,\n application_name: process.env.AWS_LAMBDA_FUNCTION_NAME,\n // /var/task/node_modules/middy-rds/certificates/ca-central-1.pem ported to a js file for easy import\n ssl: { ca }\n }\n }\n })\n)\n```\n\n### postgres\n\n```javascript\nimport rdsMiddleware from 'middy-rds/postgres'\nimport ca from 'middy-rds/certificates/ca-central-1'\n\nimport postgresClient from 'postgres'\n\nconst handler = middy(async (event, context) => {\n const { sql } = context\n const records = await sql`SELECT * FROM my_table`\n console.log(records)\n}).use(\n rdsMiddleware({\n client: postgresClient,\n config: {\n host: '*.ca-central-1.rds.amazonaws.com',\n user: 'iam_role',\n database: 'postgres',\n connection: {\n application_name: process.env.AWS_LAMBDA_FUNCTION_NAME\n },\n ssl: {\n ca\n }\n }\n })\n)\n```\n\n## Using with docker\n\n```Dockerfile\n# https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL.html\nADD https://truststore.pki.rds.amazonaws.com/global/global-bundle.pem /path/to/save/\nENV NODE_EXTRA_CA_CERTS=/path/to/save/global-bundle.pem\n```\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## 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## License\n\nLicensed under [MIT License](LICENSE). Copyright (c) 2017-2022 will Farrell 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/docs/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/%40willfarrell%2Fmiddy-rds.svg\"){kind=icon}
\n ![\"Known](\"https://snyk.io/test/github/willfarrell/middy-rds/badge.svg\"){kind=icon}
\n ![\"Standard](\"https://img.shields.io/badge/code_style-standard-brightgreen.svg\"){kind=icon}
\n ![\"Chat](\"https://badges.gitter.im/gitterHQ/gitter.svg\")
\n