Dynamodb-enhanced: added 'conditionExpression' support to put, get, delete operations; slightly breaking style changes to immutable object getters

Author: bmaizels

.changes/next-release/feature-AmazonDynamoDBEnhancedClientPreview-5c8520f.json

@@ -0,0 +1,5 @@
+{
+    "type": "feature",
+    "category": "Amazon DynamoDB Enhanced Client [Preview]",
+    "description": "Write operations (put, get, delete) now support 'conditionExpression'"
+}

services-custom/dynamodb-enhanced/src/main/java/software/amazon/awssdk/extensions/dynamodb/mappingclient/BatchableReadOperation.java

@@ -19,7 +19,7 @@
 
 @SdkProtectedApi
 public interface BatchableReadOperation {
-    Boolean getConsistentRead();
+    Boolean consistentRead();
 
-    Key getKey();
+    Key key();
 }

services-custom/dynamodb-enhanced/src/main/java/software/amazon/awssdk/extensions/dynamodb/mappingclient/CommonOperation.java

@@ -53,7 +53,7 @@ public interface CommonOperation<ItemT, RequestT, ResponseT, ResultT> {
      * @param dynamoDbClient A low level {@link DynamoDbClient} to make the call against.
      * @return A function that calls DynamoDb with a provided request object and returns the response object.
      */
-    Function<RequestT, ResponseT> getServiceCall(DynamoDbClient dynamoDbClient);
+    Function<RequestT, ResponseT> serviceCall(DynamoDbClient dynamoDbClient);
 
     /**
      * Takes the response object returned by the actual DynamoDb call and maps it into a higher level abstracted
@@ -89,7 +89,7 @@ default ResultT execute(TableSchema<ItemT> tableSchema,
                             MapperExtension mapperExtension,
                             DynamoDbClient dynamoDbClient) {
         RequestT request = generateRequest(tableSchema, context, mapperExtension);
-        ResponseT response = getServiceCall(dynamoDbClient).apply(request);
+        ResponseT response = serviceCall(dynamoDbClient).apply(request);
         return transformResponse(response, tableSchema, context, mapperExtension);
     }
 }

services-custom/dynamodb-enhanced/src/main/java/software/amazon/awssdk/extensions/dynamodb/mappingclient/DatabaseOperation.java

@@ -48,7 +48,7 @@ public interface DatabaseOperation<RequestT, ResponseT, ResultT> {
      * @param dynamoDbClient A low level {@link DynamoDbClient} to make the call against.
      * @return A function that calls DynamoDb with a provided request object and returns the response object.
      */
-    Function<RequestT, ResponseT> getServiceCall(DynamoDbClient dynamoDbClient);
+    Function<RequestT, ResponseT> serviceCall(DynamoDbClient dynamoDbClient);
 
     /**
      * Takes the response object returned by the actual DynamoDb call and maps it into a higher level abstracted
@@ -73,7 +73,7 @@ public interface DatabaseOperation<RequestT, ResponseT, ResultT> {
      */
     default ResultT execute(DynamoDbClient dynamoDbClient, MapperExtension mapperExtension) {
         RequestT request = generateRequest(mapperExtension);
-        ResponseT response = getServiceCall(dynamoDbClient).apply(request);
+        ResponseT response = serviceCall(dynamoDbClient).apply(request);
         return transformResponse(response, mapperExtension);
     }
 }

services-custom/dynamodb-enhanced/src/main/java/software/amazon/awssdk/extensions/dynamodb/mappingclient/Expression.java

@@ -51,14 +51,14 @@ public static Expression coalesce(Expression condition1, Expression condition2,
 
         return Expression.builder()
                          .expression(coalesceExpressions(condition1.expression, condition2.expression, joinToken))
-                         .expressionValues(coalesceValues(condition1.getExpressionValues(),
-                                                          condition2.getExpressionValues()))
-                         .expressionNames(coalesceNames(condition1.getExpressionNames(),
-                                                        condition2.getExpressionNames()))
+                         .expressionValues(coalesceValues(condition1.expressionValues(),
+                                                          condition2.expressionValues()))
+                         .expressionNames(coalesceNames(condition1.expressionNames(),
+                                                        condition2.expressionNames()))
                          .build();
     }
 
