drg-adaptive / db-migrate-aurora

A driver for db-migrate to connect to Aurora Serverless through the Data API

Welcome to db-migrate-aurora 👋

A db-migrate driver for aurora serverless.

AWS Aurora Serverless db-migrate Driver

A db-migrate driver for aurora serverless.

🏠 Homepage

Install

yarn install

Usage

See db-migrate for more information.

Configuration Example

Add the following configuration to your database.json file:

{
  "prod": {
    "driver": {
      "require": "db-migrate-aurora"
    },
    "database": "name of database on server...", // OPTIONAL
    "schema": "name of schema in database...", // OPTIONAL
    "secretArn": "ARN of a secret store containing credentials for the cluster",
    "resourceArn": "ARN of the cluster to connect to",
    "region": "us-east-1", // The AWS region of the cluster
    "maxRetries": 3, // OPTIONAL: number of times to retry connecting
    "connectTimeout": 45000 // OPTIONAL: number of milliseconds to wait until timing out the connection
  }
}

Run tests

yarn test

Author

👤 Ben Force [e-mail]

• Github: @drg-adaptive

🤝 Contributing

Contributions, issues and feature requests are welcome!

Feel free to check issues page.

Show your support

Give a ⭐️ if this project helped you!

📝 License

Copyright © 2019 DRG Adaptive.

This project is MIT licensed.

---

This README was generated with ❤️ by readme-md-generator