Modify system parameters

OceanBase Migration Service (OMS) Community Edition allows an admin user to modify system parameters and a general user to only view system parameters.

Procedure

1. Log on to the console of OMS Community Edition.

2. In the left-side navigation pane, choose System Management > System Parameters.

   The table on the System Parameters page contains the following columns: Parameter Name, Value, Module, Description, and Modified At.

   Parameter	Description	Default value
   struct.obkv.createtable	When you migrate data from an HBase database to OBKV, you can modify the value of this parameter to specify the default CREATE TABLE statement in OBKV for schema migration in all projects.	create table if not exists {TABLE_NAME} (Kvarbinary(1024) not null,Qvarbinary(256) not null,Tbigint not null,Vvarbinary(1048576),primary key(K,Q,T)) partition by key(K) partitions 64;
   mysql_to_obmysql.charset.mapping	The rules for converting unsupported character sets in a project that migrates data from a MySQL database to OceanBase Database Community Edition.	[] [{"charset":"utf16le","mappedCharset":"utf16"},{"charset":"*","mappedCharset":"utf8mb4"}]
   sync.unified.config	The parameters that you must specify for all synchronization projects of OMS Community Edition: enableHadoopVendorsKafkaServer: specifies whether the Kafka server supports Hadoop. disableIdentificationAlgorithm: specifies whether to disable hostname (domain name) verification for the address of the created Kafka data source that requires SSL authentication. If the SSL root certificate provided does not contain the address of this Kafka data source, you can set this parameter to true to disable hostname verification. checkStoreStartedMinSyncProcess: the minimum synchronization progress for determining whether the store is properly started. Default value: 3s. You can change the value and the change takes effect in real time. The full migration starts only when the store is running and the synchronization progress exceeds the specified minimum value. fullJvmMem: the initial memory for the connector during full migration. Default value: 4096 MB. incrJvmMem: the initial memory for the connector during incremental migration. Default value: 2048 MB.	{"enableHadoopVendorsKafkaServer":false,"checkStoreStartedMinSyncProcess":3,"fullJvmMem":4096,"incrJvmMem":2048}
   sync.ddl.supported	The DDL operations supported for data synchronization projects.	{"supportConfigs":{"ADB_SINK":["ALTER_TABLE","ALTER_TABLE_ADD_COLUMN","ALTER_TABLE_MODIFY_COLUMN"],"DATAFLOW_SINK":["ALTER_TABLE","ALTER_TABLE_ADD_COLUMN","ALTER_TABLE_MODIFY_COLUMN"]}}
   sync.connnector.max.size	The maximum number of concurrent data synchronization projects.	2
   struct.transfer.config	The parameters related to the execution of a schema migration task.	{"dbcat.ob.query.timeout": 15, "ob.parallel": 2, "independent.obj.convert.batch.size": 50, "independent.obj.convert.partition.size": 10, "independent.obj.execute.batch.size": 50, "independent.obj.execute.partition.size": 2, "independent.core.pool.size": 256, "independent.max.pool.size": 256, "independent.queue.capacity": 16}
   store.topic.mode.config	The rules for building an allowlist of store subtopics in a data synchronization project in OMS Community Edition. OceanBase Database supports store subtopics in unshared and shared modes. Store subtopics in shared mode can be shared within a cluster and among tenants. In the oceanbase field, you can specify UN_SHARE, DATABASE, OCEANBASE_TENANT, or OCEANBASE_CLUSTER for mode. mode_num specifies the maximum subscription granularity for the specified mode. Sharing within a cluster: A store is shared within a cluster. The store configurations in tenants are invalid. The first created store is reused. A new store is created only when the current store does not meet the timestamp requirements. Sharing among tenants: When the value of mode_num is 1, different stores are created for different tenants. When the value of mode_num is greater than 1, multiple tenants share the same store. The number of affected tenants is the value of mode_num minus 1, and the first created store is reused. A new store is created only when the current store does not meet the timestamp requirements. OceanBase Database in MySQL mode supports the subscription of store subtopics based only on service instances. In the mysql field, you can specify only INSTANCE for mode.	{"oceanbase":{"mode":"OCEANBASE_TENANT","modeNum":1},"mysql":{"mode":"INSTANCE","modeNum":1}}
   precheck.skippable_flags	Specifies whether to skip the precheck. In the case of failed precheck items, if you confirm that they have no impact on the database service, you can set their values to true in the precheck.skippable_flags parameter. The value of this parameter is of the JSON type. Example: { "DB_ACCOUNT_FULL_READ_PRIVILEGE": true, "DB_ACCOUNT_INCR_READ_PRIVILEGE":true, "DB_SERVICE_STATUS":true }. For more information about the values of different precheck items, see the "Precheck items" section in this topic.	{}
   ops.store.max_count_per_subtopic	The maximum number of active store processes allowed under a subtopic. The value indicates the maximum number of active store processes allowed.	6
   oms.user.password.expiration.date.config	The expiration strategy for different user passwords.	{"rootRolePasswordValidityDays":90,"rootViewerRolePasswordValidityDays":90,"adminRolePasswordValidityDays":90,"adminViewerRolePasswordValidityDays":90,"userRolePasswordValidityDays":90,"userViewerRolePasswordValidityDays":90,"userPasswordValidityDaysTipsThreshold":30}
   oms.captcha.enable	Specifies whether to enable the verification code feature. After you change the value to true, an image verification code appears on the logon page. The image verification code will time out in 10 minutes. You must enter the verification code to log on to OMS Community Edition. A timeout or input error will cause a logon failure.	false
   obmysql41_to_obmysql40_and_earlier.collation.mapping	The rules for converting unsupported collations in a project that migrates data from OceanBase Database Community Edition V4.1.0 to OceanBase Database Community Edition of an earlier version.	[{"collation":"latin1_swedish_ci","mappedCollation":"utf8mb4_general_ci"}]
   obmysql41_to_obmysql40_and_earlier.charset.mapping	The rules for converting unsupported character sets in a project that migrates data from OceanBase Database Community Edition V4.1.0 to OceanBase Database Community Edition of an earlier version.	[{"charset":"latin1","mappedCharset":"utf8mb4"}]
   mysql_to_obmysql.collation.mapping	The rules for converting unsupported collations in a project that migrates data from a MySQL database to a MySQL tenant of OceanBase Database.	[] Example: [{"collation":"utf16le_general_ci","mappedCollation":"utf16_general_ci"},{"collation":"*","mappedCollation":"utf8mb4_general_ci"}]
   alarm.thresholds	The alert thresholds. failedLengthOfTimeThreshold: the failure alert threshold for a project. syncDelayThreshold: the delay alert threshold for a synchronization project. syncFailedLengthOfTimeThreshold: the failure time alert threshold for a synchronization project. migrateDelayThreshold: the delay alert threshold for a migration project. migrateFailedLengthOfTimeThreshold: the failure time alert threshold for a migration project. alarmRestrainTimeOfMin: the alert suppression time by alert level. HIGH: the high protection level. MEDIUM: the medium protection level. LOW: the low protection level. IGNORE: the No Protection level.	{"delayThreshold":{"HIGH":30,"MEDIUM":300,"LOW":900},"failedLengthOfTimeThreshold":{"HIGH":30,"MEDIUM":300,"LOW":900},"alarmRestrainTimeOfMin":{"HIGH":3,"MEDIUM":3,"LOW":3,"IGNORE":100},"rule":"OMS_CONFIG_RULE_ALARM_THRESHOLDS"}
   mysql.store.metabuilder.filter	Specifies whether the MySQL store filters metadata based on the allowlist. Valid values: true and false. true: indicates that metadata is filtered based on the allowlist. false: indicates that all metadata is pulled without filtering. In scenarios without online DDL statements, which need to be implemented by using the RENAME TABLE statement, we recommend that you set this parameter to true to reduce the time for obtaining metadata. If online DDL statements are used, set this parameter to false. Otherwise, subsequent data cannot be consumed after an online DDL statement is executed.	false
   migration.timeout	The timeout configuration for the migration object.	{"ddl.timeout.in.private.cloud": 172800000, "ddl.timeout.in.public.cloud": 172800000}
   migration.record.init.batch_size	The initial batch size of schema migration objects.	100
   migration.mysql.support_datatypes	The allowlist of data types supported by the source MySQL database in data migration. The value is an array of data types supported by MySQL. Each element is one MySQL data type.	[]
   migration.mysql.support_collations	The allowlist of collations supported by the source MySQL database in data migration.	["binary","gbk","gb18030","utf8mb4","utf16","utf8"]
   migration.mysql.support_charsets	The allowlist of character sets supported by the source MySQL database in data migration. The value is an array of character sets supported by MySQL. Each element is one MySQL character set.	["binary","utf8mb4","utf8"]
   migration.db.support_versions	The source database versions supported in data migration. The key is the database type, and the value is a regular expression containing supported database versions. "MYSQL": "(5.5\|5.6\|5.7\|8.0).*" indicates that OMS Community Edition supports MySQL 5.5, 5.6, 5.7, and 8.0. "MARIADB": "10.\[12345\].\*" indicates that OMS Community Edition supports MariaDB 10.1.0 to 10.5.9. "POSTGRESQL": "(10).\*" indicates that OMS Community Edition supports PostgreSQL 10.x.	{ "MYSQL": "(5.5|5.6|5.7|8.0).*", "MARIADB": "10.[12345].*", "POSTGRESQL": "(10).*"}
   migration.db.dest.support_versions	The destination database versions supported in data migration.	{"POLARDB_X_1": {"OB_MYSQL": "(1	2	3).*"}}
   migration.checker.params.steady	The parameters that need to be specified when the concurrency of the Full-Import component is set to Stable. limitator.platform.threads.number: the number of threads. limitator.select.batch.max: the batch query size in full data migration or verification. limitator.image.insert.batch.max: the batch INSERT size in full data migration. limitator.datasource.connections.max: the number of connections. If the number of concurrent threads exceeds the number of connections, the concurrent data is invalid. limitator.java.opt: the Java virtual machine (JVM) parameters.	{"limitator.platform.threads.number": 4, "limitator.select.batch.max": 200, "limitator.image.insert.batch.max": 100,"limitator.datasource.connections.max":50, "limitator.java.opt":"-server -Xms4g -Xmx4g -Xmn2g -Xss256k"}
   migration.checker.params.normal	The parameters that need to be specified when the concurrency of the Full-Import component is set to Normal. limitator.platform.threads.number: the number of threads. limitator.select.batch.max: the batch query size in full data migration or verification. limitator.image.insert.batch.max: the batch INSERT size in full data migration. limitator.datasource.connections.max: the number of connections. If the number of concurrent threads exceeds the number of connections, the concurrent data is invalid. limitator.java.opt: the JVM parameters.	{"limitator.platform.threads.number": 8, "limitator.select.batch.max": 600, "limitator.image.insert.batch.max": 200,"limitator.datasource.connections.max":50, "limitator.java.opt":"-server -Xms8g -Xmx8g -Xmn4g -Xss256k"}
   migration.checker.params.fast	The parameters that need to be specified when the concurrency of the Full-Import component is set to Fast. limitator.platform.threads.number: the number of threads. limitator.select.batch.max: the batch query size in full data migration or verification. limitator.image.insert.batch.max: the batch INSERT size in full data migration. limitator.datasource.connections.max: the number of connections. If the number of concurrent threads exceeds the number of connections, the concurrent data is invalid. limitator.java.opt: the JVM parameters.	{"limitator.platform.threads.number": 32, "limitator.select.batch.max": 1200, "limitator.image.insert.batch.max": 400,"limitator.datasource.connections.max":50, "limitator.java.opt":"-server -Xms16g -Xmx16g -Xmn8g -Xss256k"}
   ha.config	Specifies whether to enable high availability (HA). For more information, see Modify high availability configurations.	{"enable":false,"enableHost":false,"enableStore":true,"enableConnector":true,"enableJdbcWriter":true,"subtopicStoreNumberThreshold":5,"checkRequestIntervalSec":600,"checkHostDownIntervalSec":540,"checkModuleExceptionIntervalSec":240,"clearAbnormalResourceHours":72}
   oms.telemetry	OMS supports the telemetry feature. If the value of enabled is true, the telemetry feature is enabled. For more information, see Telemetry parameters	{"url":"<https://openwebapi.oceanbase.com","enabled":true}

3. Click the edit icon in the Value column for a specified parameter.

4. In the Modify Value dialog box, set Value or click Reset to Default.

5. Click OK.

Precheck items

The following table describes precheck items that are controlled by the precheck.skippable_flags parameter. The value true indicates that the key can be skipped, and the value false indicates that the key cannot be skipped. For example, if the precheck of the unique key and foreign key can be skipped, you can specify the following statements to configure the precheck.skippable_flags parameter:

{
  "DB_UK_INDEX": true,
  "DB_FOREIGN_REFERENCE":true,
}

You can log on to the console of OMS Community Edition, go to the details page of a data migration project, and view the names of the precheck items on the Precheck tab, which are prefixed with "Source-" or "Destination-".