-    private static String coalesceExpressions(String expression1, String expression2, String joinToken) {
+    public static String coalesceExpressions(String expression1, String expression2, String joinToken) {
         if (expression1 == null) {
             return expression2;
         }
@@ -67,7 +67,7 @@ private static String coalesceExpressions(String expression1, String expression2
             return expression1;
         }
 
-        return expression1 + joinToken + expression2;
+        return "(" + expression1 + ")" + joinToken + "(" + expression2 + ")";
     }
 
     public static Map<String, AttributeValue> coalesceValues(Map<String, AttributeValue> expressionValues1,
@@ -118,15 +118,15 @@ public static Map<String, String> coalesceNames(Map<String, String> expressionVa
         return Collections.unmodifiableMap(result);
     }
 
-    public String getExpression() {
+    public String expression() {
         return expression;
     }
 
-    public Map<String, AttributeValue> getExpressionValues() {
+    public Map<String, AttributeValue> expressionValues() {
         return expressionValues;
     }
 
-    public Map<String, String> getExpressionNames() {
+    public Map<String, String> expressionNames() {
         return expressionNames;
     }
 
@@ -173,12 +173,30 @@ public Builder expression(String expression) {
         }
 
         public Builder expressionValues(Map<String, AttributeValue> expressionValues) {
-            this.expressionValues = expressionValues;
+            this.expressionValues = expressionValues == null ? null : new HashMap<>(expressionValues);
+            return this;
+        }
+
+        public Builder putExpressionValue(String key, AttributeValue value) {
+            if (this.expressionValues == null) {
+                this.expressionValues = new HashMap<>();
+            }
+
+            this.expressionValues.put(key, value);
             return this;
         }
 
         public Builder expressionNames(Map<String, String> expressionNames) {
-            this.expressionNames = expressionNames;
+            this.expressionNames = expressionNames == null ? null : new HashMap<>(expressionNames);
+            return this;
+        }
+
+        public Builder putExpressionName(String key, String value) {
+            if (this.expressionNames == null) {
+                this.expressionNames = new HashMap<>();
+            }
+
+            this.expressionNames.put(key, value);
             return this;
         }
 

services-custom/dynamodb-enhanced/src/main/java/software/amazon/awssdk/extensions/dynamodb/mappingclient/Key.java

@@ -66,12 +66,12 @@ public static Key of(AttributeValue partitionKeyValue, AttributeValue sortKeyVal
      * @param index The name of the index to use when determining the key attribute names.
      * @return A map of attribute names to {@link AttributeValue}.
      */
-    public Map<String, AttributeValue> getKeyMap(TableSchema<?> tableSchema, String index) {
+    public Map<String, AttributeValue> keyMap(TableSchema<?> tableSchema, String index) {
         Map<String, AttributeValue> keyMap = new HashMap<>();
-        keyMap.put(tableSchema.getTableMetadata().getIndexPartitionKey(index), partitionKeyValue);
+        keyMap.put(tableSchema.tableMetadata().indexPartitionKey(index), partitionKeyValue);
 
         if (sortKeyValue != null) {
-            keyMap.put(tableSchema.getTableMetadata().getIndexSortKey(index).orElseThrow(
+            keyMap.put(tableSchema.tableMetadata().indexSortKey(index).orElseThrow(
                 () -> new IllegalArgumentException("A sort key value was supplied for an index that does not support "
                                                    + "one. Index: " + index)), sortKeyValue);
         }
@@ -83,7 +83,7 @@ public Map<String, AttributeValue> getKeyMap(TableSchema<?> tableSchema, String
      * Get the literal value of the partition key stored in this object.
      * @return An {@link AttributeValue} representing the literal value of the partition key.
      */
-    public AttributeValue getPartitionKeyValue() {
+    public AttributeValue partitionKeyValue() {
         return partitionKeyValue;
     }
 
@@ -92,7 +92,7 @@ public AttributeValue getPartitionKeyValue() {
      * @return An optional {@link AttributeValue} representing the literal value of the sort key, or empty if there
      * is no sort key value in this Key.
      */
-    public Optional<AttributeValue> getSortKeyValue() {
+    public Optional<AttributeValue> sortKeyValue() {
         return Optional.ofNullable(sortKeyValue);
     }
 
@@ -101,8 +101,8 @@ public Optional<AttributeValue> getSortKeyValue() {
      * @param tableSchema A tableschema to determine the key attribute names from.
      * @return A map of attribute names to {@link AttributeValue}.
      */
-    public Map<String, AttributeValue> getPrimaryKeyMap(TableSchema<?> tableSchema) {
-        return getKeyMap(tableSchema, TableMetadata.getPrimaryIndexName());
+    public Map<String, AttributeValue> primaryKeyMap(TableSchema<?> tableSchema) {
+        return keyMap(tableSchema, TableMetadata.primaryIndexName());
     }
 
     @Override

services-custom/dynamodb-enhanced/src/main/java/software/amazon/awssdk/extensions/dynamodb/mappingclient/MappedIndex.java

@@ -50,25 +50,25 @@ public interface MappedIndex<T> {
      * Gets the {@link MapperExtension} associated with this mapped resource.
      * @return The {@link MapperExtension} associated with this mapped resource.
      */
-    MapperExtension getMapperExtension();
+    MapperExtension mapperExtension();
 
     /**
      * Gets the {@link TableSchema} object that this mapped table was built with.
      * @return The {@link TableSchema} object for this mapped table.
      */
-    TableSchema<T> getTableSchema();
+    TableSchema<T> tableSchema();
 
     /**
      * Gets the physical table name that operations performed by this object will be executed against.
      * @return The physical table name.
      */
-    String getTableName();
+    String tableName();
 
     /**
      * Gets the physical secondary index name that operations performed by this object will be executed against.
      * @return The physical secondary index name.
      */
-    String getIndexName();
+    String indexName();
 
     /**
      * Creates a {@link Key} object from a modelled item. This key can be used in query conditionals and get

services-custom/dynamodb-enhanced/src/main/java/software/amazon/awssdk/extensions/dynamodb/mappingclient/MappedTable.java

@@ -56,19 +56,19 @@ public interface MappedTable<T> {
      * Gets the {@link MapperExtension} associated with this mapped resource.
      * @return The {@link MapperExtension} associated with this mapped resource.
      */
-    MapperExtension getMapperExtension();
+    MapperExtension mapperExtension();
 
     /**
      * Gets the {@link TableSchema} object that this mapped table was built with.
      * @return The {@link TableSchema} object for this mapped table.
      */
-    TableSchema<T> getTableSchema();
+    TableSchema<T> tableSchema();
 
     /**
      * Gets the physical table name that operations performed by this object will be executed against.
      * @return The physical table name.
      */
-    String getTableName();
+    String tableName();
 
     /**
      * Creates a {@link Key} object from a modelled item. This key can be used in query conditionals and get

services-custom/dynamodb-enhanced/src/main/java/software/amazon/awssdk/extensions/dynamodb/mappingclient/OperationContext.java

@@ -32,14 +32,14 @@ public static OperationContext of(String tableName, String indexName) {
     }
 
     public static OperationContext of(String tableName) {
-        return new OperationContext(tableName, TableMetadata.getPrimaryIndexName());
+        return new OperationContext(tableName, TableMetadata.primaryIndexName());
     }
 
-    public String getTableName() {
+    public String tableName() {
         return tableName;
     }
 
-    public String getIndexName() {
+    public String indexName() {
         return indexName;
     }
 

services-custom/dynamodb-enhanced/src/main/java/software/amazon/awssdk/extensions/dynamodb/mappingclient/Page.java

@@ -61,7 +61,7 @@ public static <T> Page<T> of(List<T> items) {
      * Returns a page of mapped objects that represent records from a database query or scan.
      * @return A list of mapped objects.
      */
-    public List<T> getItems() {
+    public List<T> items() {
         return items;
     }
 
@@ -70,7 +70,7 @@ public List<T> getItems() {
      * to continue the query or scan if passed into a request.
      * @return The 'lastEvaluatedKey' from the last query or scan operation or null if the no more pages are available.
      */
-    public Map<String, AttributeValue> getLastEvaluatedKey() {
+    public Map<String, AttributeValue> lastEvaluatedKey() {
         return lastEvaluatedKey;
     }
 

services-custom/dynamodb-enhanced/src/main/java/software/amazon/awssdk/extensions/dynamodb/mappingclient/TableMetadata.java

@@ -34,7 +34,7 @@ public interface TableMetadata {
      * @throws IllegalArgumentException if the index does not exist in the metadata or does not have a partition key
      * associated with it..
      */
-    String getIndexPartitionKey(String indexName);
+    String indexPartitionKey(String indexName);
 
     /**
      * Returns the attribute name of the sort key for an index.
@@ -43,7 +43,7 @@ public interface TableMetadata {
      * @return Optional of the attribute name representing the sort key for this index; empty if the index does not
      * have a sort key.
      */
-    Optional<String> getIndexSortKey(String indexName);
+    Optional<String> indexSortKey(String indexName);
 
     /**
      * Returns a custom metadata object. These objects are used by extensions to the library, therefore the type of
@@ -56,15 +56,15 @@ public interface TableMetadata {
      * @param <T> The flexible type for the object being returned. The compiler will typically infer this.
      * @return An optional containing custom metadata object or empty if the object was not found.
      */
-    <T> Optional<T> getCustomMetadataObject(String key, Class<? extends T> objectClass);
+    <T> Optional<T> customMetadataObject(String key, Class<? extends T> objectClass);
 
     /**
      * Returns all the names of attributes associated with the keys of a specified index.
      *
      * @param indexName The name of the index.
      * @return A collection of all key attribute names for that index.
      */
-    Collection<String> getIndexKeys(String indexName);
+    Collection<String> indexKeys(String indexName);
 
     /**
      * Returns all the names of attributes associated with any index (primary or secondary) known for this table.
@@ -74,42 +74,42 @@ public interface TableMetadata {
      *
      * @return A collection of all key attribute names for the table.
      */
-    Collection<String> getAllKeys();
+    Collection<String> allKeys();
 
     /**
      * Returns the DynamoDb scalar attribute type associated with a key attribute if one is applicable.
      * @param keyAttribute The key attribute name to return the scalar attribute type of.
      * @return Optional {@link ScalarAttributeType} of the attribute, or empty if attribute is a non-scalar type.
      * @throws IllegalArgumentException if the keyAttribute is not found.
      */
-    Optional<ScalarAttributeType> getScalarAttributeType(String keyAttribute);
+    Optional<ScalarAttributeType> scalarAttributeType(String keyAttribute);
 
     /**
      * Returns the attribute name used as the primary partition key for the table.
      *
      * @return The primary partition key attribute name.
      * @throws IllegalArgumentException if the primary partition key is not known.
      */
-    default String getPrimaryPartitionKey() {
-        return getIndexPartitionKey(getPrimaryIndexName());
+    default String primaryPartitionKey() {
+        return indexPartitionKey(primaryIndexName());
     }
 
     /**
      * Returns the attribute name used as the primary sort key for the table.
      *
      * @return An optional of the primary sort key attribute name; empty if this key is not known.
      */
-    default Optional<String> getPrimarySortKey() {
-        return getIndexSortKey(getPrimaryIndexName());
+    default Optional<String> primarySortKey() {
+        return indexSortKey(primaryIndexName());
     }
 
     /**
      * Returns the names of the attributes that make up the primary key for the table.
      *
      * @return A collection of attribute names that make up the primary key for the table.
      */
-    default Collection<String> getPrimaryKeys() {
-        return getIndexKeys(getPrimaryIndexName());
+    default Collection<String> primaryKeys() {
+        return indexKeys(primaryIndexName());
     }
 
     /**
@@ -119,7 +119,7 @@ default Collection<String> getPrimaryKeys() {
      *
      * @return An arbitrary constant that internally represents the primary index name.
      */
-    static String getPrimaryIndexName() {
+    static String primaryIndexName() {
         // Must include illegal symbols that cannot be used by a real index.
         // This value is arbitrary and ephemeral but could end up being serialized with TableMetadata through the
         // actions of a client, so it should not be altered unless absolutely necessary.

services-custom/dynamodb-enhanced/src/main/java/software/amazon/awssdk/extensions/dynamodb/mappingclient/TableOperation.java

@@ -55,7 +55,7 @@ default ResultT executeOnPrimaryIndex(TableSchema<ItemT> tableSchema,
                                           String tableName,
                                           MapperExtension mapperExtension,
                                           DynamoDbClient dynamoDbClient) {
-        OperationContext context = OperationContext.of(tableName, TableMetadata.getPrimaryIndexName());
+        OperationContext context = OperationContext.of(tableName, TableMetadata.primaryIndexName());
         return execute(tableSchema, context, mapperExtension, dynamoDbClient);
     }
 }

services-custom/dynamodb-enhanced/src/main/java/software/amazon/awssdk/extensions/dynamodb/mappingclient/TableSchema.java

@@ -76,14 +76,14 @@ public interface TableSchema<T> {
      * @return A single {@link AttributeValue} representing the requested modelled attribute in the model object or
      * null if the attribute has not been set with a value in the modelled object.
      */
-    AttributeValue getAttributeValue(T item, String key);
+    AttributeValue attributeValue(T item, String key);
 
     /**
      * Returns the object that describes the structure of the table being modelled by the mapper. This includes
      * information such as the table name, index keys and attribute tags.
      * @return A {@link TableMetadata} object that contains structural information about the table being modelled.
      */
-    TableMetadata getTableMetadata();
+    TableMetadata tableMetadata();
 
     /**
      * Returns a builder for the default implementation of this interface which is an immutable, declarative, type-safe

services-custom/dynamodb-enhanced/src/main/java/software/amazon/awssdk/extensions/dynamodb/mappingclient/core/AttributeValueType.java

@@ -40,7 +40,7 @@ public enum AttributeValueType {
         this.scalarAttributeType = scalarAttributeType;
     }
 
-    public ScalarAttributeType getScalarAttributeType() {
+    public ScalarAttributeType scalarAttributeType() {
         return scalarAttributeType;
     }
 }