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

  1. Go to Data Connection > Connectors.

  2. Select New connector.

  3. Enter a connector name.

  4. Select a data-source type.

  5. Fill in the connection details in the form.

  6. Select a purpose from the options provided by the form.

  7. Select Test connection.

  8. 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

The current creation form provides 11 connector types.

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

Observability

Langfuse

Not used for import or export tasks

After selecting a type, provide its connection details. Object-storage forms include an endpoint and credentials; database forms include host, port, and authentication details; the Langfuse form includes a service address, Public Key, Secret Key, and pull mode. Required fields are marked as such. When creating, validating, or updating a connector through the API, use the complete connector configuration field table in the API Reference.

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

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.
Last updated on