This repository has been archived by the owner on Jun 19, 2023. It is now read-only.
annotations: Add example of usage with Glboal Secondary Indexes #213
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Issue #, if available:
Right now there is very limited information on how to annotate properly the GSI related columns. In one of our projects previous devs did use the @hashkey annotation for columns that were part just of a GSI partition key, which is wrong and was causing problems that we spent quite some time to understand why it was happening.
Description of changes:
This is adding one code example with two types of GSI indexes (hash and ranged) to the annotations README file. While it's not a full documentation, I feel it will be useful to have these basic examples that can guide the developers and save a lot of time in investigation.
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.