Migrate from PolarDB-X 2.0 to Elasticsearch

Prerequisites

• A source PolarDB-X 2.0 instance has been created.

• A destination Elasticsearch instance has been created. For more information, see Create an Alibaba Cloud Elasticsearch instance.

• For the supported versions of the source and destination instances, see Overview of migration solutions.

• The destination Elasticsearch instance must have more storage space than the source PolarDB-X 2.0 instance.

Limitations

Billing

Migration types

• Schema migration

  DTS migrates the schema definitions of the migration objects from the source database to the destination database.

• Full migration

  DTS migrates all historical data of the specified migration objects from the source database to the destination database.

• Incremental migration

  After a full migration is complete, DTS migrates incremental data updates from the source database to the destination database. Incremental migration lets you smoothly migrate data without interrupting your self-managed applications.

SQL operations for incremental migration

Permission requirements for database accounts

Procedure

1. Navigate to the migration task list page for the destination region using one of the following methods.

   From the DTS console

   1. Log on to the Data Transmission Service (DTS) console.

   2. In the navigation pane on the left, click Data Migration.

   3. In the upper-left corner of the page, select the region where the migration instance is located.

   From the DMS console

   Note

   The actual operations may vary based on the mode and layout of the DMS console. For more information, see Simple mode console and Customize the layout and style of the DMS console.

   1. Log on to the Data Management (DMS) console.

   2. In the top menu bar, choose Data + AI > Data Transmission (DTS) > Data Migration.

   3. To the right of Data Migration Tasks, select the region where the migration instance is located.

2. Click Create Task to navigate to the task configuration page.

3. Configure the source and destination databases.

   Warning

   After you select the source and destination instances, we recommend that you carefully read the limits displayed at the top of the page. Otherwise, the task may fail or data inconsistency may occur.

   Section	Parameter	Description
   N/A	Task Name	DTS automatically generates a task name. We recommend that you specify a descriptive name for easy identification. The name does not need to be unique.
   Source Database	Select Existing Connection	To use a database instance that has been added to the system (created or saved), select the desired database instance from the drop-down list. The database information below will be automatically configured. Note In the DMS console, this parameter is named Select a DMS database instance.. If you have not registered the database instance with the system, or do not need to use a registered instance, manually configure the database information below.
   	Database Type	Select PolarDB-X 2.0.
   	Access Method	Select Alibaba Cloud Instance.
   	Instance Region	Select the region where the source PolarDB-X 2.0 instance is located.
   	Replicate Data Across Alibaba Cloud Accounts	This example shows a migration within the same Alibaba Cloud account. Select No.
   	Instance ID	Select the ID of the source PolarDB-X 2.0 instance.
   	Database Account	Enter the database account of the source PolarDB-X 2.0 instance. For information about the required permissions, see Database account permissions.
   	Database Password	Enter the password for the database account.
   Destination Database	Select Existing Connection	To use a database instance that has been added to the system (created or saved), select the desired database instance from the drop-down list. The database information below will be automatically configured. Note In the DMS console, this parameter is named Select a DMS database instance.. If you have not registered the database instance with the system, or do not need to use a registered instance, manually configure the database information below.
   	Database Type	Select Elasticsearch.
   	Access Method	Select Alibaba Cloud Instance.
   	Instance Region	Select the region where the destination Elasticsearch instance is located.
   	Type	Select Cluster Edition or Serverless based on your needs.
   	Instance ID	Select the ID of the destination Elasticsearch instance.
   	Database Account	Enter the database account of the destination Elasticsearch instance. The default account is elastic. For information about the required permissions, see Database account permissions.
   	Database Password	Enter the password for the database account.
   	Encryption	Select HTTP or HTTPS as needed.

4. After you complete the configuration, click Test Connectivity and Proceed at the bottom of the page.

   Note

   • Ensure that the IP address segment of the DTS service is automatically or manually added to the security settings of the source and destination databases to allow access from DTS servers. For more information, see Add DTS server IP addresses to a whitelist.

   • If the source or destination database is a self-managed database (the Access Method is not Alibaba Cloud Instance), you must also click Test Connectivity in the CIDR Blocks of DTS Servers dialog box that appears.

