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

Prerequisites

• An ApsaraDB RDS for MySQL instance is created. For more information, see Create an ApsaraDB RDS for MySQL instance. In this example, an ApsaraDB RDS instance that runs MySQL 5.7 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

Create a database and a table in the ApsaraDB RDS for MySQL instance.

• You can use an ApsaraDB RDS for MySQL database or use a self-managed database that is hosted on your on-premises machine. In this example, an ApsaraDB RDS for MySQL database is used. For more information, see Getting started.

• In this example, the following statements are executed to create a table and insert data into the table:

  -- create table
  CREATE TABLE `es_test` (
      `id` bigint(32) NOT NULL,
      `name` varchar(32) NULL,
      `age` bigint(32) NULL,
      `hobby` varchar(32) NULL,
      PRIMARY KEY (`id`)
  ) ENGINE=InnoDB
  DEFAULT CHARACTER SET=utf8;
  
  -- insert data
  INSERT INTO `es_test` (`id`,`name`,`age`,`hobby`) VALUES (1,'user1',22,'music');
  INSERT INTO `es_test` (`id`,`name`,`age`,`hobby`) VALUES (2,'user2',23,'sport');
  INSERT INTO `es_test` (`id`,`name`,`age`,`hobby`) VALUES (3,'user3',43,'game');
  INSERT INTO `es_test` (`id`,`name`,`age`,`hobby`) VALUES (4,'user4',24,'run');
  INSERT INTO `es_test` (`id`,`name`,`age`,`hobby`) VALUES (5,'user5',42,'basketball');

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 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 newly created resource group and click Network Settings in the Actions column to associate the resource group with a VPC. For more information, see Associate an 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 more information, see Configure an IP address whitelist.

   The exclusive resource group must be connected to the VPC where the ApsaraDB RDS for MySQL 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 ApsaraDB RDS for MySQL instance and with those of the Elasticsearch cluster. For information about how to view the VPC where the ApsaraDB RDS for MySQL instance resides, see Change the VPC and vSwitch. 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 ApsaraDB RDS for MySQL instance and the Elasticsearch cluster belong to the private IP address whitelists of the ApsaraDB RDS for MySQL instance and Elasticsearch cluster. For more information, see Configure an IP address whitelist for an ApsaraDB RDS for MySQL instance and 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 ApsaraDB RDS for MySQL 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 an ApsaraDB RDS for MySQL data source.

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

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

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

      For more information, see Add a MySQL data source.

   4. In the Connection Configuration section, find the resource group and click Test Network Connectivity in the Connection Status column. If Connected is displayed, the resource group is connected to the ApsaraDB RDS for MySQL 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 Workspaces.

   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.

3. Configure the network and resources.

   1. For the source part, set Source to MySQL and Data Source Name to the name of the added ApsaraDB RDS for MySQL 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.

   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: Verify the data synchronization result

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 /es_test/_search?pretty
   {
   "query": { "match_all": {}}
   }

   Note

   You must replace es_test with the index name that you specify when you configure the batch synchronization task.

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