[](https://circleci.com/gh/Fyreware/mysql-data-api/tree/master)
npm install @fyreware/mysql-data-apiThis package was created to easily enabled the sequelize package to utilize the AWS data-api for Aurora Serverless MySQL by mocking parts of the interface of the mysql2 package that is utilize in sequelize mysql dialect.
Install sequelize in project
```
npm i --save sequelize
Install Wrapper
``
npm install @fyreware/mysql-data-api --save$3
When using the data api wrapper you will configure sequelize like normal with the exception of of certain fields that are ignored, or have been hijacked by the wrapper as shown below.
` javascript
const database = 'testDb'
// Arn of Aurora serverless cluster cluster
const host = 'arn:aws:rds:us-east-1:123456789000:cluster:http-endpoint-test';
// This param is ignored by the wrapper.
const username = 'anything';
// Arn of secrets manager secret containing the rds credentials
const passowrd = 'arn:aws:secretsmanager:region:123456789012:secret:tutorials/MyFirstTutorialSecret-jiObOV'
const sequelize = new Sequelize(database, username, password, {
host: host,
dialect: 'mysql'
// This tells sequelize to load our module instead of the mysql2 module`
dialectModulePath: '@fyreware/mysql-data-api',
});
* Currently AWS credentials can only be passed in via the environment. So local development is only works when you use the AWS Environment Variables or have the default profile set in your Shared Credentials File
Explain how to run the automated tests for this system
```
npm test
Add additional notes about how to deploy this on a live system
Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.
We use SemVer for versioning. For the versions available, see the tags on this repository.
Michael Strong - Initial work* - mtstrong17
Travis Delly - Initial work* - Dellybro
This project is licensed under the MIT License - see the LICENSE.md file for details