Skip to content

Commit 4dbd6a8

Browse files
Merge pull request #4671 from segmentio/sarahrudy-patch-9
Add info about properties with the "\" character
2 parents 3c6d74e + 51c30d0 commit 4dbd6a8

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

src/protocols/transform/index.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -109,6 +109,13 @@ In this scenario, we do not support the transformation of product_id.
109109

110110
After selecting a property/trait, select JSON Path or Simple String to change the property/trait. Simple string will change the name in-line, while JSON path allows you to move the property/trait in or out of an object.
111111

112+
> info ""
113+
> When you see properties that have the escape character `\` in them - this escape character `\` is added to differentiate between a property name that has a . in it, and a nested field, like so:
114+
> ```
115+
> ingredients.salad → "ingredients": { "salad": "yum" }
116+
> ingredients\.salad → "ingredients.salad": "yum"
117+
> ```
118+
112119
### Step 3: Name the transformation and enable it
113120
114121
Enter a descriptive name to act as a label for the transformation. This label helps you organize your Transformations, and Segment recommends that you make this descriptive and focused on the problem you're solving. For example `Fix misnamed order_completed event for ecommerce spec` is much better than `Map order_completed`.

0 commit comments

Comments
 (0)