public class HBaseBolt extends AbstractHBaseBolt
Basic bolt for writing to HBase.
Note: Each HBaseBolt defined in a topology is tied to a specific table.
collector, configKey, hBaseClient, mapper, tableName
Constructor and Description |
---|
HBaseBolt(String tableName,
HBaseMapper mapper) |
Modifier and Type | Method and Description |
---|---|
void |
declareOutputFields(OutputFieldsDeclarer outputFieldsDeclarer)
Declare the output schema for all the streams of this topology.
|
void |
execute(Tuple tuple)
Process a single tuple of input.
|
Map<String,Object> |
getComponentConfiguration()
Declare configuration specific to this component.
|
void |
prepare(Map<String,Object> map,
TopologyContext topologyContext,
OutputCollector collector)
Called when a task for this component is initialized within a worker on the cluster.
|
HBaseBolt |
withBatchSize(int batchSize) |
HBaseBolt |
withConfigKey(String configKey) |
HBaseBolt |
withFlushIntervalSecs(int flushIntervalSecs) |
HBaseBolt |
writeToWAL(boolean writeToWAL) |
cleanup
public HBaseBolt(String tableName, HBaseMapper mapper)
public HBaseBolt writeToWAL(boolean writeToWAL)
public HBaseBolt withBatchSize(int batchSize)
public HBaseBolt withFlushIntervalSecs(int flushIntervalSecs)
public Map<String,Object> getComponentConfiguration()
IComponent
Declare configuration specific to this component. Only a subset of the “topology.*” configs can be overridden. The component configuration can be further overridden when constructing the topology using TopologyBuilder
getComponentConfiguration
in interface IComponent
getComponentConfiguration
in class BaseComponent
public void execute(Tuple tuple)
IBolt
Process a single tuple of input. The Tuple object contains metadata on it about which component/stream/task it came from. The values of the Tuple can be accessed using Tuple#getValue. The IBolt does not have to process the Tuple immediately. It is perfectly fine to hang onto a tuple and process it later (for instance, to do an aggregation or join).
Tuples should be emitted using the OutputCollector provided through the prepare method. It is required that all input tuples are acked or failed at some point using the OutputCollector. Otherwise, Storm will be unable to determine when tuples coming off the spouts have been completed.
For the common case of acking an input tuple at the end of the execute method, see IBasicBolt which automates this.
tuple
- The input tuple to be processed.public void prepare(Map<String,Object> map, TopologyContext topologyContext, OutputCollector collector)
IBolt
Called when a task for this component is initialized within a worker on the cluster. It provides the bolt with the environment in which the bolt executes.
This includes the:
prepare
in interface IBolt
prepare
in class AbstractHBaseBolt
map
- The Storm configuration for this bolt. This is the configuration provided to the topology merged in with cluster configuration on this machine.topologyContext
- This object can be used to get information about this task’s place within the topology, including the task id and component id of this task, input and output information, etc.collector
- The collector is used to emit tuples from this bolt. Tuples can be emitted at any time, including the prepare and cleanup methods. The collector is thread-safe and should be saved as an instance variable of this bolt object.public void declareOutputFields(OutputFieldsDeclarer outputFieldsDeclarer)
IComponent
Declare the output schema for all the streams of this topology.
outputFieldsDeclarer
- this is used to declare output stream ids, output fields, and whether or not each output stream is a direct streamCopyright © 2022 The Apache Software Foundation. All rights reserved.