Operator HBASEIncrement

Primitive operator image not displayed. Problem loading file: ../../image/tk$com.teracloud.streams.hbase/op$com.teracloud.streams.hbase$HBASEIncrement.svg

The HBASEIncrement operator increments the specified HBase entry. The operator uses the HTable.increment function. You can specify the value to increment as an operator parameter or as an attribute in the input tuple.

Behavior in a consistent region

HBASEIncrement is not allowed in a consistent region.

Summary

Ports
This operator has 1 input port and 2 output ports.
Windowing
This operator does not accept any windowing configurations.
Parameters
This operator supports 12 parameters.

Required: rowAttrName

Optional: authKeytab, authPrincipal, columnFamilyAttrName, columnQualifierAttrName, hbaseSite, increment, incrementAttrName, staticColumnFamily, staticColumnQualifier, tableName, tableNameAttribute

Metrics
This operator does not report any metrics.

Properties

Implementation
Java

Input Ports

Ports (0)

Tuples describing entry to increment

Properties

Output Ports

Assignments
Java operators do not support output assignments.
Ports (0)

Optional port for success or failure information.

Properties

Ports (1)

Optional port for error information. This port submits an error message and a tuple, when an error occurs while HBase actions.

Properties

Parameters

This operator supports 12 parameters.

Required: rowAttrName

Optional: authKeytab, authPrincipal, columnFamilyAttrName, columnQualifierAttrName, hbaseSite, increment, incrementAttrName, staticColumnFamily, staticColumnQualifier, tableName, tableNameAttribute

authKeytab

The authKeytab parameter specifies the kerberos keytab file that is created for the principal.

Properties
authPrincipal

The authPrincipal parameter specifies the Kerberos principal, which is typically the principal that is created for HBase server

Properties
columnFamilyAttrName

Name of the attribute on the input tuple containing the columnFamily. Cannot be used with staticColumnFmily.

Properties
columnQualifierAttrName

Name of the attribute on the input tuple containing the columnQualifier. Cannot be used with staticColumnQualifier.

Properties
hbaseSite

The hbaseSite parameter specifies the path of hbase-site.xml file. This is the recommended way to specify the HBASE configuration. If not specified, then HBASE_HOME must be set when the operator runs, and it will use $HBASE_SITE/conf/hbase-site.xml

Properties
increment

This parameter specifies the value by which to increment. It cannot be specified with incrementAttrName parameter.

Properties
incrementAttrName

This parameter specifies the attribute that is used to determine the increment. It cannot be used with the increment parameter.

Properties
rowAttrName

Name of the attribute on the input tuple containing the row. It is required.

Properties
staticColumnFamily

If this parameter is specified, it will be used as the columnFamily for all operations. (Compare to columnFamilyAttrName.) For HBASEScan, it can have cardinality greater than one.

Properties
staticColumnQualifier

If this parameter is specified, it will be used as the columnQualifier for all tuples. HBASEScan allows it to be specified multiple times.

Properties
tableName

Name of the HBASE table. It is an optional parameter but one of these parameters must be set in opeartor: 'tableName' or 'tableNameAttribute'. Cannot be used with 'tableNameAttribute'. If the table does not exist, the operator will throw an exception

Properties
tableNameAttribute

Name of the attribute on the input tuple containing the tableName. Use this parameter to pass the table name to the operator via input port. Cannot be used with parameter 'tableName'. This is suitable for tables with the same schema.

Properties

Libraries

Operator class library
Library Path: ../../impl/lib/com.teracloud.streams.hbase.jar, ../../opt/downloaded/*