MultiRowMutationProcessor (Apache HBase 1.2.12 API)

java.lang.Object
- org.apache.hadoop.hbase.regionserver.BaseRowProcessor<org.apache.hadoop.hbase.protobuf.generated.MultiRowMutationProtos.MultiRowMutationProcessorRequest,org.apache.hadoop.hbase.protobuf.generated.MultiRowMutationProtos.MultiRowMutationProcessorResponse>
- - org.apache.hadoop.hbase.regionserver.MultiRowMutationProcessor

All Implemented Interfaces:

RowProcessor<org.apache.hadoop.hbase.protobuf.generated.MultiRowMutationProtos.MultiRowMutationProcessorRequest,org.apache.hadoop.hbase.protobuf.generated.MultiRowMutationProtos.MultiRowMutationProcessorResponse>
```
@InterfaceAudience.Private
 class MultiRowMutationProcessor
extends BaseRowProcessor<org.apache.hadoop.hbase.protobuf.generated.MultiRowMutationProtos.MultiRowMutationProcessorRequest,org.apache.hadoop.hbase.protobuf.generated.MultiRowMutationProtos.MultiRowMutationProcessorResponse>
```
A MultiRowProcessor that performs multiple puts and deletes.

Field Summary

Fields
Modifier and Type	Field and Description
`(package private) MiniBatchOperationInProgress<Mutation>`	`miniBatch`
`(package private) Collection<Mutation>`	`mutations`
`(package private) Collection<byte[]>`	`rowsToLock`

Constructor Summary

Constructors
Constructor and Description

MultiRowMutationProcessor(Collection<Mutation> mutations, Collection<byte[]> rowsToLock)

Constructors
Constructor and Description
`MultiRowMutationProcessor(Collection<Mutation> mutations, Collection<byte[]> rowsToLock)`

Method Summary

Methods
Modifier and Type	Method and Description
`org.apache.hadoop.hbase.protobuf.generated.MultiRowMutationProtos.MultiRowMutationProcessorRequest`	`getRequestData()` This method should return any additional data that is needed on the server side to construct the RowProcessor.
`org.apache.hadoop.hbase.protobuf.generated.MultiRowMutationProtos.MultiRowMutationProcessorResponse`	`getResult()` Obtain the processing result.
`Collection<byte[]>`	`getRowsToLock()` Rows to lock while operation.
`void`	`initialize(org.apache.hadoop.hbase.protobuf.generated.MultiRowMutationProtos.MultiRowMutationProcessorRequest msg)` This method should initialize any field(s) of the RowProcessor with a parsing of the passed message bytes (used on the server side).
`void`	`postBatchMutate(HRegion region)` The hook to be executed after the process() and applying the Mutations to region.
`void`	`postProcess(HRegion region, WALEdit walEdit, boolean success)` The hook to be executed after process() and applying the Mutations to region.
`void`	`preBatchMutate(HRegion region, WALEdit walEdit)` The hook to be executed after the process() but before applying the Mutations to region.
`void`	`preProcess(HRegion region, WALEdit walEdit)` The hook to be executed before process().
`void`	`process(long now, HRegion region, List<Mutation> mutationsToApply, WALEdit walEdit)` HRegion handles the locks and MVCC and invokes this method properly.
`boolean`	`readOnly()` Is this operation read only? If this is true, process() should not add any mutations or it throws IOException.
`Durability`	`useDurability()`

Methods inherited from class org.apache.hadoop.hbase.regionserver.BaseRowProcessor
getClusterIds, getName

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - rowsToLock
```
Collection<byte[]> rowsToLock
```
  - mutations
```
Collection<Mutation> mutations
```
  - miniBatch
```
MiniBatchOperationInProgress<Mutation> miniBatch
```
- Constructor Detail
  - MultiRowMutationProcessor
```
MultiRowMutationProcessor(Collection<Mutation> mutations,
                         Collection<byte[]> rowsToLock)
```
- Method Detail
  - getRowsToLock
```
public Collection<byte[]> getRowsToLock()
```
    Description copied from interface: RowProcessor
    
    Rows to lock while operation. They have to be sorted with RowProcessor to avoid deadlock.
  - readOnly
```
public boolean readOnly()
```
    Description copied from interface: RowProcessor
    
    Is this operation read only? If this is true, process() should not add any mutations or it throws IOException.
    
    Returns:
    ture if read only operation
  - getResult
```
public org.apache.hadoop.hbase.protobuf.generated.MultiRowMutationProtos.MultiRowMutationProcessorResponse getResult()
```
    Description copied from interface: RowProcessor
    
    Obtain the processing result. All row processor implementations must implement this, even if the method is simply returning an empty Message.
  - process
```
public void process(long now,
           HRegion region,
           List<Mutation> mutationsToApply,
           WALEdit walEdit)
             throws IOException
```
    Description copied from interface: RowProcessor
    
    HRegion handles the locks and MVCC and invokes this method properly. You should override this to create your own RowProcessor. If you are doing read-modify-write here, you should consider using IsolationLevel.READ_UNCOMMITTED for scan because we advance MVCC after releasing the locks for optimization purpose.
    
    Parameters:
    now - the current system millisecond
    region - the HRegion
    mutationsToApply - the output mutations to apply to memstore
    walEdit - the output WAL edits to apply to write ahead log
    
    Throws:
    
    IOException
  - preProcess
