...
This component provides an idemptotent idempotent repository, producers and consumers for Apache HBase.
...
Camel and HBase
When using a datasotre datastore inside a camel route, there is always the chalenge challenge of specifying how the camel message will stored to the datastore. In document based stores things are more easy as the message body can be directly mapped to a document. In relational databases an ORM solution can be used to map properties to columns etc. In column based stores things are more challenging as there is no standard way to perform that kind of mapping.
...
As mentioned above camel provides produers producer endpoints for HBase. This allows you to store, delete, retrieve or query data from HBase using your camel routes.
...
Supported URI options on producer
| Wiki Markup |
|---|
{div:class=confluenceTableSmall}
|| Name || Default Value || Description ||
| {{operation}} | {{CamelHBasePut}} | The HBase operation to perform. *Supported values*: {{CamelHBasePut}}, {{CamelHBaseGet}}, {{CamelHBaseDelete}}, and {{CamelHBaseScan}}. |
| {{maxResults}} | {{100}} | The maximum number of rows to scan.*Supported operations*: {{CamelHBaseScan}}. |
| {{mappingStrategyName}} | {{header}} | The strategy to use for mapping Camel messages to HBase columns. Supported values: {{header}}, or {{body}}. |
| {{mappingStrategyClassName}} | {{null}} | The class name of a custom mapping strategy implementation. |
| {{filters}} | {{null}} | A list of filters. *Supported operations*: {{CamelHBaseScan}}. |
{div} |
Header mapping options:
| Div |
|---|
| class | confluenceTableSmall |
|---|
|
Name | Default Value | Description |
|---|
operation
| CamelHBasePut
| The HBase operation to perform. Supported values: CamelHBasePut, CamelHBaseGet, CamelHBaseDelete, and CamelHBaseScan. | maxResults
| 100
| The maximum number of rows to scan.Supported operations: CamelHBaseScan. | mappingStrategyName
| header
| The strategy to use for mapping Camel messages to HBase columns. Supported values: header, or body. | mappingStrategyClassName
| null
| The class name of a custom mapping strategy implementation. | filters
| null
| A list of filters. Supported operations: CamelHBaseScan. | | userGroupInformation | UserGroupInformation | Camel 2.17: Defines privileges to communicate with HBase such as using kerberos | | row.xxx | null | Camel 2.17: To map the key/values to the HBaseRow model. From Camel 2.17 onwards the mapping requires to use row. as prefix.
The keys is listed below in the header mapping table. An example: row.family=info&row.qualifier=firstName&row.family2=birthdate&row.qualifier2=year |
|
Header mapping options:
| Div |
|---|
| class | confluenceTableSmall |
|---|
|
Name | Default Value | Description |
|---|
rowId
| | The id of the row. This has limited use as the row usually changes per Exchange. | rowType
| String | 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
| String | The value type. Supports a number suffix for referring to more than one columns. Supported operations: CamelHBaseGet, and CamelHBaseScan. |
|
| Wiki Markup |
|---|
| {div:class=confluenceTableSmall}
|| Name || Default Value || Description ||
| {{rowId}} | | The id of the row. This has limited use as the row usually changes per Exchange.|
| {{rowType}} | String | 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}} | String | The value type. Supports a number suffix for referring to more than one columns. *Supported operations*: {{CamelHBaseGet}}, and {{CamelHBaseScan}}. |
{div} |
Put Operations.
HBase is a column based store, which allows you to store data into a specific column of a specific row. Columns are grouped into families, so in order to specify a column you need to specify the column family and the qualifier of that column. To store data into a specific column you need to specify both the column and the row.
...
The Camel HBase Consumer, will perform repeated scan on the specified HBase table and will return the scan results as part of the message. You can either specify header mapping (default) or body mapping. The later latter will just add the org.apache.camel.component.hbase.model.HBaseData as part of the message body.
...
Supported URI options on consumer
| Wiki Markup |
|---|
{div:class=confluenceTableSmall}
|| Name || Default Value || Description ||
| {{initialDelay}} | {{1000}} | Milliseconds before the first polling starts. |
| {{delay}} | {{500}} | Milliseconds before the next poll. |
| {{useFixedDelay}} | {{true}} | Controls if fixed delay or fixed rate is used. See [ScheduledExecutorService|http://java.sun.com/j2se/1.5.0/docs/api/java/util/concurrent/ScheduledExecutorService.html] in JDK for details. |
| timeUnit | {{TimeUnit.MILLISECONDS}} | time unit for {{initialDelay}} and {{delay}} options. |
| {{runLoggingLevel}} | {{TRACE}} | *Camel 2.8:* The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that. |
| {{operation}} | {{CamelHBasePut}} | The HBase operation to perform. *Supported values*: {{CamelHBasePut}}, {{CamelHBaseGet}}, {{CamelHBaseDelete}}, and {{CamelHBaseScan}}. |
| {{maxResults}} | {{100}} | The maximum number of rows to scan. *Supported operations:* {{CamelHBaseScan}}. |
| {{mappingStrategyName}} | {{header}} | The strategy to use for mapping Camel messages to HBase columns. Supported values: {{header}}, or {{body}}. |
| {{mappingStrategyClassName}} | {{null}} | The class name of a custom mapping strategy implementation. |
| {{filters}} | {{null}} | A list of filters. *Supported operations*: {{CamelHBaseScan}} |
| {{remove}} | {{true}} | If the option is true, Camel HBase Consumer will remove the rows which it processes.|
{div} |
Header mapping options:
| Div |
|---|
| class | confluenceTableSmall |
|---|
|
Name | Default Value | Description |
|---|
initialDelay
| 1000
| Milliseconds before the first polling starts. | delay
| 500
| Milliseconds before the next poll. | useFixedDelay
| true
| Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details. | timeUnit | TimeUnit.MILLISECONDS
| time unit for initialDelay and delay options. | runLoggingLevel
| TRACE
| Camel 2.8: The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that. | operation
| CamelHBasePut
| The HBase operation to perform. Supported values: CamelHBasePut, CamelHBaseGet, CamelHBaseDelete, and CamelHBaseScan. | maxResults
| 100
| The maximum number of rows to scan. Supported operations: CamelHBaseScan. | mappingStrategyName
| header
| The strategy to use for mapping Camel messages to HBase columns. Supported values: header, or body. | mappingStrategyClassName
| null
| The class name of a custom mapping strategy implementation. | filters
| null
| A list of filters. Supported operations: CamelHBaseScan | remove
| true
| If the option is true, Camel HBase Consumer will remove the rows which it processes. | | userGroupInformation | UserGroupInformation | Camel 2.17: Defines privileges to communicate with HBase such as using kerberos |
|
Header mapping options:
| Div |
|---|
| class | confluenceTableSmall |
|---|
|
Name | Default Value | Description |
|---|
rowId
| | The id of the row. This has limited use as the row usually changes per Exchange. | rowType
| String | The type to covert row id to. Supported operations: CamelHBaseScan | family
| | The column family. *upports 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 | rowModel
| String | An instance of |
|
| Wiki Markup |
|---|
{div:class=confluenceTableSmall}
|| Name || Default Value || Description ||
| {{rowId}} | | The id of the row. This has limited use as the row usually changes per Exchange.|
| {{rowType}} | String | The type to covert row id to. *Supported operations*: CamelHBaseScan |
| {{family}} | | The column family. *upports 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 |
| {{rowModel}} | String | An instance of org.apache.camel.component.hbase.model.HBaseRow |
|
If the role of the rowModel is not clear, it allows you to construct the HBaseRow modle programmatically instead of "describing" it with uri options (such as family, qualifier, type etc).
...
The header mapping is the default mapping.
To put the value "myvalue" into HBase row "myrow" and column "myfamily:mycolum" the message should contain the following headers:
| Div |
|---|
| class | confluenceTableSmall |
|---|
|
Header | Value |
|---|
CamelHBaseRowId | myrow | CamelHBaseFamily | myfamily | CamelHBaseQualifier | myqualifier | CamelHBaseValue | myvalue |
|
| Wiki Markup |
|---|
| {div:class=confluenceTableSmall}
|| Header || Value ||
| CamelHBaseRowId | myrow |
| CamelHBaseFamily | myfamily |
| CamelHBaseQualifier | myqualifier |
| CamelHBaseValue | myvalue |
{div} |
To put more values for different columns and / or different rows you can specify additional headers suffixed with the index of the headers, e.g:
| Div |
|---|
| class | confluenceTableSmall |
|---|
|
Header | Value |
|---|
CamelHBaseRowId | myrow | CamelHBaseFamily | myfamily | CamelHBaseQualifier | myqualifier | CamelHBaseValue | myvalue | CamelHBaseRowId2 | myrow2 | CamelHBaseFamily2 | myfamily | CamelHBaseQualifier2 | myqualifier | CamelHBaseValue2 | myvalue2 |
|
| Wiki Markup |
|---|
| {div:class=confluenceTableSmall}
|| Header || Value ||
| CamelHBaseRowId | myrow |
| CamelHBaseFamily | myfamily |
| CamelHBaseQualifier | myqualifier |
| CamelHBaseValue | myvalue |
| CamelHBaseRowId2 | myrow2 |
| CamelHBaseFamily2 | myfamily |
| CamelHBaseQualifier2 | myqualifier |
| CamelHBaseValue2 | myvalue2 |
{div} |
In the case of retrieval operations such as get or scan you can also specify for each column the type that you want the data to be converted to. For exampe:
| Div |
|---|
| class | confluenceTableSmall |
|---|
|
Header | Value |
|---|
CamelHBaseFamily | myfamily | CamelHBaseQualifier | myqualifier | CamelHBaseValueType | Long |
|
| Wiki Markup |
|---|
| {div:class=confluenceTableSmall}
|| Header || Value ||
| CamelHBaseFamily | myfamily |
| CamelHBaseQualifier | myqualifier |
| CamelHBaseValueType | Long |
{div} |
Please note that in order to avoid boilerplate headers that are considered constant for all messages, you can also specify them as part of the endpoint uri, as you will see below.
...
