Skip to content

Commit ca2ad84

Browse files
committed
Add information about key marshalling
1 parent f096a48 commit ca2ad84

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

README.md

+11
Original file line numberDiff line numberDiff line change
@@ -221,6 +221,17 @@ internal static class Program
221221

222222
### Key conversion
223223

224+
The key marshallers contain three methods based on your intent.
225+
The source generator will internally validate your object arguments. So if you pass a `int` but the actual key is represented as a `string`, then you will get an `exception`.
226+
227+
* `Keys(object partitionKey, object rangeKey)`
228+
* Used when you want convert both a partion key and a range key.
229+
* `PartionKey(object key)`
230+
* Used when you only want to only convert a partiton key without range key.
231+
* `RangeKey(object key)`
232+
* Used when you only want to only convert a range key without a partition key.
233+
234+
224235
```csharp
225236

226237
public class EntityDTO

0 commit comments

Comments
 (0)