Skip to content

Commit

Permalink
Respect the pagination size for queries
Browse files Browse the repository at this point in the history
This change respects the pagination size as provided from a Pageable
object given to a findXXX method.
Mostly important in conjunction with lazy list processing via
```java
DynamoDBMapperConfig.Builder builder = new DynamoDBMapperConfig.Builder();
builder.setPaginationLoadingStrategy(PaginationLoadingStrategy.ITERATION_ONLY);
```
as this loads the result set of a query page-by-page.
Also see the comments in
`com.amazonaws.services.dynamodbv2.datamodeling.PaginatedQueryList<T>` as
used by
`org.socialsignin.spring.data.dynamodb.core.DynamoDBTemplate.query(Class<T>,
QueryRequest)`
  • Loading branch information
derjust committed Jan 17, 2018
1 parent 500b5fa commit a14956b
Show file tree
Hide file tree
Showing 3 changed files with 27 additions and 2 deletions.
Expand Up @@ -29,6 +29,7 @@
import org.socialsignin.spring.data.dynamodb.marshaller.Instant2IsoDynamoDBMarshaller;
import org.socialsignin.spring.data.dynamodb.query.Query;
import org.socialsignin.spring.data.dynamodb.repository.support.DynamoDBEntityInformation;
import org.springframework.data.domain.Pageable;
import org.springframework.data.domain.Sort;
import org.springframework.data.domain.Sort.Direction;
import org.springframework.data.domain.Sort.Order;
Expand Down Expand Up @@ -66,6 +67,7 @@ public abstract class AbstractDynamoDBQueryCriteria<T, ID> implements DynamoDBQu
protected Object hashKeyPropertyValue;
protected String globalSecondaryIndexName;
protected Sort sort;
protected Pageable pageable;

public abstract boolean isApplicableForLoad();

Expand Down Expand Up @@ -132,9 +134,16 @@ protected QueryRequest buildQueryRequest(String tableName, String theIndexName,
queryRequest.setSelect(Select.ALL_PROJECTED_ATTRIBUTES);
applySortIfSpecified(queryRequest, new ArrayList<String>(new HashSet<String>(allowedSortProperties)));
}
applyPageableIfSpecified(queryRequest);
return queryRequest;
}

private void applyPageableIfSpecified(QueryRequest queryRequest) {
if (pageable != Pageable.unpaged()) {
queryRequest.setLimit(pageable.getPageSize());
}
}

protected void applySortIfSpecified(DynamoDBQueryExpression<T> queryExpression, List<String> permittedPropertyNames) {
if (permittedPropertyNames.size() > 1) {
throw new UnsupportedOperationException("Can only sort by at most a single range or index range key");
Expand Down Expand Up @@ -688,4 +697,10 @@ public DynamoDBQueryCriteria<T, ID> withSort(Sort sort) {
return this;
}

@Override
public DynamoDBQueryCriteria<T, ID> withPageable(Pageable pageable) {
this.pageable = pageable;
return this;
}

}
Expand Up @@ -18,31 +18,38 @@
import org.socialsignin.spring.data.dynamodb.core.DynamoDBOperations;
import org.socialsignin.spring.data.dynamodb.query.Query;
import org.socialsignin.spring.data.dynamodb.repository.support.DynamoDBEntityInformation;
import org.springframework.data.domain.Pageable;
import org.springframework.data.domain.Sort;
import org.springframework.data.repository.query.ParameterAccessor;
import org.springframework.data.repository.query.parser.PartTree;

public class DynamoDBQueryCreator<T,ID> extends AbstractDynamoDBQueryCreator<T, ID,T> {

private final Pageable pageable;

public DynamoDBQueryCreator(PartTree tree,
DynamoDBEntityInformation<T, ID> entityMetadata,
DynamoDBOperations dynamoDBOperations) {
super(tree, entityMetadata, dynamoDBOperations);
pageable = Pageable.unpaged();
}

public DynamoDBQueryCreator(PartTree tree,
ParameterAccessor parameterAccessor,
DynamoDBEntityInformation<T, ID> entityMetadata,
DynamoDBOperations dynamoDBOperations) {
super(tree, parameterAccessor, entityMetadata, dynamoDBOperations);
pageable = parameterAccessor.getPageable();
}

@Override
protected Query<T> complete(DynamoDBQueryCriteria<T, ID> criteria, Sort sort) {
if (sort != null) {
criteria.withSort(sort);
}

criteria.withPageable(pageable);

return criteria.buildQuery(dynamoDBOperations);

}
Expand Down
Expand Up @@ -18,6 +18,7 @@
import com.amazonaws.services.dynamodbv2.model.ComparisonOperator;
import org.socialsignin.spring.data.dynamodb.core.DynamoDBOperations;
import org.socialsignin.spring.data.dynamodb.query.Query;
import org.springframework.data.domain.Pageable;
import org.springframework.data.domain.Sort;

/**
Expand All @@ -37,7 +38,9 @@ DynamoDBQueryCriteria<T, ID> withSingleValueCriteria(String propertyName, Compar
DynamoDBQueryCriteria<T, ID> withPropertyBetween(String segment, Object value1, Object value2, Class<?> type);

DynamoDBQueryCriteria<T, ID> withSort(Sort sort);


DynamoDBQueryCriteria<T, ID> withPageable(Pageable pageable);

Query<T> buildQuery(DynamoDBOperations dynamoDBOperations);

Query<Long> buildCountQuery(DynamoDBOperations dynamoDBOperations, boolean pageQuery);
Expand Down

0 comments on commit a14956b

Please sign in to comment.