All Products
Search

This Product

    Dataphin:Create a Tablestore data source

    Document Center

    Dataphin:Create a Tablestore data source

    Last Updated:Jun 23, 2026

    Create a Tablestore data source to enable Dataphin to read business data from or write data to Tablestore.

    Background information

    Alibaba Cloud Tablestore provides Serverless table storage services for massive structured data and offers a one-stop IoTstore solution optimized for IoT scenarios. Tablestore supports millisecond-level online data queries and multi-dimensional analysis. It is suitable for scenarios such as billing, instant messaging (IM), Internet of Things (IoT), Internet of Vehicles (IoV), risk control, and intelligent recommendation.

    To use Tablestore with Dataphin for data development, or to 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.

      Alternatively, select Tablestore from the Recently Used section if available, or search for it by keyword 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.

        • 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

        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

        We recommend configuring 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.

        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.

      Clicking Test Connection verifies connectivity between the data source and Dataphin. If you click OK directly, the system tests all selected clusters automatically. The data source is created even if all clusters fail the connection test.