https://github.com/ctala/aurora-mysql2-cluster
Managed Pool Connections for Aurora DB
https://github.com/ctala/aurora-mysql2-cluster
Last synced: 5 months ago
JSON representation
Managed Pool Connections for Aurora DB
- Host: GitHub
- URL: https://github.com/ctala/aurora-mysql2-cluster
- Owner: ctala
- Created: 2019-02-16T16:56:15.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2019-03-09T16:44:12.000Z (over 7 years ago)
- Last Synced: 2025-12-22T21:44:29.779Z (6 months ago)
- Language: JavaScript
- Size: 10.7 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
# aurora-mysql2-cluster
Managed Pool Connections for Aurora DB.
This module will create 2 Mysql2 pools using the Amazon Aurora endpoints. Read replicas will be automatically optimized by Amazon.
Also executes plain Mysql queries through the pools.
# Configuration
This module will read the enviromental variables in order to find the information regarding to the write and read endpoints for the Aurora Cluster. If the information for read is not provided, it will use the corresponding variable for write.
## Enviromental Variables
### Writter
* DB_HOST
* DB_USER
* DB_DATABASE
* DB_PORT
* DB_PASS
### Reader
While we can use an Aurora writter endpoint to read is not recommended. All the information not found in the enviroment will use the writter variables by default.
* DB_HOST_DEV (RECOMMENDED)
* DB_USER_DEV (OPTIONAL)
* DB_DATABASE_DEV (OPTIONAL)
* DB_PORT_DEV (OPTIONAL)
* DB_PASS_DEV (OPTIONAL)
## Creating the object
Using the enviromental variables.
```
const AuroraPool = require("aurora-mysql2-cluster");
let auroraPool = new AuroraPool();
```
### Using params
```
const AuroraPool = require("aurora-mysql2-cluster");
let writterInfo = {
host : "",
user : "",
database : "",
port : "",
password : ""
}
let readerInfo = {
host : "",
user : "",
database : "",
port : "",
password : ""
}
let auroraPool = new AuroraPool(writterInfo,readerInfo);
```
### Amazon Systems Manager Agent (SSM)
A good practice is to keep passwords encrypted and database information safe. That is why by default we can use SSM variables directly from our account. Any variable that we want to be loaded from AWS SSM just need to start with the pattern "ssm//".
For example :
```
let writterInfo = {
host : "ssm//RDS_GW_HOST_WRITE",
password : "ssm//RDS_GW_HOST_PASSWORD"
}
```
In this case we will load the host and the password from SSM ( Assuming you have permissions ). All passwords MUST be encrypted in SSM.
### Read Query
```
auroraPool.read(query);
```
Return Mysql2 pool query result as a promise.
### Write Query
```
auroraPool.write(query);
```
Return Mysql2 pool query result as a promise.