HBase

HBase

Scheme: hbase
Syntax: hbase:tableName
Description: For reading/writing from/to an HBase store (Hadoop database).
Deprecated:false
Async:false
Maven: org.apache.camel/camel-hbase/2.18.1.redhat-000015

For reading/writing from/to an HBase store (Hadoop database).

Name Kind Group Required Default Type Enum Description
tableName path common true java.lang.String The name of the table
cellMappingStrategyFactory parameter common org.apache.camel.component.hbase.mapping.CellMappingStrategyFactory To use a custom CellMappingStrategyFactory that is responsible for mapping cells.
filters parameter common java.util.List A list of filters to use.
mappingStrategyClassName parameter common java.lang.String The class name of a custom mapping strategy implementation.
mappingStrategyName parameter common java.lang.String header
body
The strategy to use for mapping Camel messages to HBase columns. Supported values: header, or body.
rowMapping parameter common java.util.Map To map the key/values from the Map to a {@link HBaseRow}.

The following keys is supported:

  • rowId - The id of the row. This has limited use as the row usually changes per Exchange.
  • rowType - The type to covert row id to. Supported operations: CamelHBaseScan.
  • family - The column family. Supports a number suffix for referring to more than one columns.
  • qualifier - The column qualifier. Supports a number suffix for referring to more than one columns.
  • value - The value. Supports a number suffix for referring to more than one columns
  • valueType - The value type. Supports a number suffix for referring to more than one columns. Supported operations: CamelHBaseGet, and CamelHBaseScan.
rowModel parameter common org.apache.camel.component.hbase.model.HBaseRow An instance of org.apache.camel.component.hbase.model.HBaseRow which describes how each row should be modeled
userGroupInformation parameter common org.apache.hadoop.security.UserGroupInformation Defines privileges to communicate with HBase such as using kerberos.
bridgeErrorHandler parameter consumer boolean Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions, that will be logged at WARN/ERROR level and ignored.
maxMessagesPerPoll parameter consumer int Gets the maximum number of messages as a limit to poll at each polling.

Is default unlimited, but use 0 or negative number to disable it as unlimited.

operation parameter consumer java.lang.String CamelHBasePut
CamelHBaseGet
CamelHBaseScan
CamelHBaseDelete
The HBase operation to perform
remove parameter consumer true boolean If the option is true, Camel HBase Consumer will remove the rows which it processes.
removeHandler parameter consumer org.apache.camel.component.hbase.HBaseRemoveHandler To use a custom HBaseRemoveHandler that is executed when a row is to be removed.
exceptionHandler parameter consumer (advanced) org.apache.camel.spi.ExceptionHandler To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions, that will be logged at WARN/ERROR level and ignored.
exchangePattern parameter consumer (advanced) org.apache.camel.ExchangePattern InOnly
RobustInOnly
InOut
InOptionalOut
OutOnly
RobustOutOnly
OutIn
OutOptionalIn
Sets the exchange pattern when the consumer creates an exchange.
maxResults parameter producer 100 int The maximum number of rows to scan.
synchronous parameter advanced false boolean Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported).

hbase consumer

The HBase consumer.