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

Projection expression with list item throws error using DynamoDB Enhanced client #5603

Open
1 task
tkhill-AWS opened this issue Sep 17, 2024 · 1 comment
Open
1 task
Assignees
Labels
bug This issue is a bug. dynamodb-enhanced p2 This is a standard priority issue

Comments

@tkhill-AWS
Copy link
Contributor

tkhill-AWS commented Sep 17, 2024

Describe the bug

DynamoDB Enhanced Client: An object contains an attribute that is a list. That list has 2 items in it. When I attempt to project an attribute of one of the list items, I get this error:

ExpressionAttributeNames contains invalid key: Syntax error; key: "#AMZN_MAPPED_phoneNumbers[1]" (Service: DynamoDb, Status Code: 400, Request ID: A93OVV2TS1G41T9U8G8U84QKAJVV4KQNSO5AEMVJF66Q9ASUAAJG)

phoneNumbers is the name of the object's property that is a list.

Regression Issue

  • Select this option if this issue appears to be a regression.

Expected Behavior

Return the same results that the following CLI command does:

 aws dynamodb scan --table-name PersonTable \
 --filter-expression "phoneNumbers[1].#type = :type" \
 --expression-attribute-values '{":type":{"S":"cell"}}' \
 --expression-attribute-names '{"#type": "type"}' \
 --projection-expression "firstName, lastName, id, phoneNumbers[1].#type"

but using this Java code:

        Expression phoneFilter = Expression.builder()
                .expression("phoneNumbers[1].#type = :type")
                .putExpressionName("#type", "type")
                .putExpressionValue(":type", AttributeValue.builder().s("cell").build())
                .build();

        PageIterable<Person> phoneFilterResults = personDynamoDbTable.scan(rb -> rb
                .filterExpression(phoneFilter)
                .attributesToProject("id", "firstName", "lastName")
                .addNestedAttributesToProject(NestedAttributeName.create("phoneNumbers[1]", "#type")));

which is:

{
    "Items": [
        {
            "phoneNumbers": {
                "L": [
                    {
                        "M": {
                            "type": {
                                "S": "cell"
                            }
                        }
                    }
                ]
            },
            "id": {
                "N": "2"
            },
            "firstName": {
                "S": "FirstName2"
            },
            "lastName": {
                "S": "LastName2"
            }
        }
    ],
    "Count": 1,
    "ScannedCount": 2,
    "ConsumedCapacity": null
}

Current Behavior

This is the error:

ExpressionAttributeNames contains invalid key: Syntax error; key: "#AMZN_MAPPED_phoneNumbers[1]"

produced by:

        Expression phoneFilter = Expression.builder()
                .expression("phoneNumbers[1].#type = :type")
                .putExpressionName("#type", "type")
                .putExpressionValue(":type", AttributeValue.builder().s("cell").build())
                .build();

        PageIterable<Person> phoneFilterResults = personDynamoDbTable.scan(rb -> rb
                .filterExpression(phoneFilter)
                .attributesToProject("id", "firstName", "lastName")
                .addNestedAttributesToProject(NestedAttributeName.create("phoneNumbers[1]", "#type")));

Reproduction Steps

I can give you access to a repo to reproduce the example.

Possible Solution

. I don't have any suggestions.

Additional Information/Context

I am working on the section of the DynamoDB Enhanced Client documentation of the Java Dev. Guide. This section discusses how to filter and project based on attributes that are beans, maps or lists.

The SDK Javadoc also indicates that this should work:

 Examples of creating NestedAttributeNames:

    Simple attribute Level0 can be created as NestedAttributeName.create("Level0")
    Nested attribute Level0.Level1 can be created as NestedAttributeName.create("Level0", "Level1")
    Nested attribute Level0.Level-2 can be created as NestedAttributeName.create("Level0", "Level-2")
    List item 0 of ListAttribute can be created as NestedAttributeName.create("ListAttribute[0]")

AWS Java SDK version used

2.26.6

JDK version used

17

Operating System and version

Mac - Sonoma 14.5

@tkhill-AWS tkhill-AWS added bug This issue is a bug. needs-triage This issue or PR still needs to be triaged. labels Sep 17, 2024
@debora-ito debora-ito self-assigned this Oct 14, 2024
@debora-ito
Copy link
Member

@tkhill-AWS acknowledged. I believe is the same issue we have with other special characters (#3058), we need to add "[" and "]" to the list.

@debora-ito debora-ito added p2 This is a standard priority issue and removed needs-triage This issue or PR still needs to be triaged. labels Oct 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug This issue is a bug. dynamodb-enhanced p2 This is a standard priority issue
Projects
None yet
Development

No branches or pull requests

2 participants