OpenMetadata/openmetadata-docs/content/v1.4.x/connectors/database/sap-hana/yaml.md

title	slug
Run the SAP Hana Connector Externally	/connectors/database/sap-hana/yaml

{% connectorDetailsHeader name="SAP Hana" stage="PROD" platform="OpenMetadata" availableFeatures=["Metadata", "Data Profiler", "Data Quality", "View Lineage", "View Column-level Lineage", "dbt"] unavailableFeatures=["Query Usage", "Stored Procedures", "Owners", "Tags"] / %}

In this section, we provide guides and references to use the SAP Hana connector.

Configure and schedule SAP Hana metadata and profiler workflows from the OpenMetadata UI:

• Requirements
• Metadata Ingestion
• Data Profiler
• Data Quality
• dbt Integration

{% partial file="/v1.4/connectors/external-ingestion-deployment.md" /%}

Requirements

{%inlineCallout icon="description" bold="OpenMetadata 1.1 or later" href="/deployment"%} To deploy OpenMetadata, check the Deployment guides. {%/inlineCallout%}

{% note %} The connector is compatible with HANA or HANA express versions since HANA SPS 2. {% /note %}

Python Requirements

{% partial file="/v1.4/connectors/python-requirements.md" /%}

To run the SAP Hana ingestion, you will need to install:

pip3 install "openmetadata-ingestion[sap-hana]"

Metadata Ingestion

All connectors are defined as JSON Schemas. Here you can find the structure to create a connection to SAP Hana.

In order to create and run a Metadata Ingestion workflow, we will follow the steps to create a YAML configuration able to connect to the source, process the Entities if needed, and reach the OpenMetadata server.

The workflow is modeled around the following JSON Schema

1. Define the YAML Config

This is a sample config for SAP Hana:

{% codePreview %}

{% codeInfoContainer %}

Source Configuration - Service Connection

We support two possible connection types:

1. SQL Connection, where you will the username, password and host.
2. HDB User Store connection. Note that the HDB Store will need to be locally available to the instance running the ingestion process. If you are unsure about this setting, you can run the ingestion process passing the usual SQL connection details.

SQL Connection

If using the SQL Connection, inform:

{% codeInfo srNumber=1 %}

hostPort: Host and port of the SAP Hana service. This should be specified as a string in the format hostname:port. E.g., localhost:39041, host.docker.internal:39041.

{% /codeInfo %}

{% codeInfo srNumber=2 %}

username: Specify the User to connect to SAP Hana. It should have enough privileges to read all the metadata.

{% /codeInfo %}

{% codeInfo srNumber=3 %}

password: Password to connect to SAP Hana.

{% /codeInfo %}

{% codeInfo srNumber=4 %}

database: Optional parameter to connect to a specific database.

{% /codeInfo %}

{% codeInfo srNumber=5 %}

databaseSchema: databaseSchema of the data source. This is an optional parameter, if you would like to restrict the metadata reading to a single schema. When left blank, OpenMetadata Ingestion attempts to scan all the schemas.

{% /codeInfo %}

HDB User Store

If you have a User Store configured, then:

{% codeInfo srNumber=6 %}

userKey: HDB Store User Key generated from the command hdbuserstore SET <KEY> <host:port> <USERNAME> <PASSWORD>.

{% /codeInfo %}

{% partial file="/v1.4/connectors/yaml/database/source-config-def.md" /%}

{% partial file="/v1.4/connectors/yaml/ingestion-sink-def.md" /%}

{% partial file="/v1.4/connectors/yaml/workflow-config-def.md" /%}

Advanced Configuration

{% codeInfo srNumber=7 %}

Connection Options (Optional): Enter the details for any additional connection options that can be sent to database during the connection. These details must be added as Key-Value pairs.

{% /codeInfo %}

{% codeInfo srNumber=8 %}

Connection Arguments (Optional): Enter the details for any additional connection arguments such as security or protocol configs that can be sent to database during the connection. These details must be added as Key-Value pairs.

• In case you are using Single-Sign-On (SSO) for authentication, add the authenticator details in the Connection Arguments as a Key-Value pair as follows: "authenticator" : "sso_login_url"

{% /codeInfo %}

{% /codeInfoContainer %}

{% codeBlock fileName="filename.yaml" %}

source:
  type: sapHana
  serviceName: <service name>
  serviceConnection:
    config:
      type: SapHana
      connection:

        ## Parameters for the SQL Connection
        # hostPort: <hostPort>

        # username: <username>

        # password: <password>

        # database: <database>

        # databaseSchema: <schema>

        ## Parameter for the HDB User Store
        # userKey: <key>

      # connectionOptions:
      #   key: value

      # connectionArguments:
      #   key: value

{% partial file="/v1.4/connectors/yaml/database/source-config.md" /%}

{% partial file="/v1.4/connectors/yaml/ingestion-sink.md" /%}

{% partial file="/v1.4/connectors/yaml/workflow-config.md" /%}

{% /codeBlock %}

{% /codePreview %}

{% partial file="/v1.4/connectors/yaml/ingestion-cli.md" /%}

{% partial file="/v1.4/connectors/yaml/data-profiler.md" variables={connector: "sapHana"} /%}

{% partial file="/v1.4/connectors/yaml/data-quality.md" /%}

dbt Integration

{% tilesContainer %}

{% tile icon="mediation" title="dbt Integration" description="Learn more about how to ingest dbt models' definitions and their lineage." link="/connectors/ingestion/workflows/dbt" /%}

{% /tilesContainer %}