Add an AnalyticDB for MySQL data source

Updated at:

Before you can create reports in DataV-Note by using data from AnalyticDB for MySQL, you must add your AnalyticDB for MySQL instance as a data source. After you add the data source, you can use it across your projects to query, analyze, and visualize instance data. This topic describes how to add an AnalyticDB for MySQL data source.

Prerequisites

  • You have purchased an AnalyticDB for MySQL instance and created a database. For more information, see Create an AnalyticDB for MySQL instance.

  • You must have a workspace. For more information, see Create a workspace.

    Note

    After you activate DataV-Note (Intelligent Analysis), the platform provides a default workspace that you can use.

Limitations

DataV-Note (Intelligent Analysis) currently supports three connection methods: public endpoint, internal endpoint, and VPC endpoint.

  • Public endpoint: Supports instances in all regions.

  • Internal endpoint or VPC endpoint: Supports only instances in the China (Shanghai) region.

Procedure

  1. Go to the data sources page.

    1. Log on to the DataV-Note console.

    2. In the left-side navigation pane, select the target workspace, and then click Data > Data sources.

  2. Click New data connection.

  3. Configure the data source.

    1. In the Basic information section, configure the following parameters.

      Parameter

      Description

      Data source name

      A custom name for the data source. The name must be unique within the workspace.

      Data source description

      A description of the data source. You can briefly describe its purpose.

      Data source type

      Select AnalyticDB for MySQL.

      Allowlist

      Add an IP address to the allowlist. To prevent access restrictions when DataV-Note accesses the AnalyticDB for MySQL database, go to the AnalyticDB for MySQL console and add the IP address to the IP allowlist. For more information, see Set an allowlist.

      • Public allowlist: On the data source configuration page, obtain the system IP address from the information box below the Data source type parameter.

      • Internal allowlist/VPC allowlist: Log on to the AnalyticDB for MySQL console, click the cluster ID, and on the Cluster information > Network information tab, find the vSwitch ID. Then, go to the vSwitch console and use the vSwitch ID to find the IP CIDR block.image

      Note

      If the default allowlist group named default for your instance contains 0.0.0.0/0, the instance accepts connections from all IP addresses, so you do not need to configure an allowlist.

    2. In the Connection information section, configure the following parameters.

      Endpoint and port

      The public, internal, or VPC endpoint of the database.

      • Public endpoint: The public endpoint used to access the AnalyticDB for MySQL instance. Log on to the AnalyticDB for MySQL console, click the cluster ID, and find the public endpoint and port number in the Cluster information > Network information section.

      • Internal endpoint/VPC endpoint: The internal or VPC endpoint used to access the AnalyticDB for MySQL instance. Log on to the AnalyticDB for MySQL console, click the cluster ID, and find the VPC endpoint and port number in the Cluster information > Network information section.

      Database logon credentials

      Enter the Database name, Username, and Password for the AnalyticDB for MySQL database that you want to access.

      Log on to the AnalyticDB for MySQL console, click the cluster ID, and find the database name and user information under Database management and account management in the left-side navigation pane.

      Test connectivity

      Specifies whether to automatically test the connection when you create the data source.

  4. Test the connection.

    The Test connectivity parameter determines whether to test the connection:

    • On: The system automatically tests the connection.

    • Off: The system does not test the connection. You must test it manually later.

    Note

    After the data source is created, its connection status appears in the data source list. The possible statuses are as follows:

    • Connection normal: Indicates that the data source is available. You can use the data source for subsequent query and analysis operations.

    • Connection failed: DataV-Note cannot access the data source. Click the image icon below the data source to run a test. Fix any reported errors.

    • Untested: Click the image icon below the data source to test the connectivity. You can use the data source for queries and analysis only after the connection is normal.

  5. Click OK.

Next steps

After the data source is created, you can perform the following operations as needed:

  • Use the data source: Go to the edit page of your project to perform queries and analysis. For more information, see Data Analysis.

    Note

    Only data sources with a Connected status can be used in projects.

  • Manage the data source: Perform tasks such as refreshing cached tables or deleting the data source. For more information, see Manage data sources.

References

  • If you have questions or suggestions when you use DataV-Note (Intelligent Analysis), contact us.

  • For more information about data sources, see Data Source Management.