bricksentry 0.1.0__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- bricksentry-0.1.0/.gitignore +9 -0
- bricksentry-0.1.0/CHANGELOG.md +12 -0
- bricksentry-0.1.0/LICENSE +202 -0
- bricksentry-0.1.0/PKG-INFO +186 -0
- bricksentry-0.1.0/README.md +146 -0
- bricksentry-0.1.0/action.yml +59 -0
- bricksentry-0.1.0/examples/databricks/bricksentry.yml +34 -0
- bricksentry-0.1.0/examples/databricks/github-workflow.yml +44 -0
- bricksentry-0.1.0/examples/databricks/policy.yml +19 -0
- bricksentry-0.1.0/examples/demo/agent_loop_demo.py +119 -0
- bricksentry-0.1.0/pyproject.toml +53 -0
- bricksentry-0.1.0/src/bricksentry/__init__.py +26 -0
- bricksentry-0.1.0/src/bricksentry/agent_tools.py +139 -0
- bricksentry-0.1.0/src/bricksentry/assess.py +165 -0
- bricksentry-0.1.0/src/bricksentry/backends/__init__.py +3 -0
- bricksentry-0.1.0/src/bricksentry/backends/base.py +96 -0
- bricksentry-0.1.0/src/bricksentry/backends/databricks_backend.py +161 -0
- bricksentry-0.1.0/src/bricksentry/backends/duckdb_backend.py +52 -0
- bricksentry-0.1.0/src/bricksentry/changes.py +34 -0
- bricksentry-0.1.0/src/bricksentry/cli.py +260 -0
- bricksentry-0.1.0/src/bricksentry/config.py +123 -0
- bricksentry-0.1.0/src/bricksentry/diff.py +194 -0
- bricksentry-0.1.0/src/bricksentry/explain.py +91 -0
- bricksentry-0.1.0/src/bricksentry/github.py +52 -0
- bricksentry-0.1.0/src/bricksentry/lineage.py +224 -0
- bricksentry-0.1.0/src/bricksentry/mcp_server.py +47 -0
- bricksentry-0.1.0/src/bricksentry/models.py +212 -0
- bricksentry-0.1.0/src/bricksentry/policy.py +221 -0
- bricksentry-0.1.0/src/bricksentry/preview.py +79 -0
- bricksentry-0.1.0/src/bricksentry/py.typed +0 -0
- bricksentry-0.1.0/src/bricksentry/report.py +88 -0
- bricksentry-0.1.0/tests/conftest.py +45 -0
- bricksentry-0.1.0/tests/test_assess_policy.py +74 -0
- bricksentry-0.1.0/tests/test_databricks_and_uc.py +77 -0
- bricksentry-0.1.0/tests/test_diff.py +75 -0
- bricksentry-0.1.0/tests/test_preview_agents.py +84 -0
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
# Changelog
|
|
2
|
+
|
|
3
|
+
## 0.1.0 (2026-11-10)
|
|
4
|
+
|
|
5
|
+
- Key-based data diff with SQL pushdown: schema changes, added/removed/changed rows, per-column changes, nulls, numeric totals, duplicate keys, samples, segment attribution, deterministic hash sampling.
|
|
6
|
+
- Downstream impact from Unity Catalog lineage system tables (tables, jobs, notebooks, pipelines, dashboards, queries) with owners and tags, plus static lineage for local work.
|
|
7
|
+
- Policy-as-code verdicts: pass / warn / needs_human / block.
|
|
8
|
+
- `preview_write`: run one write against a disposable shallow clone, with SQL guards.
|
|
9
|
+
- Rollback plans from Delta history.
|
|
10
|
+
- CLI (`diff`, `impact`, `assess`, `preview`, `rollback`, `mcp`, `init`), markdown PR report, GitHub PR comment, composite GitHub Action.
|
|
11
|
+
- MCP server with six agent tools; the same tools as plain Python functions.
|
|
12
|
+
- Backends: Databricks SQL warehouse (Statement Execution API) and DuckDB.
|
|
@@ -0,0 +1,202 @@
|
|
|
1
|
+
|
|
2
|
+
Apache License
|
|
3
|
+
Version 2.0, January 2004
|
|
4
|
+
http://www.apache.org/licenses/
|
|
5
|
+
|
|
6
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
7
|
+
|
|
8
|
+
1. Definitions.
|
|
9
|
+
|
|
10
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
11
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
12
|
+
|
|
13
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
14
|
+
the copyright owner that is granting the License.
|
|
15
|
+
|
|
16
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
17
|
+
other entities that control, are controlled by, or are under common
|
|
18
|
+
control with that entity. For the purposes of this definition,
|
|
19
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
20
|
+
direction or management of such entity, whether by contract or
|
|
21
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
22
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
23
|
+
|
|
24
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
25
|
+
exercising permissions granted by this License.
|
|
26
|
+
|
|
27
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
28
|
+
including but not limited to software source code, documentation
|
|
29
|
+
source, and configuration files.
|
|
30
|
+
|
|
31
|
+
"Object" form shall mean any form resulting from mechanical
|
|
32
|
+
transformation or translation of a Source form, including but
|
|
33
|
+
not limited to compiled object code, generated documentation,
|
|
34
|
+
and conversions to other media types.
|
|
35
|
+
|
|
36
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
37
|
+
Object form, made available under the License, as indicated by a
|
|
38
|
+
copyright notice that is included in or attached to the work
|
|
39
|
+
(an example is provided in the Appendix below).
|
|
40
|
+
|
|
41
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
42
|
+
form, that is based on (or derived from) the Work and for which the
|
|
43
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
44
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
45
|
+
of this License, Derivative Works shall not include works that remain
|
|
46
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
47
|
+
the Work and Derivative Works thereof.
|
|
48
|
+
|
|
49
|
+
"Contribution" shall mean any work of authorship, including
|
|
50
|
+
the original version of the Work and any modifications or additions
|
|
51
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
52
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
53
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
54
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
55
|
+
means any form of electronic, verbal, or written communication sent
|
|
56
|
+
to the Licensor or its representatives, including but not limited to
|
|
57
|
+
communication on electronic mailing lists, source code control systems,
|
|
58
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
59
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
60
|
+
excluding communication that is conspicuously marked or otherwise
|
|
61
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
62
|
+
|
|
63
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
64
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
65
|
+
subsequently incorporated within the Work.
|
|
66
|
+
|
|
67
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
68
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
69
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
70
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
71
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
72
|
+
Work and such Derivative Works in Source or Object form.
|
|
73
|
+
|
|
74
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
75
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
76
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
77
|
+
(except as stated in this section) patent license to make, have made,
|
|
78
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
79
|
+
where such license applies only to those patent claims licensable
|
|
80
|
+
by such Contributor that are necessarily infringed by their
|
|
81
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
82
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
83
|
+
institute patent litigation against any entity (including a
|
|
84
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
85
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
86
|
+
or contributory patent infringement, then any patent licenses
|
|
87
|
+
granted to You under this License for that Work shall terminate
|
|
88
|
+
as of the date such litigation is filed.
|
|
89
|
+
|
|
90
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
91
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
92
|
+
modifications, and in Source or Object form, provided that You
|
|
93
|
+
meet the following conditions:
|
|
94
|
+
|
|
95
|
+
(a) You must give any other recipients of the Work or
|
|
96
|
+
Derivative Works a copy of this License; and
|
|
97
|
+
|
|
98
|
+
(b) You must cause any modified files to carry prominent notices
|
|
99
|
+
stating that You changed the files; and
|
|
100
|
+
|
|
101
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
102
|
+
that You distribute, all copyright, patent, trademark, and
|
|
103
|
+
attribution notices from the Source form of the Work,
|
|
104
|
+
excluding those notices that do not pertain to any part of
|
|
105
|
+
the Derivative Works; and
|
|
106
|
+
|
|
107
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
108
|
+
distribution, then any Derivative Works that You distribute must
|
|
109
|
+
include a readable copy of the attribution notices contained
|
|
110
|
+
within such NOTICE file, excluding those notices that do not
|
|
111
|
+
pertain to any part of the Derivative Works, in at least one
|
|
112
|
+
of the following places: within a NOTICE text file distributed
|
|
113
|
+
as part of the Derivative Works; within the Source form or
|
|
114
|
+
documentation, if provided along with the Derivative Works; or,
|
|
115
|
+
within a display generated by the Derivative Works, if and
|
|
116
|
+
wherever such third-party notices normally appear. The contents
|
|
117
|
+
of the NOTICE file are for informational purposes only and
|
|
118
|
+
do not modify the License. You may add Your own attribution
|
|
119
|
+
notices within Derivative Works that You distribute, alongside
|
|
120
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
121
|
+
that such additional attribution notices cannot be construed
|
|
122
|
+
as modifying the License.
|
|
123
|
+
|
|
124
|
+
You may add Your own copyright statement to Your modifications and
|
|
125
|
+
may provide additional or different license terms and conditions
|
|
126
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
127
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
128
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
129
|
+
the conditions stated in this License.
|
|
130
|
+
|
|
131
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
132
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
133
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
134
|
+
this License, without any additional terms or conditions.
|
|
135
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
136
|
+
the terms of any separate license agreement you may have executed
|
|
137
|
+
with Licensor regarding such Contributions.
|
|
138
|
+
|
|
139
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
140
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
141
|
+
except as required for reasonable and customary use in describing the
|
|
142
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
143
|
+
|
|
144
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
145
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
146
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
147
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
148
|
+
implied, including, without limitation, any warranties or conditions
|
|
149
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
150
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
151
|
+
appropriateness of using or redistributing the Work and assume any
|
|
152
|
+
risks associated with Your exercise of permissions under this License.
|
|
153
|
+
|
|
154
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
155
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
156
|
+
unless required by applicable law (such as deliberate and grossly
|
|
157
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
158
|
+
liable to You for damages, including any direct, indirect, special,
|
|
159
|
+
incidental, or consequential damages of any character arising as a
|
|
160
|
+
result of this License or out of the use or inability to use the
|
|
161
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
162
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
163
|
+
other commercial damages or losses), even if such Contributor
|
|
164
|
+
has been advised of the possibility of such damages.
|
|
165
|
+
|
|
166
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
167
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
168
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
169
|
+
or other liability obligations and/or rights consistent with this
|
|
170
|
+
License. However, in accepting such obligations, You may act only
|
|
171
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
172
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
173
|
+
defend, and hold each Contributor harmless for any liability
|
|
174
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
175
|
+
of your accepting any such warranty or additional liability.
|
|
176
|
+
|
|
177
|
+
END OF TERMS AND CONDITIONS
|
|
178
|
+
|
|
179
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
180
|
+
|
|
181
|
+
To apply the Apache License to your work, attach the following
|
|
182
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
183
|
+
replaced with your own identifying information. (Don't include
|
|
184
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
185
|
+
comment syntax for the file format. We also recommend that a
|
|
186
|
+
file or class name and description of purpose be included on the
|
|
187
|
+
same "printed page" as the copyright notice for easier
|
|
188
|
+
identification within third-party archives.
|
|
189
|
+
|
|
190
|
+
Copyright [yyyy] [name of copyright owner]
|
|
191
|
+
|
|
192
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
193
|
+
you may not use this file except in compliance with the License.
|
|
194
|
+
You may obtain a copy of the License at
|
|
195
|
+
|
|
196
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
197
|
+
|
|
198
|
+
Unless required by applicable law or agreed to in writing, software
|
|
199
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
200
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
201
|
+
See the License for the specific language governing permissions and
|
|
202
|
+
limitations under the License.
|
|
@@ -0,0 +1,186 @@
|
|
|
1
|
+
Metadata-Version: 2.5
|
|
2
|
+
Name: bricksentry
|
|
3
|
+
Version: 0.1.0
|
|
4
|
+
Summary: Change-safety for Databricks pipelines and the AI agents that edit them: data diffs, Unity Catalog blast radius, policy verdicts and rollback plans.
|
|
5
|
+
Author: Brahma
|
|
6
|
+
License-Expression: Apache-2.0
|
|
7
|
+
License-File: LICENSE
|
|
8
|
+
Keywords: ai-agents,ci,data-diff,data-engineering,data-quality,databricks,delta-lake,impact-analysis,lineage,mcp,unity-catalog
|
|
9
|
+
Classifier: Development Status :: 3 - Alpha
|
|
10
|
+
Classifier: Intended Audience :: Developers
|
|
11
|
+
Classifier: Operating System :: OS Independent
|
|
12
|
+
Classifier: Programming Language :: Python :: 3
|
|
13
|
+
Classifier: Programming Language :: Python :: 3.10
|
|
14
|
+
Classifier: Programming Language :: Python :: 3.11
|
|
15
|
+
Classifier: Programming Language :: Python :: 3.12
|
|
16
|
+
Classifier: Programming Language :: Python :: 3.13
|
|
17
|
+
Classifier: Topic :: Database
|
|
18
|
+
Classifier: Topic :: Software Development :: Quality Assurance
|
|
19
|
+
Classifier: Topic :: Software Development :: Testing
|
|
20
|
+
Classifier: Typing :: Typed
|
|
21
|
+
Requires-Python: >=3.10
|
|
22
|
+
Requires-Dist: click>=8.1
|
|
23
|
+
Requires-Dist: pyyaml>=6.0
|
|
24
|
+
Provides-Extra: all
|
|
25
|
+
Requires-Dist: databricks-sdk>=0.30; extra == 'all'
|
|
26
|
+
Requires-Dist: duckdb>=1.0; extra == 'all'
|
|
27
|
+
Requires-Dist: mcp>=1.10; extra == 'all'
|
|
28
|
+
Provides-Extra: databricks
|
|
29
|
+
Requires-Dist: databricks-sdk>=0.30; extra == 'databricks'
|
|
30
|
+
Provides-Extra: dev
|
|
31
|
+
Requires-Dist: databricks-sdk>=0.30; extra == 'dev'
|
|
32
|
+
Requires-Dist: duckdb>=1.0; extra == 'dev'
|
|
33
|
+
Requires-Dist: mcp>=1.10; extra == 'dev'
|
|
34
|
+
Requires-Dist: pytest>=8; extra == 'dev'
|
|
35
|
+
Provides-Extra: duckdb
|
|
36
|
+
Requires-Dist: duckdb>=1.0; extra == 'duckdb'
|
|
37
|
+
Provides-Extra: mcp
|
|
38
|
+
Requires-Dist: mcp>=1.10; extra == 'mcp'
|
|
39
|
+
Description-Content-Type: text/markdown
|
|
40
|
+
|
|
41
|
+
# bricksentry
|
|
42
|
+
|
|
43
|
+
**Change-safety for Databricks pipelines and the AI agents that edit them.**
|
|
44
|
+
|
|
45
|
+
Before a change reaches production, bricksentry answers three questions, in a
|
|
46
|
+
pull-request comment for humans and in structured JSON for agents:
|
|
47
|
+
|
|
48
|
+
1. **What does it do to the data?** A key-based data diff: added, removed and changed rows, schema changes, per-column changes, numeric totals, duplicate keys, and *where* the change is concentrated ("100% of affected rows are region = APAC").
|
|
49
|
+
2. **Who gets hurt?** The downstream blast radius from Unity Catalog lineage: tables, jobs, notebooks, Lakeflow pipelines, dashboards and queries, with owners and tags.
|
|
50
|
+
3. **Is it safe, and how do I undo it?** A deterministic policy verdict (`pass` · `warn` · `needs_human` · `block`) and the exact `RESTORE TABLE … VERSION AS OF n` rollback.
|
|
51
|
+
|
|
52
|
+
```
|
|
53
|
+
pip install "bricksentry[databricks,mcp]"
|
|
54
|
+
```
|
|
55
|
+
|
|
56
|
+
## Why it exists
|
|
57
|
+
|
|
58
|
+
AI now writes much of our pipeline code, and checking what that code does to the data hasn't kept up. Code review can't see a silent 3% revenue shift or a join that fans out. The tools that do catch this mostly cover dbt, or need a paid platform. Most Databricks work is PySpark notebooks, Jobs and Lakeflow pipelines, and bricksentry is built for that work:
|
|
59
|
+
|
|
60
|
+
- **Unity Catalog runtime lineage**, not SQL parsing, so PySpark notebooks and jobs are included.
|
|
61
|
+
- **SQL pushdown**: all diffing runs on your SQL warehouse, so no Spark session is needed and calls stay cheap enough for an agent loop.
|
|
62
|
+
- **One engine, three faces**: CLI and GitHub Action · Python API · MCP server.
|
|
63
|
+
|
|
64
|
+
## For AI agents: the MCP server
|
|
65
|
+
|
|
66
|
+
```bash
|
|
67
|
+
bricksentry mcp --config bricksentry.yml # stdio
|
|
68
|
+
claude mcp add bricksentry -- bricksentry mcp --config /abs/path/bricksentry.yml
|
|
69
|
+
```
|
|
70
|
+
|
|
71
|
+
| Tool | What the agent gets |
|
|
72
|
+
|---|---|
|
|
73
|
+
| `whats_downstream(table, depth)` | Downstream assets with owners and tags. Call it *before* editing. |
|
|
74
|
+
| `rollback_plan(table)` | The restore SQL. Capture it *before* changing anything. |
|
|
75
|
+
| `preview_write(sql, target, keys?)` | Runs one write against a **disposable shallow clone**, never production, and returns the diff plus verdict. |
|
|
76
|
+
| `assess_change(tables, candidates?, pr?)` | Diffs prod vs. the candidate built by your change, plus lineage and policy. Returns a verdict and an `id`. |
|
|
77
|
+
| `explain_diff(assessment_id or table)` | Plain-English summary. |
|
|
78
|
+
| `safe_to_ship(assessment_id)` | `safe_to_ship`, the reasons, and an explicit `next_step` to follow. |
|
|
79
|
+
|
|
80
|
+
Designed for agents:
|
|
81
|
+
|
|
82
|
+
- **The verdict never comes from an LLM.** Rules in `policy.yml` decide, so the same change always gets the same answer.
|
|
83
|
+
- **Read-only by default.** Only `preview_write` writes, and only to a sandbox clone. It accepts a single INSERT / MERGE / UPDATE / DELETE / CREATE OR REPLACE whose target must be the clone, and it refuses DROP, TRUNCATE, ALTER, GRANT and multiple statements.
|
|
84
|
+
- **Errors come back as `{"error": ...}`**, so agents can recover instead of crashing.
|
|
85
|
+
- **Bounded cost:** deterministic hash sampling (`sample_pct`), capped samples, and lineage limited by depth and lookback window.
|
|
86
|
+
|
|
87
|
+
The same tools are plain Python functions in `bricksentry.agent_tools`, so you can use them from LangGraph, the OpenAI Agents SDK or the Databricks Agent Framework without MCP.
|
|
88
|
+
|
|
89
|
+
### See the agent loop (no Databricks needed)
|
|
90
|
+
|
|
91
|
+
```bash
|
|
92
|
+
pip install "bricksentry[duckdb]"
|
|
93
|
+
python examples/demo/agent_loop_demo.py
|
|
94
|
+
```
|
|
95
|
+
|
|
96
|
+
In the demo, an agent previews a risky DELETE (needs_human, production untouched), ships a pipeline change with a join fan-out (**blocked**: 40 duplicate keys), fixes it, and gets routed to the certified table's owners. It ends with the pull-request comment a reviewer would see.
|
|
97
|
+
|
|
98
|
+
## For data engineers: CLI and CI
|
|
99
|
+
|
|
100
|
+
```bash
|
|
101
|
+
bricksentry init # starter bricksentry.yml + policy.yml
|
|
102
|
+
bricksentry impact main.sales.orders # blast radius
|
|
103
|
+
bricksentry diff main.sales.orders main.sales_pr_42.orders
|
|
104
|
+
bricksentry preview main.sales.orders --sql "MERGE INTO {{target}} t USING updates u ON t.order_id = u.order_id WHEN MATCHED THEN UPDATE SET *"
|
|
105
|
+
bricksentry assess --from-git origin/main --pr 42 --format markdown --fail-on needs_human
|
|
106
|
+
bricksentry rollback main.sales.orders
|
|
107
|
+
```
|
|
108
|
+
|
|
109
|
+
Exit codes: `0` below `--fail-on`, `1` at or above it, `2` for configuration errors.
|
|
110
|
+
|
|
111
|
+
**In GitHub Actions.** Build your PR's version of the pipeline into a per-PR schema (for example with a Databricks Asset Bundle `ci` target), then add:
|
|
112
|
+
|
|
113
|
+
```yaml
|
|
114
|
+
- run: pip install "bricksentry[databricks]"
|
|
115
|
+
- run: >
|
|
116
|
+
bricksentry assess
|
|
117
|
+
--from-git origin/${{ github.base_ref }}
|
|
118
|
+
--pr ${{ github.event.pull_request.number }}
|
|
119
|
+
--comment --output bricksentry-report.md
|
|
120
|
+
--fail-on needs_human
|
|
121
|
+
env:
|
|
122
|
+
GITHUB_TOKEN: ${{ github.token }}
|
|
123
|
+
DATABRICKS_HOST: ${{ secrets.DATABRICKS_HOST }}
|
|
124
|
+
DATABRICKS_CLIENT_ID: ${{ secrets.DATABRICKS_CLIENT_ID }}
|
|
125
|
+
DATABRICKS_CLIENT_SECRET: ${{ secrets.DATABRICKS_CLIENT_SECRET }}
|
|
126
|
+
DATABRICKS_WAREHOUSE_ID: ${{ secrets.DATABRICKS_WAREHOUSE_ID }}
|
|
127
|
+
```
|
|
128
|
+
|
|
129
|
+
It detects changed tables from the files in the PR and posts or updates one PR comment. Check out with `fetch-depth: 0` and give the job `pull-requests: write` permission. The source repository also ships a composite `action.yml` that wraps these steps.
|
|
130
|
+
|
|
131
|
+
## Python API
|
|
132
|
+
|
|
133
|
+
```python
|
|
134
|
+
from bricksentry import Sentry
|
|
135
|
+
|
|
136
|
+
s = Sentry() # reads ./bricksentry.yml
|
|
137
|
+
a = s.assess(["main.sales.orders"], pr="42")
|
|
138
|
+
print(a.verdict, a.notify)
|
|
139
|
+
print(a.tables[0].summary)
|
|
140
|
+
|
|
141
|
+
s.preview_write("DELETE FROM main.sales.orders WHERE status = 'test'", "main.sales.orders")
|
|
142
|
+
```
|
|
143
|
+
|
|
144
|
+
## Configuration
|
|
145
|
+
|
|
146
|
+
```yaml
|
|
147
|
+
backend: {type: databricks, warehouse_id: abc123} # auth: standard Databricks SDK chain
|
|
148
|
+
sandbox_schema: main.bricksentry_sandbox
|
|
149
|
+
candidate_pattern: "{catalog}.{schema}_pr_{pr}.{table}"
|
|
150
|
+
sample_pct: 10
|
|
151
|
+
lineage: {type: databricks, depth: 3, lookback_days: 90}
|
|
152
|
+
tables:
|
|
153
|
+
main.sales.orders:
|
|
154
|
+
keys: [order_id]
|
|
155
|
+
segment_by: [region]
|
|
156
|
+
paths: ["src/pipelines/orders/**", "resources/orders_job.yml"]
|
|
157
|
+
policy: policy.yml
|
|
158
|
+
```
|
|
159
|
+
|
|
160
|
+
### Policy conditions
|
|
161
|
+
|
|
162
|
+
`table` (glob) · `tag` · `downstream_tag` · `downstream_kind` · `downstream_count_gt` · `removed_pct_gt` · `added_pct_gt` · `changed_pct_gt` · `row_count_change_pct_gt` · `row_count_drop_pct_gt` · `column_removed` · `column_added` · `column_type_changed` · `duplicate_keys` · `sum_change_pct_gt` / `null_increase_gt` (optionally with `column`) · `any_change` · `diff_error`
|
|
163
|
+
|
|
164
|
+
All conditions in a `when` must hold. The most severe matching rule sets the verdict. Unknown conditions are rejected at load time, so a typo can't silently disable a rule.
|
|
165
|
+
|
|
166
|
+
## Permissions needed on Databricks
|
|
167
|
+
|
|
168
|
+
- `CAN USE` on a SQL warehouse.
|
|
169
|
+
- `SELECT` on the tables you assess and their candidates.
|
|
170
|
+
- `SELECT` on `system.access.table_lineage`, plus `system.information_schema` for owners and tags. Without these, bricksentry still diffs; lineage is just empty.
|
|
171
|
+
- `CREATE TABLE` on `sandbox_schema`, for `preview_write`.
|
|
172
|
+
|
|
173
|
+
## Known limits (v0.1)
|
|
174
|
+
|
|
175
|
+
- **Lineage is recorded at runtime.** Brand-new tables have no downstream history yet. Unity Catalog doesn't capture RDD operations, and UDFs hide column-level mapping.
|
|
176
|
+
- **Keys are required.** Tables without a stable key can't be diffed row by row yet (an aggregate-profile mode is planned).
|
|
177
|
+
- **Changed-table detection uses path globs** from config. It doesn't parse Asset Bundles yet.
|
|
178
|
+
- **The Databricks backend is tested against a mocked SDK.** Run it against a dev workspace before relying on it in CI.
|
|
179
|
+
|
|
180
|
+
## Roadmap
|
|
181
|
+
|
|
182
|
+
Asset Bundle parsing for automatic table detection · column-level blast radius from `system.access.column_lineage` · an aggregate diff for keyless tables · Lakeflow expectations in the verdict · `bricksentry watch` for scheduled drift checks · a Databricks App UI.
|
|
183
|
+
|
|
184
|
+
## License
|
|
185
|
+
|
|
186
|
+
Apache-2.0
|
|
@@ -0,0 +1,146 @@
|
|
|
1
|
+
# bricksentry
|
|
2
|
+
|
|
3
|
+
**Change-safety for Databricks pipelines and the AI agents that edit them.**
|
|
4
|
+
|
|
5
|
+
Before a change reaches production, bricksentry answers three questions, in a
|
|
6
|
+
pull-request comment for humans and in structured JSON for agents:
|
|
7
|
+
|
|
8
|
+
1. **What does it do to the data?** A key-based data diff: added, removed and changed rows, schema changes, per-column changes, numeric totals, duplicate keys, and *where* the change is concentrated ("100% of affected rows are region = APAC").
|
|
9
|
+
2. **Who gets hurt?** The downstream blast radius from Unity Catalog lineage: tables, jobs, notebooks, Lakeflow pipelines, dashboards and queries, with owners and tags.
|
|
10
|
+
3. **Is it safe, and how do I undo it?** A deterministic policy verdict (`pass` · `warn` · `needs_human` · `block`) and the exact `RESTORE TABLE … VERSION AS OF n` rollback.
|
|
11
|
+
|
|
12
|
+
```
|
|
13
|
+
pip install "bricksentry[databricks,mcp]"
|
|
14
|
+
```
|
|
15
|
+
|
|
16
|
+
## Why it exists
|
|
17
|
+
|
|
18
|
+
AI now writes much of our pipeline code, and checking what that code does to the data hasn't kept up. Code review can't see a silent 3% revenue shift or a join that fans out. The tools that do catch this mostly cover dbt, or need a paid platform. Most Databricks work is PySpark notebooks, Jobs and Lakeflow pipelines, and bricksentry is built for that work:
|
|
19
|
+
|
|
20
|
+
- **Unity Catalog runtime lineage**, not SQL parsing, so PySpark notebooks and jobs are included.
|
|
21
|
+
- **SQL pushdown**: all diffing runs on your SQL warehouse, so no Spark session is needed and calls stay cheap enough for an agent loop.
|
|
22
|
+
- **One engine, three faces**: CLI and GitHub Action · Python API · MCP server.
|
|
23
|
+
|
|
24
|
+
## For AI agents: the MCP server
|
|
25
|
+
|
|
26
|
+
```bash
|
|
27
|
+
bricksentry mcp --config bricksentry.yml # stdio
|
|
28
|
+
claude mcp add bricksentry -- bricksentry mcp --config /abs/path/bricksentry.yml
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
| Tool | What the agent gets |
|
|
32
|
+
|---|---|
|
|
33
|
+
| `whats_downstream(table, depth)` | Downstream assets with owners and tags. Call it *before* editing. |
|
|
34
|
+
| `rollback_plan(table)` | The restore SQL. Capture it *before* changing anything. |
|
|
35
|
+
| `preview_write(sql, target, keys?)` | Runs one write against a **disposable shallow clone**, never production, and returns the diff plus verdict. |
|
|
36
|
+
| `assess_change(tables, candidates?, pr?)` | Diffs prod vs. the candidate built by your change, plus lineage and policy. Returns a verdict and an `id`. |
|
|
37
|
+
| `explain_diff(assessment_id or table)` | Plain-English summary. |
|
|
38
|
+
| `safe_to_ship(assessment_id)` | `safe_to_ship`, the reasons, and an explicit `next_step` to follow. |
|
|
39
|
+
|
|
40
|
+
Designed for agents:
|
|
41
|
+
|
|
42
|
+
- **The verdict never comes from an LLM.** Rules in `policy.yml` decide, so the same change always gets the same answer.
|
|
43
|
+
- **Read-only by default.** Only `preview_write` writes, and only to a sandbox clone. It accepts a single INSERT / MERGE / UPDATE / DELETE / CREATE OR REPLACE whose target must be the clone, and it refuses DROP, TRUNCATE, ALTER, GRANT and multiple statements.
|
|
44
|
+
- **Errors come back as `{"error": ...}`**, so agents can recover instead of crashing.
|
|
45
|
+
- **Bounded cost:** deterministic hash sampling (`sample_pct`), capped samples, and lineage limited by depth and lookback window.
|
|
46
|
+
|
|
47
|
+
The same tools are plain Python functions in `bricksentry.agent_tools`, so you can use them from LangGraph, the OpenAI Agents SDK or the Databricks Agent Framework without MCP.
|
|
48
|
+
|
|
49
|
+
### See the agent loop (no Databricks needed)
|
|
50
|
+
|
|
51
|
+
```bash
|
|
52
|
+
pip install "bricksentry[duckdb]"
|
|
53
|
+
python examples/demo/agent_loop_demo.py
|
|
54
|
+
```
|
|
55
|
+
|
|
56
|
+
In the demo, an agent previews a risky DELETE (needs_human, production untouched), ships a pipeline change with a join fan-out (**blocked**: 40 duplicate keys), fixes it, and gets routed to the certified table's owners. It ends with the pull-request comment a reviewer would see.
|
|
57
|
+
|
|
58
|
+
## For data engineers: CLI and CI
|
|
59
|
+
|
|
60
|
+
```bash
|
|
61
|
+
bricksentry init # starter bricksentry.yml + policy.yml
|
|
62
|
+
bricksentry impact main.sales.orders # blast radius
|
|
63
|
+
bricksentry diff main.sales.orders main.sales_pr_42.orders
|
|
64
|
+
bricksentry preview main.sales.orders --sql "MERGE INTO {{target}} t USING updates u ON t.order_id = u.order_id WHEN MATCHED THEN UPDATE SET *"
|
|
65
|
+
bricksentry assess --from-git origin/main --pr 42 --format markdown --fail-on needs_human
|
|
66
|
+
bricksentry rollback main.sales.orders
|
|
67
|
+
```
|
|
68
|
+
|
|
69
|
+
Exit codes: `0` below `--fail-on`, `1` at or above it, `2` for configuration errors.
|
|
70
|
+
|
|
71
|
+
**In GitHub Actions.** Build your PR's version of the pipeline into a per-PR schema (for example with a Databricks Asset Bundle `ci` target), then add:
|
|
72
|
+
|
|
73
|
+
```yaml
|
|
74
|
+
- run: pip install "bricksentry[databricks]"
|
|
75
|
+
- run: >
|
|
76
|
+
bricksentry assess
|
|
77
|
+
--from-git origin/${{ github.base_ref }}
|
|
78
|
+
--pr ${{ github.event.pull_request.number }}
|
|
79
|
+
--comment --output bricksentry-report.md
|
|
80
|
+
--fail-on needs_human
|
|
81
|
+
env:
|
|
82
|
+
GITHUB_TOKEN: ${{ github.token }}
|
|
83
|
+
DATABRICKS_HOST: ${{ secrets.DATABRICKS_HOST }}
|
|
84
|
+
DATABRICKS_CLIENT_ID: ${{ secrets.DATABRICKS_CLIENT_ID }}
|
|
85
|
+
DATABRICKS_CLIENT_SECRET: ${{ secrets.DATABRICKS_CLIENT_SECRET }}
|
|
86
|
+
DATABRICKS_WAREHOUSE_ID: ${{ secrets.DATABRICKS_WAREHOUSE_ID }}
|
|
87
|
+
```
|
|
88
|
+
|
|
89
|
+
It detects changed tables from the files in the PR and posts or updates one PR comment. Check out with `fetch-depth: 0` and give the job `pull-requests: write` permission. The source repository also ships a composite `action.yml` that wraps these steps.
|
|
90
|
+
|
|
91
|
+
## Python API
|
|
92
|
+
|
|
93
|
+
```python
|
|
94
|
+
from bricksentry import Sentry
|
|
95
|
+
|
|
96
|
+
s = Sentry() # reads ./bricksentry.yml
|
|
97
|
+
a = s.assess(["main.sales.orders"], pr="42")
|
|
98
|
+
print(a.verdict, a.notify)
|
|
99
|
+
print(a.tables[0].summary)
|
|
100
|
+
|
|
101
|
+
s.preview_write("DELETE FROM main.sales.orders WHERE status = 'test'", "main.sales.orders")
|
|
102
|
+
```
|
|
103
|
+
|
|
104
|
+
## Configuration
|
|
105
|
+
|
|
106
|
+
```yaml
|
|
107
|
+
backend: {type: databricks, warehouse_id: abc123} # auth: standard Databricks SDK chain
|
|
108
|
+
sandbox_schema: main.bricksentry_sandbox
|
|
109
|
+
candidate_pattern: "{catalog}.{schema}_pr_{pr}.{table}"
|
|
110
|
+
sample_pct: 10
|
|
111
|
+
lineage: {type: databricks, depth: 3, lookback_days: 90}
|
|
112
|
+
tables:
|
|
113
|
+
main.sales.orders:
|
|
114
|
+
keys: [order_id]
|
|
115
|
+
segment_by: [region]
|
|
116
|
+
paths: ["src/pipelines/orders/**", "resources/orders_job.yml"]
|
|
117
|
+
policy: policy.yml
|
|
118
|
+
```
|
|
119
|
+
|
|
120
|
+
### Policy conditions
|
|
121
|
+
|
|
122
|
+
`table` (glob) · `tag` · `downstream_tag` · `downstream_kind` · `downstream_count_gt` · `removed_pct_gt` · `added_pct_gt` · `changed_pct_gt` · `row_count_change_pct_gt` · `row_count_drop_pct_gt` · `column_removed` · `column_added` · `column_type_changed` · `duplicate_keys` · `sum_change_pct_gt` / `null_increase_gt` (optionally with `column`) · `any_change` · `diff_error`
|
|
123
|
+
|
|
124
|
+
All conditions in a `when` must hold. The most severe matching rule sets the verdict. Unknown conditions are rejected at load time, so a typo can't silently disable a rule.
|
|
125
|
+
|
|
126
|
+
## Permissions needed on Databricks
|
|
127
|
+
|
|
128
|
+
- `CAN USE` on a SQL warehouse.
|
|
129
|
+
- `SELECT` on the tables you assess and their candidates.
|
|
130
|
+
- `SELECT` on `system.access.table_lineage`, plus `system.information_schema` for owners and tags. Without these, bricksentry still diffs; lineage is just empty.
|
|
131
|
+
- `CREATE TABLE` on `sandbox_schema`, for `preview_write`.
|
|
132
|
+
|
|
133
|
+
## Known limits (v0.1)
|
|
134
|
+
|
|
135
|
+
- **Lineage is recorded at runtime.** Brand-new tables have no downstream history yet. Unity Catalog doesn't capture RDD operations, and UDFs hide column-level mapping.
|
|
136
|
+
- **Keys are required.** Tables without a stable key can't be diffed row by row yet (an aggregate-profile mode is planned).
|
|
137
|
+
- **Changed-table detection uses path globs** from config. It doesn't parse Asset Bundles yet.
|
|
138
|
+
- **The Databricks backend is tested against a mocked SDK.** Run it against a dev workspace before relying on it in CI.
|
|
139
|
+
|
|
140
|
+
## Roadmap
|
|
141
|
+
|
|
142
|
+
Asset Bundle parsing for automatic table detection · column-level blast radius from `system.access.column_lineage` · an aggregate diff for keyless tables · Lakeflow expectations in the verdict · `bricksentry watch` for scheduled drift checks · a Databricks App UI.
|
|
143
|
+
|
|
144
|
+
## License
|
|
145
|
+
|
|
146
|
+
Apache-2.0
|
|
@@ -0,0 +1,59 @@
|
|
|
1
|
+
name: bricksentry
|
|
2
|
+
description: Data diff, Unity Catalog blast radius and a policy verdict for every pull request that changes Databricks pipelines.
|
|
3
|
+
branding:
|
|
4
|
+
icon: shield
|
|
5
|
+
color: orange
|
|
6
|
+
|
|
7
|
+
inputs:
|
|
8
|
+
config:
|
|
9
|
+
description: Path to bricksentry.yml
|
|
10
|
+
default: bricksentry.yml
|
|
11
|
+
base-ref:
|
|
12
|
+
description: Git ref to compare against for changed-table detection (defaults to the PR base branch)
|
|
13
|
+
default: ""
|
|
14
|
+
tables:
|
|
15
|
+
description: Optional space-separated list of tables to always assess
|
|
16
|
+
default: ""
|
|
17
|
+
fail-on:
|
|
18
|
+
description: Fail the check when the verdict is at least this severe (pass, warn, needs_human, block)
|
|
19
|
+
default: needs_human
|
|
20
|
+
comment:
|
|
21
|
+
description: Post or update a PR comment with the report
|
|
22
|
+
default: "true"
|
|
23
|
+
version:
|
|
24
|
+
description: bricksentry version spec to install (e.g. "==0.1.0"); empty = latest
|
|
25
|
+
default: ""
|
|
26
|
+
|
|
27
|
+
outputs:
|
|
28
|
+
verdict:
|
|
29
|
+
description: pass, warn, needs_human or block
|
|
30
|
+
value: ${{ steps.run.outputs.verdict }}
|
|
31
|
+
|
|
32
|
+
runs:
|
|
33
|
+
using: composite
|
|
34
|
+
steps:
|
|
35
|
+
- uses: actions/setup-python@v5
|
|
36
|
+
with:
|
|
37
|
+
python-version: "3.12"
|
|
38
|
+
- name: Install bricksentry
|
|
39
|
+
shell: bash
|
|
40
|
+
run: pip install "bricksentry[databricks]${{ inputs.version }}"
|
|
41
|
+
- name: Assess change
|
|
42
|
+
id: run
|
|
43
|
+
shell: bash
|
|
44
|
+
env:
|
|
45
|
+
BRICKSENTRY_PR: ${{ github.event.pull_request.number }}
|
|
46
|
+
GITHUB_TOKEN: ${{ github.token }}
|
|
47
|
+
run: |
|
|
48
|
+
set +e
|
|
49
|
+
BASE="${{ inputs.base-ref }}"
|
|
50
|
+
if [ -z "$BASE" ]; then BASE="origin/${{ github.base_ref }}"; fi
|
|
51
|
+
ARGS=(assess --config "${{ inputs.config }}" --from-git "$BASE" --format json --output bricksentry-report.md --fail-on "${{ inputs.fail-on }}")
|
|
52
|
+
for t in ${{ inputs.tables }}; do ARGS+=(--table "$t"); done
|
|
53
|
+
if [ "${{ inputs.comment }}" = "true" ] && [ -n "$BRICKSENTRY_PR" ]; then ARGS+=(--comment); fi
|
|
54
|
+
bricksentry "${ARGS[@]}" > bricksentry-result.json
|
|
55
|
+
CODE=$?
|
|
56
|
+
VERDICT=$(python -c "import json;print(json.load(open('bricksentry-result.json')).get('verdict','pass'))" 2>/dev/null || echo "error")
|
|
57
|
+
echo "verdict=$VERDICT" >> "$GITHUB_OUTPUT"
|
|
58
|
+
[ -f bricksentry-report.md ] && cat bricksentry-report.md >> "$GITHUB_STEP_SUMMARY"
|
|
59
|
+
exit $CODE
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
# Example config for a Databricks workspace.
|
|
2
|
+
backend:
|
|
3
|
+
type: databricks
|
|
4
|
+
# warehouse_id: 1234567890abcdef # or set DATABRICKS_WAREHOUSE_ID
|
|
5
|
+
# profile: DEFAULT # ~/.databrickscfg profile; CI usually uses env vars
|
|
6
|
+
|
|
7
|
+
# Disposable clones for preview_write live here (SHALLOW CLONE, metadata only).
|
|
8
|
+
sandbox_schema: main.bricksentry_sandbox
|
|
9
|
+
|
|
10
|
+
# Your CI job builds the changed pipeline into a per-PR schema; bricksentry diffs it against prod.
|
|
11
|
+
candidate_pattern: "{catalog}.{schema}_pr_{pr}.{table}"
|
|
12
|
+
|
|
13
|
+
# Big tables: diff a deterministic 10% key sample. Remove for full diffs.
|
|
14
|
+
sample_pct: 10
|
|
15
|
+
max_samples: 5
|
|
16
|
+
|
|
17
|
+
lineage:
|
|
18
|
+
type: databricks # reads system.access.table_lineage + information_schema
|
|
19
|
+
depth: 3
|
|
20
|
+
lookback_days: 90
|
|
21
|
+
|
|
22
|
+
tables:
|
|
23
|
+
main.sales.orders:
|
|
24
|
+
keys: [order_id]
|
|
25
|
+
segment_by: [region, channel]
|
|
26
|
+
paths:
|
|
27
|
+
- "src/pipelines/orders/**"
|
|
28
|
+
- "resources/orders_job.yml"
|
|
29
|
+
main.sales.daily_revenue:
|
|
30
|
+
keys: [revenue_date, region]
|
|
31
|
+
paths:
|
|
32
|
+
- "src/pipelines/revenue/**"
|
|
33
|
+
|
|
34
|
+
policy: policy.yml
|