Skip to content

DOC-2210: Document SAP HANA connector (sap_hana input + hana driver)#464

Draft
JakeSCahill wants to merge 1 commit into
mainfrom
doc-2210-sap-hana
Draft

DOC-2210: Document SAP HANA connector (sap_hana input + hana driver)#464
JakeSCahill wants to merge 1 commit into
mainfrom
doc-2210-sap-hana

Conversation

@JakeSCahill

@JakeSCahill JakeSCahill commented Jul 20, 2026

Copy link
Copy Markdown
Contributor

What

Draft docs for the SAP HANA connector, per DOC-2210 (eng: ENG-1213). Two deliverables:

  • sap_hana input — new page documenting all reading modes, per-mode examples, schema_registry_encode auto-registration, metadata, permissions, and configuration fields.
  • hana driver for sql_insert/sql_raw — a self-managed-only SAP HANA section on sql_raw covering driver: hana and the distinctive UPSERT ... WITH PRIMARY KEY syntax.

⚠️ Draft — blocked on connect#4462

The connector is not yet merged (redpanda-data/connect#4462, not on main). This PR is intentionally a draft:

  • component_type_dropdown::[] is commented out until sap_hana lands in the upstream info.csv (same pattern as the iceberg page).
  • The configuration-fields table is hand-authored from the PR source; on merge, the auto-docs pipeline generates the standard field/example partials, which should replace it (TODO marker in the page).
  • No "Introduced in version" line — the source Version() tag is stale (4.92.0, already shipped without this feature); the real version is unknown until merge.

Changes

  • modules/components/pages/inputs/sap_hana.adoc (new)
  • modules/ROOT/nav.adoc — input nav entry
  • modules/components/pages/outputs/sql_raw.adocifndef::env-cloud[] SAP HANA section (self-managed only)

Verification

  • Config field tree, 5 modes, metadata, Enterprise gating, hana driver + DSN, and cloud=n all verified against connect#4462 source (internal/impl/saphana/, internal/impl/sql/conn_fields.go, internal/plugins/info.csv).
  • Local Antora build clean (no xref/CSV errors). Cloud gating confirmed: the SAP HANA sql_raw section renders in the connect build and is suppressed in cloud.

Findings for engineering / reviewers (from research)

  1. Modes: implementation has 5 modes (bulk, incrementing, query, timestamp, timestamp+incrementing), not the 3 in the ticket — docs describe all 5. Worth confirming the ticket/epic should be updated.
  2. Version: source Version("4.92.0") is stale — needs correcting at merge (see also the pattern of CON-513 for the jira input).
  3. Cloud: info.csv marks sap_hana cloud=n ("not yet certified for cloud"). No cloud-docs follow-up until that changes.
  4. Driver enum is shared — adding hana also enables it in sql_select and the sql processors, not just the two named outputs. Likely intended.
  5. TLS: no explicit tls field found; presumably DSN-param based — confirm.

Once the connector merges and docs regenerate, mark ready for review and swap the hand-authored fields table for the generated partial.

Draft docs for the SAP HANA connector (ENG-1213 / connect#4462, not yet
merged):

- New modules/components/pages/inputs/sap_hana.adoc: reading modes
  (bulk, incrementing, timestamp, timestamp+incrementing, query),
  examples for each mode plus schema_registry_encode auto-registration,
  metadata, permissions, and a hand-authored configuration-fields table
  (to be replaced by the generated partial once the connector ships).
- nav entry under Connect inputs.
- sql_raw: self-managed-only (ifndef::env-cloud) SAP HANA section
  showing driver: hana and the UPSERT ... WITH PRIMARY KEY syntax.

Enterprise, self-managed only (cloud=n). component_type_dropdown is
commented out until sap_hana lands in the upstream info.csv, matching
the iceberg pattern. Version intentionally omitted (source Version tag
is stale; real version unknown until merge).
@netlify

netlify Bot commented Jul 20, 2026

Copy link
Copy Markdown

Deploy Preview for redpanda-connect ready!

Name Link
🔨 Latest commit 1e6dc83
🔍 Latest deploy log https://app.netlify.com/projects/redpanda-connect/deploys/6a5e362255ea7d0008b42058
😎 Deploy Preview https://deploy-preview-464--redpanda-connect.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@coderabbitai

coderabbitai Bot commented Jul 20, 2026

Copy link
Copy Markdown
Contributor

Important

Review skipped

Draft detected.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 6644de83-e5ab-437b-a163-3db69d6e12dc

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch doc-2210-sap-hana

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

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.

1 participant