Issue #142 - Project fields in queries

derjust · Mar 19, 2018 · f5aa240 · f5aa240
1 parent 937ace8
commit f5aa240
Show file tree

Hide file tree

Showing 24 changed files with 241 additions and 110 deletions.
diff --git a/src/changes/changes.xml b/src/changes/changes.xml
@@ -27,6 +27,9 @@
       <action dev="derjust" type="fix" date="2018-03-05">
         Fix Javadoc and cast warnings
       </action>
+      <action dev="derjust" issue="142" type="add" date="">
+        Added support for @Query-based projections
+      </action>
     </release>
     <release version="5.0.2" date="2018-03-05" description="Maintenance release">
       <action dev="vitolimandibhrata" issue="40" type="add" date="2017-01-07">

diff --git a/src/main/java/org/socialsignin/spring/data/dynamodb/core/DynamoDBOperations.java b/src/main/java/org/socialsignin/spring/data/dynamodb/core/DynamoDBOperations.java
@@ -27,6 +27,9 @@
 import java.util.List;
 import java.util.Map;
 
+/**
+ * Interface to DynmaoDB - as seen from the Spring-Data world
+ */
 public interface DynamoDBOperations {
 
 	<T> int count(Class<T> domainClass, DynamoDBQueryExpression<T> queryExpression);

diff --git a/src/main/java/org/socialsignin/spring/data/dynamodb/query/AbstractQuery.java b/src/main/java/org/socialsignin/spring/data/dynamodb/query/AbstractQuery.java
@@ -25,15 +25,17 @@
  */
 public abstract class AbstractQuery<T> implements Query<T> {
 
-	protected DynamoDBOperations dynamoDBOperations;
-	protected Class<T> clazz;
+	protected final DynamoDBOperations dynamoDBOperations;
+	protected final Class<T> clazz;
 	protected boolean scanEnabled = false;
 	protected boolean scanCountEnabled = false;
 
-
-
 	public boolean isScanCountEnabled() {
-		return scanCountEnabled;
+		return this.scanCountEnabled;
+	}
+
+	public boolean isScanEnabled() {
+		return this.scanEnabled;
 	}
 
 	@Override
@@ -46,10 +48,6 @@ public void setScanEnabled(boolean scanEnabled) {
 		this.scanEnabled = scanEnabled;
 	}
 
-	public boolean isScanEnabled() {
-		return scanEnabled;
-	}
-
 	public AbstractQuery(DynamoDBOperations dynamoDBOperations, Class<T> clazz) {
 		this.dynamoDBOperations = dynamoDBOperations;
 		this.clazz = clazz;

diff --git a/...ain/java/org/socialsignin/spring/data/dynamodb/query/MultipleEntityQueryRequestQuery.java b/...ain/java/org/socialsignin/spring/data/dynamodb/query/MultipleEntityQueryRequestQuery.java
@@ -34,7 +34,7 @@ public MultipleEntityQueryRequestQuery(DynamoDBOperations dynamoDBOperations,Cla
 	@Override
 	public List<T> getResultList() {
 
-		return dynamoDBOperations.query(clazz, queryRequest);		
+		return dynamoDBOperations.query(clazz, queryRequest);
 	}
 
 }
diff --git a/src/main/java/org/socialsignin/spring/data/dynamodb/query/Query.java b/src/main/java/org/socialsignin/spring/data/dynamodb/query/Query.java
@@ -18,7 +18,6 @@
 import java.util.List;
 
 
-
 public interface Query<T> {
 
 	/**

diff --git a/src/main/java/org/socialsignin/spring/data/dynamodb/repository/Query.java b/src/main/java/org/socialsignin/spring/data/dynamodb/repository/Query.java
@@ -0,0 +1,36 @@
+/**
+ * Copyright © 2018 spring-data-dynamodb (https://github.com/derjust/spring-data-dynamodb)
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.socialsignin.spring.data.dynamodb.repository;
+
+import java.lang.annotation.Documented;
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+
+@Retention(RetentionPolicy.RUNTIME)
+@Target(ElementType.METHOD)
+@Documented
+public @interface Query {
+
+    /**
+     * A string that identifies the attributes you want. To retrieve a single attribute, specify its name.
+     * For multiple attributes, the names must be comma-separated.
+     *
+     * @see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.ProjectionExpressions.html">Projection Expressions</a>
+     */
+    String fields() default "";
+}
diff --git a/.../org/socialsignin/spring/data/dynamodb/repository/query/AbstractDynamoDBQueryCreator.java b/.../org/socialsignin/spring/data/dynamodb/repository/query/AbstractDynamoDBQueryCreator.java
@@ -33,6 +33,7 @@
 
 import java.util.Arrays;
 import java.util.Iterator;
+import java.util.Optional;
 
 /**
  * @author Michael Lavelle
@@ -41,21 +42,23 @@
 public abstract class AbstractDynamoDBQueryCreator<T, ID, R> extends
 		AbstractQueryCreator<Query<R>, DynamoDBQueryCriteria<T, ID>> {
 
-	private DynamoDBEntityInformation<T, ID> entityMetadata;
-	protected DynamoDBOperations dynamoDBOperations;
+	protected final DynamoDBEntityInformation<T, ID> entityMetadata;
+	protected final DynamoDBOperations dynamoDBOperations;
+	protected final Optional<String> projection;
 
-	public AbstractDynamoDBQueryCreator(PartTree tree, DynamoDBEntityInformation<T, ID> entityMetadata, DynamoDBOperations dynamoDBOperations) {
+	public AbstractDynamoDBQueryCreator(PartTree tree, DynamoDBEntityInformation<T, ID> entityMetadata, Optional<String> projection, DynamoDBOperations dynamoDBOperations) {
 		super(tree);
 		this.entityMetadata = entityMetadata;
+		this.projection = projection;
 		this.dynamoDBOperations = dynamoDBOperations;
 	}
 
 	public AbstractDynamoDBQueryCreator(PartTree tree, ParameterAccessor parameterAccessor,
-			DynamoDBEntityInformation<T, ID> entityMetadata, DynamoDBOperations dynamoDBOperations) {
+			DynamoDBEntityInformation<T, ID> entityMetadata, Optional<String> projection, DynamoDBOperations dynamoDBOperations) {
 		super(tree, parameterAccessor);
 		this.entityMetadata = entityMetadata;
+		this.projection = projection;
 		this.dynamoDBOperations = dynamoDBOperations;
-
 	}
 
 	@Override

diff --git a/...org/socialsignin/spring/data/dynamodb/repository/query/AbstractDynamoDBQueryCriteria.java b/...org/socialsignin/spring/data/dynamodb/repository/query/AbstractDynamoDBQueryCriteria.java
@@ -48,6 +48,7 @@
 import java.util.List;
 import java.util.Map;
 import java.util.Map.Entry;
+import java.util.Optional;
 
 /**
  * @author Michael Lavelle
@@ -68,6 +69,7 @@ public abstract class AbstractDynamoDBQueryCriteria<T, ID> implements DynamoDBQu
 	protected Object hashKeyPropertyValue;
 	protected String globalSecondaryIndexName;
 	protected Sort sort = Sort.unsorted();
+	protected Optional<String> projection = Optional.empty();
 
 	public abstract boolean isApplicableForLoad();
 
@@ -120,7 +122,14 @@ protected QueryRequest buildQueryRequest(String tableName, String theIndexName,
 			}
 
 			queryRequest.setKeyConditions(keyConditions);
-			queryRequest.setSelect(Select.ALL_PROJECTED_ATTRIBUTES);
+			// Might be overwritten in the actual Query classes
+			if (projection.isPresent()) {
+				queryRequest.setSelect(Select.SPECIFIC_ATTRIBUTES);
+				queryRequest.setProjectionExpression(projection.get());
+			} else {
+				queryRequest.setSelect(Select.ALL_PROJECTED_ATTRIBUTES);
+			}
+
 			applySortIfSpecified(queryRequest, new ArrayList<>(new HashSet<>(allowedSortProperties)));
 		}
 		return queryRequest;
@@ -323,7 +332,6 @@ protected String getHashKeyAttributeName() {
 		return getAttributeName(getHashKeyPropertyName());
 	}
 
-
 	protected boolean hasIndexHashKeyEqualCondition()
 	{
 		boolean hasIndexHashKeyEqualCondition = false;
@@ -677,4 +685,9 @@ public DynamoDBQueryCriteria<T, ID> withSort(Sort sort) {
 		return this;
 	}
 
+	@Override
+	public DynamoDBQueryCriteria<T, ID> withProjection(Optional<String> projection) {
+		this.projection = projection;
+		return this;
+	}
 }
diff --git a/...ava/org/socialsignin/spring/data/dynamodb/repository/query/DynamoDBCountQueryCreator.java b/...ava/org/socialsignin/spring/data/dynamodb/repository/query/DynamoDBCountQueryCreator.java
@@ -22,22 +22,24 @@
 import org.springframework.data.repository.query.ParameterAccessor;
 import org.springframework.data.repository.query.parser.PartTree;
 
+import java.util.Optional;
+
 public class DynamoDBCountQueryCreator<T ,ID> extends AbstractDynamoDBQueryCreator<T, ID, Long> {
 
 	private boolean pageQuery;
-	
+
 	public DynamoDBCountQueryCreator(PartTree tree,
 			DynamoDBEntityInformation<T, ID> entityMetadata,
 			DynamoDBOperations dynamoDBOperations,boolean pageQuery) {
-		super(tree, entityMetadata, dynamoDBOperations);
+		super(tree, entityMetadata, Optional.empty(), dynamoDBOperations);
 		this.pageQuery = pageQuery;
 	}
 
 	public DynamoDBCountQueryCreator(PartTree tree,
 			ParameterAccessor parameterAccessor,
 			DynamoDBEntityInformation<T, ID> entityMetadata,
 			DynamoDBOperations dynamoDBOperations,boolean pageQuery) {
-		super(tree, parameterAccessor, entityMetadata, dynamoDBOperations);
+		super(tree, parameterAccessor, entityMetadata, Optional.empty(), dynamoDBOperations);
 		this.pageQuery = pageQuery;
 
 	}

diff --git a/...gnin/spring/data/dynamodb/repository/query/DynamoDBEntityWithHashAndRangeKeyCriteria.java b/...gnin/spring/data/dynamodb/repository/query/DynamoDBEntityWithHashAndRangeKeyCriteria.java
@@ -21,6 +21,7 @@
 import com.amazonaws.services.dynamodbv2.model.ComparisonOperator;
 import com.amazonaws.services.dynamodbv2.model.Condition;
 import com.amazonaws.services.dynamodbv2.model.QueryRequest;
+import com.amazonaws.services.dynamodbv2.model.Select;
 import org.socialsignin.spring.data.dynamodb.core.DynamoDBOperations;
 import org.socialsignin.spring.data.dynamodb.query.CountByHashAndRangeKeyQuery;
 import org.socialsignin.spring.data.dynamodb.query.MultipleEntityQueryExpressionQuery;
@@ -77,7 +78,6 @@ public DynamoDBEntityWithHashAndRangeKeyCriteria(
 			indexRangeKeyPropertyNames = new HashSet<>();
 		}
 		this.entityInformation = entityInformation;
-
 	}
 
 	public Set<String> getIndexRangeKeyAttributeNames() {
@@ -184,6 +184,11 @@ public DynamoDBQueryExpression<T> buildQueryExpression() {
 			applySortIfSpecified(queryExpression, Arrays.asList(new String[] { getRangeKeyPropertyName() }));
 		}
 
+		if (projection.isPresent()) {
+			queryExpression.setSelect(Select.SPECIFIC_ATTRIBUTES);
+			queryExpression.setProjectionExpression(projection.get());
+		}
+
 		return queryExpression;
 	}
 
@@ -206,13 +211,13 @@ protected Query<T> buildFinderQuery(DynamoDBOperations dynamoDBOperations) {
 				QueryRequest queryRequest = buildQueryRequest(tableName, getGlobalSecondaryIndexName(),
 						getHashKeyAttributeName(), getRangeKeyAttributeName(), this.getRangeKeyPropertyName(),
 						getHashKeyConditions(), getRangeKeyConditions());
-				return new MultipleEntityQueryRequestQuery<T>(dynamoDBOperations,entityInformation.getJavaType(), queryRequest);
+				return new MultipleEntityQueryRequestQuery<>(dynamoDBOperations,entityInformation.getJavaType(), queryRequest);
 			} else {
 				DynamoDBQueryExpression<T> queryExpression = buildQueryExpression();
-				return new MultipleEntityQueryExpressionQuery<T>(dynamoDBOperations, entityInformation.getJavaType(), queryExpression);
+				return new MultipleEntityQueryExpressionQuery<>(dynamoDBOperations, entityInformation.getJavaType(), queryExpression);
 			}
 		} else {
-			return new MultipleEntityScanExpressionQuery<T>(dynamoDBOperations, clazz, buildScanExpression());
+			return new MultipleEntityScanExpressionQuery<>(dynamoDBOperations, clazz, buildScanExpression());
 		}
 	}
 
@@ -228,7 +233,7 @@ protected Query<Long> buildFinderCountQuery(DynamoDBOperations dynamoDBOperation
 
 			} else {
 				DynamoDBQueryExpression<T> queryExpression = buildQueryExpression();
-				return new QueryExpressionCountQuery<T>(dynamoDBOperations, entityInformation.getJavaType(), queryExpression);
+				return new QueryExpressionCountQuery<>(dynamoDBOperations, entityInformation.getJavaType(), queryExpression);
 
 			}
 		} else {

diff --git a/...alsignin/spring/data/dynamodb/repository/query/DynamoDBEntityWithHashKeyOnlyCriteria.java b/...alsignin/spring/data/dynamodb/repository/query/DynamoDBEntityWithHashKeyOnlyCriteria.java
@@ -20,6 +20,7 @@
 import com.amazonaws.services.dynamodbv2.model.ComparisonOperator;
 import com.amazonaws.services.dynamodbv2.model.Condition;
 import com.amazonaws.services.dynamodbv2.model.QueryRequest;
+import com.amazonaws.services.dynamodbv2.model.Select;
 import org.socialsignin.spring.data.dynamodb.core.DynamoDBOperations;
 import org.socialsignin.spring.data.dynamodb.query.CountByHashKeyQuery;
 import org.socialsignin.spring.data.dynamodb.query.MultipleEntityQueryRequestQuery;
@@ -47,11 +48,11 @@ public DynamoDBEntityWithHashKeyOnlyCriteria(DynamoDBEntityInformation<T, ID> en
 	}
 
 	protected Query<T> buildSingleEntityLoadQuery(DynamoDBOperations dynamoDBOperations) {
-		return new SingleEntityLoadByHashKeyQuery<T>(dynamoDBOperations, clazz, getHashKeyPropertyValue());
+		return new SingleEntityLoadByHashKeyQuery<>(dynamoDBOperations, clazz, getHashKeyPropertyValue());
 	}
 
 	protected Query<Long> buildSingleEntityCountQuery(DynamoDBOperations dynamoDBOperations) {
-		return new CountByHashKeyQuery<T>(dynamoDBOperations, clazz, getHashKeyPropertyValue());
+		return new CountByHashKeyQuery<>(dynamoDBOperations, clazz, getHashKeyPropertyValue());
 	}
 
 	protected Query<T> buildFinderQuery(DynamoDBOperations dynamoDBOperations) {
@@ -72,6 +73,7 @@ protected Query<Long> buildFinderCountQuery(DynamoDBOperations dynamoDBOperation
 			List<Condition> hashKeyConditions = getHashKeyConditions();
 			QueryRequest queryRequest = buildQueryRequest(dynamoDBOperations.getOverriddenTableName(clazz, entityInformation.getDynamoDBTableName()),
 					getGlobalSecondaryIndexName(), getHashKeyAttributeName(), null, null, hashKeyConditions, null);
+			queryRequest.setSelect(Select.COUNT);
 			return new QueryRequestCountQuery(dynamoDBOperations, queryRequest);
 
 		} else {
@@ -106,6 +108,11 @@ public DynamoDBScanExpression buildScanExpression() {
 				scanExpression.addFilterCondition(conditionEntry.getKey(), condition);
 			}
 		}
+
+		if (projection.isPresent()) {
+			scanExpression.setSelect(Select.SPECIFIC_ATTRIBUTES);
+			scanExpression.setProjectionExpression(projection.get());
+		}
 		return scanExpression;
 	}
 

diff --git a/...ain/java/org/socialsignin/spring/data/dynamodb/repository/query/DynamoDBQueryCreator.java b/...ain/java/org/socialsignin/spring/data/dynamodb/repository/query/DynamoDBQueryCreator.java
@@ -22,29 +22,24 @@
 import org.springframework.data.repository.query.ParameterAccessor;
 import org.springframework.data.repository.query.parser.PartTree;
 
+import java.util.Optional;
+
 public class DynamoDBQueryCreator<T,ID> extends AbstractDynamoDBQueryCreator<T, ID,T> {
-/*
-	public DynamoDBQueryCreator(PartTree tree,
-			DynamoDBEntityInformation<T, ID> entityMetadata,
-			DynamoDBOperations dynamoDBOperations) {
-		super(tree, entityMetadata, dynamoDBOperations);
-	}
-*/
+
 	public DynamoDBQueryCreator(PartTree tree,
 			ParameterAccessor parameterAccessor,
 			DynamoDBEntityInformation<T, ID> entityMetadata,
+			Optional<String> projection,
 			DynamoDBOperations dynamoDBOperations) {
-		super(tree, parameterAccessor, entityMetadata, dynamoDBOperations);
+		super(tree, parameterAccessor, entityMetadata, projection, dynamoDBOperations);
 	}
 
 	@Override
 	protected Query<T> complete(DynamoDBQueryCriteria<T, ID> criteria, Sort sort) {
-		if (sort != null) {
-			criteria.withSort(sort);
-		}
+		criteria.withSort(sort);
+		criteria.withProjection(projection);
 
 		return criteria.buildQuery(dynamoDBOperations);
-
 	}
 
 }
diff --git a/...in/java/org/socialsignin/spring/data/dynamodb/repository/query/DynamoDBQueryCriteria.java b/...in/java/org/socialsignin/spring/data/dynamodb/repository/query/DynamoDBQueryCriteria.java
@@ -20,6 +20,8 @@
 import org.socialsignin.spring.data.dynamodb.query.Query;
 import org.springframework.data.domain.Sort;
 
+import java.util.Optional;
+
 /**
  * @author Michael Lavelle
  * @author Sebastian Just
@@ -39,6 +41,8 @@ DynamoDBQueryCriteria<T, ID> withSingleValueCriteria(String propertyName, Compar
 
 	DynamoDBQueryCriteria<T, ID> withSort(Sort sort);
 
+	DynamoDBQueryCriteria<T, ID> withProjection(Optional<String> projection);
+
 	Query<T> buildQuery(DynamoDBOperations dynamoDBOperations);
 
 	Query<Long> buildCountQuery(DynamoDBOperations dynamoDBOperations, boolean pageQuery);