drg-adaptive/db-migrate-pg-aurora

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

Welcome to db-migrate-pg-aurora 👋

AWS Postgres Aurora Serverless db-migrate Driver

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

🏠 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-pg-aurora"
    },
    "database": "<Database Name>",
    "schema": "<Schema Name>",
    "secretArn": "<Secrets Manager ARN that contains credentials for the cluster> ",
    "resourceArn": "<Database Cluster ARN to connect to>",
    "region": "<AWS Region to connect to>",
    "maxRetries": 3,
    "connectTimeout": 45000
  }
}

Run tests

yarn test

Author

👤 Elisha Boozer [email protected]

• 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

db-migrate-pg-aurora's Issues

The automated release is failing 🚨

🚨 The automated release from the master branch failed. 🚨

I recommend you give this issue a high priority, so other packages depending on you could benefit from your bug fixes and new features.

You can find below the list of errors reported by semantic-release. Each one of them has to be resolved in order to automatically publish your package. I’m sure you can resolve this 💪.

Errors are usually caused by a misconfiguration or an authentication problem. With each error reported below you will find explanation and guidance to help you to resolve it.

Once all the errors are resolved, semantic-release will release your package the next time you push a commit to the master branch. You can also manually restart the failed CI job that runs semantic-release.

If you are not sure how to resolve this, here is some links that can help you:

• Usage documentation
• Frequently Asked Questions
• Support channels

If those don’t help, or if this issue is reporting something you think isn’t right, you can always ask the humans behind semantic-release.

---

Cannot push to the Git repository.

semantic-release cannot push the version tag to the branch master on the remote Git repository with URL https://[secure]@github.com/drg-adaptive/db-migrate-pg-aurora.git.

This can be caused by:

• a misconfiguration of the repositoryUrl option
• the repository being unavailable
• or missing push permission for the user configured via the Git credentials on your CI environment

---

Good luck with your project ✨

Your semantic-release bot 📦🚀

Support for endpoint in rdsParams

Hi! I use the serverless framework and its plugin data-api-local-serverless for local development. The plugin generates starts a mock data-api service on a local endpoint.

At the moment, this package doesn't support setting a custom endpoint on the RDSDataService instance (see here). Please consider adding support for it? I'm happy to submit a PR.

driver.close does not call the provided callback

a difference between your driver and others is that no callback is ever caller after all migrations is applied:

DBMigrate.getInstance(true,{})
    .sync()
    .then(() =>console.log('migration done'))
    .catch((err) => console.log('migration failed', err))

will never have his then or catch called

I found that the source of this problem is that you never call the provided callback during driver.close(cb);

this callback is responsible for terminating the promise of all operations. (see db-migrate/lib/commands/on-complete.js:11)

do you still maintains this repository, and if so, would you merge a PR that fix this bug if I fill one ?