Skip to content

Commit b2b43e7

Browse files
authored
Update README.md - verbage and formatting changes to complete changes for issue aws-samples#137
1 parent ef56bcd commit b2b43e7

File tree

1 file changed

+25
-2
lines changed

1 file changed

+25
-2
lines changed

scripts/nosqlworkbenchscript/README.md

+25-2
Original file line numberDiff line numberDiff line change
@@ -34,8 +34,32 @@ This guide will help you export the schema and first 1MB of data from an existin
3434
```
3535
node create-workbench-import.js YourTableNameHere > YourTableNameHere.json
3636
```
37-
The command directs the JSON output to `YourTableNameHere.json`
37+
The command directs the JSON output to `YourTableNameHere.json`. You can see part of a sample JSON output for a table named 'Blog1' below.
3838

39+
```
40+
{
41+
"ModelName": "Blog1",
42+
"ModelMetadata": {
43+
"Author": "testuser",
44+
"DateCreated": "Wed Oct 23 2024 19:31:56 GMT-0700 (Pacific Daylight Time)",
45+
"DateLastModified": "Wed Oct 23 2024 19:31:56 GMT-0700 (Pacific Daylight Time)",
46+
"Description": "A NoSQL Workbench model generated from table Blog1",
47+
"AWSService": "Amazon DynamoDB",
48+
"Version": "2.0"
49+
},
50+
"DataModel": [
51+
{
52+
"TableName": "Blog1",
53+
"KeyAttributes": {
54+
"PartitionKey": {
55+
"AttributeName": "email",
56+
"AttributeType": "S"
57+
},
58+
"SortKey": {
59+
"AttributeName": "State",
60+
"AttributeType": "S"
61+
}
62+
```
3963
If you wish to direct the output to stdout instead of a file, leave off the `> YourTableNameHere.json` in the command.
4064

4165
```
@@ -47,7 +71,6 @@ This guide will help you export the schema and first 1MB of data from an existin
4771
Once you have the JSON file from your table, you can perform a "import data model" in NoSQL Workbench to bring it into the tool.
4872
\
4973
\
50-
\
5174
Initial script by [Rob McCauley](https://github.com/robm26).
5275

5376
This script is provided as is and at your own risk. There are no guarantees expressly written or implied.

0 commit comments

Comments
 (0)