aws / aws/aws-sdk-java-v2

DynamoDB enhanced client DynamoDbIndex.query to return PageIterable

Ouverte
#2,855 2 commentaires 3 réactions 0 personnes assignées Voir sur GitHub
dynamodb-enhanced feature-request p3
Langage dominant
Java
Étoiles
2.6k
Forks
1k
Merge moyen
2 j 9 h
PR mergées (30 j)
51

Description

### Describe the feature

When using enhanced DynamoDB there is an interface for PageIterable that adds useful functionality on top of SDKIterable.java, namely an iterator across all pages from the result set. The [query method](https://github.com/aws/aws-sdk-java-v2/blob/8f54393ff4e166eb3f56bc1b411b27f6bf0213b5/services-custom/dynamodb-enhanced/src/main/java/software/amazon/awssdk/enhanced/dynamodb/internal/client/DefaultDynamoDbIndex.java#L57) of DynamoDBTable.java returns said useful type, however similar class DynamoDBIndex.java returns the more basic SDKIterable.java in the [query method](https://github.com/aws/aws-sdk-java-v2/blob/8f54393ff4e166eb3f56bc1b411b27f6bf0213b5/services-custom/dynamodb-enhanced/src/main/java/software/amazon/awssdk/enhanced/dynamodb/internal/client/DefaultDynamoDbTable.java#L177).

This was already raised in https://github.com/aws/aws-sdk-java-v2/issues/2185, but I believe the documentation fix is not the ideal long term solution. The solution would be to provide similar support for query() both in DynamoDBTable and DynamoDBIndex.

When using dynamo console in the browser, the query works the same for the default table index and the created GSIs, the code should behave consistently.

### Is your Feature Request related to a problem?

This requires all consumers of SDK to do extra coding for replicating code that the SDK already distributes. This increases code duplication as is error prone, both issues that PageIterable interface solves in the first place.

### Proposed Solution

Proposal for non-breaking change,
- Keep the existing DynamoDBIndex ```SdkIterable> query(QueryEnhancedRequest request);```
- Add a new method in DynamoDBIndex ```PageIterable query(QueryEnhancedRequest request);```

### Describe alternatives you've considered

_No response_

### Acknowledge

- [ ] I may be able to implement this feature request

### AWS Java SDK version used

2.17.76

### JDK version used

openjdk 11.0.12

### Operating System and version

MacOS 12.0.1

Guide de contribution

Ouvrir le guide de contribution

Piste de recherche

Commencez par les déclarations de requêtes de DynamoDBIndex et DynamoDBTable, puis comparez DefaultDynamoDbIndex.java à DefaultDynamoDbTable.java, en particulier les implémentations de requêtes associées. Suivez la façon dont PageIterable est renvoyé pour les requêtes de table et déterminez le comportement correspondant de l’index ; le travail est terminé lorsque les requêtes d’index fournissent la même prise en charge de l’itération des pages tout en préservant les exigences de compatibilité proposées.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
aws, java
Domaine
database
Type d'issue
Fonctionnalité
Difficulté
3/5
Temps estimé
1-2 jours
Activité
À l'abandon
Clarté
Clairement spécifiée
Accessibilité débutants
35/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.