Skip to content

Fixed DynamoDbEnhancedClient DefaultDynamoDbAsyncTable::createTable()… #5847

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{
"type": "bugfix",
"category": "Amazon DynamoDB Enhanced Client",
"contributor": "",
"description": "Fixed DynamoDbEnhancedClient DefaultDynamoDbAsyncTable::createTable() to create secondary indices that are defined on annotations of the POJO class, similar to DefaultDynamoDbTable::createTable()."
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
/*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License").
* You may not use this file except in compliance with the License.
* A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file 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 software.amazon.awssdk.enhanced.dynamodb.internal;

import java.util.Collections;
import java.util.List;
import java.util.stream.Collectors;
import software.amazon.awssdk.annotations.SdkInternalApi;
import software.amazon.awssdk.enhanced.dynamodb.IndexMetadata;
import software.amazon.awssdk.enhanced.dynamodb.TableMetadata;
import software.amazon.awssdk.enhanced.dynamodb.model.EnhancedGlobalSecondaryIndex;
import software.amazon.awssdk.enhanced.dynamodb.model.EnhancedLocalSecondaryIndex;
import software.amazon.awssdk.services.dynamodb.model.ProjectionType;

@SdkInternalApi
public class TableIndices {
private final List<IndexMetadata> indices;

public TableIndices(List<IndexMetadata> indices) {
this.indices = indices;
}

public List<EnhancedLocalSecondaryIndex> localSecondaryIndices() {
return Collections.unmodifiableList(indices.stream()
.filter(index -> !TableMetadata.primaryIndexName().equals(index.name()))
.filter(index -> !index.partitionKey().isPresent())
.map(TableIndices::mapIndexMetadataToEnhancedLocalSecondaryIndex)
.collect(Collectors.toList()));
}

public List<EnhancedGlobalSecondaryIndex> globalSecondaryIndices() {
return Collections.unmodifiableList(indices.stream()
.filter(index -> !TableMetadata.primaryIndexName().equals(index.name()))
.filter(index -> index.partitionKey().isPresent())
.map(TableIndices::mapIndexMetadataToEnhancedGlobalSecondaryIndex)
.collect(Collectors.toList()));
}

private static EnhancedLocalSecondaryIndex mapIndexMetadataToEnhancedLocalSecondaryIndex(IndexMetadata indexMetadata) {
return EnhancedLocalSecondaryIndex.builder()
.indexName(indexMetadata.name())
.projection(pb -> pb.projectionType(ProjectionType.ALL))
.build();
}

private static EnhancedGlobalSecondaryIndex mapIndexMetadataToEnhancedGlobalSecondaryIndex(IndexMetadata indexMetadata) {
return EnhancedGlobalSecondaryIndex.builder()
.indexName(indexMetadata.name())
.projection(pb -> pb.projectionType(ProjectionType.ALL))
.build();
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@

import static software.amazon.awssdk.enhanced.dynamodb.internal.EnhancedClientUtils.createKeyFromItem;

import java.util.ArrayList;
import java.util.concurrent.CompletableFuture;
import java.util.function.Consumer;
import software.amazon.awssdk.annotations.SdkInternalApi;
Expand All @@ -25,6 +26,7 @@
import software.amazon.awssdk.enhanced.dynamodb.Key;
import software.amazon.awssdk.enhanced.dynamodb.TableMetadata;
import software.amazon.awssdk.enhanced.dynamodb.TableSchema;
import software.amazon.awssdk.enhanced.dynamodb.internal.TableIndices;
import software.amazon.awssdk.enhanced.dynamodb.internal.operations.CreateTableOperation;
import software.amazon.awssdk.enhanced.dynamodb.internal.operations.DeleteItemOperation;
import software.amazon.awssdk.enhanced.dynamodb.internal.operations.DeleteTableOperation;
Expand Down Expand Up @@ -114,7 +116,12 @@ public CompletableFuture<Void> createTable(Consumer<CreateTableEnhancedRequest.B

@Override
public CompletableFuture<Void> createTable() {
return createTable(CreateTableEnhancedRequest.builder().build());
TableIndices indices = new TableIndices(new ArrayList<>(tableSchema.tableMetadata().indices()));

return createTable(CreateTableEnhancedRequest.builder()
.localSecondaryIndices(indices.localSecondaryIndices())
.globalSecondaryIndices(indices.globalSecondaryIndices())
.build());
}

@Override
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,22 +15,17 @@

package software.amazon.awssdk.enhanced.dynamodb.internal.client;

import static java.util.Collections.emptyList;
import static software.amazon.awssdk.enhanced.dynamodb.internal.EnhancedClientUtils.createKeyFromItem;

import java.util.Collection;
import java.util.List;
import java.util.Map;
import java.util.ArrayList;
import java.util.function.Consumer;
import java.util.stream.Collectors;
import software.amazon.awssdk.annotations.SdkInternalApi;
import software.amazon.awssdk.enhanced.dynamodb.DynamoDbEnhancedClientExtension;
import software.amazon.awssdk.enhanced.dynamodb.DynamoDbTable;
import software.amazon.awssdk.enhanced.dynamodb.IndexMetadata;
import software.amazon.awssdk.enhanced.dynamodb.Key;
import software.amazon.awssdk.enhanced.dynamodb.KeyAttributeMetadata;
import software.amazon.awssdk.enhanced.dynamodb.TableMetadata;
import software.amazon.awssdk.enhanced.dynamodb.TableSchema;
import software.amazon.awssdk.enhanced.dynamodb.internal.TableIndices;
import software.amazon.awssdk.enhanced.dynamodb.internal.operations.CreateTableOperation;
import software.amazon.awssdk.enhanced.dynamodb.internal.operations.DeleteItemOperation;
import software.amazon.awssdk.enhanced.dynamodb.internal.operations.DeleteTableOperation;
Expand All @@ -46,8 +41,6 @@
import software.amazon.awssdk.enhanced.dynamodb.model.DeleteItemEnhancedRequest;
import software.amazon.awssdk.enhanced.dynamodb.model.DeleteItemEnhancedResponse;
import software.amazon.awssdk.enhanced.dynamodb.model.DescribeTableEnhancedResponse;
import software.amazon.awssdk.enhanced.dynamodb.model.EnhancedGlobalSecondaryIndex;
import software.amazon.awssdk.enhanced.dynamodb.model.EnhancedLocalSecondaryIndex;
import software.amazon.awssdk.enhanced.dynamodb.model.GetItemEnhancedRequest;
import software.amazon.awssdk.enhanced.dynamodb.model.GetItemEnhancedResponse;
import software.amazon.awssdk.enhanced.dynamodb.model.PageIterable;
Expand All @@ -61,7 +54,6 @@
import software.amazon.awssdk.services.dynamodb.DynamoDbClient;
import software.amazon.awssdk.services.dynamodb.model.DescribeTableRequest;
import software.amazon.awssdk.services.dynamodb.model.DescribeTableResponse;
import software.amazon.awssdk.services.dynamodb.model.ProjectionType;

@SdkInternalApi
public class DefaultDynamoDbTable<T> implements DynamoDbTable<T> {
Expand Down Expand Up @@ -126,52 +118,14 @@ public void createTable(Consumer<CreateTableEnhancedRequest.Builder> requestCons

@Override
public void createTable() {
Map<IndexType, List<IndexMetadata>> indexGroups = splitSecondaryIndicesToLocalAndGlobalOnes();
TableIndices indices = new TableIndices(new ArrayList<>(tableSchema.tableMetadata().indices()));

createTable(CreateTableEnhancedRequest.builder()
.localSecondaryIndices(extractLocalSecondaryIndices(indexGroups))
.globalSecondaryIndices(extractGlobalSecondaryIndices(indexGroups))
.localSecondaryIndices(indices.localSecondaryIndices())
.globalSecondaryIndices(indices.globalSecondaryIndices())
.build());
}

private Map<IndexType, List<IndexMetadata>> splitSecondaryIndicesToLocalAndGlobalOnes() {
Collection<IndexMetadata> indices = tableSchema.tableMetadata().indices();
return indices.stream()
.filter(index -> !TableMetadata.primaryIndexName().equals(index.name()))
.collect(Collectors.groupingBy(metadata -> {
String partitionKeyName = metadata.partitionKey().map(KeyAttributeMetadata::name).orElse(null);
if (partitionKeyName == null) {
return IndexType.LSI;
}
return IndexType.GSI;
}));
}

private List<EnhancedLocalSecondaryIndex> extractLocalSecondaryIndices(Map<IndexType, List<IndexMetadata>> indicesGroups) {
return indicesGroups.getOrDefault(IndexType.LSI, emptyList()).stream()
.map(this::mapIndexMetadataToEnhancedLocalSecondaryIndex)
.collect(Collectors.toList());
}

private EnhancedLocalSecondaryIndex mapIndexMetadataToEnhancedLocalSecondaryIndex(IndexMetadata indexMetadata) {
return EnhancedLocalSecondaryIndex.builder()
.indexName(indexMetadata.name())
.projection(pb -> pb.projectionType(ProjectionType.ALL))
.build();
}

private List<EnhancedGlobalSecondaryIndex> extractGlobalSecondaryIndices(Map<IndexType, List<IndexMetadata>> indicesGroups) {
return indicesGroups.getOrDefault(IndexType.GSI, emptyList()).stream()
.map(this::mapIndexMetadataToEnhancedGlobalSecondaryIndex)
.collect(Collectors.toList());
}

private EnhancedGlobalSecondaryIndex mapIndexMetadataToEnhancedGlobalSecondaryIndex(IndexMetadata indexMetadata) {
return EnhancedGlobalSecondaryIndex.builder()
.indexName(indexMetadata.name())
.projection(pb -> pb.projectionType(ProjectionType.ALL))
.build();
}

@Override
public T deleteItem(DeleteItemEnhancedRequest request) {
TableOperation<T, ?, ?, DeleteItemEnhancedResponse<T>> operation = DeleteItemOperation.create(request);
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,105 @@
package software.amazon.awssdk.enhanced.dynamodb;

import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertTrue;

import java.util.Arrays;
import java.util.Collections;
import java.util.List;
import org.junit.jupiter.api.Test;
import software.amazon.awssdk.enhanced.dynamodb.internal.TableIndices;
import software.amazon.awssdk.enhanced.dynamodb.internal.mapper.StaticIndexMetadata;
import software.amazon.awssdk.enhanced.dynamodb.internal.mapper.StaticKeyAttributeMetadata;
import software.amazon.awssdk.enhanced.dynamodb.model.EnhancedGlobalSecondaryIndex;
import software.amazon.awssdk.enhanced.dynamodb.model.EnhancedLocalSecondaryIndex;

public class TableIndicesTest {

@Test
public void testLocalSecondaryIndices_onlyIncludesLSIs() {
List<IndexMetadata> indices = Arrays.asList(StaticIndexMetadata.builder()
.name("lsi-1")
.build(),
StaticIndexMetadata.builder()
.name("lsi-2")
.build(),
StaticIndexMetadata.builder()
.name("gsi-1")
.partitionKey(StaticKeyAttributeMetadata.create(
"GlobalIndexPartitionKey",
AttributeValueType.N))
.build());

TableIndices tableIndices = new TableIndices(indices);

List<EnhancedLocalSecondaryIndex> lsiList = tableIndices.localSecondaryIndices();

assertEquals(2, lsiList.size());
assertTrue(lsiList.stream().anyMatch(i -> "lsi-1".equals(i.indexName())));
assertTrue(lsiList.stream().anyMatch(i -> "lsi-2".equals(i.indexName())));
}

@Test
public void testGlobalSecondaryIndices_onlyIncludesGSIs() {
List<IndexMetadata> indices = Arrays.asList(StaticIndexMetadata.builder()
.name("lsi-1")
.build(),
StaticIndexMetadata.builder()
.name("gsi-1")
.partitionKey(StaticKeyAttributeMetadata.create(
"GlobalIndexPartitionKey1",
AttributeValueType.N))
.build(),
StaticIndexMetadata.builder()
.name("gsi-2")
.partitionKey(StaticKeyAttributeMetadata.create(
"GlobalIndexPartitionKey2",
AttributeValueType.N))
.build());

TableIndices tableIndices = new TableIndices(indices);

List<EnhancedGlobalSecondaryIndex> gsiList = tableIndices.globalSecondaryIndices();

assertEquals(2, gsiList.size());
assertTrue(gsiList.stream().anyMatch(i -> "gsi-1".equals(i.indexName())));
assertTrue(gsiList.stream().anyMatch(i -> "gsi-2".equals(i.indexName())));
}

@Test
public void testPrimaryIndexIsExcluded() {
List<IndexMetadata> indices = Arrays.asList(StaticIndexMetadata.builder()
.name(TableMetadata.primaryIndexName())
.partitionKey(StaticKeyAttributeMetadata.create("pk",
AttributeValueType.S))
.build(),
StaticIndexMetadata.builder()
.name("lsi-1")
.build(),
StaticIndexMetadata.builder()
.name("gsi-1")
.partitionKey(StaticKeyAttributeMetadata.create(
"GlobalIndexPartitionKey",
AttributeValueType.N))
.build());

TableIndices tableIndices = new TableIndices(indices);

List<EnhancedGlobalSecondaryIndex> gsiList = tableIndices.globalSecondaryIndices();
List<EnhancedLocalSecondaryIndex> lsiList = tableIndices.localSecondaryIndices();

assertEquals(1, gsiList.size());
assertEquals("gsi-1", gsiList.get(0).indexName());

assertEquals(1, lsiList.size());
assertEquals("lsi-1", lsiList.get(0).indexName());
}

@Test
public void testEmptyIndexList() {
TableIndices tableIndices = new TableIndices(Collections.emptyList());

assertTrue(tableIndices.globalSecondaryIndices().isEmpty());
assertTrue(tableIndices.localSecondaryIndices().isEmpty());
}
}
Loading