Docs: Exasol Connector CHANGES (#19494)

Co-authored-by: Rounak Dhillon <rounakdhillon@Rounaks-MacBook-Air.local>
This commit is contained in:
RounakDhillon 2025-01-23 18:05:08 +05:30 committed by GitHub
parent c7d66b6ba6
commit a5bf0f19ea
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
4 changed files with 52 additions and 68 deletions

View File

@ -46,38 +46,30 @@ The connector requires **Exasol version 7.1 or higher** to function correctly. E
{% stepsContainer %} {% stepsContainer %}
{% extraContent parentTagName="stepsContainer" %} {% extraContent parentTagName="stepsContainer" %}
#### Connection Options ### Connection Options
### Connection Scheme **Connection Scheme**: Specifies the SQLAlchemy driver scheme options required to connect to Exasol.
Specifies the SQLAlchemy driver scheme options required to connect to Exasol.
### Username **Username**: The username used to connect to the Exasol database. Ensure that this user has sufficient privileges to read all the metadata from Exasol.
The username used to connect to the Exasol database. Ensure that this user has sufficient privileges to read all the metadata from Exasol.
### Password **Password**: The password associated with the user connecting to Exasol.
The password associated with the user connecting to Exasol.
### Host and Port **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`
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`. - If running the OpenMetadata ingestion in a Docker container and your services are hosted on `localhost`, use `host.docker.internal:8563`.
### SSL/TLS Settings **SSL/TLS Settings**: Specifies the mode or settings for SSL/TLS validation during the connection. Available options:
Specifies the mode or settings for SSL/TLS validation during the connection. Available options:
#### validate-certificate (Default) **validate-certificate (Default)**: Enables Transport Layer Security (TLS) and validates the server certificate using system certificate stores.
- Enables Transport Layer Security (TLS).
- Validates the server certificate using system certificate stores.
#### ignore-certificate **ignore-certificate**: Enables Transport Layer Security (TLS) but disables validation of the server 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 {% note %}
- Disables Transport Layer Security (TLS). This mode should not be used in production. It is useful for testing with self-signed certificates.
- Data is sent in plain text (no encryption). {% /note %}
- **Warning**: This mode is not recommended for production and should only be used in debugging scenarios.
**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 %} {% note %}
Ensure that the appropriate TLS setting is chosen based on your security and deployment requirements. Ensure that the appropriate TLS setting is chosen based on your security and deployment requirements.

View File

@ -46,6 +46,15 @@ This is a sample config for Exasol:
{% codeInfo srNumber=1 %} {% codeInfo srNumber=1 %}
**`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.
**`SSL/TLS Settings`** **`SSL/TLS Settings`**
Mode/setting for SSL validation: Mode/setting for SSL validation:
@ -56,15 +65,6 @@ Mode/setting for SSL validation:
- **`disable-tls`**: Does not use any Transport Layer Security (TLS). Data will be sent in plain text (no encryption). - **`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. 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 %} {% /codeInfo %}
#### Advanced Configuration #### Advanced Configuration
@ -94,10 +94,10 @@ source:
type: Exasol type: Exasol
``` ```
```yaml {% srNumber=1 %} ```yaml {% srNumber=1 %}
SSL/TLS Settings: validate-certificate (default), or ignore-certificate, or disable-tls
hostPort: 127.0.0.1:8563
username: Exasol username: Exasol
password: password password: password
hostPort: 127.0.0.1:8563
SSL/TLS Settings: validate-certificate (default), or ignore-certificate, or disable-tls
``` ```
```yaml {% srNumber=2 %} ```yaml {% srNumber=2 %}
# connectionOptions: # connectionOptions:

View File

@ -46,38 +46,30 @@ The connector requires **Exasol version 7.1 or higher** to function correctly. E
{% stepsContainer %} {% stepsContainer %}
{% extraContent parentTagName="stepsContainer" %} {% extraContent parentTagName="stepsContainer" %}
#### Connection Options ### Connection Options
### Connection Scheme **Connection Scheme**: Specifies the SQLAlchemy driver scheme options required to connect to Exasol.
Specifies the SQLAlchemy driver scheme options required to connect to Exasol.
### Username **Username**: The username used to connect to the Exasol database. Ensure that this user has sufficient privileges to read all the metadata from Exasol.
The username used to connect to the Exasol database. Ensure that this user has sufficient privileges to read all the metadata from Exasol.
### Password **Password**: The password associated with the user connecting to Exasol.
The password associated with the user connecting to Exasol.
### Host and Port **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`
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`. - If running the OpenMetadata ingestion in a Docker container and your services are hosted on `localhost`, use `host.docker.internal:8563`.
### SSL/TLS Settings **SSL/TLS Settings**: Specifies the mode or settings for SSL/TLS validation during the connection. Available options:
Specifies the mode or settings for SSL/TLS validation during the connection. Available options:
#### validate-certificate (Default) **validate-certificate (Default)**: Enables Transport Layer Security (TLS) and validates the server certificate using system certificate stores.
- Enables Transport Layer Security (TLS).
- Validates the server certificate using system certificate stores.
#### ignore-certificate **ignore-certificate**: Enables Transport Layer Security (TLS) but disables validation of the server 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 {% note %}
- Disables Transport Layer Security (TLS). - This mode should not be used in production. It is useful for testing with self-signed certificates.
- Data is sent in plain text (no encryption). {% /note %}
- **Warning**: This mode is not recommended for production and should only be used in debugging scenarios.
**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 %} {% note %}
Ensure that the appropriate TLS setting is chosen based on your security and deployment requirements. Ensure that the appropriate TLS setting is chosen based on your security and deployment requirements.

View File

@ -46,6 +46,15 @@ This is a sample config for Exasol:
{% codeInfo srNumber=1 %} {% codeInfo srNumber=1 %}
**`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.
**`SSL/TLS Settings`** **`SSL/TLS Settings`**
Mode/setting for SSL validation: Mode/setting for SSL validation:
@ -56,15 +65,6 @@ Mode/setting for SSL validation:
- **`disable-tls`**: Does not use any Transport Layer Security (TLS). Data will be sent in plain text (no encryption). - **`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. 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 %} {% /codeInfo %}
#### Advanced Configuration #### Advanced Configuration
@ -94,10 +94,10 @@ source:
type: Exasol type: Exasol
``` ```
```yaml {% srNumber=1 %} ```yaml {% srNumber=1 %}
SSL/TLS Settings: validate-certificate (default), or ignore-certificate, or disable-tls
hostPort: 127.0.0.1:8563
username: Exasol username: Exasol
password: password password: password
hostPort: 127.0.0.1:8563
SSL/TLS Settings: validate-certificate (default), or ignore-certificate, or disable-tls
``` ```
```yaml {% srNumber=2 %} ```yaml {% srNumber=2 %}
# connectionOptions: # connectionOptions: