Connection Details

• Username: Specify the User to connect to Trino. It should have enough privileges to read all the metadata.
• Auth Config: 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:
    • Client ID: 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.
    • Client Secret: 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.
    • Tenant ID: 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
• Host and Port: Enter the fully qualified hostname and port number for your Trino deployment in the Host and Port field.
• Catalog: Trino offers a catalog feature where all the databases are stored.
• 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.
• proxies: Proxies for the connection to Trino data source
• params: URL parameters for connection to the Trino data source
• Connection Options (Optional): Enter the details for any additional connection options that can be sent to Trino during the connection. These details must be added as Key-Value pairs.
• Connection Arguments (Optional): Enter the details for any additional connection arguments such as security or protocol configs that can be sent to Trino 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"

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.

SSL Modes There are a 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. Find more details in the Python requests library documentation.

Advanced Configuration

Database Services have an Advanced Configuration section, where you can pass extra arguments to the connector and, if needed, change the connection Scheme.

This would only be required to handle advanced connectivity scenarios or customizations.

• 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.
• Connection Arguments (Optional): Enter the details for any additional connection arguments such as security or protocol configs that can be sent during the connection. These details must be added as Key-Value pairs.

Advanced Configuration

Metadata Ingestion Options

• Name: This field refers to the name of ingestion pipeline, you can customize the name or use the generated name.

• Database Filter Pattern (Optional): Use to database filter patterns to control whether or not to include database as part of metadata ingestion.

  • Include: Explicitly include databases by adding a list of comma-separated regular expressions to the Include field. OpenMetadata will include all databases with names matching one or more of the supplied regular expressions. All other databases will be excluded.
  • Exclude: Explicitly exclude databases by adding a list of comma-separated regular expressions to the Exclude field. OpenMetadata will exclude all databases with names matching one or more of the supplied regular expressions. All other databases will be included.

• Schema Filter Pattern (Optional): Use to schema filter patterns to control whether to include schemas as part of metadata ingestion.

  • Include: Explicitly include schemas by adding a list of comma-separated regular expressions to the Include field. OpenMetadata will include all schemas with names matching one or more of the supplied regular expressions. All other schemas will be excluded.
  • Exclude: Explicitly exclude schemas by adding a list of comma-separated regular expressions to the Exclude field. OpenMetadata will exclude all schemas with names matching one or more of the supplied regular expressions. All other schemas will be included.

• Table Filter Pattern (Optional): Use to table filter patterns to control whether to include tables as part of metadata ingestion.

  • Include: Explicitly include tables by adding a list of comma-separated regular expressions to the Include field. OpenMetadata will include all tables with names matching one or more of the supplied regular expressions. All other tables will be excluded.
  • Exclude: Explicitly exclude tables by adding a list of comma-separated regular expressions to the Exclude field. OpenMetadata will exclude all tables with names matching one or more of the supplied regular expressions. All other tables will be included.

• Enable Debug Log (toggle): Set the Enable Debug Log toggle to set the default log level to debug.

• Mark Deleted Tables (toggle): Set the Mark Deleted Tables toggle to flag tables as soft-deleted if they are not present anymore in the source system.

• Mark Deleted Tables from Filter Only (toggle): Set the Mark Deleted Tables from Filter Only toggle to flag tables as soft-deleted if they are not present anymore within the filtered schema or database only. This flag is useful when you have more than one ingestion pipelines. For example if you have a schema

• includeTables (toggle): Optional configuration to turn off fetching metadata for tables.

• includeViews (toggle): Set the Include views toggle to control whether to include views as part of metadata ingestion.

• includeTags (toggle): Set the 'Include Tags' toggle to control whether to include tags as part of metadata ingestion.

• includeOwners (toggle): Set the 'Include Owners' toggle to control whether to include owners to the ingested entity if the owner email matches with a user stored in the OM server as part of metadata ingestion. If the ingested entity already exists and has an owner, the owner will not be overwritten.

• includeStoredProcedures (toggle): Optional configuration to toggle the Stored Procedures ingestion.

• includeDDL (toggle): Optional configuration to toggle the DDL Statements ingestion.

• queryLogDuration (Optional): Configuration to tune how far we want to look back in query logs to process Stored Procedures results.

• queryParsingTimeoutLimit (Optional): Configuration to set the timeout for parsing the query in seconds.

• useFqnForFiltering (toggle): Regex will be applied on fully qualified name (e.g service_name.db_name.schema_name.table_name) instead of raw name (e.g. table_name).

• Incremental (Beta): Use Incremental Metadata Extraction after the first execution. This is done by getting the changed tables instead of all of them. Only Available for BigQuery, Redshift and Snowflake

  • Enabled: If True, enables Metadata Extraction to be Incremental.
  • lookback Days: Number of days to search back for a successful pipeline run. The timestamp of the last found successful pipeline run will be used as a base to search for updated entities.
  • Safety Margin Days: Number of days to add to the last successful pipeline run timestamp to search for updated entities.

• Threads (Beta): Use a Multithread approach for Metadata Extraction. You can define here the number of threads you would like to run concurrently. For further information please check the documentation on Metadata Ingestion - Multithreading

Note that the right-hand side panel in the OpenMetadata UI will also share useful documentation when configuring the ingestion.