All Products
Search

This Product

    Dataphin:Create an Amazon Redshift data source

    Document Center

    Dataphin:Create an Amazon Redshift data source

    Last Updated:Jun 17, 2026

    Create an Amazon Redshift data source to allow Dataphin to read business data from or write data to Amazon Redshift.

    Permission requirements

    Only custom global roles with the permission to create data sources and the super administrator, data source administrator, domain architect, and project administrator roles can create data sources.

    Procedure

    1. On the Dataphin homepage, choose Management Center > Datasource Management from the top navigation bar.

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

    3. On the Create Data Source page, select Amazon Redshift in the Big Data section.

      You can also select Amazon Redshift in the Recently Used section or enter keywords in the search box to find it.

    4. On the Create Amazon Redshift Data Source page, configure the connection parameters.

      1. Configure the basic information of the data source

        Parameter

        Description

        Datasource Name

        Enter a name for the data source. The name must meet the following requirements:

        • The name can contain only Chinese characters, letters, digits, underscores (_), and hyphens (-).

        • The name cannot exceed 64 characters in length.

        Datasource Code

        After you configure the data source code, you can access Dataphin data source tables in Flink_SQL tasks or using the Dataphin JDBC client in the format of data source code.table name or data source code.schema.table name for quick consumption. To automatically switch data sources based on the task execution environment, you can access them using the variable format ${data source code}.table or ${data source code}.schema.table. For more information, see Development methods for Dataphin data source tables.

        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.

        Version

        Currently, only version 1.0.x is supported.

        Data Source Description

        Enter a brief description of the data source. The description can be up to 128 characters long.

        Time Zone

        The time zone used to process time-format data in integration tasks. The default time zone is Asia/Shanghai. Click Modify to select a different time zone. The options are as follows:

        • GMT: GMT-12:00, GMT-11:00, GMT-10:00, GMT-09:30, GMT-09:00, GMT-08:00, GMT-07:00, GMT-06:00, GMT-05:00, GMT-04:00, GMT-03:00, GMT-03:00, GMT-02:30, GMT-02:00, GMT-01:00, GMT+00:00, GMT+01:00, GMT+02:00, GMT+03:00, GMT+03:30, GMT+04:00, GMT+04:30, GMT+05:00, GMT+05:30, GMT+05:45, GMT+06:00, GMT+06:30, GMT+07:00, GMT+08:00, GMT+08:45, GMT+09:00, GMT+09:30, GMT+10:00, GMT+10:30, GMT+11:00, GMT+12:00, GMT+12:45, GMT+13:00, GMT+14:00.

        • Daylight Saving Time: Africa/Cairo, America/Chicago, America/Denver, America/Los_Angeles, America/New_York, America/Sao_Paulo, Asia/Bangkok, Asia/Dubai, Asia/Kolkata, Asia/Shanghai, Asia/Tokyo, Atlantic/Azores, Australia/Sydney, Europe/Berlin, Europe/London, Europe/Moscow, Europe/Paris, Pacific/Auckland, Pacific/Honolulu.

        Data Source Configuration

        Select the data source configuration:

        • If your business data source distinguishes between production and development data sources, select Production + Development Data Source.

        • If your business data source does not distinguish between production and development data sources, select Production Data Source.

        Tag

        Categorize data sources using tags. For information about creating tags, see Manage data source tags.

      2. Configure the connection parameters between the data source and Dataphin

        If you select Production + Development data source for your data source configuration, configure the connection information for both environments. If you select Production data source, configure the connection information for the production environment only.

        Note

        We recommend that you configure different data sources for production and development environments to achieve environment isolation. However, Dataphin also supports configuring them as the same data source with identical parameter values.

        Parameter

        Description

        Server Address

        Enter the server IP address and port number.

        Click +Add to add more address-port pairs, or click the image icon to remove one. At least one pair must be retained.

        Parameter Settings

        • Parameter name: You can select an existing parameter name or enter a custom parameter name.

          Custom parameter names can contain only letters, digits, periods (.), underscores (_), and hyphens (-).

        • Parameter value: When a parameter name is selected, the parameter value is required. It can contain only letters, digits, periods (.), underscores (_), and hyphens (-), and cannot exceed 256 characters in length.

        Note

        You can click +Add Parameter to add multiple parameters, and click the image icon to delete excess parameters. You can add up to 30 parameters.

        dbname

        Enter the database name.

        Schema

        Enter the schema associated with the username.

        Username, Password

        Enter the authentication username and password. Make sure the user has the required data permissions for tasks to run properly.

      3. Advanced configuration

        Parameter

        Description

        connectTimeout

        The connection timeout period in seconds. Default: 900 seconds (15 minutes).

        Note

        For data sources created before Dataphin V3.11, the default value of connectTimeout is -1, which indicates no timeout limit.

        socketTimeout

        The socket timeout period in seconds. Default: 1800 seconds (30 minutes).

        Note

        For data sources created before Dataphin V3.11, the default value of socketTimeout is -1, which indicates no timeout limit.

        Connection Retries

        If the database connection times out, the system automatically retries until the specified retry count is reached. If the connection still fails after all retries, the connection fails.

        Note

        • The default number of retries is 1. You can set a value between 0 and 10.

        • Connection retries apply by default to offline integration tasks and global quality (requires the asset quality feature). You can configure the retry count separately at the task level in offline integration tasks.

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

    6. Click Test Connection or directly click OK to save and complete the creation of the Amazon Redshift data source.

      When you click Test Connection, the system verifies connectivity between the data source and Dataphin. If you click OK directly, the system tests the connection for all selected clusters automatically. The data source can still be created even if all clusters fail the connection test.

      Test Connection tests the connection for the Default Cluster or Registered Scheduling Clusters that have been registered in Dataphin and are in normal use. The Default Cluster is selected by default and cannot be deselected. If there are no resource groups under a Registered Scheduling Cluster, connection testing is not supported. You need to create a resource group first before testing the connection.

      • The selected clusters are only used to test network connectivity with the current data source and are not used for running related tasks later.

      • The test connection usually takes less than 2 minutes. If it times out, you can click the image icon to view the specific reason and retry.

      • Regardless of whether the test result is Connection Failed, Connection Successful, or Succeeded With Warning, the system will record the generation time of the final result.

        Note

        Only the test results for the Default Cluster include three connection statuses: Succeeded With Warning, Connection Successful, and Connection Failed. The test results for Registered Scheduling Clusters in Dataphin only include two connection statuses: Connection Successful and Connection Failed.

      • When the test result is Connection Failed, you can click the image icon to view the specific failure reason.

      • When the test result is Succeeded With Warning, it means that the application cluster connection is successful but the scheduling cluster connection failed. The current data source cannot be used for data development and integration. You can click the image icon to view the log information.