{"component":{"kind":"component","name":"hbase","title":"HBase","description":"Reading and write from/to an HBase store (Hadoop database).","deprecated":false,"firstVersion":"2.10.0","label":"bigdata,database,hadoop","javaType":"org.apache.camel.component.hbase.HBaseComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-hbase","version":"3.18.0","scheme":"hbase","extendsScheme":"","syntax":"hbase:tableName","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false},"headers":{"CamelHBaseOperation":{"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The HBase operation to perform","constantName":"org.apache.camel.component.hbase.HBaseConstants#OPERATION"},"CamelHBaseMaxScanResults":{"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The maximum number of rows to scan.","constantName":"org.apache.camel.component.hbase.HBaseConstants#HBASE_MAX_SCAN_RESULTS"},"CamelHBaseStartRow":{"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The row to start scanner at or after","constantName":"org.apache.camel.component.hbase.HBaseConstants#FROM_ROW"},"CamelHBaseStopRow":{"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The row to end at (exclusive)","constantName":"org.apache.camel.component.hbase.HBaseConstants#STOP_ROW"},"CamelMappingStrategy":{"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The strategy to use for mapping Camel messages to HBase columns. Supported values: header body","constantName":"org.apache.camel.component.hbase.HBaseConstants#STRATEGY"},"CamelMappingStrategyClassName":{"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The class name of a custom mapping strategy implementation.","constantName":"org.apache.camel.component.hbase.HBaseConstants#STRATEGY_CLASS_NAME"},"CamelHBaseMarkedRowId":{"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"byte[]","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The marked row id","constantName":"org.apache.camel.component.hbase.HBaseConstants#HBASE_MARKED_ROW_ID"}},"properties":{"tableName":{"kind":"path","displayName":"Table Name","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The name of the table"},"cellMappingStrategyFactory":{"kind":"parameter","displayName":"Cell Mapping Strategy Factory","group":"common","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.hbase.mapping.CellMappingStrategyFactory","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom CellMappingStrategyFactory that is responsible for mapping cells."},"filters":{"kind":"parameter","displayName":"Filters","group":"common","label":"","required":false,"type":"array","javaType":"java.util.List<org.apache.hadoop.hbase.filter.Filter>","deprecated":false,"autowired":false,"secret":false,"description":"A list of filters to use."},"mappingStrategyClassName":{"kind":"parameter","displayName":"Mapping Strategy Class Name","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The class name of a custom mapping strategy implementation."},"mappingStrategyName":{"kind":"parameter","displayName":"Mapping Strategy Name","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","enum":["header","body"],"deprecated":false,"autowired":false,"secret":false,"description":"The strategy to use for mapping Camel messages to HBase columns. Supported values: header, or body."},"rowMapping":{"kind":"parameter","displayName":"Row Mapping","group":"common","label":"","required":false,"type":"object","javaType":"java.util.Map<java.lang.String, java.lang.Object>","prefix":"row.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"description":"To map the key/values from the Map to a 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":{"kind":"parameter","displayName":"Row Model","group":"common","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.hbase.model.HBaseRow","deprecated":false,"autowired":false,"secret":false,"description":"An instance of org.apache.camel.component.hbase.model.HBaseRow which describes how each row should be modeled"},"userGroupInformation":{"kind":"parameter","displayName":"User Group Information","group":"common","label":"","required":false,"type":"object","javaType":"org.apache.hadoop.security.UserGroupInformation","deprecated":false,"autowired":false,"secret":false,"description":"Defines privileges to communicate with HBase such as using kerberos."},"maxMessagesPerPoll":{"kind":"parameter","displayName":"Max Messages Per Poll","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"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":{"kind":"parameter","displayName":"Operation","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","enum":["CamelHBasePut","CamelHBaseGet","CamelHBaseScan","CamelHBaseDelete"],"deprecated":false,"autowired":false,"secret":false,"description":"The HBase operation to perform"},"remove":{"kind":"parameter","displayName":"Remove","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"If the option is true, Camel HBase Consumer will remove the rows which it processes."},"removeHandler":{"kind":"parameter","displayName":"Remove Handler","group":"consumer","label":"consumer","required":false,"type":"object","javaType":"org.apache.camel.component.hbase.HBaseRemoveHandler","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom HBaseRemoveHandler that is executed when a row is to be removed."},"bridgeErrorHandler":{"kind":"parameter","displayName":"Bridge Error Handler","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"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 or ERROR level and ignored."},"exceptionHandler":{"kind":"parameter","displayName":"Exception Handler","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.spi.ExceptionHandler","optionalPrefix":"consumer.","deprecated":false,"autowired":false,"secret":false,"description":"To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this option is not in use. By default the consumer will deal with exceptions, that will be logged at WARN or ERROR level and ignored."},"exchangePattern":{"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut","InOptionalOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"maxResults":{"kind":"parameter","displayName":"Max Results","group":"producer","label":"producer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":100,"description":"The maximum number of rows to scan."},"lazyStartProducer":{"kind":"parameter","displayName":"Lazy Start Producer","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel's routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing."}}}