OpenMetadata/openmetadata-docs/content/v1.3.x-SNAPSHOT/connectors/database/impala/yaml.md

title	slug
Run the Impala Connector Externally	/connectors/database/impala/yaml

Run the Impala Connector Externally

{% multiTablesWrapper %}

Feature	Status
Stage	PROD
Metadata	{% icon iconName="check" /%}
Query Usage	{% icon iconName="cross" /%}
Data Profiler	{% icon iconName="check" /%}
Data Quality	{% icon iconName="check" /%}
Stored Procedures	{% icon iconName="cross" /%}
DBT	{% icon iconName="check" /%}
Supported Versions	Impala >= 2.0

Feature	Status
Lineage	Partially via Views
Table-level	{% icon iconName="check" /%}
Column-level	{% icon iconName="check" /%}

{% /multiTablesWrapper %}

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

Configure and schedule Impala metadata and profiler workflows from the OpenMetadata UI:

• Requirements
• Metadata Ingestion
• Data Profiler
• dbt Integration

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

Requirements

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

Python Requirements

To run the Impala ingestion, you will need to install:

pip3 install "openmetadata-ingestion[impala]"

Metadata Ingestion

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

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 Hive:

{% codePreview %}

{% codeInfoContainer %}

Source Configuration - Service Connection

{% codeInfo srNumber=1 %}

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

{% /codeInfo %}

{% codeInfo srNumber=2 %}

password: User password.

{% /codeInfo %}

{% codeInfo srNumber=4 %}

authOptions: Enter the auth options string.

{% /codeInfo %}

{% codeInfo srNumber=5 %}

authMechanism: PLAIN, NOSASL, GSSAPI, LDAP or JWT

{% /codeInfo %}

{% codeInfo srNumber=6 %}

hostPort: Enter the fully qualified hostname and port number for your Hive deployment in the Host and Port field.

{% /codeInfo %}

Source Configuration - Source Config

{% codeInfo srNumber=8 %}

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

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

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

Advanced Configuration

{% codeInfo srNumber=6 %}

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

{% /codeInfo %}

{% codeInfo srNumber=7 %}

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

{% /codeInfo %}

{% /codeInfoContainer %}

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

source:
  type: impala
  serviceName: local_impala
  serviceConnection:
    config:
      type: Impala

      username: <username>

      password: <password>

      authOptions: <auth options>

      authMechanism: PLAIN # NOSASL, PLAIN, GSSAPI, LDAP, JWT

      hostPort: <hive connection host & port>

      # connectionOptions:
      #   key: value

      # connectionArguments:
      #   key: value

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

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

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

{% /codeBlock %}

{% /codePreview %}

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

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

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 %}