All Products
Search

This Product

    Dataphin:Create a custom data source

    Document Center

    Dataphin:Create a custom data source

    Last Updated:Jun 23, 2026

    Integrate a custom data source type into Dataphin for integration development.

    Prerequisites

    A custom data source type exists. For more information, see:

    Procedure

    1. In the top navigation bar of the Dataphin homepage, choose Management Hub > Datasource Management.

    2. On the Datasource page, click +Create Data Source.

    3. In the Create Data Source page in the Custom Data Source Area, select the customized data source type.

      The following example uses a custom data source type named mysql-test, which is a relational database management system (RDBMS).

    4. On the Create mysql-test Data Source page, configure the connection information.

      Parameter

      Description

      Datasource Name

      Enter the data source name. The name can contain Chinese characters, uppercase and lowercase letters, digits, underscores (_), and hyphens (-), up to 64 characters.

      Datasource Code

      The data source code allows you to access Dataphin data source tables in Flink_SQL nodes or through the Dataphin JDBC client. Use the format DatasourceCode.TableName or DatasourceCode.Schema.TableName for quick access. To automatically switch data sources based on the task execution environment, use the variable format ${DatasourceCode}.table or ${DatasourceCode}.schema.table. For more information, see Development methods for Dataphin data source tables and .

      Important

      • The data source code cannot be modified after it is configured.

      • You can preview data on the object details page in the asset directory and asset checklist only after the data source code is configured.

      • In Flink SQL, only MySQL, Hologres, MaxCompute, Oracle, StarRocks, Hive, SelectDB, and GaussDB data warehouse service (DWS) data sources are currently supported.

      Data Source Description (Optional)

      Enter a brief description of the data source, up to 128 characters.

      Data Source Configuration

      Configure the data source:

      • If the development mode is Basic mode, select Production Data Source.

      • If the development mode is Dev-Prod mode, you can configure the data source using the following methods:

        • Click Production + Development Data Source to configure data sources for both production and development environments.

        • Click Production Data Source to configure the production data source. After you create the production data source, click Development Data Source to configure the development environment data source.

      Note

      You can configure Production Data Source and Development Data Source as the same or different data sources.

      Tag (optional)

      Select a tag category for the data source.

      Connection Address

      Enter the connection URL for the database. For example, jdbc:mysql://host:port/dbname.

      Username, Password

      Enter the username and password for the database.

      Dbname

      The database or catalog used to retrieve metadata about available tables.

      Schema

      The schema used to retrieve metadata about available tables.

    5. Select Default Resource Group, which is used to run tasks related to the current data source, including database SQL, offline database migration, and data preview.

    6. Click Test Connection to verify connectivity, or click OK to save the custom data source.

      Clicking Test Connection verifies the connection to Dataphin. Clicking OK automatically tests the connection for all selected clusters. The data source is created even if connection tests fail.