Skip to content

Commit 704ae9b

Browse files
author
Gary Arora
committedApr 5, 2020
added clarity to readme
1 parent 5bb04f8 commit 704ae9b

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed
 

‎README.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -120,7 +120,7 @@ const aws = require("aws-sdk");
120120
//Advance configuration with all options
121121
const athenaExpressConfig = {
122122
aws, /* required */
123-
s3: "STRING_VALUE", /* optional */
123+
s3: "STRING_VALUE", /* optional format 's3://bucketname'*/
124124
db: "STRING_VALUE", /* optional */
125125
workgroup: "STRING_VALUE", /* optional */
126126
formatJson: BOOLEAN, /* optional default=true */
@@ -139,9 +139,9 @@ const athenaExpress = new AthenaExpress(athenaExpressConfig);
139139

140140
| Parameter | Format | Default Value | Description |
141141
| ------------- | ------------- | ------------- | ------------- |
142-
| s3 | string | `athena-express` creates a new bucket for you | S3 bucket name/prefix to store Athena query results |
142+
| s3 | string | `athena-express` creates a new bucket for you | The location in Amazon S3 where your query results are stored, such as `s3://path/to/query/bucket/`. <br /> `athena-express` will create a new bucket for you if you don't provide a value for this param but sometimes that could cause an issue if you had recently deleted a bucket with the same name. (something to do with cache). When that happens, just specify you own bucket name. Alternatively you can also use `workgroup`. |
143143
| db | string | `default` | Athena database name that the SQL queries should be executed in. When a `db` name is specified in the config, you can execute SQL queries without needing to explicitly mention DB name. e.g. <br />` athenaExpress.query("SELECT * FROM movies LIMIT 3")` <br /> as opposed to <br />` athenaExpress.query({sql: "SELECT * FROM movies LIMIT 3", db: "moviedb"});` |
144-
| workgroup | string | `primary` | The name of the workgroup in which the query is being started. |
144+
| workgroup | string | `primary` | The name of the workgroup in which the query is being started. <br /> Note: athena-express cannot create workgroups (as it includes a lot of configuration) so you will need to create one beforehand IFF you intend to use a non default workgroup. Learn More here. [Setting up Workgroups](https://docs.aws.amazon.com/athena/latest/ug/user-created-workgroups.html) |
145145
|formatJson | boolean | `true` | Override as false if you rather get the raw unformatted output from S3. |
146146
|retry | integer | `200` milliseconds| Wait interval between re-checking if the specific Athena query has finished executing |
147147
|getStats | boolean | `false`| Set `getStats: true` to capture additional metadata for your query, such as: <ul><li>`EngineExecutionTimeInMillis`</li><li>`DataScannedInBytes`</li><li>`TotalExecutionTimeInMillis`</li><li>`QueryQueueTimeInMillis`</li><li>`QueryPlanningTimeInMillis`</li><li>`ServiceProcessingTimeInMillis`</li><li>`DataScannedInMB`</li><li>`QueryCostInUSD`</li><li>`Count`</li><li>`QueryExecutionId`</li><li>`S3Location`</li></ul> |

0 commit comments

Comments
 (0)
Please sign in to comment.