mirror of
https://github.com/open-metadata/OpenMetadata.git
synced 2025-07-18 22:53:09 +00:00
346 lines
9.5 KiB
Markdown
346 lines
9.5 KiB
Markdown
---
|
|
title: Run DomoDatabase Connector using the CLI
|
|
slug: /connectors/database/domo-database/cli
|
|
---
|
|
|
|
# Run Domo Database using the metadata CLI
|
|
|
|
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](#requirements)
|
|
- [Metadata Ingestion](#metadata-ingestion)
|
|
- [Data Profiler](#data-profiler)
|
|
- [dbt Integration](#dbt-integration)
|
|
|
|
## Requirements
|
|
|
|
<InlineCallout color="violet-70" icon="description" bold="OpenMetadata 0.12 or later" href="/deployment">
|
|
To deploy OpenMetadata, check the <a href="/deployment">Deployment</a> guides.
|
|
</InlineCallout>
|
|
|
|
To run the Ingestion via the UI you'll need to use the OpenMetadata Ingestion Container, which comes shipped with
|
|
custom Airflow plugins to handle the workflow deployment.
|
|
|
|
### Python Requirements
|
|
|
|
To run the DomoDatabase ingestion, you will need to install:
|
|
|
|
```bash
|
|
pip3 install "openmetadata-ingestion[domo]"
|
|
```
|
|
|
|
## 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/athenaConnection.json)
|
|
you can find the structure to create a connection to DomoDatbase.
|
|
|
|
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 DomoDatabase:
|
|
|
|
```yaml
|
|
source:
|
|
type: domodatabase
|
|
serviceName: local_domodatabase
|
|
serviceConnection:
|
|
config:
|
|
type: DomoDatabase
|
|
clientId: clientid
|
|
secretToken: secret-token
|
|
accessToken: access-token
|
|
apiHost: api.domo.com
|
|
sandboxDomain: https://<api_domo>.domo.com
|
|
sourceConfig:
|
|
config:
|
|
type: DatabaseMetadata
|
|
sink:
|
|
type: metadata-rest
|
|
config: {}
|
|
workflowConfig:
|
|
# loggerLevel: DEBUG # DEBUG, INFO, WARN or ERROR
|
|
openMetadataServerConfig:
|
|
hostPort: <OpenMetadata host and port>
|
|
authProvider: <OpenMetadata auth provider>
|
|
|
|
```
|
|
|
|
#### Source Configuration - Service Connection
|
|
|
|
- **Client ID**: Client ID to Connect to DOMO Database.
|
|
- **Secret Token**: Secret Token to Connect DOMO Database.
|
|
- **Access Token**: Access to Connect to DOMO Database.
|
|
- **API Host**: API Host to Connect to DOMO Database instance.
|
|
- **SandBox Domain**: Connect to SandBox Domain.
|
|
|
|
#### Source Configuration - Source Config
|
|
|
|
The `sourceConfig` is defined [here](https://github.com/open-metadata/OpenMetadata/blob/main/openmetadata-spec/src/main/resources/json/schema/metadataIngestion/databaseServiceMetadataPipeline.json):
|
|
|
|
- `markDeletedTables`: To flag tables as soft-deleted if they are not present anymore in the source system.
|
|
- `includeTables`: true or false, to ingest table data. Default is true.
|
|
- `includeViews`: true or false, to ingest views definitions.
|
|
- `databaseFilterPattern`, `schemaFilterPattern`, `tableFilternPattern`: Note that the they support regex as include or exclude. E.g.,
|
|
|
|
```yaml
|
|
tableFilterPattern:
|
|
includes:
|
|
- users
|
|
- type_test
|
|
```
|
|
|
|
#### Sink Configuration
|
|
|
|
To send the metadata to OpenMetadata, it needs to be specified as `type: metadata-rest`.
|
|
|
|
#### Workflow Configuration
|
|
|
|
The main property here is the `openMetadataServerConfig`, where you can define the host and security provider of your OpenMetadata installation.
|
|
|
|
For a simple, local installation using our docker containers, this looks like:
|
|
|
|
```yaml
|
|
workflowConfig:
|
|
openMetadataServerConfig:
|
|
hostPort: 'http://localhost:8585/api'
|
|
authProvider: openmetadata
|
|
securityConfig:
|
|
jwtToken: '{bot_jwt_token}'
|
|
```
|
|
|
|
We support different security providers. You can find their definitions [here](https://github.com/open-metadata/OpenMetadata/tree/main/openmetadata-spec/src/main/resources/json/schema/security/client).
|
|
You can find the different implementation of the ingestion below.
|
|
|
|
<Collapse title="Configure SSO in the Ingestion Workflows">
|
|
|
|
### Openmetadata JWT Auth
|
|
|
|
```yaml
|
|
workflowConfig:
|
|
openMetadataServerConfig:
|
|
hostPort: 'http://localhost:8585/api'
|
|
authProvider: openmetadata
|
|
securityConfig:
|
|
jwtToken: '{bot_jwt_token}'
|
|
```
|
|
|
|
### Auth0 SSO
|
|
|
|
```yaml
|
|
workflowConfig:
|
|
openMetadataServerConfig:
|
|
hostPort: 'http://localhost:8585/api'
|
|
authProvider: auth0
|
|
securityConfig:
|
|
clientId: '{your_client_id}'
|
|
secretKey: '{your_client_secret}'
|
|
domain: '{your_domain}'
|
|
```
|
|
|
|
### Azure SSO
|
|
|
|
```yaml
|
|
workflowConfig:
|
|
openMetadataServerConfig:
|
|
hostPort: 'http://localhost:8585/api'
|
|
authProvider: azure
|
|
securityConfig:
|
|
clientSecret: '{your_client_secret}'
|
|
authority: '{your_authority_url}'
|
|
clientId: '{your_client_id}'
|
|
scopes:
|
|
- your_scopes
|
|
```
|
|
|
|
### Custom OIDC SSO
|
|
|
|
```yaml
|
|
workflowConfig:
|
|
openMetadataServerConfig:
|
|
hostPort: 'http://localhost:8585/api'
|
|
authProvider: custom-oidc
|
|
securityConfig:
|
|
clientId: '{your_client_id}'
|
|
secretKey: '{your_client_secret}'
|
|
domain: '{your_domain}'
|
|
```
|
|
|
|
### Google SSO
|
|
|
|
```yaml
|
|
workflowConfig:
|
|
openMetadataServerConfig:
|
|
hostPort: 'http://localhost:8585/api'
|
|
authProvider: google
|
|
securityConfig:
|
|
secretKey: '{path-to-json-creds}'
|
|
```
|
|
|
|
### Okta SSO
|
|
|
|
```yaml
|
|
workflowConfig:
|
|
openMetadataServerConfig:
|
|
hostPort: http://localhost:8585/api
|
|
authProvider: okta
|
|
securityConfig:
|
|
clientId: "{CLIENT_ID - SPA APP}"
|
|
orgURL: "{ISSUER_URL}/v1/token"
|
|
privateKey: "{public/private keypair}"
|
|
email: "{email}"
|
|
scopes:
|
|
- token
|
|
```
|
|
|
|
### Amazon Cognito SSO
|
|
|
|
The ingestion can be configured by [Enabling JWT Tokens](https://docs.open-metadata.org/deployment/security/enable-jwt-tokens)
|
|
|
|
```yaml
|
|
workflowConfig:
|
|
openMetadataServerConfig:
|
|
hostPort: 'http://localhost:8585/api'
|
|
authProvider: auth0
|
|
securityConfig:
|
|
clientId: '{your_client_id}'
|
|
secretKey: '{your_client_secret}'
|
|
domain: '{your_domain}'
|
|
```
|
|
|
|
### OneLogin SSO
|
|
|
|
Which uses Custom OIDC for the ingestion
|
|
|
|
```yaml
|
|
workflowConfig:
|
|
openMetadataServerConfig:
|
|
hostPort: 'http://localhost:8585/api'
|
|
authProvider: custom-oidc
|
|
securityConfig:
|
|
clientId: '{your_client_id}'
|
|
secretKey: '{your_client_secret}'
|
|
domain: '{your_domain}'
|
|
```
|
|
|
|
### KeyCloak SSO
|
|
|
|
Which uses Custom OIDC for the ingestion
|
|
|
|
```yaml
|
|
workflowConfig:
|
|
openMetadataServerConfig:
|
|
hostPort: 'http://localhost:8585/api'
|
|
authProvider: custom-oidc
|
|
securityConfig:
|
|
clientId: '{your_client_id}'
|
|
secretKey: '{your_client_secret}'
|
|
domain: '{your_domain}'
|
|
```
|
|
|
|
</Collapse>
|
|
|
|
### 2. Run with the CLI
|
|
|
|
First, we will need to save the YAML file. Afterward, and with all requirements installed, we can run:
|
|
|
|
```bash
|
|
metadata ingest -c <path-to-yaml>
|
|
```
|
|
|
|
Note that from connector to connector, this recipe will always be the same. By updating the YAML configuration,
|
|
you will be able to extract metadata from different sources.
|
|
|
|
|
|
### 1. Define the YAML Config
|
|
|
|
This is a sample config for the profiler:
|
|
|
|
```yaml
|
|
source:
|
|
type: domodatabase
|
|
serviceName: <service name>
|
|
serviceConnection:
|
|
config:
|
|
type: DomoDatabase
|
|
type: DomoDashboard
|
|
clientId: client-id
|
|
secretToken: secret-token
|
|
accessToken: access-token
|
|
apiHost: api.domo.com
|
|
sandboxDomain: https://<api_domo>.domo.com
|
|
# endPointURL: https://athena.us-east-2.amazonaws.com/
|
|
# awsSessionToken: TOKEN
|
|
s3StagingDir: s3 directory for datasource
|
|
workgroup: workgroup name
|
|
sourceConfig:
|
|
config:
|
|
type: Profiler
|
|
# generateSampleData: true
|
|
# profileSample: 85
|
|
# threadCount: 5 (default)
|
|
# databaseFilterPattern:
|
|
# includes:
|
|
# - database1
|
|
# - database2
|
|
# excludes:
|
|
# - database3
|
|
# - database4
|
|
# schemaFilterPattern:
|
|
# includes:
|
|
# - schema1
|
|
# - schema2
|
|
# excludes:
|
|
# - schema3
|
|
# - schema4
|
|
# tableFilterPattern:
|
|
# includes:
|
|
# - table1
|
|
# - table2
|
|
# excludes:
|
|
# - table3
|
|
# - table4
|
|
- ...
|
|
sink:
|
|
type: metadata-rest
|
|
config: {}
|
|
workflowConfig:
|
|
# loggerLevel: DEBUG # DEBUG, INFO, WARN or ERROR
|
|
openMetadataServerConfig:
|
|
hostPort: <OpenMetadata host and port>
|
|
authProvider: <OpenMetadata auth provider>
|
|
```
|
|
|
|
#### Source Configuration
|
|
|
|
- You can find all the definitions and types for the `serviceConnection` [here](https://github.com/open-metadata/OpenMetadata/blob/main/openmetadata-spec/src/main/resources/json/schema/entity/services/connections/database/athenaConnection.json).
|
|
- The `sourceConfig` is defined [here](https://github.com/open-metadata/OpenMetadata/blob/main/openmetadata-spec/src/main/resources/json/schema/metadataIngestion/databaseServiceProfilerPipeline.json).
|
|
|
|
Note that the filter patterns support regex as includes or excludes. E.g.,
|
|
|
|
```yaml
|
|
tableFilterPattern:
|
|
includes:
|
|
- *users$
|
|
```
|
|
#### Workflow Configuration
|
|
|
|
The same as the metadata ingestion.
|
|
|
|
### 2. Run with the CLI
|
|
|
|
After saving the YAML config, we will run the command the same way we did for the metadata ingestion:
|
|
|
|
```bash
|
|
metadata profile -c <path-to-yaml>
|
|
```
|
|
|
|
Note how instead of running `ingest`, we are using the `profile` command to select the Profiler workflow.
|