Connectors¶
Connectors store connection parameters for external storage or databases. Import and export tasks use these settings according to the connector type and purpose. Available purposes differ by type; select the type and purpose, then test the current parameters before creating the connector.
Create a connector¶
Go to Data Connection > Connectors.
Select New connector.
Enter a connector name.
Select a data-source type.
Fill in the connection details in the form.
Select a purpose from the options provided by the form.
Select Test connection.
After the test succeeds, select Confirm.
Testing a connection checks whether the current connection parameters are usable. It does not validate permissions for source files, source tables, target paths, or target tables selected by a later task.
Select a data-source type¶
Check the options enabled in the current deployment. Common types and purposes are listed below.
Category |
Connector |
Available for |
|---|---|---|
Object storage |
Alibaba Cloud OSS |
Data import and data export |
Object storage |
Standard S3 |
Data import and data export |
Distributed file system |
HDFS |
Data import |
Database |
MatrixOne |
Data export |
Database |
Hive |
Structured data import |
Database |
MySQL |
Structured data import |
Database |
SQL Server |
Structured data import |
Database |
Oracle |
Structured data import |
Database |
PostgreSQL |
Structured data import |
Database |
MongoDB |
Structured data import |
Database |
Apache Doris |
Structured data import |
Message queue |
Kafka |
Structured imports; see Kafka imports |
Web API |
REST API |
Structured imports; see Import data from REST APIs |
Observability |
Langfuse |
Not used for import/export tasks; availability depends on deployment |
After choosing a type, enter its connection details. Object storage forms contain access URLs and credentials; database forms contain hosts, ports, and authentication (for Apache Doris, configure the FE host, query port, query TLS mode, FE HTTP protocol and port, and optional FE Flight SQL port); Langfuse forms contain a service URL, Public Key, Secret Key, and fetch mode. Required fields are marked. For API connector creation, validation, or updates, see the complete configuration field table in create a connector.
Only the connector types listed above are available in this page. Huawei Cloud OBS, Tencent Cloud COS, FTP/SFTP, SMB/NAS, ClickHouse, RabbitMQ/MQTT, ERP systems, email servers, and GraphQL connectors are not currently provided.
Except for Langfuse, the purpose determines whether a connector can be selected in import or export tasks. The form hides or disables purposes that do not apply. The Langfuse form does not show a purpose selector.
View and filter connectors¶
The connector list shows the name, type, status, creator, creation time, update time, and purpose.
You can:
Search connectors by name.
Filter by connector type, status, or purpose.
Select Refresh to retrieve the latest list.
Select a connector name to view its configuration details.
Edit, test, or delete a connector¶
After locating a connector, perform the operations allowed by your permissions.
Task |
Operation |
|---|---|
Change connection settings |
Select Edit, change the name, purpose, or connection details, and select Test connection again before saving. |
Check connectivity again |
Select Test connection in the create or edit form. |
Delete a connector |
Select Delete, then confirm the operation in the confirmation prompt. |
Configure object permissions |
Use the permissions entry in the list to configure the members or roles that can view or operate the connector. |
When deleting a connector, if the system detects unfinished import tasks associated with it, the confirmation prompt lists those tasks. Handle them before deleting the connector to prevent later tasks from losing access to the data source.
The connection test passes but a task fails¶
Symptom |
How to check |
|---|---|
The task cannot find a source file or table |
Check the connector, path, database, schema, and table selected by the task. |
The task cannot write to the target |
Check the target path, target database or table, and the corresponding write permission. |
The connector is not visible or an operation is unavailable |
Check the current workspace and connector-object permissions. |