All Products
Search
Document Center

Dataphin:Create a Redis data source

Last Updated:Mar 05, 2025

This topic explains how to create a Redis data source, allowing Dataphin to write business data to Redis.

Background information

Redis is a high-performance key-value database used in scenarios such as caching, event publishing and subscribing, and high-speed queues. For more information, visit the Redis Official Website.

Permissions description

Only custom global roles with the Create Data Source permission and system roles such as Super Administrator, Data Source Administrator, Section Architect, and Project Administrator can create data sources.

Procedure

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

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

  3. In the New Data Source dialog box, in the NoSQL area, select Redis.

    If you have recently used Redis, you can also select it in the Recently Used area. Alternatively, enter 'Redis' in the search box for a quick search.

  4. In the New Redis Data Source dialog box, configure the relevant connection parameters.

    1. Configure the basic information for the data source.

      Parameter

      Description

      Datasource Name

      The naming convention is as follows:

      • Can only contain Chinese characters, letters, numbers, underscores (_), or hyphens (-).

      • Cannot exceed 64 characters in length.

      Datasource Code

      After configuring the data source encoding, you can reference tables in the data source in Flink_SQL tasks using the format DatasourceCode.TableName or DatasourceCode.Schema.TableName. If you need to automatically access the data source of the corresponding environment based on the environment, access it using the variable format ${DatasourceCode}.table or ${DatasourceCode}.schema.table. For more information, see Dataphin Data Source Table Development Method.

      Important
      • Once the data source encoding is successfully configured, it cannot be modified.

      • After the data source encoding is successfully configured, data preview can be performed on the object details page of the asset directory and asset checklist.

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

      Datasource Description

      A brief description of the data source. No more than 128 characters.

      Datasource Configuration

      Select the data source to be configured:

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

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

      Tag

      You can classify and label the data source based on tags. For 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 steps, the configuration page for Production + Development Data Source is displayed. If you selected Production Data Source in the previous steps, only the configuration page for Production Data Source is displayed.

      Note

      Typically, production and development data sources should be configured separately to maintain environmental isolation and minimize the impact of development activities on production data sources. However, Dataphin also allows them to be configured identically.

      Parameter

      Description

      Deployment Method

      Supports two different deployment methods: Cluster and Standalone.

      Host

      The endpoint that is used to access the Redis database. If you use Alibaba Cloud Redis service, you can refer to Cloud Database Redis - Step 3: Connect to the Redis instance to obtain it.

      Port

      Enter the port of the Redis instance.

      Password

      The password to access the Redis instance.

  5. Click Test Connection to verify the data source's connectivity with Dataphin.

  6. Click OK to finalize the creation of the Redis data source.