Document API for DynamoDB usung EnhancedDynamoDB impementation issue #36

[joviegas]

Motivation and Context

Fix for #36

Modifications

Classname	Changes	Type	package	API Access
{@link EnhancedDocument}	New Interface	Interface	software.amazon.awssdk.enhanced.dynamodb.document	Public API
{@link DocumentTableSchema}	New class	Implementation of {@link TableSchema}	package software.amazon.awssdk.enhanced.dynamodb.document	Public API
{@link TableSchema}	New API added	Implementation of {@link TableSchema}	software.amazon.awssdk.enhanced.dynamodb	Public API

Creating SCHEMA with Primary and secondary keys

DocumentTableSchema tableSchema = TableSchema.documentSchemaBuilder()
                                             .addIndexPartitionKey(TableMetadata.primaryIndexName(),"sampleHashKey", AttributeValueType.S)
                                             .addIndexSortKey(TableMetadata.primaryIndexName(),"sampleSortKey", AttributeValueType.S)
                                             .attributeConverterProviders(CustomAttributeForDocumentConverterProvider.create(),
                                                                          defaultProvider())
                                             .build();

DynamoDbTable<EnhancedDocument> documentDDBTable = enhancedClient.table("your_tableName", tableSchema);

Simple Creation of EnhancedDocument using Builder

EnhancedDocument simpleDoc = EnhancedDocument.builder()
    .attributeConverterProviders(defaultProvider())
                                             .putString("HashKey", "abcdefg123")
                                             .putNull("nullKey")
                                             .putNumber("numberKey", 2.0)
                                             .putBytes("sdkByte", SdkBytes.fromUtf8String("a"))
                                             .putBoolean("booleanKey", true)
                                             .putJson("jsonKey", "{\"1\": [\"a\", \"b\", \"c\"],\"2\": 1}")
                                             .putStringSet("stingSet",
                                                           Stream.of("a", "b", "c").collect(Collectors.toSet()))

                                             .putNumberSet("numberSet", Stream.of(1, 2, 3, 4).collect(Collectors.toSet()))
                                             .putBytesSet("sdkByteSet",
                                                          Stream.of(SdkBytes.fromUtf8String("a")).collect(Collectors.toSet()))
                                             .build();

Put Item to table with simpleDoc as created above

        table.putItem(simpleDoc);

Put Item to table with EnhancedDocument builder

        table.putItem(EnhancedDocument
                          .builder()
                          .putString(HASH_KEY, "first_hash")
                          .putString(SORT_KEY, "1_sort")
                          .putNull("null_Key")
                          .build());

Get Item from table

            table.getItem(EnhancedDocument.builder()
                             .attributeConverterProviders(defaultProvider())
                                          .putString(SORT_KEY, "1_sort")
                                          .putString(HASH_KEY, "first_hash").build()).getString(SORT_KEY));
                                          .build());

Getter	Value Extracted
simpleDoc.toJson()	"{"HashKey":"abcdefg123","nullKey":null,"numberKey":2.0,"sdkByte":"a","booleanKey":true,"jsonKey":{"1":["a","b","c"],"2":1},"stingSet":["a","b","c"],"numberSet":[1,2,3,4],"sdkByteSet":["a"]}")
simpleDoc.isPresent("HashKey")	true
simpleDoc.isPresent("HashKey2")	false
simpleDoc.getString("HashKey")	"abcdefg123"
simpleDoc.isNull("nullKey")	true
simpleDoc.getNumber("numberKey")	SdkNumber.fromDouble(2.0)
simpleDoc.getBytes("sdkByte")	SdkBytes.fromUtf8String("a"))
simpleDoc.getBoolean("booleanKey")	true
simpleDoc.getJson("jsonKey")	"{"1":["a","b","c"],"2":1}"
simpleDoc.getStringSet("stingSet")	Stream.of("a", "b", "c").collect(Collectors.toSet()))
simpleDoc.getList("stingSet", EnhancedType.of(String.class))	Stream.of("a", "b", "c").collect(Collectors.toList()))
simpleDoc.getNumberSet("numberSet")	Stream.of(1, 2, 3, 4).collect(Collectors.toSet()))
simpleDoc.getBytesSet("sdkByteSet")	Stream.of(SdkBytes.fromUtf8String("a")).collect(Collectors.toSet()))

Testing

• Junits and Functional test using Local DDB

Screenshots (if appropriate)

Types of changes

• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)

License

• I confirm that this pull request can be released under the Apache 2 license

[sonarqubecloud]

Kudos, SonarCloud Quality Gate passed!   

0 Bugs
0 Vulnerabilities
0 Security Hotspots
9 Code Smells

81.3% Coverage
0.3% Duplication