5. Configure the task objects.

   1. On the Configure Objects page, configure the objects that you want to migrate.

      Parameter	Description
      Migration Types	If you only need to perform a full migration, select both Schema Migration and Full Data Migration. To perform a migration with no downtime, select Schema Migration, Full Data Migration, and Incremental Data Migration. Note If you do not select Schema Migration, you must ensure that a database and tables to receive the data exist in the destination database. You can also use the object name mapping feature in the Selected Objects box as needed. If you do not select Incremental Data Migration, do not write new data to the source instance during data migration to ensure data consistency.
      Index Name	Table Name If you select Table Name, the name of the index created in the destination Elasticsearch instance is the same as the table name. In this example, the index name is order. Database Name_Table Name If you select Database Name_Table Name, the name of the index created in the destination Elasticsearch instance is in the Database name_Table name format. In this example, the index name is dtstest_order.
      Processing Mode of Conflicting Tables	Precheck and Report Errors: Checks whether tables with the same names exist in the destination database. If no tables with the same names exist, the precheck is passed. If tables with the same names exist, an error is reported during the precheck, and the data migration task does not start. Note If a table in the destination database has the same name but cannot be easily deleted or renamed, you can change the name of the table in the destination database. For more information, see Object name mapping. Ignore Errors and Proceed: Skips the check for tables with the same names. Warning Selecting Ignore Errors and Proceed may cause data inconsistency and business risks. For example: If the table schemas are consistent and a record in the destination database has the same primary key value as a record in the source database: During full migration, DTS keeps the record in the destination database. The record from the source database is not migrated. During incremental migration, DTS does not keep the record in the destination database. The record from the source database overwrites the record in the destination database. If the table schemas are inconsistent, only some columns of data may be migrated, or the migration may fail. Proceed with caution.
      Capitalization of Object Names in Destination Instance	You can configure the case sensitivity policy for the names of databases, tables, and columns in the destination instance. By default, DTS default policy is selected. You can also select a policy that is consistent with the source or destination database. For more information, see Case sensitivity of object names in destination databases.
      Source Objects	Select one or more objects from the Source Objects section. Click the icon and add the objects to the Selected Objects section. Note The granularity for selecting migration objects is schema, table, and column. If you select only tables or columns as migration objects, other objects such as views, triggers, and stored procedures are not migrated to the destination database.
      Selected Objects	To change the name of a single migration object in the target instance, right-click the object in the Selected Objects box. For more information, see Map individual schema, table, and column names. To change the names of multiple migration objects in the target instance, click Selected Objects in the upper-right corner of the Batch Edit box. For more information, see Map multiple schema, table, and column names. Note The underscore (_) is the only special character supported in index and type names. If you use the object name mapping feature, the migration of other objects that depend on the renamed object may fail. To set a WHERE condition to filter data, right-click the table that you want to migrate in the Selected Objects section, and set the filter condition in the dialog box that appears. For more information, see Filter task data by using SQL conditions. To select the SQL operations to migrate at the database or table level, right-click an object in the Selected Objects box and select the desired SQL operations in the dialog box that appears.

   2. Click Next: Advanced Settings to configure advanced parameters.

      Parameter	Description
      Dedicated Cluster for Task Scheduling	By default, DTS schedules tasks on a shared cluster. You do not need to select one. If you want more stable tasks, you can purchase a dedicated cluster to run DTS migration tasks.
      Retry Time for Failed Connections	After the migration task starts, if the connection to the source or destination database fails, DTS reports an error and immediately begins to retry the connection. The default retry duration is 720 minutes. You can customize the retry time to a value from 10 to 1440 minutes. We recommend that you set the duration to more than 30 minutes. If DTS reconnects to the source and destination databases within the specified duration, the migration task automatically resumes. Otherwise, the task fails. Note For multiple DTS instances that share the same source or destination, the network retry time is determined by the setting of the last created task. Because you are charged for the task during the connection retry period, we recommend that you customize the retry time based on your business needs, or release the DTS instance as soon as possible after the source and destination database instances are released.
      Retry Time for Other Issues	After the migration task starts, if a non-connectivity issue, such as a DDL or DML execution exception, occurs in the source or destination database, DTS reports an error and immediately begins to retry the operation. The default retry duration is 10 minutes. You can customize the retry time to a value from 1 to 1440 minutes. We recommend that you set the duration to more than 10 minutes. If the related operations succeed within the specified retry duration, the migration task automatically resumes. Otherwise, the task fails. Important The value of Retry Time for Other Issues must be less than the value of Retry Time for Failed Connections.
      Enable Throttling for Full Data Migration	During full migration, DTS consumes read and write resources on the source and destination databases, which may increase the database load. If required, you can enable throttling for the full migration task. You can set Queries per second (QPS) to the source database, RPS of Full Data Migration, and Data migration speed for full migration (MB/s) to reduce the load on the destination database. Note This configuration item is available only if you select Full Data Migration for Migration Types. You can also adjust the full migration speed after the migration instance is running.
      Enable Throttling for Incremental Data Migration	If required, you can also choose to set speed limits for the incremental migration task. You can set RPS of Incremental Data Migration and Data migration speed for incremental migration (MB/s) to reduce the load on the destination database. Note This configuration item is available only if you select Incremental Data Migration for Migration Types. You can also adjust the incremental migration speed after the migration instance is running.
      Environment Tag	Optional. Select an environment tag to identify the instance.
      Shard Configuration	Set the number of primary and replica shards for the index based on the maximum shard configuration of the index in the destination Elasticsearch instance.
      String Index	The method for indexing strings in the destination Elasticsearch instance. analyzed: Analyzes the strings before indexing them. You must also select a specific analyzer. For more information about analyzer types and their functions, see Analyzers. not analyzed: Indexes the strings with their original values without analysis. no: Does not index the strings.
      Time Zone	The time zone applied when DTS migrates time-related data types, such as DATETIME and TIMESTAMP, to the destination Elasticsearch instance. Note If these time-related data types do not require a time zone in the destination instance, you must set the document type (type) for these data types in the destination instance before the migration.
      DOCID	The DOCID defaults to the primary key of the table. If the table has no primary key, the DOCID is the ID column that Elasticsearch automatically generates.
      Whether to delete SQL operations on heartbeat tables of forward and reverse tasks	Choose whether DTS writes heartbeat SQL information to the source database while the instance is running. Yes: Does not write heartbeat SQL information to the source database. The DTS instance may display latency. No: Writes heartbeat SQL information to the source database. This may interfere with source database operations like physical backups and cloning.
      Configure ETL	Choose whether to enable the extract, transform, and load (ETL) feature. For more information, see What is ETL? Valid values: Yes: Enables the ETL feature. Enter data processing statements in the code editor. For more information, see Configure ETL in a data migration or data synchronization task. No: Disables the ETL feature.
      Monitoring and Alerting	Select whether to set alerts and receive alert notifications based on your business needs. No: Does not set an alert. Yes: Configure alerts by setting an alert threshold and an alert contact. If a migration fails or the latency exceeds the threshold, the system sends an alert notification.

   3. After you complete the preceding configurations, click Next: Configure Database and Table Fields at the bottom of the page to set the `_routing` policy and `_id` value for the tables to be migrated in the destination Elasticsearch instance.

      Type	Description
      Set _routing	Setting _routing can route and store documents on a specific shard of the destination Elasticsearch instance. For more information, see _routing. Select Yes to use custom columns for routing. Select No to use the _id for routing. Note If the destination Elasticsearch instance is version 7.x, you must select No.
      Value of _id	Primary key column of the table A composite primary key is merged into a single column. Business primary key If you select Business primary key, you must also set the corresponding Business primary key column.

