DocsICP FilingConsole
Documentation
Home Page Dataphin Intelligent Data construction and governance Dataphin-sharing mode (fully managed version) User Guide Management Center Manage data sources Relational data sources Create a MySQL data source

Create a MySQL data source

Updated at:
Copy as MD
Product
My Favorites

Create a MySQL data source to enable Dataphin to read data from or write data to MySQL. This topic describes how to create a MySQL data source.

Prerequisites

Before you create a data source in Dataphin for an Alibaba Cloud product, you must add the Dataphin IP address to the whitelist or security group of the database. This step ensures network connectivity between Dataphin and the data source. For more information, see Data source whitelist configuration.

Background information

MySQL is a leading open-source relational database management system that uses Structured Query Language (SQL) to store, retrieve, and manage data. It is often used for websites, applications, and commercial products. It is commonly used as a primary relational data storage system. For more information, see the official MySQL website.

Permissions

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

Procedure

  1. On the Dataphin home page, choose Management Center > Datasource Management from the top menu bar.

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

  3. On the Create Data Source page, select MySQL in the Relational Database section.

    If you have recently used MySQL, you can also select it from the Recently Used section. Alternatively, you can enter MySQL in the search box to find it.

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

    1. Configure the basic information for the data source.

      Parameter

      Description

      Datasource Name

      Enter a name for the data source. The naming convention is as follows:

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

      • The name can be up to 64 characters long.

      Datasource Code

      After you configure the data source code, you can directly access Dataphin data source tables in Flink SQL tasks or using 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 Develop Flink SQL tasks.

      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

      You can select only MySQL 5.1.43, MySQL 5.6/5.7, MySQL 8.0.x, MySQL 8.4.x, or RDS MySQL.

      Important

      If you use a MySQL data source from Alibaba Cloud, select RDS MySQL to connect properly.

      Data Source Description

      A brief description of the MySQL data source. The description can be up to 128 characters long.

      Time Zone

      Time-formatted data in integration tasks is processed based on the current time zone. The default time zone is Asia/Shanghai. Click Modify to select a target 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

      Specify whether your business data source distinguishes between production and development environments:

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

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

      Tag

      You can add tags to data sources for categorization. For more information about how to create a tag, see Manage data source tags.

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

      The connection information that you need to configure depends on the Data Source Configuration setting. 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

      Typically, production and development data sources are configured separately to isolate the environments and prevent development activities from affecting the production data source. However, Dataphin also supports configuring them as a single data source with identical parameter values.

      For Configuration Method, you can select JDBC URL, Host, or Alibaba Cloud Instance. The default method is JDBC URL.

      JDBC URL configuration method

      Parameter

      Description

      JDBC URL

      The format of the JDBC URL is jdbc:mysql://host:port/dbname.

      Note

      The default port for a MySQL data source is 3306.

      Username, Password

      The Username and Password for the database.

      Type

      Supports Directly Connectable Database, Alibaba Cloud Database, and Self-managed Database On ECS (VPC). Select and configure a type based on your database type and business requirements.

      • Directly Connectable Database: Connect to the database directly through the default or a registered scheduling cluster. This method is suitable for the following scenarios: ① databases on the internet, and ② databases in the same network environment as the registered scheduling cluster. To add the IP address to a whitelist, use the public egress IP address of the Dataphin default scheduling cluster: 47.102.192.174.

      • Alibaba Cloud Database: A database purchased on Alibaba Cloud. Supports access through VPC Proxy or Direct Connection.

        • VPC Proxy: If the database is an Alibaba Cloud database in a virtual private cloud (VPC), add 100.104.0.0/16 to the authorized IP address whitelist for the connection.

          • Region: The region where the database is located. Only databases in the same region as the Dataphin instance are supported. For example, if your Dataphin instance is in the China (Shanghai) region, you can select only the China (Shanghai) region.

          • VPC ID: Enter the ID of the VPC where the database is located. You can log on to the VPC console to view the ID.

          • VPC Instance ID: Enter the VPC instance ID of the database, which is VpcInstanceId. If an error indicates that the instance cannot be found, you can call the DescribeDBInstances API operation to obtain the VpcCloudInstanceId.

        • Direct Connection: Connect to the database directly through the default or a registered scheduling cluster. To add the IP address to a whitelist, use the public egress IP address of the Dataphin default scheduling cluster: 47.102.192.174.

      • Self-managed Database On ECS (VPC): If the database is a self-managed database on an ECS instance in a VPC, add 100.104.0.0/16 to the authorized IP address whitelist for the connection.

        • Region: The region where the database is located. Only databases in the same region as the Dataphin instance are supported. For example, if your Dataphin instance is in the China (Shanghai) region, you can select only the China (Shanghai) region.

        • VPC ID: Enter the ID of the VPC where the ECS instance is located. You can log on to the VPC console to view the ID.

        • ECS ID: Enter the ID of the ECS instance where the database is deployed. You can log on to the ECS console to view the ID.

      Host configuration method

      • Host configuration

        Parameter

        Description

        Server Address

        Enter the IP address and port number of the server.

        Click +Add to add multiple IP addresses and port numbers. Click the image icon to delete IP addresses and port numbers. You must retain at least one IP address and port number.

        dbname

        Enter the database name.

      • Parameter configuration

        Parameter

        Description

        Parameter

        • Parameter name: You can select only an existing parameter name.

        • Parameter value: If you select a parameter name, this parameter is required. The value can contain only letters, digits, periods (.), underscores (_), and hyphens (-). The value can be up to 256 characters long.

        Note

        Click +Add Parameter to add multiple parameters. Click the image icon to delete parameters. You can add up to 30 parameters.

        Username, Password

        The username and password used to log on to the MySQL instance.

        SSL Encryption

        If you enable this feature, upload a Truststore certificate and enter the Truststore certificate password.

      Note

      If you select the Host configuration method and later switch to the JDBC URL method for the same data source, the system automatically populates the JDBC URL field by concatenating the server IP address and port number.

      Alibaba Cloud Instance

      Note

      The Alibaba Cloud Instance configuration method is available only if the Version is set to RDS MySQL.

      Parameter

      Description

      Configuration Method

      Select Alibaba Cloud Instance. The system then automatically checks whether the service-linked role (SLR) AliyunServiceRoleForDataphinOnDB exists for your account. If it does not exist, follow the on-screen instructions to grant the required permissions.

      Region

      You can select one of the following regions:

      China (Hangzhou), China (Shanghai), China (Nanjing - Local Region), China (Qingdao), China (Beijing), China (Zhangjiakou), China (Hohhot), China (Ulanqab), China (Shenzhen), China (Heyuan), China (Guangzhou), China (Chengdu), China (Hong Kong), China (Fuzhou - Local Region), China (Wuhan - Local Region), Japan (Tokyo), South Korea (Seoul), Singapore, Malaysia (Kuala Lumpur), Indonesia (Jakarta), Philippines (Manila), Thailand (Bangkok), Germany (Frankfurt), UK (London), US (Silicon Valley), US (Virginia), Mexico, UAE (Dubai).

      Instance

      Select an existing RDS MySQL instance under your account in the selected region.

      Connection Url

      Select the internal or public endpoint of the instance. The internal endpoint is used by default. If you select the internal endpoint, Access Method is set to VPC Proxy by default. If you select the public endpoint, Access Method is set to Direct Connection by default.

      DBname

      Enter the DBname.

      Username, Password

      The Username and Password for the database.

      SSL Encryption

      If you enable this feature, upload a Truststore certificate and enter the Truststore certificate password.

      Access Method

      Supports access through VPC Proxy or Direct Connection.

      • VPC Proxy: If the database is an Alibaba Cloud database in a VPC, add 100.104.0.0/16 to the authorized IP address whitelist for the connection.

        • Region: Displays the region you selected.

        • VPC ID: Enter the ID of the VPC where the database is located. You can log on to the VPC console to view the ID.

          If the VPC instance is in the same region as the Dataphin instance, the system automatically obtains the VPC ID. You can modify it as needed.

        • VPC Instance ID: Enter the VPC instance ID of the database, which is VpcInstanceId. If an error indicates that the instance cannot be found, you can call the DescribeDBInstances API operation to obtain the VpcCloudInstanceId.

          If the VPC instance is in the same region as the Dataphin instance, the system automatically obtains the VPC instance ID. You can modify it as needed.

      • Direct Connection: Connect to the database directly through the default or a registered scheduling cluster. To add the IP address to a whitelist, use the public egress IP address of the Dataphin default scheduling cluster: 47.102.192.174.

    3. Configure the advanced settings for the data source.

      Parameter

      Description

      connectTimeout

      The connection timeout period for the database, in milliseconds. The default value is 900000 ms (15 minutes).

      Note

      • If you specify a `connectTimeout` value in the JDBC URL, that value is used.

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

      socketTimeout

      The socket timeout period for the database, in milliseconds. The default value is 1800000 ms (30 minutes).

      Note

      • If you specify a `socketTimeout` value in the JDBC URL, that value is used.

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

      Connection Retries

      If the database connection times out, the system automatically retries the connection until the specified number of retries is reached. If the connection still fails after the maximum number of retries, the connection fails.

      Note

      • The default number of retries is 1. You can set this parameter to a value from 0 to 10.

      • The number of connection retries is applied to offline integration tasks and global quality checks by default. To use global quality checks, you must enable the asset quality module. For offline integration tasks, you can configure the number of retries at the task level.

    Note

    Value rules for duplicate parameters:

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

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

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

  5. Select a Default Resource Group. This resource group is used to run tasks related to the data source, such as SQL tasks, full offline database migrations, and data previews.

  6. Click Test Connection or click OK to save the configuration and create the MySQL data source.

    When you click Test Connection, the system tests the connection to the data source. If you click OK, the system automatically tests the connection for all selected clusters. The data source can be created even if the connection test fails.

    Test Connection tests the connection for the Public Scheduling Cluster or Registered Scheduling Clusters that have been registered in Dataphin and are in normal use. The Public Scheduling 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 Public Scheduling 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.

    Important

Previous：Create a PolarDB-X data sourceNext：Create a SAP HANA data source