OpenMetadata/openmetadata-docs/content/v1.6.x-SNAPSHOT/connectors/database/trino/yaml.md

title	slug
Run the Trino Connector Externally	/connectors/database/trino/yaml

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

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

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

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

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

Requirements

Python Requirements

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

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

pip3 install "openmetadata-ingestion[trino]"

{% tilesContainer %}

To extract metadata, the user needs to be able to have SELECT privilege on all the tables that you would like to ingest in OpenMetadata as well as SELECT privilege system.metadata.table_comments table.

{% /tilesContainer %}

Metadata Ingestion

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

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

{% codePreview %}

{% codeInfoContainer %}

Source Configuration - Service Connection

{% codeInfo srNumber=1 %}

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

{% /codeInfo %}

{% codeInfo srNumber=2 %}

• authType: User can authenticate the Trino Instance with auth type as Basic Authentication i.e. Password or by using JWT Authentication.
  • Basic Auth:
    • password: Password to connect to Trino.
  • JWT Auth Config:
    • jwt: JWT can be used to authenticate with trino. Follow the steps in the official trino documentation to setup trino with jwt.
  • Azure:
    • clientId: To get the Client ID (also known as application ID), follow these steps:
      1. Log into Microsoft Azure.
      2. Search for App registrations and select the App registrations link.
      3. Select the Azure AD app you're using for Trino.
      4. From the Overview section, copy the Application (client) ID.
    • clientSecret: To get the client secret, follow these steps:
      1. Log into Microsoft Azure.
      2. Search for App registrations and select the App registrations link.
      3. Select the Azure AD app you're using for Trino.
      4. Under Manage, select Certificates & secrets.
      5. Under Client secrets, select New client secret.
      6. In the Add a client secret pop-up window, provide a description for your application secret. Choose when the application should expire, and select Add.
      7. From the Client secrets section, copy the string in the Value column of the newly created application secret.
    • tenantId: To get the tenant ID, follow these steps:
      1. Log into Microsoft Azure.
      2. Search for App registrations and select the App registrations link.
      3. Select the Azure AD app you're using for Trino.
      4. From the Overview section, copy the Directory (tenant) ID.
    • scopes: To let OM use the Trino Auth APIs using your Azure AD app, you'll need to add the scope
      1. Log into Microsoft Azure.
      2. Search for App registrations and select the App registrations link.
      3. Select the Azure AD app you're using for Trino.
      4. From the Expose an API section, copy the Application ID URI
      5. Make sure the URI ends with /.default in case it does not, you can append the same manually

{% /codeInfo %}

{% codeInfo srNumber=3 %}

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

{% /codeInfo %} {% codeInfo srNumber=4 %}

catalog: Trino offers a catalog feature where all the databases are stored.

{% /codeInfo %} {% codeInfo srNumber=5 %}

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

{% /codeInfo %} {% codeInfo srNumber=6 %}

proxies: Proxies for the connection to Trino data source

{% /codeInfo %} {% codeInfo srNumber=7 %}

params: URL parameters for connection to the Trino data source

{% /codeInfo %}

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

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

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

Advanced Configuration

{% codeInfo srNumber=8 %}

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

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: trino
  serviceName: <service name>
  serviceConnection:
    config:
      type: Trino

      hostPort: <hostPort>

      username: <username>

      authType:
      # For basic auth
        password: password
      # # For JWT auth
      #   jwt: jwt_token
      #   azureConfig:
      #     clientId: your-client-id
      #     clientSecret: your-client-secret
      #     tenantId: your-tenant-id
      #     scopes: https://your-scope/.default

      catalog: <catalog>

      # databaseSchema: schema

      # proxies:
      #   http: http_proxy
      #   https: https_proxy

      # We can add URL parameters if needed
      # params:
      #   key: value

      # connectionOptions:
      #   key: value

      # connectionArguments:
      #   key: value
      #   http_scheme: http  # required when connecting over HTTP

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

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

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

{% /codeBlock %}

{% /codePreview %}

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

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

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

SSL Configuration

In order to integrate SSL in the Metadata Ingestion Config, the user will have to add the SSL config under connectionArguments which is placed in source.

{% codePreview %}

{% codeInfoContainer %}

{% codeInfo srNumber=25 %}

SSL Modes

There are couple of types of SSL modes that redshift supports which can be added to ConnectionArguments, they are as follows:

• false: In order to disable SSL verification, set the verify parameter to False.
• <path-to-crt>: To use self-signed certificates, specify a path to the certificate in verify parameter. More details can be found in the Python requests library documentation.

{% /codeInfo %}

{% /codeInfoContainer %}

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

source:
  type: trino
  serviceName: <service name>
  serviceConnection:
    config:
      type: Trino
      hostPort: <hostPort>
      username: <username>
      catalog: <catalog>
      ...
      ...
      connectionArguments:
        verify: <verify-mode>

{% /codeBlock %} {% /codePreview %}

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