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

title	slug
Run the Domo Database Connector Externally	/connectors/database/domo-database/yaml

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

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

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

• Requirements
• Metadata Ingestion
• dbt Integration

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

Requirements

Note:

For metadata ingestion, kindly make sure add atleast data scopes to the clientId provided. Question related to scopes, click here.

Python Requirements

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

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

pip3 install "openmetadata-ingestion[domo]"

Metadata Ingestion

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

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

{% codePreview %}

{% codeInfoContainer %}

Source Configuration - Service Connection

{% codeInfo srNumber=1 %}

Client ID: Client ID to Connect to DOMODatabase.

{% /codeInfo %}

{% codeInfo srNumber=2 %}

Secret Token: Secret Token to Connect DOMODatabase.

{% /codeInfo %}

{% codeInfo srNumber=3 %}

Access Token: Access to Connect to DOMODatabase.

{% /codeInfo %}

{% codeInfo srNumber=4 %}

API Host: API Host to Connect to DOMODatabase instance.

{% /codeInfo %}

{% codeInfo srNumber=5 %}

Instance Domain: URL to connect to your Domo instance UI. For example https://<your>.domo.com.

{% /codeInfo %}

{% codeInfo srNumber=6 %}

database: Optional name to give to the database in OpenMetadata. If left blank, we will use default as the database name

{% /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=10 %}

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

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: domodatabase
  serviceName: local_DomoDatabase
  serviceConnection:
    config:
      type: DomoDashboard

      clientId: client-id

      secretToken: secret-token

      accessToken: access-token

      apiHost: api.domo.com

      instancexDomain: https://<your>.domo.com

      # database: database

      # connectionOptions:
      #   key: value

      # connectionArguments:
      #   key: value

{% 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" /%}

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