docs: Add flattening configuration examples (#2037)

meltano · Nov 10, 2023 · 62a2eaf · 62a2eaf
1 parent e43be2c
commit 62a2eaf
Show file tree

Hide file tree

Showing 2 changed files with 25 additions and 1 deletion.
diff --git a/.github/workflows/codeql-analysis.yml b/.github/workflows/codeql-analysis.yml
@@ -9,7 +9,13 @@ name: "CodeQL"
 on:
   push:
     branches: [ "main" ]
-  pull_request: {}
+    paths:
+      - .github/workflows/codeql-analysis.yml
+      - '**.py'  # Any Python file
+  pull_request:
+    paths:
+      - .github/workflows/codeql-analysis.yml
+      - '**.py'  # Any Python file
   schedule:
     - cron: '37 10 * * 5'
 

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_: