Skip to content

Commit

Permalink
minor fix and version bump
Browse files Browse the repository at this point in the history
  • Loading branch information
jeremydaly committed Dec 16, 2020
1 parent 61206cd commit 1f26665
Show file tree
Hide file tree
Showing 4 changed files with 24 additions and 34 deletions.
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -137,6 +137,7 @@ Below is a table containing all of the possible configuration options for the `d
| resourceArn | `string` | The ARN of your Aurora Serverless Cluster. This value is *required*, but can be overridden when querying. | |
| secretArn | `string` | The ARN of the secret associated with your database credentials. This is *required*, but can be overridden when querying. | |
| database | `string` | *Optional* default database to use with queries. Can be overridden when querying. | |
| engine | `mysql` or `pg` | The type of database engine you're connecting to (MySQL or Postgres). | `mysql` |
| hydrateColumnNames | `boolean` | When `true`, results will be returned as objects with column names as keys. If `false`, results will be returned as an array of values. | `true` |
| ~~keepAlive~~ (deprecated) | `boolean` | See [Connection Reuse](#connection-reuse) below. | |
| ~~sslEnabled~~ (deprecated) | `boolean` | Set this in the `options` | `true` |
Expand Down
6 changes: 3 additions & 3 deletions index.js
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
* https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/data-api.html
*
* @author Jeremy Daly <[email protected]>
* @version 1.1.0
* @version 1.2.0
* @license MIT
*/

Expand Down Expand Up @@ -490,7 +490,7 @@ const commit = async (config,queries,rollback) => {
/**
* Create a Data API client instance
* @param {object} params
* @param {'mysql'|'pg'} params.engine The type of database (MySQL or Postgres)
* @param {'mysql'|'pg'} [params.engine=mysql] The type of database (MySQL or Postgres)
* @param {string} params.resourceArn The ARN of your Aurora Serverless Cluster
* @param {string} params.secretArn The ARN of the secret associated with your
* database credentials
Expand Down Expand Up @@ -529,7 +529,7 @@ const init = params => {
// Require engine
engine: typeof params.engine === 'string' ?
params.engine
: error('\'engine\' string value required'),
: 'mysql',

// Require secretArn
secretArn: typeof params.secretArn === 'string' ?
Expand Down
43 changes: 17 additions & 26 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

8 changes: 3 additions & 5 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "data-api-client",
"version": "1.1.0",
"version": "1.2.0",
"description": "A lightweight wrapper that simplifies working with the Amazon Aurora Serverless Data API",
"main": "index.js",
"scripts": {
Expand All @@ -25,17 +25,15 @@
},
"homepage": "https://github.com/jeremydaly/data-api-client#readme",
"devDependencies": {
"aws-sdk": "^2.713.0",
"aws-sdk": "^2.811.0",
"eslint": "^6.8.0",
"jest": "^25.5.4",
"rewire": "^4.0.1"
},
"dependencies": {
"sqlstring": "^2.3.1"
"sqlstring": "^2.3.2"
},
"files": [
"LICENSE",
"README.md",
"index.js"
]
}

0 comments on commit 1f26665

Please sign in to comment.