All Products
Search

This Product

    Dataphin:Create a Tablestore data source

    Document Center

    Dataphin:Create a Tablestore data source

    Last Updated:Jun 04, 2025

    By creating a Tablestore data source, you can enable Dataphin to read business data from Tablestore or write data to Tablestore. This topic describes how to create a Tablestore data source.

    Background information

    Tablestore is Alibaba Cloud Tablestore. Tablestore provides Serverless table storage services for massive structured data and offers a one-stop IoTstore solution optimized for IoT scenarios. Tablestore allows you to query and retrieve online data within milliseconds and perform multi-dimensional analysis on stored data. Tablestore is suitable for scenarios such as billing, instant messaging (IM), Internet of Things (IoT), Internet of Vehicles (IoV), risk control, and intelligent recommendation.

    If you are using Alibaba Cloud Tablestore and need to connect it to Dataphin for data development or write Dataphin data to Tablestore, you must first create a Tablestore data source. For more information, see What is Tablestore.

    Permissions

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

    Procedure

    1. On the Dataphin homepage, click Management Center > Datasource Management in the top navigation bar.

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

    3. In the Create Data Source page, select Tablestore from the NoSQL section.

      If you have recently used Tablestore, you can also select it from the Recently Used section. You can also quickly search for Tablestore by entering keywords in the search box.

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

      1. Configure the basic information of the data source.

        Parameter

        Description

        Datasource Name

        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 reference tables in the data source in Flink_SQL tasks by using the format data source code.table name or data source code.schema.table name. If you need to automatically access the data source in the corresponding environment based on the current environment, use the variable format ${data source code}.table or ${data source code}.schema.table. For more information, see Dataphin data source table development method.

        Important

        • The data source code cannot be modified after it is configured successfully.

        • After the data source code is configured successfully, you can preview data on the object details page in the asset directory and asset inventory.

        • In Flink SQL, only MySQL, Hologres, MaxCompute, Oracle, StarRocks, Hive, and SelectDB data sources are currently supported.

        Data Source Description

        A brief description of the data source. It cannot exceed 128 characters.

        Data Source Configuration

        Select the data source 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 using 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 selected Production + Development Data Source in the previous step, the configuration page appears as shown in the following figure. If you selected Production Data Source, only the production data source configuration page is displayed.image

        Note

        Typically, production and development data sources should be configured as separate data sources to achieve environment isolation and reduce the impact of development activities on production. However, Dataphin also supports configuring them as the same data source with identical parameter values.

        Parameter

        Description

        Endpoint

        The instance access address. We recommend that you use the VPC network instance access address. You can view the instance access address on the Instance Details tab of the Instance Management page in the Tablestore console.

        Access Id, Access Key

        The AccessKey ID and AccessKey Secret of the current account. For information about how to obtain them, see Create an AccessKey pair.

        Instance Name

        The name of the instance. You can view the instance name on the All Instances page in the Tablestore console.

    5. Select Default Resource Group, which 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 Tablestore data source.

      When you click Test Connection, the system tests whether the data source can connect to Dataphin normally. If you directly click OK, the system automatically tests the connection for all selected clusters. However, even if all selected clusters fail the connection test, the data source can still be created normally.