Nefarious Pomegranate Magnate

    @fyreware/mysql-data-api

    0.1.1 • Public • Published

    Mysql Data API Wapper

    CircleCI

    This 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.

    Getting Started

    This package has only been testes for sequelize v5, and only for the mysql dialect.

    Prerequisites

    When getting started make sure you are using Aurora Serverless MySQL and that the Data API is enabled. And that you cluster is configured to use secrets from AWS Secrets Manager

    Install sequelize in project

    npm i --save sequelize
    

    Installing

    Install Wrapper

    npm install @fyreware/mysql-data-api --save
    

    Usage

    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.

    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',
    });

    Things to know

    • When using the Data API is that you will not be able to insert or select zero date values on the database ass both will result in error. This is a limitation of the Data API its self so not much can be done about it. We suggest ensuring these values are not zero values by either explicitly setting the date on insert or setting a default value of NULL or CURRENT_TIMESTAMP.

    • 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

    Running the tests

    Explain how to run the automated tests for this system

    And coding style tests

    npm test
    

    Deployment

    Add additional notes about how to deploy this on a live system

    Contributing

    Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

    Versioning

    We use SemVer for versioning. For the versions available, see the tags on this repository.

    Authors

    License

    This project is licensed under the MIT License - see the LICENSE.md file for details

    Keywords

    none

    Install

    npm i @fyreware/mysql-data-api

    DownloadsWeekly Downloads

    1,271

    Version

    0.1.1

    License

    MIT

    Unpacked Size

    12.4 kB

    Total Files

    6

    Last publish

    Collaborators

    • fyreman
    • mtstrong