Skip to content
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

Valid comparisons for KeyConditionExpression explanation incomplete or incorrect #6803

Open
koabra opened this issue Jan 15, 2025 · 1 comment
Assignees
Labels
documentation This is a problem with documentation. p2 This is a standard priority issue queued This issues is on the AWS team's backlog

Comments

@koabra
Copy link

koabra commented Jan 15, 2025

Describe the issue

In the KeyConditionExpression parameter description, the Valid comparisons for the sort key condition are as incorrecly given, or illegible for different operators like less than, less than or equal to, greater than, greater than or equal to.

Everything is shown as such:

Valid comparisons for the sort key condition are as follows:

sortKeyName = :sortkeyval - true if the sort key value is equal to :sortkeyval.
sortKeyName :sortkeyval - true if the sort key value is less than :sortkeyval.
sortKeyName = :sortkeyval - true if the sort key value is less than or equal to :sortkeyval.
sortKeyName :sortkeyval - true if the sort key value is greater than :sortkeyval.
sortKeyName = :sortkeyval - true if the sort key value is greater than or equal to :sortkeyval.

Links

https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/dynamodb/command/QueryCommand/

@koabra koabra added documentation This is a problem with documentation. needs-triage This issue or PR still needs to be triaged. labels Jan 15, 2025
@aBurmeseDev aBurmeseDev self-assigned this Jan 15, 2025
@aBurmeseDev
Copy link
Member

Hi @koabra - thanks for reporting this issue. I've noted that there are formatting issues there and will work on fixing them. Meanwhile, please refer to correct format content in the service documentation.

Valid comparisons for the sort key condition are as follows:

  • sortKeyName = :sortkeyval - true if the sort key value is equal to :sortkeyval.
  • sortKeyName < :sortkeyval - true if the sort key value is less than :sortkeyval.
  • sortKeyName <= :sortkeyval - true if the sort key value is less than or equal to :sortkeyval.
  • sortKeyName > :sortkeyval - true if the sort key value is greater than :sortkeyval.
  • sortKeyName >= :sortkeyval - true if the sort key value is greater than or equal to :sortkeyval.
  • sortKeyName BETWEEN :sortkeyval1 AND :sortkeyval2 - true if the sort key value is greater than or equal to :sortkeyval1, and less than or equal to :sortkeyval2.
  • begins_with ( sortKeyName, :sortkeyval ) - true if the sort key value begins with a particular operand. (You cannot use this function with a sort key that is of type Number.) Note that the function name begins_with is case-sensitive.

@aBurmeseDev aBurmeseDev added p2 This is a standard priority issue queued This issues is on the AWS team's backlog and removed needs-triage This issue or PR still needs to be triaged. labels Jan 16, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation This is a problem with documentation. p2 This is a standard priority issue queued This issues is on the AWS team's backlog
Projects
None yet
Development

No branches or pull requests

2 participants