Fix reconcile notebook docs: update TableRecon API for v2#2327
Closed
moomindani wants to merge 1 commit intodatabrickslabs:mainfrom
Closed
Fix reconcile notebook docs: update TableRecon API for v2#2327moomindani wants to merge 1 commit intodatabrickslabs:mainfrom
moomindani wants to merge 1 commit intodatabrickslabs:mainfrom
Conversation
…labs#2232) TableRecon was refactored in v2 to remove source_schema, target_catalog, target_schema, and source_catalog fields. These are now configured via DatabaseConfig inside ReconcileConfig. The notebook documentation still showed the old v1 signature, causing `TypeError: TableRecon.__init__() got an unexpected keyword argument 'source_schema'` for users following the guide. - Update TableRecon dataclass signature in recon_notebook.mdx to show only `tables: list[Table]` - Remove old schema fields from the TableRecon usage example - Add a migration note pointing users to DatabaseConfig - Fix reconcile_configuration.mdx: `drop_columns` belongs to `Table`, not `TableRecon` Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #2327 +/- ##
=======================================
Coverage 66.41% 66.41%
=======================================
Files 99 99
Lines 9094 9094
Branches 974 974
=======================================
Hits 6040 6040
Misses 2878 2878
Partials 176 176 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Contributor
|
thank you, I cherry picked your commit here #2329 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Fixes #2232.
Users following the Running Reconcile on Notebook guide hit this error immediately:
Root cause
TableReconwas refactored in v2 (PR #2150) to remove the schema/catalog fields —source_schema,target_catalog,target_schema,source_catalog— which moved toDatabaseConfiginsideReconcileConfig. Av1_migrate()method was added to handle old YAML config files, but the notebook documentation was never updated, so users copy-pasting the examples get an immediate crash.Changes
recon_notebook.mdxTableRecondataclass signature to show onlytables: list[Table](the current v2 API)source_schema,target_catalog,target_schema) from theTableRecon(...)usage example:::notecallout explaining the migration so users upgrading from v1 understand what changed and where to put those values nowreconcile_configuration.mdxdrop_columnsexample was shown insideTableRecon(...)butdrop_columnsis actually a field onTable, notTableReconBefore / After
Before (causes crash):
After (correct v2 API):
🤖 Generated with Claude Code