Manage Connectors
Displays the Connector information of the Query Engine. All Connector Types support four operations: Add, View, Update, Delete.
Add a Connector
- Step 1: On the Connectors screen, click Create a connector, then select the Connector Type to create.
- Step 2: Enter the information for the Connector (see the detailed field descriptions below).
- Step 3: Click Create to create the Connector, or click Cancel to abort.
Note: After successful creation, the Query Engine transitions to the Processing state and completes the configuration in approximately ~3 minutes.
Update a Connector
- Step 1: On the Connectors screen, click the Action button of the connector to update, then select Update.
- Step 2: Enter the information to update (the Connector Type cannot be modified).
- Step 3: Click Update to save, or click Cancel to abort.
View a Connector
- Step 1: On the Connectors screen, click on the Connector name to view its details.
Note: Sensitive fields (Password, S3 Secret Key, SASL Password, Credentials Key) will not be displayed for security reasons.
Delete a Connector
- Step 1: On the Connectors screen, click the Action button of the connector to delete, then select Delete.
- Step 2: Click Confirm to confirm the deletion, or click Cancel to abort.
Field Information by Connector Type
The table below describes the detailed fields corresponding to each Connector Type.
Iceberg catalog - Hive
| Field | Description |
|---|---|
| Catalog Name | The name of the catalog |
| Catalog Type | The catalog type (enter: hive) |
| Enable S3 SSE | Automatically encrypts all files written to S3. When viewing or downloading files, the Workspace automatically decrypts them, increasing data security. Keyvault: Select the keystore you created (Keystore Management). If S3 SSE is not enabled, files are stored raw and unencrypted. |
| Catalog URL | Hive Metastore connection address |
| File Format | Storage file format (parquet / orc / avro) |
| Default Warehouse Directory | The default warehouse directory path (s3a://<bucket>/path) |
| S3 Endpoint | S3 access endpoint address |
| S3 Access Key | S3 access key |
| S3 Secret Key | S3 secret access key (not displayed in detail View) |
| S3 Region | The region of the S3 bucket (e.g., us-east-1, ap-southeast-1) |
| S3 Path Style Access | Enable if the S3 endpoint uses path-style access, fill with true/false |
| Cache Enabled | Enable/disable data caching for the catalog: True/False |
| Cache Size | Maximum cache size to use (e.g., 10GB, 100GB). Only applicable when cache is enabled. |
| Cache TTL | Cache time-to-live before expiration/refresh (e.g., 1h, 24h, 7d). Only applicable when cache is enabled. |
Iceberg catalog - Nessie
| Field | Description |
|---|---|
| Catalog Name | The name of the catalog |
| Catalog Type | The catalog type (enter: nessie) |
| Enable S3 SSE | Automatically encrypts all files written to S3. When viewing or downloading files, the Workspace automatically decrypts them, increasing data security. Keyvault: Select the keystore you created (Keystore Management). If S3 SSE is not enabled, files are stored raw and unencrypted. |
| Catalog URL | Nessie server connection address |
| Nessie Branch | The Nessie branch to connect to |
| File Format | Storage file format (parquet / orc / avro) |
| Default Warehouse Directory | The default warehouse directory path (s3a://<bucket>/path) |
| S3 Endpoint | S3 access endpoint address |
| S3 Access Key | S3 access key |
| S3 Secret Key | S3 secret access key (not displayed in detail View) |
| S3 Region | The region of the S3 bucket (e.g., us-east-1, ap-southeast-1) |
| S3 Path Style Access | Enable if the S3 endpoint uses path-style access, fill with true/false |
| Cache Enabled | Enable/disable data caching for the catalog: True/False |
| Cache Size | Maximum cache size to use (e.g., 10GB, 100GB). Only applicable when cache is enabled. |
| Cache TTL | Cache time-to-live before expiration/refresh (e.g., 1h, 24h, 7d). Only applicable when cache is enabled. |
PostgreSQL
| Field | Description |
|---|---|
| Catalog Name | The name of the catalog |
| Host | Host address of the database server |
| Port | Connection port to the database server |
| DB Name | The name of the database to connect to |
| User Name | Authentication username |
| Password | Authentication password (not displayed in detail View) |
SQL Server
| Field | Description |
|---|---|
| Catalog Name | The name of the catalog |
| Host | Host address of the database server |
| Port | Connection port to the database server |
| DB Name | The name of the database to connect to |
| User Name | Authentication username |
| Password | Authentication password (not displayed in detail View) |
| Encrypt | Enable/disable SSL/TLS connection encryption between client and SQL Server |
| Trust Server Certificate | Bypass SSL server certificate validation (typically used for dev/test environments) |
MySQL
| Field | Description |
|---|---|
| Catalog Name | The name of the catalog |
| Host | Host address of the database server |
| Port | Connection port to the database server |
| DB Name | The name of the database to connect to |
| User Name | Authentication username |
| Password | Authentication password (not displayed in detail View) |
MariaDB
| Field | Description |
|---|---|
| Catalog Name | The name of the catalog |
| Host | Host address of the database server |
| Port | Connection port to the database server |
| DB Name | The name of the database to connect to |
| User Name | Authentication username |
| Password | Authentication password (not displayed in detail View) |
MongoDB
| Field | Description |
|---|---|
| Catalog Name | The name of the catalog |
| Connection URL | MongoDB connection string (mongodb://<user>:<pass>@<host>:<port>/<db>) |
| User Name | Authentication username |
| Password | Authentication password (not displayed in detail View) |
OpenSearch
| Field | Description |
|---|---|
| Catalog Name | The name of the catalog |
| Host | Host address of the OpenSearch server |
| Port | Connection port |
| User Name | Authentication username |
| Password | Authentication password (not displayed in detail View) |
ClickHouse
| Field | Description |
|---|---|
| Catalog Name | The name of the catalog |
| Host | Host address of the ClickHouse server |
| Port | Connection port |
| DB Name | The name of the database to connect to |
| User Name | Authentication username |
| Password | Authentication password (not displayed in detail View) |
Elasticsearch
| Field | Description |
|---|---|
| Catalog Name | The name of the catalog |
| Host | Host address of the Elasticsearch server |
| Port | Connection port |
| Default Schema Name | Default schema name when querying |
| User Name | Authentication username |
| Password | Authentication password (not displayed in detail View) |
Kafka
| Field | Description |
|---|---|
| Catalog Name | The name of the catalog |
| Kafka Nodes | List of Kafka broker nodes (host:port, multiple nodes separated by commas) |
| Default Schema | Default schema when querying |
| Table Names | List of Kafka topics to connect to |
| Security Protocol | Security protocol (PLAINTEXT / SSL / SASL_PLAINTEXT / SASL_SSL) |
| SASL Mechanism | SASL authentication mechanism (PLAIN / SCRAM-SHA-256 / GSSAPI) |
| SASL Username | SASL username |
| SASL Password | SASL password (not displayed in detail View) |
BigQuery
| Field | Description |
|---|---|
| Catalog Name | The name of the catalog |
| GCP Project ID | Project ID on Google Cloud Platform |
| Credentials Key | GCP credentials for authentication, Base64 encoded JSON service account file (not displayed in detail View) |
| Views Enabled | Allow querying views in BigQuery |
| Skip View Materialization | Skip view materialization during query to optimize performance |
| Max Parallelism | Maximum number of parallel tasks when reading data from BigQuery |