```
public void preProcess(HRegion region,
              WALEdit walEdit)
                throws IOException
```
    Description copied from interface: RowProcessor
    
    The hook to be executed before process().
    
    Specified by:
    
    preProcess in interface RowProcessor<org.apache.hadoop.hbase.protobuf.generated.MultiRowMutationProtos.MultiRowMutationProcessorRequest,org.apache.hadoop.hbase.protobuf.generated.MultiRowMutationProtos.MultiRowMutationProcessorResponse>
    
    Overrides:
    
    preProcess in class BaseRowProcessor<org.apache.hadoop.hbase.protobuf.generated.MultiRowMutationProtos.MultiRowMutationProcessorRequest,org.apache.hadoop.hbase.protobuf.generated.MultiRowMutationProtos.MultiRowMutationProcessorResponse>
    
    Parameters:
    region - the HRegion
    walEdit - the output WAL edits to apply to write ahead log
    
    Throws:
    
    IOException
  - preBatchMutate
```
public void preBatchMutate(HRegion region,
                  WALEdit walEdit)
                    throws IOException
```
    Description copied from interface: RowProcessor
    
    The hook to be executed after the process() but before applying the Mutations to region. Also by the time this hook is been called, mvcc transaction is started.
    
    Specified by:
    
    preBatchMutate in interface RowProcessor<org.apache.hadoop.hbase.protobuf.generated.MultiRowMutationProtos.MultiRowMutationProcessorRequest,org.apache.hadoop.hbase.protobuf.generated.MultiRowMutationProtos.MultiRowMutationProcessorResponse>
    
    Overrides:
    
    preBatchMutate in class BaseRowProcessor<org.apache.hadoop.hbase.protobuf.generated.MultiRowMutationProtos.MultiRowMutationProcessorRequest,org.apache.hadoop.hbase.protobuf.generated.MultiRowMutationProtos.MultiRowMutationProcessorResponse>
    
    walEdit - the output WAL edits to apply to write ahead log
    
    Throws:
    
    IOException
  - postBatchMutate
```
public void postBatchMutate(HRegion region)
                     throws IOException
```
    Description copied from interface: RowProcessor
    
    The hook to be executed after the process() and applying the Mutations to region. The difference of this one with RowProcessor.postProcess(HRegion, WALEdit, boolean) is this hook will be executed before the mvcc transaction completion.
    
    Specified by:
    
    postBatchMutate in interface RowProcessor<org.apache.hadoop.hbase.protobuf.generated.MultiRowMutationProtos.MultiRowMutationProcessorRequest,org.apache.hadoop.hbase.protobuf.generated.MultiRowMutationProtos.MultiRowMutationProcessorResponse>
    
    Overrides:
    
    postBatchMutate in class BaseRowProcessor<org.apache.hadoop.hbase.protobuf.generated.MultiRowMutationProtos.MultiRowMutationProcessorRequest,org.apache.hadoop.hbase.protobuf.generated.MultiRowMutationProtos.MultiRowMutationProcessorResponse>
    
    Throws:
    
    IOException
  - postProcess
```
public void postProcess(HRegion region,
               WALEdit walEdit,
               boolean success)
                 throws IOException
```
    Description copied from interface: RowProcessor
    
    The hook to be executed after process() and applying the Mutations to region.
    
    Specified by:
    
    postProcess in interface RowProcessor<org.apache.hadoop.hbase.protobuf.generated.MultiRowMutationProtos.MultiRowMutationProcessorRequest,org.apache.hadoop.hbase.protobuf.generated.MultiRowMutationProtos.MultiRowMutationProcessorResponse>
    
    Overrides:
    
    postProcess in class BaseRowProcessor<org.apache.hadoop.hbase.protobuf.generated.MultiRowMutationProtos.MultiRowMutationProcessorRequest,org.apache.hadoop.hbase.protobuf.generated.MultiRowMutationProtos.MultiRowMutationProcessorResponse>
    
    Parameters:
    region - the HRegion
    walEdit - the output WAL edits to apply to write ahead log
    success - true if batch operation is successful otherwise false.
    
    Throws:
    
    IOException
  - getRequestData
```
public org.apache.hadoop.hbase.protobuf.generated.MultiRowMutationProtos.MultiRowMutationProcessorRequest getRequestData()
```
    Description copied from interface: RowProcessor
    
    This method should return any additional data that is needed on the server side to construct the RowProcessor. The server will pass this to the RowProcessor.initialize(Message msg) method. If there is no RowProcessor specific data then null should be returned.
    
    Returns:
    the PB message
  - initialize
```
public void initialize(org.apache.hadoop.hbase.protobuf.generated.MultiRowMutationProtos.MultiRowMutationProcessorRequest msg)
```
    Description copied from interface: RowProcessor
    
    This method should initialize any field(s) of the RowProcessor with a parsing of the passed message bytes (used on the server side).
  - useDurability
```
public Durability useDurability()
```
    Specified by:
    
    useDurability in interface RowProcessor<org.apache.hadoop.hbase.protobuf.generated.MultiRowMutationProtos.MultiRowMutationProcessorRequest,org.apache.hadoop.hbase.protobuf.generated.MultiRowMutationProtos.MultiRowMutationProcessorResponse>
    
    Overrides:
    
    useDurability in class BaseRowProcessor<org.apache.hadoop.hbase.protobuf.generated.MultiRowMutationProtos.MultiRowMutationProcessorRequest,org.apache.hadoop.hbase.protobuf.generated.MultiRowMutationProtos.MultiRowMutationProcessorResponse>
    
    Returns:
    The Durability to use

Class MultiRowMutationProcessor

Field Summary

Constructor Summary

Method Summary

Methods inherited from class org.apache.hadoop.hbase.regionserver.BaseRowProcessor

Methods inherited from class java.lang.Object

Field Detail

rowsToLock

mutations

miniBatch

Constructor Detail

MultiRowMutationProcessor

Method Detail

getRowsToLock

readOnly

getResult

process

preProcess

preBatchMutate

postBatchMutate

postProcess

getRequestData

initialize

useDurability