knex-aurora-data-api-client

Knex Aurora Data API Client

This is a fork of the knex-data-api-client by @alan-cooney to support both Postgres and Mysql

The Knex Aurora Data API Client is a Knex extension that supports the RDS Data API, built using Jeremy Daily's excellent data-api-client module.

Support for transactions, and nestTables is included.

Configuration

The library uses the default AWS credentials to connect to the RDS database using the data-api. The data-api-client that this library is a using provides more documentation on the permissions required and how to enable the data-api for the database.

Use

To use aurora in mysql mode:

constknexDataApiClient=require('knex-aurora-data-api-client');constknex=require('knex')({client: knexDataApiClient.mysql,connection: {secretArn: 'secret-arn',// RequiredresourceArn: 'db-resource-arn',// Requireddatabase: 'db-name',region: 'eu-west-2',},});

To use aurora in postgres mode:

constknexDataApiClient=require('knex-aurora-data-api-client');constknex=require('knex')({client: knexDataApiClient.postgres,connection: {secretArn: 'secret-arn',// RequiredresourceArn: 'db-resource-arn',// Requireddatabase: 'db-name',region: 'eu-west-2',},});

Nested tables support

Note - this significantly increases the data required back from the RDS data api.

knex().doSomething().options({nestTables: true});

Credits

Forked from Skyhookknex-data-api-client and provided under an MIT license.