All Products
Search

This Product

    Dataphin:Create an Amazon RDS for PostgreSQL data source

    Document Center

    Dataphin:Create an Amazon RDS for PostgreSQL data source

    Last Updated:Jun 17, 2026

    Create an Amazon RDS for PostgreSQL data source to enable Dataphin to read business data from or write data to Amazon RDS for PostgreSQL.

    Permission requirements

    Only users with the Create Data Source permission in a custom global role, or users assigned the super administrator, data source administrator, domain architect, or project administrator role, can create data sources.

    Procedure

    1. On the Dataphin homepage, choose Management Hub > 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 RDS for PostgreSQL in the Relational Database section.

      If you have recently used Amazon RDS for PostgreSQL, you can also select it in the Recently Used section, or enter keywords in the search box to find it quickly.

    4. On the Create Amazon RDS For PostgreSQL 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:

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

        • It 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 by using the Dataphin JDBC client in the format of data source code.table name or data source code.schema.table name for quick consumption. If you need 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 method 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.

        Data Source Description

        Enter a brief description of the data source. The description cannot exceed 128 characters.

        Data Source Configuration

        Select the data source that you want to configure:

        • 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

        You can categorize and tag data sources based on tags. For information about how to create tags, see Manage data source tags.

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

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

        Note

        We recommend that you configure separate production and development data sources for environment isolation. However, Dataphin also supports using the same data source with identical parameter values for both environments.

        For Configuration Method, you can select either JDBC URL or Host. The default selection is JDBC URL.

        JDBC URL configuration method

        Parameter

        Description

        JDBC URL

        The format of the connection address is jdbc:postgresql://host:port/database.

        Schema

        Enter the schema associated with the username.

        Username, Password

        Enter the username and password of the database.
        Host configuration method

        • Host configuration method

          Parameter

          Description

          Server Address

          Enter the IP address and port number of the server.

          You can click +Add to add multiple sets of IP addresses and port numbers, and click the image icon to delete extra IP addresses and port numbers, but you must keep at least one set.

          dbname

          Enter the database name.

        • Parameter configuration

          Parameter

          Description

          Parameter

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

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

          • Parameter value: When a parameter name is selected, the parameter value is required. It can only contain uppercase and lowercase 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 extra parameters. You can add up to 30 parameters.

          Schema

          Enter the schema information associated with the username.

          Username, Password

          Enter the authentication username and password. To ensure that tasks can be executed normally, make sure that the user has the required data permissions.
        Note

        After you create a data source with the Host configuration method, if you switch to the JDBC URL method, the system concatenates the server IP address and port number into a JDBC URL automatically.

      3. Configure advanced settings for the data source.

        Parameter

        Description

        connectTimeout

        The connection timeout of the database, in seconds. Default value: 900 (15 minutes).

        Note

        • If you have connectTimeout configured in the JDBC URL, the connectTimeout will be the timeout value configured in the JDBC URL.

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

        socketTimeout

        The socket timeout of the database, in seconds. Default value: 1800 (30 minutes).

        Note

        • If you have socketTimeout configured in the JDBC URL, the socketTimeout will be the timeout value configured in the JDBC URL.

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

        Connection Retries

        When a database connection times out, Dataphin automatically retries until the configured retry limit is reached. If all retries fail, the connection fails.

        Note

        • The default number of retries is 1, and you can configure a value between 0 and 10.

        • The connection retry count will be applied by default to offline integration tasks and global quality (requires the asset quality function module to be enabled). In offline integration tasks, you can configure task-level retry counts separately.
        Note

        Rules for duplicate parameter values:

        • If a parameter exists in JDBC URL, Advanced Settings parameters, and Host Configuration method's parameter configuration, the value in the JDBC URL takes precedence.

        • If a parameter exists in both JDBC URL and Advanced Settings parameters, the value in the JDBC URL takes precedence.

        • If a parameter exists in both Advanced Settings parameters and Host Configuration method's parameter configuration, the value in the Advanced Settings parameters takes precedence.

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

    6. Perform a Test Connection or directly click OK to save and complete the creation of the Amazon RDS for PostgreSQL data source.

      Click Test Connection to verify that the data source can connect to Dataphin. If you click OK directly, the system automatically tests the connection for all selected clusters. The data source is created even if all cluster connections fail.

      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.