DynamoDB Bulk Write
On this Page
Snap type: | Write | |||||||
|---|---|---|---|---|---|---|---|---|
Description: | This Snap provides the ability to write the data into DynamoDB table. The table becomes suggestible once the account is defined.
| |||||||
| Prerequisites: | [None] | |||||||
| Support and limitations: | Works in Ultra Task Pipelines. | |||||||
| Account: | This Snap uses account references created on the Accounts page of SnapLogic Manager to handle access to this endpoint. See DynamoDB Account for information on setting up this type of account. | |||||||
| Views: |
| |||||||
Settings | ||||||||
Label | Required. The name for the Snap. You can modify this to be more specific, especially if you have more than one of the same Snap in your pipeline. | |||||||
Table name | Required. The name of the table to write the data into. This property is suggestible, that shown the list of the tables in the DB. | |||||||
| Thread count | This property represents the total number of parallel threads to be created for Bulk Write operation. | |||||||
| Batch size | Number of records batched for each request. | |||||||
| Request delay | Delay between two successive batch requests in seconds | |||||||
Snap execution | Select one of the three modes in which the Snap executes. Available options are:
| |||||||
Mandatory Path Mappings in upstream Mapper
The DynamoDB Bulk Write Snap expects an upstream Mapper Snap to feed the right mappings between input stream and the DynamoDB table. The Mapper must output a file/document that has the data in a readable and writable form for the DynamoDB Bulk Write Snap to populate the DynamoDB tables. See Examples for more details.
Input stream mappings are mandatory
In the absence of input stream mappings from the upstream (Mapper) Snap, the DynamoDB Bulk Write Snap fails during Pipeline execution.
DynamoDB Complex types:
- Sets
- Lists
- Map
Sets
String Set [SS]
A values of this type contains a set of strings delimited by double quotes as follows:
Pattern: [String object 1, String object 2, ........, String Object n]
Example: ["Snaplogic", "San Mateo", "Pipeline"]
Number Set [NS]
A value of this type contains a set of numbers delimited by double quotes as follows:
Pattern: [Number Obj1, Number Object2,...., Number Object n]
Example: ["123", "24.56", "-35", "-21.456","0"]
Binary Set [BS]
A value of this type contains a set of base64-encoded binary data objects delimited by double quotes as follows:
Pattern: [ Binary Object 1, Binary Object 2,...Binary Object n]
Example: ["U3Vubnk=", "UmFpbnk=", "U25vd3k="]
List (L):
A value of this type contains a set of objects. Each object further can be of any type (String, Number, String Set, Map, List etc.,). In general, the List object resembles a JSON array.
Pattern: [ object 1, object 2, ........, Object n]
Example: [{"N":"3"},{"S":"-7.5"},{"B":"U3Vubnk="},{"L":[{"N":"-45.56"},{"M":{"Name":{"S":"ahmed"}}}]},{"M":{"name":{"S":"syed"}}},{"SS":["a","b"]},{"BS":["U3Vubnk="]},{"NS":["23","45"]}]
Map(M):
A value of this type contains a set of key- value pairs. Keys are always strings, whereas values can be of any type (String, Number, String Set, Map, List etc.,). In general, the Map object resembles a JSON array.
Pattern: {"Key1":Object1, "Key2": Object2......"Keyn": Objectn}
Example: {"id":{"S":"snaplogic"}, "orgs":{"L":[{"S":"uat"}, {"S":"qa"}]}, "admins":{"L":[{"M":{"name":{"S":"a"}}}, {"M":{"name":{"S":"45"}}}]}}
The pipeline using all the Set types for the Bulk Write Snap:
Examples
Writing CSV data to a DynamoDB table
The following example will illustrate the usage of the DynamoDB BulkWrite Snap.
In this pipeline, we read a table data using the File Reader Snap and write the data to the table Exampletable using the Dynamo Bulk Write Snap.
The following images shows the CSV input data passed from the File Reader Snap:
.png?version=1&modificationDate=1489931210386&cacheVersion=1&api=v2&width=860&height=400)
The Mapper Snap maps the object record details that need to be updated in the input view of the DynamoDB Bulk Write Snap:
The data is loaded to the DynamoDB table Exampletable.
Successful execution of the above Snap gives the following data preview:
Path mappings in upstream Mapper
The following Pipeline illustrates the path mappings needed for writing multiple records using DynamoDB Bulk Write Snap.
To write multiple records into a DynamoDB table, you must first define by using the mappings in the Mapper Snap, the mappings between incoming data and the DynamoDB table schema.
- Ensure the Target path in the Mapping table contains
$PutRequest.Item.preceding every mapping entry. This prefix is mandatory to update the DynamoDB table using this Snap. - The entry in the target path must follow the syntax: $PutRequest.Item.<column>.<datatype>. , both for creating and updating the respective column in the target table.
- For any DynamoDB table target, the Target Schema displays only the (primary) key column details irrespective of the number of mappings defined.
Examples
$PutRequest.Item.id.S, $PutRequest.Item.Map.M
The Mapper generates the mappings output for DynamoDB Bulk Write Snap.
After selecting an appropriate account to connect to the DynamoDB database, define the target table name for the DynamoDB Bulk Write Snap.
Upon validation, the DynamoDB Bulk Write Snap generates the output preview similar to the following image. It contains the name of the table to be updated, the columns, and the respective values.
Upon execution, the Pipeline inserts multiple records into the specified DynamoDB table, with values defined in the Mapper output.
Downloads
Important steps to successfully reuse Pipelines
- Download and import the Pipeline into SnapLogic.
- Configure Snap accounts as applicable.
- Provide Pipeline parameters as applicable.
Snap Pack History
Have feedback? Email documentation@snaplogic.com | Ask a question in the SnapLogic Community
© 2017-2024 SnapLogic, Inc.