Skip to content

docs(cdc): document Debezium push ingest (from: cdc:, no Kafka)#1961

Merged
lukekim merged 1 commit into
trunkfrom
docs-cdc-debezium-push-ingest
Jul 23, 2026
Merged

docs(cdc): document Debezium push ingest (from: cdc:, no Kafka)#1961
lukekim merged 1 commit into
trunkfrom
docs-cdc-debezium-push-ingest

Conversation

@claudespice

Copy link
Copy Markdown
Collaborator

Summary

Documents the new push-based Debezium CDC ingest path shipped in spiceai/spiceai#11955: any Debezium source plugin (Debezium Server / Embedded Engine) can stream change events directly into a Spice-accelerated dataset over HTTPfrom: cdc:<name> + POST /v1/datasets/{name}/cdc, JSON or Avro — with no Kafka bus. The existing Kafka debezium: connector path is unchanged.

New content (vNext / website/docs only — this feature is not in any released version):

  • New page features/cdc/debezium-ingest.md — architecture, spicepod config, HTTP API (content types, JSON/Avro body shapes, response + full status-code table), Debezium Server sink example, native-vs-push comparison, feature availability.
  • Adds the push-ingest path to the Supported Data Connectors list in features/cdc/index.md.

Verified against source (origin/trunk)

  • Route POST /v1/datasets/{name}/cdc and status mapping (200/400/403/404/501/503/504) from crates/runtime/src/http/v1/cdc.rs and routes.rs.
  • Params are declared ParameterSpec::component under prefix() = "cdc", so the user-facing keys are cdc_schema_registry_url / cdc_avro_schema (the runtime ignores the unprefixed form with a warning — runtime-parameters/src/lib.rs). The source PR's own draft doc used the bare keys; this page uses the prefixed form.
  • debezium is in the spiced default feature set (bin/spiced/Cargo.toml) and the released images build with defaults (--features release,models, no --no-default-features), so "included in default builds" is accurate — no Enterprise callout needed. A build without the feature returns 501.

Source PRs

Test plan

  • cd website && npm run build passes (exit 0, no broken-link/undefined-tag errors)
  • New links resolve: ./index.md, ./debezium.md, ../../api/auth/index.md, ../../components/data-accelerators/arrow/index.md
  • vNext-only (addition — feature absent from released versions), no versioned-docs propagation
  • Files updated: 2

New feature from spiceai/spiceai#11955: any Debezium source plugin can
stream change events directly into a Spice-accelerated dataset over HTTP
(POST /v1/datasets/{name}/cdc), JSON or Avro, with no Kafka bus.

- Add website/docs/features/cdc/debezium-ingest.md (new page)
- List the push-ingest path in the CDC Supported Data Connectors section

Params documented with the runtime-required cdc_ prefix
(cdc_schema_registry_url, cdc_avro_schema) — the connector uses
ParameterSpec::component, so the unprefixed form is silently ignored.
@github-actions

github-actions Bot commented Jul 23, 2026

Copy link
Copy Markdown
Contributor

✅ Pull with Spice Passed

Passing checks:

  • ✅ Title meets minimum length requirement (10 characters)
  • ✅ Has at least one of the required labels: area/blog, area/docs, area/cookbook, dependencies
  • ✅ No banned labels detected
  • ✅ Has at least one assignee: claudespice

@github-actions

Copy link
Copy Markdown
Contributor

🔍 Pull with Spice Failed

Passing checks:

  • ✅ Title meets minimum length requirement (10 characters)
  • ✅ Has at least one of the required labels: area/blog, area/docs, area/cookbook, dependencies
  • ✅ No banned labels detected

Failed checks:

  • ❌ At least one assignee is required for this pull request.

Please address these issues and update your pull request.

1 similar comment
@github-actions

Copy link
Copy Markdown
Contributor

🔍 Pull with Spice Failed

Passing checks:

  • ✅ Title meets minimum length requirement (10 characters)
  • ✅ Has at least one of the required labels: area/blog, area/docs, area/cookbook, dependencies
  • ✅ No banned labels detected

Failed checks:

  • ❌ At least one assignee is required for this pull request.

Please address these issues and update your pull request.

@github-actions

Copy link
Copy Markdown
Contributor

🚀 deployed to https://3d3833dd.spiceai-org-website.pages.dev

@lukekim
lukekim merged commit 6afc77d into trunk Jul 23, 2026
6 of 10 checks passed
@lukekim
lukekim deleted the docs-cdc-debezium-push-ingest branch July 23, 2026 14:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants