Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

230 lines
7.2 KiB
Markdown
Raw Permalink Normal View History

2024-06-18 15:53:06 +02:00
---
title: Run the Hive Connector Externally
slug: /connectors/database/hive/yaml
---
{% connectorDetailsHeader
name="Hive"
stage="PROD"
platform="OpenMetadata"
availableFeatures=["Metadata", "Data Profiler", "Data Quality", "View Lineage", "View Column-level Lineage", "dbt", "Sample Data"]
2024-06-18 15:53:06 +02:00
unavailableFeatures=["Query Usage", "Owners", "Tags", "Stored Procedures"]
/ %}
In this section, we provide guides and references to use the Hive connector.
Configure and schedule Hive metadata and profiler workflows from the OpenMetadata UI:
- [Requirements](#requirements)
- [Metadata Ingestion](#metadata-ingestion)
- [Data Profiler](#data-profiler)
- [Lineage](#lineage)
2024-06-18 15:53:06 +02:00
- [Data Quality](#data-quality)
- [dbt Integration](#dbt-integration)
- [Enable Security](#securing-hive-connection-with-ssl-in-openmetadata)
2024-06-18 15:53:06 +02:00
{% partial file="/v1.7/connectors/external-ingestion-deployment.md" /%}
2024-06-18 15:53:06 +02:00
## Requirements
### Python Requirements
{% partial file="/v1.7/connectors/python-requirements.md" /%}
2024-06-18 15:53:06 +02:00
To run the Hive ingestion, you will need to install:
```bash
pip3 install "openmetadata-ingestion[hive]"
```
## Metadata Ingestion
All connectors are defined as JSON Schemas.
[Here](https://github.com/open-metadata/OpenMetadata/blob/main/openmetadata-spec/src/main/resources/json/schema/entity/services/connections/database/hiveConnection.json)
you can find the structure to create a connection to Hive.
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](https://github.com/open-metadata/OpenMetadata/blob/main/openmetadata-spec/src/main/resources/json/schema/metadataIngestion/workflow.json)
### 1. Define the YAML Config
This is a sample config for Hive:
{% codePreview %}
{% codeInfoContainer %}
#### Source Configuration - Service Connection
{% codeInfo srNumber=1 %}
**username**: Specify the User to connect to Hive. It should have enough privileges to read all the metadata.
{% /codeInfo %}
{% codeInfo srNumber=2 %}
**password**: Password to connect to Hive.
{% /codeInfo %}
{% codeInfo srNumber=3 %}
**hostPort**: Enter the fully qualified hostname and port number for your Hive deployment in the Host and Port field.
{% /codeInfo %}
{% codeInfo srNumber=4 %}
**authOptions**: Enter the auth options string for hive connection.
{% /codeInfo %}
{% codeInfo srNumber=22 %}
#### For MySQL Metastore Connection:
You can also ingest the metadata using Mysql metastore. This step is optional if metastore details are not provided then we will query the hive server directly.
- **username**: Specify the User to connect to MySQL Metastore. It should have enough privileges to read all the metadata.
- **password**: Password to connect to MySQL.
- **hostPort**: Enter the fully qualified hostname and port number for your MySQL Metastore deployment in the Host and Port field in the format `hostname:port`.
- **databaseSchema**: Enter the database schema which is associated with the metastore.
{% /codeInfo %}
{% codeInfo srNumber=3 %}
#### For Postgres Metastore Connection:
You can also ingest the metadata using Postgres metastore. This step is optional if metastore details are not provided then we will query the hive server directly.
- **username**: Specify the User to connect to Postgres Metastore. It should have enough privileges to read all the metadata.
- **password**: Password to connect to Postgres.
- **hostPort**: Enter the fully qualified hostname and port number for your Postgres deployment in the Host and Port field in the format `hostname:port`.
- **database**: Initial Postgres database to connect to. Specify the name of database associated with metastore instance.
{% /codeInfo %}
{% partial file="/v1.7/connectors/yaml/database/source-config-def.md" /%}
2024-06-18 15:53:06 +02:00
{% partial file="/v1.7/connectors/yaml/ingestion-sink-def.md" /%}
2024-06-18 15:53:06 +02:00
{% partial file="/v1.7/connectors/yaml/workflow-config-def.md" /%}
2024-06-18 15:53:06 +02:00
#### Advanced Configuration
{% codeInfo srNumber=5 %}
**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.
2024-06-18 15:53:06 +02:00
{% /codeInfo %}
{% codeInfo srNumber=6 %}
**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.
2024-06-18 15:53:06 +02:00
- 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" %}
```yaml {% isCodeBlock=true %}
source:
type: hive
serviceName: local_hive
serviceConnection:
config:
type: Hive
```
```yaml {% srNumber=1 %}
username: <username>
```
```yaml {% srNumber=2 %}
password: <password>
```
```yaml {% srNumber=3 %}
authOptions: <auth options>
```
```yaml {% srNumber=4 %}
hostPort: <hive connection host & port>
```
```yaml {% srNumber=22 %}
# For MySQL Metastore Connection
# metastoreConnection:
# type: Mysql
# username: <username>
# authType:
# password: <password>
# hostPort: <hostPort>
# databaseSchema: metastore
```
```yaml {% srNumber=23 %}
# For Postgres Metastore Connection
# metastoreConnection:
# type: Postgres
# username: <username>
# authType:
# password: <password>
# hostPort: <hostPort>
# database: metastore
```
```yaml {% srNumber=5 %}
# connectionOptions:
# key: value
```
```yaml {% srNumber=6 %}
# connectionArguments:
# key: value
```
{% partial file="/v1.7/connectors/yaml/database/source-config.md" /%}
2024-06-18 15:53:06 +02:00
{% partial file="/v1.7/connectors/yaml/ingestion-sink.md" /%}
2024-06-18 15:53:06 +02:00
{% partial file="/v1.7/connectors/yaml/workflow-config.md" /%}
2024-06-18 15:53:06 +02:00
{% /codeBlock %}
{% /codePreview %}
{% partial file="/v1.7/connectors/yaml/ingestion-cli.md" /%}
2024-06-18 15:53:06 +02:00
{% partial file="/v1.7/connectors/yaml/lineage.md" variables={connector: "hive"} /%}
{% partial file="/v1.7/connectors/yaml/data-profiler.md" variables={connector: "hive"} /%}
2024-06-18 15:53:06 +02:00
{% partial file="/v1.7/connectors/yaml/auto-classification.md" variables={connector: "hive"} /%}
{% partial file="/v1.7/connectors/yaml/data-quality.md" /%}
2024-06-18 15:53:06 +02:00
## Securing Hive Connection with SSL in OpenMetadata
To configure SSL for secure connections between OpenMetadata and a Hive database, you need to add `ssl_cert` as a key and the path to the CA certificate as its value under `connectionArguments`. Ensure that the certificate is accessible by the server. If you use a Docker or Kubernetes deployment, update the CA certificate in the Open Metadata server.
```yaml
connectionArguments:
ssl_cert: /path/to/ca/cert
```
2024-06-18 15:53:06 +02:00
## 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 %}