6. Save the task and run a precheck.

   • To view the parameters for configuring this instance when you call the API operation, move the pointer over the Next: Save Task Settings and Precheck button and click Preview OpenAPI parameters in the bubble that appears.

   • If you do not need to view or have finished viewing the API parameters, click Next: Save Task Settings and Precheck at the bottom of the page.

   Note

   • Before the migration task starts, DTS performs a precheck. The task starts only after it passes the precheck.

   • If the precheck fails, click View Details next to the failed check item, fix the issue based on the prompt, and then run the precheck again.

   • If a warning is reported during the precheck:

     • For check items that cannot be ignored, click View Details next to the failed item, fix the issue based on the prompt, and then run the precheck again.

     • For check items that can be ignored, you can click Confirm Alert Details, Ignore, OK, and Precheck Again to skip the alert item and run the precheck again. If you choose to ignore a warning, it may cause issues such as data inconsistency and pose risks to your business.

7. Purchase the instance.

   1. When the Success Rate is 100%, click Next: Purchase Instance.

   2. On the Purchase page, select the link specification for the data migration instance. For more information, see the following table.

      Category	Parameter	Description
      New Instance Class	Resource Group Settings	Select the resource group to which the instance belongs. The default value is default resource group. For more information, see What is Resource Management?
      	Instance Class	DTS provides migration specifications with different performance levels. The link specification affects the migration speed. You can select a specification based on your business scenario. For more information, see Data migration link specifications.

   3. After the configuration is complete, read and select Data Transmission Service (Pay-as-you-go) Service Terms.

   4. Click Buy and Start. In the OK dialog box that appears, click OK.

      You can view the progress of the migration task on the Data Migration Tasks list page.

      Note

      • If the migration task does not include incremental migration, it stops automatically after the full migration is complete. After the task stops, its Status changes to Completed.

      • If the migration task includes incremental migration, it does not stop automatically. The incremental migration task continues to run. While the incremental migration task is running, the Status of the task is Running.

Check migrated index and data

After the data migration task enters the Running state, connect to the Elasticsearch cluster by using Kibana to verify that the index and data are migrated as expected. For more information, see Log on to the Kibana console.