Elasticsearch:Use DataWorks to synchronize data from PolarDB-X to Alibaba Cloud Elasticsearch

Prerequisites

• A PolarDB-X instance is created.

• An Alibaba Cloud Elasticsearch cluster is created, and the Auto Indexing feature is enabled for the cluster. For more information, see Create an Alibaba Cloud Elasticsearch cluster and Configure the YML file.

• A DataWorks workspace is created. For more information, see Create a workspace.

Billing

• For information about the billing of Alibaba Cloud Elasticsearch clusters, see Elasticsearch billable items.

• For information about the billing of exclusive resource groups for Data Integration, see Billing of exclusive resource groups for Data Integration (subscription).

Step 1: Prepare source data

1. Insert data into a table in the PolarDB-X instance.

   For more information, see Basic SQL operations. The following figure shows the test data that is used in this example.

Step 2: Create an exclusive resource group for Data Integration

Create an exclusive resource group for Data Integration, and associate the resource group with a virtual private cloud (VPC) and the created workspace. Exclusive resource groups ensure fast and stable data transmission.

1. Log on to the DataWorks console.

2. In the top navigation bar, select a region. In the left-side navigation pane, click Resource Groups.

3. On the Exclusive Resource Groups tab of the Resource Groups page, click Create Resource Group for Data Integration.

4. On the DataWorks Exclusive Resources page, set Type to Exclusive Resource Groups for Data Integration, configure Resource Group Name, and then click Buy Now.

   For more information, see Create an exclusive resource group for Data Integration.

5. On the Exclusive Resource Groups tab, find the created resource group and click Network Settings in the Actions column to associate the resource group with a VPC. For more information, see Associate the exclusive resource group for Data Integration with a VPC.

   Note

   In this example, an exclusive resource group for Data Integration is used to synchronize data over a VPC. For information about how to use an exclusive resource group for Data Integration to synchronize data over the Internet, see Add the EIP or CIDR block of an exclusive resource group for Data Integration to an IP address whitelist of a data source.

   The exclusive resource group must be connected to the VPC where the PolarDB-X instance resides and the VPC where the Elasticsearch cluster resides. This way, data can be synchronized based on the exclusive resource group. Therefore, you must associate the exclusive resource group with the VPC, zone, and vSwitch of the PolarDB-X instance and with those of the Elasticsearch cluster. For information about how to view the VPC where the Elasticsearch cluster resides, see View the basic information of a cluster.

   Important

   After you associate the exclusive resource group with the VPCs, you need to add the CIDR blocks of the vSwitches to which the PolarDB-X instance and the Elasticsearch cluster belong to the private IP address whitelists of the PolarDB-X instance and Elasticsearch cluster. For more information, see Configure a public or private IP address whitelist for an Elasticsearch cluster.

6. Click the back icon in the upper-left corner of the page to return to the Resource Groups page.

7. On the Exclusive Resource Groups tab, find the resource group and click Change Workspace in the Actions column to associate the resource group with the created workspace.

   For more information, see Associate the exclusive resource group for Data Integration with a workspace.

Step 3: Add data sources

Add the PolarDB-X instance and Elasticsearch cluster to Data Integration as data sources.

1. Go to the Data Integration page.

   1. Log on to the DataWorks console.

   2. In the left-side navigation pane, click Workspaces.

   3. Find the workspace and choose Shortcuts > Data Integration in the Actions column.

2. In the left-side navigation pane of the Data Integration page, click Data Source.

3. Add a PolarDB-X data source.

4. On the Data Source List page, click Add Data Source.

5. In the Add data source dialog box, search for and select DRDS.

6. In the Add DRDS data source dialog box, configure the parameters and test connectivity. After the connectivity test is passed, click Complete.

   For more information, see Add a PolarDB-X data source.

7. Add an Elasticsearch data source in the same way. For more information, see Add an Elasticsearch data source.

Step 4: Configure and run a batch synchronization task

The exclusive resource group is used to run the batch synchronization task. The resource group obtains data from the source and writes the data to the Elasticsearch cluster.

1. Go to the DataStudio page of DataWorks.

   1. Log on to the DataWorks console.

   2. In the left-side navigation pane, click Workspaces.

   3. Find the workspace and choose Shortcuts > Data Integration in the Actions column.

2. Create a batch synchronization task.

   1. In the left-side navigation pane, choose Create > Create Workflow to create a workflow.

   2. Right-click the name of the newly created workflow and choose Create Node > Offline synchronization.

   3. In the Create Node dialog box, configure the Name parameter and click Confirm.

3. Configure the network and resources.

   1. For the source part, set Source to DRDS and Data Source Name to the name of the added PolarDB-X data source.

   2. For the resource group part, select the created exclusive resource group.

   3. For the destination part, set Destination to Elasticsearch and Data Source Name to the name of the added Elasticsearch data source.

4. Click Next.

5. Configure the task.

   1. In the Source section, select the table whose data you want to synchronize.

   2. In the Destination section, configure the parameters.

   3. In the Field Mapping section, configure mappings between source fields and destination fields.

      In this example, the default source fields are used. You need to only change destination fields. Click the icon to the right of destination fields. In the dialog box that appears, enter the following information:

      {"name":"Name","type":"text"}
      {"name":"Platform","type":"text"}
      {"name":"Year_of_Release","type":"date"}
      {"name":"Genre","type":"text"}
      {"name":"Publisher","type":"text"}
      {"name":"na_Sales","type":"float"}
      {"name":"EU_Sales","type":"float"}
      {"name":"JP_Sales","type":"float"}
      {"name":"Other_Sales","type":"float"}
      {"name":"Global_Sales","type":"float"}
      {"name":"Critic_Score","type":"long"}
      {"name":"Critic_Count","type":"long"}
      {"name":"User_Score","type":"float"}
      {"name":"User_Count","type":"long"}
      {"name":"Developer","type":"text"}
      {"name":"Rating","type":"text"}

   4. In the Channel Control section, configure the parameters.

   For more information, see Configure a batch synchronization task by using the codeless UI.

6. Run the task.

   1. (Optional) Configure scheduling properties for the task. In the right-side navigation pane, click Properties. On the Properties tab, configure the parameters based on your business requirements. For more information about the parameters, see Scheduling configuration.

   2. In the upper-left corner, click the Save icon to save the task.

   3. In the upper-left corner, click the Submit icon to submit the task.

      If you configure scheduling properties for the task, the task is automatically run on a regular basis. You can also click the Run icon in the upper-left corner to run the task immediately.

      If Shell run successfully! is displayed in operational logs, the task runs successfully.

Step 5: View the synchronized data

1. Log on to the Kibana console of the Elasticsearch cluster.

   For more information, see Log on to the Kibana console.

2. In the left-side navigation pane, click Dev Tools.

3. On the Console tab of the page that appears, run the following command to query the volume of data in the Elasticsearch cluster.

   Note

   You can compare the queried data volume with the volume of data in the source to check whether all data is synchronized.

   GET drdstest/_search
   {
     "query": {
       "match_all": {}
     }
   }

   If the command is successfully run, the result shown in the following figure is returned.

4. Run the following command to search for data by using a specific field:

   GET drdstest/_search
   {
     "query": {
       "term": {
         "Publisher.keyword": {
           "value": "Nintendo"
         }
       }
     }
   }

   If the command is successfully run, the result shown in the following figure is returned.