Docs: Exasol Connector Addition (#19493)
* Docs: Exasol Connector Addition * Docs: Exasol Connector Addition * Docs: Exasol Connector Addition --------- Co-authored-by: Rounak Dhillon <rounakdhillon@Rounaks-MacBook-Air.local> Co-authored-by: Prajwal214 <167504578+Prajwal214@users.noreply.github.com>
@ -15,6 +15,7 @@
|
||||
{% connectorInfoCard name="Doris" stage="PROD" href="/connectors/database/doris" platform="OpenMetadata" / %}
|
||||
{% connectorInfoCard name="Druid" stage="PROD" href="/connectors/database/druid" platform="OpenMetadata" / %}
|
||||
{% connectorInfoCard name="DynamoDB" stage="PROD" href="/connectors/database/dynamodb" platform="OpenMetadata" / %}
|
||||
{% connectorInfoCard name="Exasol" stage="PROD" href="/connectors/database/exasol" platform="OpenMetadata" / %}
|
||||
{% connectorInfoCard name="GCS Datalake" stage="PROD" href="/connectors/database/gcs-datalake" platform="OpenMetadata" / %}
|
||||
{% connectorInfoCard name="Glue" stage="PROD" href="/connectors/database/glue" platform="OpenMetadata" / %}
|
||||
{% connectorInfoCard name="Greenplum" stage="BETA" href="/connectors/database/greenplum" platform="OpenMetadata" / %}
|
||||
|
||||
@ -17,6 +17,7 @@
|
||||
{% connectorInfoCard name="Doris" stage="PROD" href="/connectors/database/doris" platform="OpenMetadata" / %}
|
||||
{% connectorInfoCard name="Druid" stage="PROD" href="/connectors/database/druid" platform="OpenMetadata" / %}
|
||||
{% connectorInfoCard name="DynamoDB" stage="PROD" href="/connectors/database/dynamodb" platform="OpenMetadata" / %}
|
||||
{% connectorInfoCard name="Exasol" stage="PROD" href="/connectors/database/exasol" platform="OpenMetadata" / %}
|
||||
{% connectorInfoCard name="GCS Datalake" stage="PROD" href="/connectors/database/gcs-datalake" platform="OpenMetadata" / %}
|
||||
{% connectorInfoCard name="Glue" stage="PROD" href="/connectors/database/glue" platform="OpenMetadata" / %}
|
||||
{% connectorInfoCard name="Greenplum" stage="BETA" href="/connectors/database/greenplum" platform="OpenMetadata" / %}
|
||||
|
||||
@ -100,6 +100,10 @@ site_menu:
|
||||
url: /connectors/database/dynamodb
|
||||
- category: Connectors / Database / DynamoDB / Run Externally
|
||||
url: /connectors/database/dynamodb/yaml
|
||||
- category: Connectors / Database / Exasol
|
||||
url: /connectors/database/exasol
|
||||
- category: Connectors / Database / Exasol / Run Externally
|
||||
url: /connectors/database/exasol/yaml
|
||||
- category: Connectors / Database / GCS Datalake
|
||||
url: /connectors/database/gcs-datalake
|
||||
- category: Connectors / Database / GCS Datalake / Run Externally
|
||||
|
||||
@ -0,0 +1,98 @@
|
||||
---
|
||||
title: Exasol
|
||||
slug: /connectors/database/exasol
|
||||
---
|
||||
|
||||
{% connectorDetailsHeader
|
||||
name="Exasol"
|
||||
stage="PROD"
|
||||
platform="OpenMetadata"
|
||||
availableFeatures=["Metadata"]
|
||||
unavailableFeatures=["Query Usage", "Lineage", "Column-level Lineage", "Data Profiler", "Data Quality", "Owners", "dbt", "Tags", "Stored Procedures"]
|
||||
/ %}
|
||||
|
||||
|
||||
In this section, we provide guides and references for using the Exasol connector.
|
||||
|
||||
Configure and schedule Exasol metadata from the OpenMetadata UI:
|
||||
|
||||
- [Requirements](#requirements)
|
||||
- [Metadata Ingestion](#metadata-ingestion)
|
||||
|
||||
{% partial file="/v1.6/connectors/ingestion-modes-tiles.md" variables={yamlPath: "/connectors/database/exasol/yaml"} /%}
|
||||
|
||||
{% partial file="/v1.6/connectors/external-ingestion-deployment.md" /%}
|
||||
|
||||
{%inlineCallout icon="description" bold="OpenMetadata 1.6.1 or later" href="/deployment"%}
|
||||
To deploy OpenMetadata, check the Deployment guides.
|
||||
{%/inlineCallout%}
|
||||
|
||||
## Requirements
|
||||
|
||||
The connector requires **Exasol version 7.1 or higher** to function correctly. Ensure your Exasol instance meets this minimum version requirement before proceeding.
|
||||
|
||||
## Metadata Ingestion
|
||||
|
||||
{% partial
|
||||
file="/v1.6/connectors/metadata-ingestion-ui.md"
|
||||
variables={
|
||||
connector: "Exasol",
|
||||
selectServicePath: "/images/v1.6/connectors/exasol/select-service.png",
|
||||
addNewServicePath: "/images/v1.6/connectors/exasol/add-new-service.png",
|
||||
serviceConnectionPath: "/images/v1.6/connectors/exasol/service-connection.png",
|
||||
}
|
||||
/%}
|
||||
|
||||
{% stepsContainer %}
|
||||
{% extraContent parentTagName="stepsContainer" %}
|
||||
|
||||
#### Connection Options
|
||||
|
||||
### Connection Scheme
|
||||
Specifies the SQLAlchemy driver scheme options required to connect to Exasol.
|
||||
|
||||
### Username
|
||||
The username used to connect to the Exasol database. Ensure that this user has sufficient privileges to read all the metadata from Exasol.
|
||||
|
||||
### Password
|
||||
The password associated with the user connecting to Exasol.
|
||||
|
||||
### Host and Port
|
||||
Defines the host and port of the Exasol instance. Provide this as a string in the format `hostname:port`. For example:
|
||||
- `localhost:8563`
|
||||
- If running the OpenMetadata ingestion in a Docker container and your services are hosted on `localhost`, use `host.docker.internal:8563`.
|
||||
|
||||
### SSL/TLS Settings
|
||||
Specifies the mode or settings for SSL/TLS validation during the connection. Available options:
|
||||
|
||||
#### validate-certificate (Default)
|
||||
- Enables Transport Layer Security (TLS).
|
||||
- Validates the server certificate using system certificate stores.
|
||||
|
||||
#### ignore-certificate
|
||||
- Enables Transport Layer Security (TLS).
|
||||
- Disables validation of the server certificate.
|
||||
- **Note**: This mode should not be used in production. It is useful for testing with self-signed certificates.
|
||||
|
||||
#### disable-tls
|
||||
- Disables Transport Layer Security (TLS).
|
||||
- Data is sent in plain text (no encryption).
|
||||
- **Warning**: This mode is not recommended for production and should only be used in debugging scenarios.
|
||||
|
||||
{% note %}
|
||||
Ensure that the appropriate TLS setting is chosen based on your security and deployment requirements.
|
||||
{% /note %}
|
||||
|
||||
{% partial file="/v1.6/connectors/database/advanced-configuration.md" /%}
|
||||
|
||||
{% /extraContent %}
|
||||
|
||||
{% partial file="/v1.6/connectors/test-connection.md" /%}
|
||||
|
||||
{% partial file="/v1.6/connectors/database/configure-ingestion.md" /%}
|
||||
|
||||
{% partial file="/v1.6/connectors/ingestion-schedule-and-deploy.md" /%}
|
||||
|
||||
{% /stepsContainer %}
|
||||
|
||||
{% partial file="/v1.6/connectors/troubleshooting.md" /%}
|
||||
@ -0,0 +1,121 @@
|
||||
---
|
||||
title: Run the Exasol Connector Externally
|
||||
slug: /connectors/database/exasol/yaml
|
||||
---
|
||||
|
||||
{% connectorDetailsHeader
|
||||
name="Exasol"
|
||||
stage="PROD"
|
||||
platform="OpenMetadata"
|
||||
availableFeatures=["Metadata"]
|
||||
unavailableFeatures=["Query Usage", "Lineage", "Column-level Lineage", "Data Profiler", "Data Quality", "Owners", "dbt", "Tags", "Stored Procedures"]
|
||||
/ %}
|
||||
|
||||
In this section, we provide guides and references to use the Exasol connector.
|
||||
|
||||
Configure and schedule Exasol metadata and profiler workflows from the OpenMetadata UI:
|
||||
|
||||
- [Requirements](#requirements)
|
||||
- [Metadata Ingestion](#metadata-ingestion)
|
||||
|
||||
{% partial file="/v1.6/connectors/external-ingestion-deployment.md" /%}
|
||||
|
||||
## Requirements
|
||||
|
||||
### Python Requirements
|
||||
|
||||
{% partial file="/v1.6/connectors/python-requirements.md" /%}
|
||||
|
||||
To run the Exasol ingestion, you will need to install:
|
||||
|
||||
```bash
|
||||
pip3 install "openmetadata-ingestion[Exasol]"
|
||||
```
|
||||
|
||||
## Metadata Ingestion
|
||||
|
||||
### 1. Define the YAML Config
|
||||
|
||||
This is a sample config for Exasol:
|
||||
|
||||
{% codePreview %}
|
||||
|
||||
{% codeInfoContainer %}
|
||||
|
||||
#### Source Configuration - Service Connection
|
||||
|
||||
{% codeInfo srNumber=1 %}
|
||||
|
||||
**`SSL/TLS Settings`**
|
||||
Mode/setting for SSL validation:
|
||||
|
||||
- **`validate-certificate`**: Uses Transport Layer Security (TLS) and validates the server certificate using system certificate stores.
|
||||
|
||||
- **`ignore-certificate`**: Uses Transport Layer Security (TLS) but disables the validation of the server certificate. This should not be used in production. It can be useful during testing with self-signed certificates.
|
||||
|
||||
- **`disable-tls`**: Does not use any Transport Layer Security (TLS). Data will be sent in plain text (no encryption).
|
||||
While this may be helpful in rare cases of debugging, make sure you do not use this in production.
|
||||
|
||||
**`username`**
|
||||
The username required to authenticate and connect to the Exasol database. The user must have sufficient privileges to access and read all the metadata available in Exasol.
|
||||
|
||||
**`password`**
|
||||
The password associated with the user account used to connect to the Exasol database. Ensure this password corresponds to the specified username and is stored securely. Avoid sharing passwords in plain text and use secure methods for managing sensitive credentials.
|
||||
|
||||
**`hostPort`**
|
||||
Provide the fully qualified hostname and port number of your Exasol deployment in the "Host and Port" field.
|
||||
|
||||
{% /codeInfo %}
|
||||
|
||||
#### Advanced Configuration
|
||||
|
||||
{% codeInfo srNumber=2 %}
|
||||
|
||||
**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=3 %}
|
||||
|
||||
**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.
|
||||
|
||||
{% /codeInfo %}
|
||||
|
||||
{% /codeInfoContainer %}
|
||||
|
||||
{% codeBlock fileName="filename.yaml" %}
|
||||
|
||||
```yaml {% isCodeBlock=true %}
|
||||
source:
|
||||
type: exasol
|
||||
serviceName: "<service name>"
|
||||
serviceConnection:
|
||||
config:
|
||||
type: Exasol
|
||||
```
|
||||
```yaml {% srNumber=1 %}
|
||||
SSL/TLS Settings: validate-certificate (default), or ignore-certificate, or disable-tls
|
||||
hostPort: 127.0.0.1:8563
|
||||
username: Exasol
|
||||
password: password
|
||||
```
|
||||
```yaml {% srNumber=2 %}
|
||||
# connectionOptions:
|
||||
# key: value
|
||||
```
|
||||
```yaml {% srNumber=3 %}
|
||||
# connectionArguments:
|
||||
# key: value
|
||||
```
|
||||
|
||||
{% partial file="/v1.6/connectors/yaml/database/source-config.md" /%}
|
||||
|
||||
{% partial file="/v1.6/connectors/yaml/ingestion-sink.md" /%}
|
||||
|
||||
{% partial file="/v1.6/connectors/yaml/workflow-config.md" /%}
|
||||
|
||||
{% /codeBlock %}
|
||||
|
||||
{% /codePreview %}
|
||||
|
||||
{% partial file="/v1.6/connectors/yaml/ingestion-cli.md" /%}
|
||||
@ -300,6 +300,10 @@ site_menu:
|
||||
url: /connectors/database/dynamodb
|
||||
- category: Connectors / Database / DynamoDB / Run Externally
|
||||
url: /connectors/database/dynamodb/yaml
|
||||
- category: Connectors / Database / Exasol
|
||||
url: /connectors/database/exasol
|
||||
- category: Connectors / Database / Exasol / Run Externally
|
||||
url: /connectors/database/exasol/yaml
|
||||
- category: Connectors / Database / GCS Datalake
|
||||
url: /connectors/database/gcs-datalake
|
||||
- category: Connectors / Database / GCS Datalake / Run Externally
|
||||
|
||||
@ -108,6 +108,10 @@ site_menu:
|
||||
url: /connectors/database/dynamodb
|
||||
- category: Connectors / Database / DynamoDB / Run Externally
|
||||
url: /connectors/database/dynamodb/yaml
|
||||
- category: Connectors / Database / Exasol
|
||||
url: /connectors/database/exasol
|
||||
- category: Connectors / Database / Exasol / Run Externally
|
||||
url: /connectors/database/exasol/yaml
|
||||
- category: Connectors / Database / GCS Datalake
|
||||
url: /connectors/database/gcs-datalake
|
||||
- category: Connectors / Database / GCS Datalake / Run Externally
|
||||
|
||||
@ -0,0 +1,98 @@
|
||||
---
|
||||
title: Exasol
|
||||
slug: /connectors/database/exasol
|
||||
---
|
||||
|
||||
{% connectorDetailsHeader
|
||||
name="Exasol"
|
||||
stage="PROD"
|
||||
platform="OpenMetadata"
|
||||
availableFeatures=["Metadata"]
|
||||
unavailableFeatures=["Query Usage", "Lineage", "Column-level Lineage", "Data Profiler", "Data Quality", "Owners", "dbt", "Tags", "Stored Procedures"]
|
||||
/ %}
|
||||
|
||||
|
||||
In this section, we provide guides and references for using the Exasol connector.
|
||||
|
||||
Configure and schedule Exasol metadata from the OpenMetadata UI:
|
||||
|
||||
- [Requirements](#requirements)
|
||||
- [Metadata Ingestion](#metadata-ingestion)
|
||||
|
||||
{% partial file="/v1.7/connectors/ingestion-modes-tiles.md" variables={yamlPath: "/connectors/database/exasol/yaml"} /%}
|
||||
|
||||
{% partial file="/v1.7/connectors/external-ingestion-deployment.md" /%}
|
||||
|
||||
{%inlineCallout icon="description" bold="OpenMetadata 1.6.1 or later" href="/deployment"%}
|
||||
To deploy OpenMetadata, check the Deployment guides.
|
||||
{%/inlineCallout%}
|
||||
|
||||
## Requirements
|
||||
|
||||
The connector requires **Exasol version 7.1 or higher** to function correctly. Ensure your Exasol instance meets this minimum version requirement before proceeding.
|
||||
|
||||
## Metadata Ingestion
|
||||
|
||||
{% partial
|
||||
file="/v1.7/connectors/metadata-ingestion-ui.md"
|
||||
variables={
|
||||
connector: "Exasol",
|
||||
selectServicePath: "/images/v1.7/connectors/exasol/select-service.png",
|
||||
addNewServicePath: "/images/v1.7/connectors/exasol/add-new-service.png",
|
||||
serviceConnectionPath: "/images/v1.7/connectors/exasol/service-connection.png",
|
||||
}
|
||||
/%}
|
||||
|
||||
{% stepsContainer %}
|
||||
{% extraContent parentTagName="stepsContainer" %}
|
||||
|
||||
#### Connection Options
|
||||
|
||||
### Connection Scheme
|
||||
Specifies the SQLAlchemy driver scheme options required to connect to Exasol.
|
||||
|
||||
### Username
|
||||
The username used to connect to the Exasol database. Ensure that this user has sufficient privileges to read all the metadata from Exasol.
|
||||
|
||||
### Password
|
||||
The password associated with the user connecting to Exasol.
|
||||
|
||||
### Host and Port
|
||||
Defines the host and port of the Exasol instance. Provide this as a string in the format `hostname:port`. For example:
|
||||
- `localhost:8563`
|
||||
- If running the OpenMetadata ingestion in a Docker container and your services are hosted on `localhost`, use `host.docker.internal:8563`.
|
||||
|
||||
### SSL/TLS Settings
|
||||
Specifies the mode or settings for SSL/TLS validation during the connection. Available options:
|
||||
|
||||
#### validate-certificate (Default)
|
||||
- Enables Transport Layer Security (TLS).
|
||||
- Validates the server certificate using system certificate stores.
|
||||
|
||||
#### ignore-certificate
|
||||
- Enables Transport Layer Security (TLS).
|
||||
- Disables validation of the server certificate.
|
||||
- **Note**: This mode should not be used in production. It is useful for testing with self-signed certificates.
|
||||
|
||||
#### disable-tls
|
||||
- Disables Transport Layer Security (TLS).
|
||||
- Data is sent in plain text (no encryption).
|
||||
- **Warning**: This mode is not recommended for production and should only be used in debugging scenarios.
|
||||
|
||||
{% note %}
|
||||
Ensure that the appropriate TLS setting is chosen based on your security and deployment requirements.
|
||||
{% /note %}
|
||||
|
||||
{% partial file="/v1.7/connectors/database/advanced-configuration.md" /%}
|
||||
|
||||
{% /extraContent %}
|
||||
|
||||
{% partial file="/v1.7/connectors/test-connection.md" /%}
|
||||
|
||||
{% partial file="/v1.7/connectors/database/configure-ingestion.md" /%}
|
||||
|
||||
{% partial file="/v1.7/connectors/ingestion-schedule-and-deploy.md" /%}
|
||||
|
||||
{% /stepsContainer %}
|
||||
|
||||
{% partial file="/v1.7/connectors/troubleshooting.md" /%}
|
||||
@ -0,0 +1,121 @@
|
||||
---
|
||||
title: Run the Exasol Connector Externally
|
||||
slug: /connectors/database/exasol/yaml
|
||||
---
|
||||
|
||||
{% connectorDetailsHeader
|
||||
name="Exasol"
|
||||
stage="PROD"
|
||||
platform="OpenMetadata"
|
||||
availableFeatures=["Metadata"]
|
||||
unavailableFeatures=["Query Usage", "Lineage", "Column-level Lineage", "Data Profiler", "Data Quality", "Owners", "dbt", "Tags", "Stored Procedures"]
|
||||
/ %}
|
||||
|
||||
In this section, we provide guides and references to use the Exasol connector.
|
||||
|
||||
Configure and schedule Exasol metadata and profiler workflows from the OpenMetadata UI:
|
||||
|
||||
- [Requirements](#requirements)
|
||||
- [Metadata Ingestion](#metadata-ingestion)
|
||||
|
||||
{% partial file="/v1.7/connectors/external-ingestion-deployment.md" /%}
|
||||
|
||||
## Requirements
|
||||
|
||||
### Python Requirements
|
||||
|
||||
{% partial file="/v1.7/connectors/python-requirements.md" /%}
|
||||
|
||||
To run the Exasol ingestion, you will need to install:
|
||||
|
||||
```bash
|
||||
pip3 install "openmetadata-ingestion[Exasol]"
|
||||
```
|
||||
|
||||
## Metadata Ingestion
|
||||
|
||||
### 1. Define the YAML Config
|
||||
|
||||
This is a sample config for Exasol:
|
||||
|
||||
{% codePreview %}
|
||||
|
||||
{% codeInfoContainer %}
|
||||
|
||||
#### Source Configuration - Service Connection
|
||||
|
||||
{% codeInfo srNumber=1 %}
|
||||
|
||||
**`SSL/TLS Settings`**
|
||||
Mode/setting for SSL validation:
|
||||
|
||||
- **`validate-certificate`**: Uses Transport Layer Security (TLS) and validates the server certificate using system certificate stores.
|
||||
|
||||
- **`ignore-certificate`**: Uses Transport Layer Security (TLS) but disables the validation of the server certificate. This should not be used in production. It can be useful during testing with self-signed certificates.
|
||||
|
||||
- **`disable-tls`**: Does not use any Transport Layer Security (TLS). Data will be sent in plain text (no encryption).
|
||||
While this may be helpful in rare cases of debugging, make sure you do not use this in production.
|
||||
|
||||
**`username`**
|
||||
The username required to authenticate and connect to the Exasol database. The user must have sufficient privileges to access and read all the metadata available in Exasol.
|
||||
|
||||
**`password`**
|
||||
The password associated with the user account used to connect to the Exasol database. Ensure this password corresponds to the specified username and is stored securely. Avoid sharing passwords in plain text and use secure methods for managing sensitive credentials.
|
||||
|
||||
**`hostPort`**
|
||||
Provide the fully qualified hostname and port number of your Exasol deployment in the "Host and Port" field.
|
||||
|
||||
{% /codeInfo %}
|
||||
|
||||
#### Advanced Configuration
|
||||
|
||||
{% codeInfo srNumber=2 %}
|
||||
|
||||
**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=3 %}
|
||||
|
||||
**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.
|
||||
|
||||
{% /codeInfo %}
|
||||
|
||||
{% /codeInfoContainer %}
|
||||
|
||||
{% codeBlock fileName="filename.yaml" %}
|
||||
|
||||
```yaml {% isCodeBlock=true %}
|
||||
source:
|
||||
type: exasol
|
||||
serviceName: "<service name>"
|
||||
serviceConnection:
|
||||
config:
|
||||
type: Exasol
|
||||
```
|
||||
```yaml {% srNumber=1 %}
|
||||
SSL/TLS Settings: validate-certificate (default), or ignore-certificate, or disable-tls
|
||||
hostPort: 127.0.0.1:8563
|
||||
username: Exasol
|
||||
password: password
|
||||
```
|
||||
```yaml {% srNumber=2 %}
|
||||
# connectionOptions:
|
||||
# key: value
|
||||
```
|
||||
```yaml {% srNumber=3 %}
|
||||
# connectionArguments:
|
||||
# key: value
|
||||
```
|
||||
|
||||
{% partial file="/v1.7/connectors/yaml/database/source-config.md" /%}
|
||||
|
||||
{% partial file="/v1.7/connectors/yaml/ingestion-sink.md" /%}
|
||||
|
||||
{% partial file="/v1.7/connectors/yaml/workflow-config.md" /%}
|
||||
|
||||
{% /codeBlock %}
|
||||
|
||||
{% /codePreview %}
|
||||
|
||||
{% partial file="/v1.7/connectors/yaml/ingestion-cli.md" /%}
|
||||
@ -308,6 +308,10 @@ site_menu:
|
||||
url: /connectors/database/dynamodb
|
||||
- category: Connectors / Database / DynamoDB / Run Externally
|
||||
url: /connectors/database/dynamodb/yaml
|
||||
- category: Connectors / Database / Exasol
|
||||
url: /connectors/database/exasol
|
||||
- category: Connectors / Database / Exasol / Run Externally
|
||||
url: /connectors/database/exasol/yaml
|
||||
- category: Connectors / Database / GCS Datalake
|
||||
url: /connectors/database/gcs-datalake
|
||||
- category: Connectors / Database / GCS Datalake / Run Externally
|
||||
|
||||
BIN
openmetadata-docs/images/connectors/exasol.webp
Normal file
|
After Width: | Height: | Size: 4.1 KiB |
|
After Width: | Height: | Size: 149 KiB |
|
After Width: | Height: | Size: 301 KiB |
|
After Width: | Height: | Size: 486 KiB |
|
After Width: | Height: | Size: 149 KiB |
|
After Width: | Height: | Size: 301 KiB |
|
After Width: | Height: | Size: 486 KiB |