Parameter | Description | Required | Default value |
haveKerberos | Specifies whether Kerberos authentication is required. Valid values: true and false. Note If you set this parameter to true, Kerberos authentication is required, and you must configure the following parameters that are related to Kerberos authentication: If you set this parameter to false, Kerberos authentication is not required, and you do not need to configure the preceding parameters.
| No | false |
hbaseConfig | The properties of the HBase cluster, in the JSON format. The hbase.zookeeper.quorum parameter is required. It specifies the ZooKeeper address of the HBase cluster. You can also configure other properties, such as those related to the cache and batch for scan operations to optimize interaction with servers. Note You must use an internal endpoint to access an ApsaraDB for HBase database. | Yes | No default value |
mode | The write mode. Only the normal mode is supported. The dynamic column mode will be available in the future. | Yes | No default value |
table | The name of the HBase table to which you want to write data. The name is case-sensitive. | Yes | No default value |
encoding | The encoding format that is used to convert a string into data in the HBase byte[] format. Valid values: utf-8 and gbk. | No | utf-8 |
column | The names of the columns to which you want to write data. index: the ID of a column in the source table, starting from 0. name: the name of a column in the destination HBase table. Specify this parameter in the Column family:Column name format. type: the data type of data that you want to write to the destination HBase table. This parameter is used for converting data into the HBase byte[] format.
| Yes | No default value |
rowkeyColumn | The rowkey column of each row in the destination HBase table. index: the ID of a column in the source table, starting from 0. If the column is a constant column, set this parameter to -1. type: the data type of data that you want to write to the destination HBase table. This parameter is used for converting data into the HBase byte[] format. value: a constant, which is usually used as the delimiter between fields. HBase Writer concatenates all columns that are specified in the rowkeyColumn parameter in the order that the columns are specified as the rowkey column in the destination HBase table. The specified columns cannot be all constant columns.
The following code provides an example:
"rowkeyColumn": [
{
"index":0,
"type":"string"
},
{
"index":-1,
"type":"string",
"value":"_"
}
]
| Yes | No default value |
versionColumn | The version of each HBase cell. You can use the current time, specific time, or a specific source column as the version. If you do not specify this parameter, the current time is used. index: the ID of a column in the source table, starting from 0. Make sure that the value can be converted into the LONG data type. type: the data type. If the data type is DATE, HBase Writer converts date data into data in the yyyy-MM-dd HH:mm:ss or yyyy-MM-dd HH:mm:ss SSS format. If you want to use the specified time as the version, set this parameter to -1. value: the specified time of the LONG data type.
The following code provides an example: -
"versionColumn":{
"index":1
}
-
"versionColumn":{
"index":-1,
"value":123456789
}
| No | No default value |
nullMode | The method used to process null values. Valid values: | No | skip |
walFlag | Specifies whether to enable WAL for HBase. If you set this parameter to true, WAL is enabled. All edits, such as PUT and DELETE operations, that are requested by an HBase client for all regions carried by the RegionServer are first recorded in the WAL log file (HLog). After the edits are recorded in the WAL log file, they are implemented to the MemStore, and a success notification is sent to the HBase client. If the edits fail to be recorded in the WAL log file, a failure notification is sent to the HBase client, and the edits are not implemented to the MemStore. If you set this parameter to false, WAL is disabled. This way, HBase Writer can write data more efficiently. | No | false |
writeBufferSize | The write buffer size, in bytes, of the HBase client. If you specify this parameter, you must also specify the autoflush parameter. By default, the value of the autoflush parameter is false. autoflush: If the value is true, the HBase client sends a PUT request each time it receives an edit. If the value is false, the HBase client sends a PUT request only when its write buffer is full.
| No | 8M |