SAP HANA Source Connector

Type

Source

Class

com.sap.kafka.connect.source.hana.HANASourceConnector

Target System

SAP HANA

Maintainer

SAP

License

Apache License 2.0

Project

github.com/SAP/kafka-connect-sap

Download

GitHub Releases

This page documents version 0.9.4. Newer versions should be compatible unless there are breaking changes, but field names or default values may differ. If you notice discrepancies, please contact Axual Support.

Description

The SAP HANA Source Connector reads data from an SAP HANA database and publishes records to Kafka topics.

These connectors are developed and maintained by SAP as part of the open-source github.com/SAP/kafka-connect-sap.

Features

  • Stream data from SAP HANA into Kafka topics

  • Works with Apache Kafka Connect framework

When to Use

  • You need to ingest data from SAP HANA into Kafka.

When NOT to Use

  • You need to write Kafka records into SAP HANA — use the SAP HANA Sink Connector instead.

  • You have not yet configured an SAP environment.

Installation

The connector is available from the GitHub Releases.

  1. Navigate to the releases page and select the version matching your Kafka Connect installation.

  2. Download the JAR file.

For installation steps, see Installing Connector Plugins.

Configuration

For the complete configuration reference, see the official source connector documentation.

To configure a connector in Axual Self-Service, see Starting Connectors. TIP: For Infrastructure-as-Code deployment, see the Axual Kafka Connect Boilerplates for Terraform and Management API boilerplates.

Getting Started

Prerequisites

SAP HANA instance

A configured SAP HANA environment is required before starting this connector. Consult the SAP Homepage for environment setup instructions and refer to the example scenarios for full configuration examples.

Axual stream

The stream where the connector will produce events must already exist in Axual Self-Service. See Creating streams if you need to create it.

Steps

Step 1 — Create a connector application

  1. Follow the Configure and install a connector documentation to set up a new Connector-Application.
    Let’s call it {application-name}.
    The plugin name is com.sap.kafka.connect.source.hana.HANASourceConnector.
    If a plugin isn’t available, ask a platform operator to install plugins.

Step 2 — Configure the connector

Consult the example scenarios for source configuration examples specific to your use case.

Step 3 — Start the connector

Start the connector application from Axual Self-Service.

Step 4 — Verify

In Axual Self-Service, use stream-browse on your target stream to confirm events are arriving.

Cleanup

When you are done:

  1. Stop the connector application in Axual Self-Service.

  2. Remove stream access for the application if no longer needed.

Known limitations

  • A configured SAP environment is required before starting this connector. No SAP setup guidance is provided in this document — refer to the SAP Homepage and the connector example scenarios.

Examples

Minimal configuration

{
  "name": "my-sap-hana-source",
  "config": {
    "connector.class": "com.sap.kafka.connect.source.hana.HANASourceConnector",
    "topics": "my_sap_topic",
    "connection.url": "jdbc:sap://sap-hana.example.com:39015/",
    "connection.user": "SAPCONNECT",
    "connection.password": "SapConn3ct!",
    "my_sap_topic.table.name": "SALES.\"ORDERS\""
  }
}

License

Sap source/sink connector is licensed under the Apache License, Version 2.0.