docs: Add flattening configuration examples

Closes #717
meltano · Nov 10, 2023 · dfb497c · dfb497c
1 parent e43be2c
commit dfb497c
Showing 1 changed file with 18 additions and 0 deletions.
diff --git a/docs/stream_maps.md b/docs/stream_maps.md
@@ -47,6 +47,24 @@ three distinct fields:
 - `user__last_name`
 - `user__id`
 
+#### Flattening Example
+
+````{tab} meltano.yml
+```yaml
+flattening_enabled: true
+flattening_max_depth: 1   # flatten only top-level properties
+```
+````
+
+````{tab} JSON
+```json
+{
+  "flattening_enabled": true,
+  "flattening_max_depth": 1
+}
+```
+````
+
 ## Out-of-scope capabilities
 
 These capabilities are all out of scope _by design_: