DataWorks provides Redis Reader and Redis Writer for you to read data from and write data to Redis data sources. You can use the code editor to configure synchronization nodes for Redis data sources.

Background information

Remote Directory Server (Redis) is a document-based Not only SQL (NoSQL) database that provides persistent and in-memory database services. Redis provides high read and write performance and flexible capacity to meet changing business requirements based on the highly reliable two-node hot standby architecture and the cluster architecture that can be seamlessly scaled.

Procedure

  1. Go to the Data Source page.
    1. Log on to the DataWorks console.
    2. In the left-side navigation pane, click Workspaces.
    3. After you select the region where the required workspace resides, find the workspace and click Data Integration in the Actions column.
    4. In the left-side navigation pane of the Data Integration page, choose Data Source > Data Sources to go to the Data Source page.
  2. On the Data Source page, click Add data source in the upper-right corner.
  3. In the Add data source dialog box, click Redis in the NoSQL section.
  4. In the Add Redis data source dialog box, configure the parameters.
    You can use one of the following modes to add a Redis data source: Alibaba Cloud instance mode and Connection string mode.
    • The following table describes the parameters you must configure if you add a Redis data source by using the Alibaba Cloud instance mode. Redis
      Parameter Description
      Data source type The type of the data source. Set this parameter to Alibaba Cloud instance mode.
      Data Source Name The name of the data source. The name can contain letters, digits, and underscores (_) and must start with a letter.
      Data source description The description of the data source. The description can be a maximum of 80 characters in length.
      Environment The environment in which the data source is used. Valid values: Development and Production.
      Note This parameter is displayed only when the workspace is in standard mode.
      Region The region where the data source resides.
      Redis instance ID The ID of the ApsaraDB for Redis instance. You can log on to the ApsaraDB for Redis console to view the ID.
      Redis access password The password that is used to connect to the ApsaraDB for Redis instance. Leave it empty if no password is required.
    • The following table describes the parameters you must configure if you add a Redis data source by using the connection string mode. Redis
      Parameter Description
      Data source type The type of the data source. Set this parameter to Connection string mode.

      If you select this mode, you must use custom resource groups for scheduling to run synchronization nodes. For more information, see Create a custom resource group for scheduling.

      Data Source Name The name of the data source. The name can contain letters, digits, and underscores (_) and must start with a letter.
      Data source description The description of the data source. The description can be a maximum of 80 characters in length.
      Environment The environment in which the data source is used. Valid values: Development and Production.
      Note This parameter is displayed only when the workspace is in standard mode.
      Server address The server address. Specify this parameter in the format of Host address:Port number.
      Add server address Click Add server address to add a server address in the format of Host address:Port number.
      Redis access password The password that is used to connect to the ApsaraDB for Redis instance.
  5. Set Resource Group connectivity to Data Integration.
  6. Find the desired resource group in the resource group list in the lower part of the dialog box and click Test connectivity in the Actions column.
    A synchronization node can use only one type of resource group. To ensure that your synchronization nodes can be normally run, you must test the connectivity of all the resource groups for Data Integration on which your synchronization nodes will be run. If you want to test the connectivity of multiple resource groups for Data Integration at a time, select the resource groups and click Batch test connectivity. For more information, see Select a network connectivity solution.
    Note
    • By default, the resource group list displays only exclusive resource groups for Data Integration. To ensure the stability and performance of data synchronization, we recommend that you use exclusive resource groups for Data Integration.
    • If you want to test the network connectivity between the shared resource group or a custom resource group and the data source, click Advanced below the resource group list. In the Warning message, click Confirm. Then, all available shared and custom resource groups appear in the resource group list.
  7. After the data source passes the connectivity test, click Complete.

What to do next

You have learned how to add a Redis data source. You can proceed to the next tutorial. In the next tutorial, you will learn how to configure Redis Writer. For more information, see Redis Writer.