Skip to content

fix: update Zerobus Ingest skill for SDK v1.1.0 breaking API changes#291

Merged
calreynolds merged 2 commits intodatabricks-solutions:mainfrom
yogesh-dbx:fix/zerobus-skill-v1.1.0
Mar 10, 2026
Merged

fix: update Zerobus Ingest skill for SDK v1.1.0 breaking API changes#291
calreynolds merged 2 commits intodatabricks-solutions:mainfrom
yogesh-dbx:fix/zerobus-skill-v1.1.0

Conversation

@yogesh-dbx
Copy link
Collaborator

@yogesh-dbx yogesh-dbx commented Mar 10, 2026

Summary

Fixes #290

The Zerobus Ingest skill generates code using SDK v0.2.x API signatures, but SDK v1.1.0 introduced breaking changes that cause runtime failures. All fixes verified through E2E testing.

Files changed: SKILL.md, 1-setup-and-authentication.md, 2-python-client.md

Changes

Breaking API fixes

  • Constructor: ZerobusSdk(server_endpoint, workspace_url)ZerobusSdk(host=server_endpoint, unity_catalog_url=workspace_url) (all sync, async, and reusable client examples)
  • Ingest pattern: ingest_record_offset(record) + wait_for_offset(offset)ingest_record(json.dumps(record)) + flush() (SKILL.md minimal example)
  • SDK version: >=0.2.0>=1.0.0
  • Status: Public Preview → GA (Feb 2026, Lakeflow Jobs Serverless SKU)
  • ingest_record note: Updated from "Deprecated" to "Primary method in SDK v1.1.0+"

New documentation

  • Serverless compute limitation (SDK can't pip-install; use classic clusters or REST API)
  • Explicit table-level grants requirement (Error 4024 / authorization_details OAuth flow)
  • REST API (Beta) as alternative for notebook-based ingestion

Minor fixes

  • Typos: "speficfied" → "specified", "Workslfow" → "Workflow"

Test plan

  • Verified constructor change via inspect.signature(ZerobusSdk.__init__)
  • E2E sync ingestion: ZerobusSdk(host=..., unity_catalog_url=...)create_stream()ingest_record(json.dumps(...))flush() → rows in Delta table
  • E2E async ingestion: same flow with await via zerobus.sdk.aio
  • REST API: POST /zerobus/v1/tables/{table}/insert on serverless compute
  • Confirmed StreamDestination (from blog) does NOT exist in v1.1.0
  • Confirmed SDK pip-install fails on serverless compute
  • Confirmed schema-level grants fail with Error 4024; explicit table grants succeed

yogesh-dbx and others added 2 commits March 10, 2026 10:55
SDK v1.1.0 introduces breaking changes from v0.2.x that cause skill-generated
code to fail at runtime. All changes verified through E2E testing.

Key fixes:
- Constructor: positional args -> keyword args (host=, unity_catalog_url=)
- Ingest pattern: ingest_record(json.dumps(record)) + flush()
- SDK version: >=0.2.0 -> >=1.0.0
- Status: Public Preview -> GA (Feb 2026)
- Add serverless compute limitation and REST API alternative
- Add explicit table grants requirement (Error 4024)
- Fix typos: "speficfied" -> "specified", "Workslfow" -> "Workflow"

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
The ZerobusSdk constructor works fine with positional args. The internal
parameter names changed in v1.1.0 but positional passing still works.
Reverted to match the official Databricks documentation.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Copy link
Collaborator

@calreynolds calreynolds left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice changes 👍

@calreynolds calreynolds merged commit 0fe561a into databricks-solutions:main Mar 10, 2026
1 of 2 checks passed
@calreynolds
Copy link
Collaborator

(Actually i saw the linter issues were unrelated, you're golden)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

fix: update Zerobus Ingest skill for SDK v1.1.0 (breaking API changes)

2 participants