OceanBase Migration Service (OMS) Community Edition V4.2.0 and later allow you to migrate data from an HBase database to OBKV. This topic describes the HBaseSource parameters.
| Parameter | Value | Description |
|---|---|---|
| queryType | scan or hfile |
The query method. This parameter applies only to full migration. scan indicates that the full data is queried by region scans. hfile indicates that the full data is queried by reading files. |
| flushTable | true or false. The default value is true. |
This parameter is optional and applies only to full migration. It specifies whether to perform a flush operation before the full migration starts if the queryType parameter is set to hfile. |
| negativeTs | true or false. The default value is true. |
This parameter applies to both full migration and incremental synchronization. It specifies whether to convert a timestamp to a negative number when OMS Community Edition reads the HBase database. Note Timestamps in OBKV are negative. |
| maxVersions | A number. The default value is -1, which indicates that all versions are read. |
If you set the queryType parameter to scan, you must specify this parameter, which applies only to full migration. This parameter specifies the maximum number of versions to read. |
| initPeerOnly | true or false |
Specifies whether to initialize only the peer. This parameter applies only to incremental synchronization. If the parameter is set to true, the start point for pulling logs is initialized after the peer is initialized, and the log processor does not process data. This way, the peer is created before full migration starts. After full migration is completed, you can set the initPeerOnly parameter to false in the console of OMS Community Edition, and then restart the incremental synchronization task to process the incremental data. |
| peer | A name string. | This parameter applies only to incremental synchronization. The name of the peer created in the source HBase database in the oms_{projectname} format. |
| createPeer | true or false. The default value is true. |
This parameter applies only to incremental synchronization. If you set the parameter to true, you need to create a peer. If you set the parameter to false, you do not need to create a peer. If a peer already exists, you can set the parameter to false. |
| autoPort | true or false. The default value is true. |
Specifies whether to automatically use available ports. This parameter applies only to incremental synchronization. If you set the autoPort parameter to true, programs automatically obtain the required ports. A port number ranges from 9000 to 60000. |
| zkHost | An IP address, or multiple IP addresses separated by commas (,). | This parameter applies only to incremental synchronization. It is equivalent to the hbase.zookeeper.quorum parameter, and specifies the IP addresses of the ZooKeeper servers that a program uses to simulate startup of HBase. It is specified in the format of ip1:port1,ip2:port2,ip3:port3. |
| zkPath | The ZooKeeper path. | This parameter applies only to incremental synchronization. It is equivalent to the zookeeper.znode.parent parameter, and specifies the ZooKeeper path that a program uses to simulate startup of HBase. |
| hbaseRootDir | The root directory of the HBase cluster. | This parameter is optional and applies only to incremental synchronization. It is equivalent to the hbase.rootdir parameter and is used by a program to simulate startup of HBase. By default, the program automatically uses a local directory as the value of hbase.rootdir. |
| regions | A number. | The number of started region servers. This parameter applies only to incremental synchronization and takes effect if you set the autoPort parameter to true. If you set the autoPort parameter to false, the number of started region servers is specified by the regionServerPorts parameter. |
| masterPort | A number. | This parameter applies only to incremental synchronization. It specifies the port of the simulated HMaster service. The port is allocated by OMS. |
| masterInfoPort | A number. | This parameter applies only to incremental synchronization. It specifies the information port of the simulated HMaster service. |
| regionServerPorts | A JSON array, for example, [123,3434]. | This parameter applies only to incremental synchronization. It specifies the port numbers of simulated region servers. The number of ports indicates that of started region servers. The value is a JSON array, for example, [123,3434]. |
| regionServerInfoPorts | A JSON array, for example, [123,3434]. | This parameter applies only to incremental synchronization. It specifies the information port numbers of the simulated region servers. The value must be greater than or equal to that of the regionServerPorts parameter. The value is a JSON array, for example: [123,3434]. |