Elasticsearch:Use DataWorks to synchronize data from MaxCompute to Alibaba Cloud Elasticsearch

Step 1: Prepare source data

Create a table in MaxCompute and import data into the table. For more information, see Create tables and Import data to tables.

The following figures show the table schema and a part of the table data.

• Table schema

• Table data

Step 2: Create and configure 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 Group.

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

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. On the page that appears, click Pay.

   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 Configure an IP address whitelist.

   The exclusive resource group must be connected to 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 Elasticsearch cluster. For information about how to view the VPC, zone, and vSwitch of the Elasticsearch cluster, see View the basic information of a cluster.

   Important

   After you associate the exclusive resource group with the VPC, you need to add the CIDR block of the vSwitch to which the Elasticsearch cluster belong to a private IP address whitelist of the 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 Associate 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 MaxCompute project 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 Workspace.

   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 MaxCompute data source.

   1. On the Data Sources page, click Add Data Source.

   2. In the Add Data Source dialog box, search for and select MaxCompute.

   3. In the Add MaxCompute Data Source dialog box, configure the parameters in the Basic Information section.

      For more information, see Add a MaxCompute data source.

   4. Find the resource group in the Connection Configuration section and click Test Network Connectivity. If Connected is displayed, the resource group is connected to the data source.

   5. Click Complete.

4. 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 Workspace.

   3. Find the workspace and choose Shortcuts > Data Development 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.

1. Configure the network and resources.

   1. For the source part, set Source to MaxCompute(ODPS) and Data Source Name to the name of the added MaxCompute 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.

2. Click Next.

3. 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.

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

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

4. 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. The following code shows a part of operational logs:

      2023-10-31 16:52:35 INFO Exit code of the Shell command 0
      2023-10-31 16:52:35 INFO --- Invocation of Shell command completed ---
      2023-10-31 16:52:35 INFO Shell run successfully!
      2023-10-31 16:52:35 INFO Current task status: FINISH
      2023-10-31 16:52:35 INFO Cost time is: 33.106s

Step 5: Verify the data synchronization result

In the Kibana console, view the synchronized data and search for data based on specific conditions.

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

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

2. Click the icon in the upper-left corner of the page that appears and select Dev Tools.

3. On the Console tab, run the following command to view the synchronized data:

   POST /odps_index/_search?pretty
   {
   "query": { "match_all": {}}
   }

   Note

   Change odps_index to the value that you specified for the Index parameter when you configure the task.

   If the data is synchronized, the result shown in the following figure is returned.

4. Run the following command to search for the category and brand fields in the data:

   POST /odps_index/_search?pretty
   {
   "query": { "match_all": {} },
   "_source": ["category", "brand"]
   }

5. Run the following command to search for documents in which the value of the category field is fresh:

   POST /odps_index/_search?pretty
   {
   "query": { "match": {"category":"fresh"} }
   }

6. Run the following command to sort documents based on the trans_num field:

   POST /odps_index/_search?pretty
   {
   "query": { "match_all": {} },
   "sort": { "trans_num": { "order": "desc" } }
   }

   For more information about other commands and their use scenarios, see open source Elasticsearch documentation.