Preserve JSON helper methods in the DynamoDB Document API

[gibbonsj]

Provide DDB Document API method parity by including toJSON() and fromJSON() methods.

See #36 comments from @millems suggesting a new feature request be opened.

This capability was a welcomed addition to the V1 Document API because it was a convenient and low-friction way to work with JSON document strings and DDB.

Adding a notional V1 to V2 DDB Document API migration example that uses both methods.

-- From v1 --

AmazonDynamoDB dynamoDB = AmazonDynamoDBClientBuilder
...
DynamoDB dynamo = new DynamoDB(dynamoDB);
dbtable = dynamo.getTable(table);

dbtable.putItem(Item.fromJSON(jsonString));
Item item = dbtable.getItem(spec);
String jsonString = item.toJSON();

-- To v2 --

DynamoDbClient ddbClient = DynamoDbClient
.builder()
...
.build();

??? ddbClient.putItem(Item.fromJSON(jsonString))
??? jsonString = ddbClient.getItem(spec).toJSON()

[debora-ito]

Thank you for reaching out. Marking as a feature request.

[pkgonan]

@dagnir @debora-ito
Hi, is there any plan about this feature ?
Thank you :)

[rmmeans]

I realize this is a feature request currently. Is there any known work-arounds for this capability? We have scenarios where we have both JS and JVM based clients accessing the same dynamo tables, allowing both to work with JSON natively makes our lives much easier.

On the JS SDK v2 we can use the AWS.DynamoDB.Converter to marshall / unmarshall full Js Objects to / from Dynamo JSON, or just individual attributes

On the JS SDK v3 we can use @aws-sdk/util-dynamodb for the same capabilities.

On AWS Java SDK v1 it appears we can use the com.amazonaws.services.dynamodbv2.document.Item fromJSON method to convert to an Item type.

Is there any work-arounds ahead of having this feature request implemented that is currently available in both JS SDK's and the v1 Java SDK?

[dscalzi]

Bump?

[davidh44]

Support for JSON methods was released a while back in 2.20.33 with the introduction of the Enhanced Document API

• https://aws.amazon.com/blogs/devops/introducing-the-enhanced-document-api-for-dynamodb-in-the-aws-sdk-for-java-2-x/
• https://docs.aws.amazon.com/sdk-for-java/latest/developer-guide/ddb-en-client-doc-api.html
• https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ProgrammingWithJava.html#DocumentInterface

[github-actions]

This issue is now closed. Comments on closed issues are hard for our team to see.
If you need more assistance, please open a new issue that references this one.