Skip to content

Commit 3cb3fe5

Browse files
Update Databricks dashboard layout and docs (#30)
1 parent dcd3ff4 commit 3cb3fe5

4 files changed

Lines changed: 42 additions & 30 deletions

File tree

README.md

Lines changed: 15 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,7 @@ There are two supported Databricks paths:
8383

8484
| Path | What it creates | When to use it | Recommendation |
8585
|---|---|---|---|
86-
| Databricks Delta | Unity Catalog control, bronze, and silver schemas | Primary production path | Recommended |
86+
| Databricks Delta | Unity Catalog control/bronze/silver schemas plus silver current-state tables | Primary production path | Recommended |
8787
| Databricks over S3 | Unity Catalog views over published Parquet snapshots | Reference example, simpler bridge from the Rust exporter | Supported, but secondary |
8888

8989
Recommended Databricks Delta flow:
@@ -95,20 +95,20 @@ just databricks-delta-bootstrap <warehouse-id>
9595
just databricks-delta-sync-secret DEFAULT
9696
just databricks-delta-deploy DEFAULT prod
9797
just databricks-delta-run DEFAULT prod
98+
just databricks-delta-deploy-pipeline DEFAULT prod
99+
just databricks-delta-run-pipeline DEFAULT prod
98100
```
99101

100102
The Delta path creates and updates:
101103

102-
- `convex_sync_kit_<source>_delta_control`
103-
- `convex_sync_kit_<source>_delta_bronze`
104-
- `convex_sync_kit_<source>_delta_silver`
104+
- `convex_sync_kit_<source>_delta_control` for checkpoints
105+
- `convex_sync_kit_<source>_delta_bronze` for append-only CDC landing tables
106+
- `convex_sync_kit_<source>_delta_silver` for Lakeflow-materialized current-state tables
105107

106-
The silver schema is expected to stay empty until you stand up a Lakeflow `AUTO CDC` pipeline for the tables you actually want to materialize there.
107-
108-
```bash
109-
just databricks-delta-deploy-pipeline DEFAULT prod
110-
just databricks-delta-run-pipeline DEFAULT prod
111-
```
108+
Bootstrap creates the schemas, the extractor job writes control + bronze, and the
109+
Lakeflow `AUTO CDC` pipeline materializes silver. The checked-in `meshix-api`
110+
example already includes a generated bronze-to-silver pipeline file, while new
111+
sources still need the same deploy/run pipeline step after bronze tables exist.
112112

113113
Reference Databricks over S3 flow:
114114

@@ -150,7 +150,7 @@ Relevant Foundry docs:
150150
| Local recurring analysis | raw change log parquet, staging parquet | user-defined paths |
151151
| S3/export | `staging/current`, manifests, versioned snapshots | bucket and prefix chosen by operator |
152152
| Databricks over S3 | Unity Catalog views over published parquet snapshots | `convex_sync_kit_<source>_s3` |
153-
| Databricks Delta | checkpoint table, bronze CDC tables, silver current-state tables | `convex_sync_kit_<source>_delta_{control,bronze,silver}` |
153+
| Databricks Delta | checkpoint table, bronze CDC tables, silver current-state tables materialized by Lakeflow `AUTO CDC` | `convex_sync_kit_<source>_delta_{control,bronze,silver}` |
154154

155155
The checked-in [`sources/meshix-api/env.sh`](sources/meshix-api/env.sh) file is only an example source profile, not a repo identity. Add more source directories as you onboard more Convex projects.
156156

@@ -215,8 +215,8 @@ The first version focuses on:
215215
- a side-by-side bronze/silver table map
216216

217217
The dashboard now filters out internal Lakeflow objects from the bronze/silver
218-
counts and uses full-width tables for recent checkpoints, per-table record
219-
counts, and the bronze/silver map.
218+
counts, places recent checkpoints and per-table record counts side by side,
219+
and keeps the bronze/silver map full width underneath.
220220

221221
To make the pipeline feel truly live:
222222

@@ -242,7 +242,8 @@ If you want to show this repo working in a talk or video, start with:
242242
- `convex_sync_kit_meshix_api_delta_silver`
243243
4. A query result from `connector_checkpoint_latest` showing `meshix-api / delta_tail`.
244244
5. A `SHOW TABLES` result for the bronze schema showing many `_cdc` tables.
245-
6. The S3-backed `__source_map` view so people can see the reference path is real too.
245+
6. A `SHOW TABLES` result for the silver schema showing materialized current-state tables.
246+
7. The S3-backed `__source_map` view so people can see the reference path is real too.
246247

247248
There is a more detailed capture list in [docs/demo-storyboard.md](docs/demo-storyboard.md).
248249

docs/monitoring.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,8 +27,9 @@ The first dashboard focuses on:
2727
- per-table bronze vs silver record counts
2828
- a side-by-side bronze/silver table map
2929

30-
The template filters out internal Lakeflow objects from the layer counts and
31-
uses full-width tables so the dashboard is easier to read in Lakeview.
30+
The template filters out internal Lakeflow objects from the layer counts,
31+
places recent checkpoints and per-table record counts side by side, and keeps
32+
the bronze/silver map full width below.
3233

3334
## AUTO CDC Status
3435

platform/databricks/delta/README.md

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -101,9 +101,14 @@ flowchart LR
101101
J[convex_delta_extract job]
102102
C[checkpoint table]
103103
T[bronze CDC tables]
104+
P[Lakeflow AUTO CDC pipeline]
105+
S[silver current-state tables]
104106
B --> J
107+
B --> P
105108
J --> C
106109
J --> T
110+
T --> P
111+
P --> S
107112
```
108113

109114
Recommended operator entrypoints:
@@ -112,13 +117,17 @@ Recommended operator entrypoints:
112117
just databricks-delta-sync-secret
113118
just databricks-delta-bootstrap <warehouse_id>
114119
just databricks-delta-publish-dashboard DEFAULT <warehouse_id>
120+
just databricks-delta-deploy DEFAULT prod
121+
just databricks-delta-run DEFAULT prod
115122
just databricks-delta-deploy-pipeline DEFAULT prod
116123
just databricks-delta-run-pipeline DEFAULT prod
117-
just databricks-delta-deploy
118-
just databricks-delta-run
119124
just databricks-delta-smoke <warehouse_id>
120125
```
121126

127+
The checked-in `meshix-api` example already has a generated bronze-to-silver
128+
Lakeflow SQL file under `generated/`. New sources render that file during the
129+
`deploy-pipeline` step once bronze tables exist.
130+
122131
Auto-update behavior after deployment:
123132

124133
- the extractor job is scheduled every 5 minutes

platform/databricks/delta/dashboards/convex_sync_overview.lvdash.json.tmpl

Lines changed: 13 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -263,7 +263,7 @@
263263
"position": {
264264
"x": 0,
265265
"y": 2,
266-
"width": 3,
266+
"width": 2,
267267
"height": 3
268268
}
269269
},
@@ -301,7 +301,7 @@
301301
}
302302
},
303303
"position": {
304-
"x": 3,
304+
"x": 2,
305305
"y": 2,
306306
"width": 3,
307307
"height": 3
@@ -341,7 +341,7 @@
341341
}
342342
},
343343
"position": {
344-
"x": 6,
344+
"x": 5,
345345
"y": 2,
346346
"width": 3,
347347
"height": 3
@@ -381,9 +381,9 @@
381381
}
382382
},
383383
"position": {
384-
"x": 9,
384+
"x": 8,
385385
"y": 2,
386-
"width": 3,
386+
"width": 4,
387387
"height": 3
388388
}
389389
},
@@ -450,7 +450,7 @@
450450
"position": {
451451
"x": 0,
452452
"y": 5,
453-
"width": 12,
453+
"width": 6,
454454
"height": 7
455455
}
456456
},
@@ -507,10 +507,10 @@
507507
}
508508
},
509509
"position": {
510-
"x": 0,
511-
"y": 12,
512-
"width": 12,
513-
"height": 6
510+
"x": 6,
511+
"y": 5,
512+
"width": 6,
513+
"height": 7
514514
}
515515
},
516516
{
@@ -583,13 +583,14 @@
583583
},
584584
"position": {
585585
"x": 0,
586-
"y": 18,
586+
"y": 12,
587587
"width": 12,
588588
"height": 12
589589
}
590590
}
591591
],
592-
"pageType": "PAGE"
592+
"pageType": "PAGE_TYPE_CANVAS",
593+
"layoutVersion": "GRID_V1"
593594
}
594595
]
595596
}

0 commit comments

Comments
 (0)