Implement DynamoDbFlatten annotation #3833
Conversation
add new attribute and update write item flow fix flattened properties issue
| @@ -181,6 +181,35 @@ public DynamoDBPolymorphicTypeAttribute(string typeDiscriminator, | |||
| } | |||
| } | |||
|
|
|||
| /// <summary> | |||
| /// Indicates that the properties of the decorated field or property type should be "flattened" | |||
| /// into the top-level attributes of the DynamoDB item. When applied, all public properties | |||
There was a problem hiding this comment.
Are they always flattened to "top-level attributes" or in the case of multi-nested structure the attributes are flattened to the parent structure.
There was a problem hiding this comment.
The attributes are flattened to the parent structure
| @@ -390,29 +390,53 @@ private void PopulateInstance(ItemStorage storage, object instance, DynamoDBFlat | |||
|
|
|||
| using (flatConfig.State.Track(document)) | |||
| { | |||
| foreach (PropertyStorage propertyStorage in storageConfig.AllPropertyStorage) | |||
| foreach (PropertyStorage propertyStorage in storageConfig.Properties) | |||
There was a problem hiding this comment.
Why the switch from AllPropertyStorage to Properties?
| /// </para> | ||
| /// </summary> | ||
| [AttributeUsage(AttributeTargets.Field | AttributeTargets.Property, Inherited = true, AllowMultiple = false)] | ||
| public sealed class DynamoDBFlattenAttribute : DynamoDBAttribute |
There was a problem hiding this comment.
What happens if a POCO has this attribute and the POCO is used in a collection property?
There was a problem hiding this comment.
It should only applies to single nested objects – not to collections, and this behavior is consistent with Java SDK. The only collection that will support flatten are Map<String, String>, but this is a new annotation @DynamoDbFlatten that is proposed to be added in the Java SDK.
|
Is there an ask for this feature or is this parity feature with the Java SDK? |
this is for feature parity with Java SDK |
Implement DynamoDbFlatten annotation
Description
Introduce the [DynamoDbFlatten] attribute, enabling developers to flatten complex nested types into their parent objects in DynamoDB, mirroring the behavior of Java SDK’s @DynamoDbFlattenDynamoDB Object Mapping. This allows for simpler, flat table schemas while maintaining clean object models in code.
Java DynamoDbFlatten
Motivation and Context
Testing
Integration test added
Unit test to be added for internal methods
Screenshots (if appropriate)
Types of changes
Checklist
License