Dataphin:Create an Amazon RDS for SQL Server data source

Permission requirements

Only users who have the Create Data Source permission point in a custom global role and users who have 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 SQL Server in the Relational Database section.

   You can also find it in the Recently Used section or use the search box.

4. On the Create Amazon RDS For SQL Server Data Source page, configure the connection parameters.

   1. Configure basic information.

      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	Use the data source code to access tables in Flink_SQL tasks or the Dataphin JDBC client: data source code.table name or data source code.schema.table name . To switch data sources by execution environment, use variable format: ${data source code}.table or ${data source code}.schema.table. 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	Brief description of the data source. Maximum 128 characters.
      Data Source Configuration	Select a 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 with tags. Manage data source tags.

   2. Configure connection parameters.

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

      Note

      We recommend separate data sources for production and development to isolate environments. However, you can use the same data source with identical parameters for both.

      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:sqlserver://host:port/dbname.
      Schema	Enter the schema associated with the username.
      Username, Password	Enter the username and password. Ensure the user has the required data permissions.

      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 icon to delete extra IP addresses and port numbers. You must keep at least one set.
        dbname	Enter the database name.

      • Parameter configuration

        Parameter	Description
        Parameter	Parameter name: Supports selecting an existing parameter name or entering 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 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 username and password. Ensure the user has the required data permissions.

      Note

      After creating a data source with Host configuration, switching to JDBC URL mode automatically concatenates the server IP and port into a JDBC URL.

   3. Configure advanced settings.

      Parameter	Description
      loginTimeout	Database login timeout in seconds. Default: 900 (15 minutes). Note If loginTimeout is specified in the JDBC URL, that value takes precedence. For data sources created before Dataphin V3.11, the default is -1 (no timeout limit).
      socketTimeout	Database socket timeout in milliseconds. Default: 1800000 (30 minutes). Note If socketTimeout is specified in the JDBC URL, that value takes precedence. For data sources created before Dataphin V3.11, the default is -1 (no timeout limit).
      Connection Retries	Number of automatic retry attempts when the database connection times out. The connection fails if all retries are exhausted. Note Default: 1. Valid range: 0 to 10. Applies by default to offline integration tasks and global quality (requires Asset Quality module). You can override retry counts at the task level for offline integration tasks.

      Note

      Rules for duplicate parameter values:

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

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

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

5. Select a Default Resource Group, which will be 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 SQL Server data source.

   Clicking Test Connection verifies connectivity to Dataphin. Clicking OK saves the data source and tests all selected clusters automatically. The data source is created even if cluster connection tests 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 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 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 icon to view the log information.