org.apache.hadoop.hbase.coprocessor

Class MultiRowMutationEndpoint

java.lang.Object

org.apache.hadoop.hbase.protobuf.generated.MultiRowMutationProtos.MultiRowMutationService

org.apache.hadoop.hbase.coprocessor.MultiRowMutationEndpoint

All Implemented Interfaces:

com.google.protobuf.Service, Coprocessor, RegionCoprocessor

@InterfaceAudience.LimitedPrivate(value="Coprocesssor")
 @InterfaceStability.Evolving
public class MultiRowMutationEndpoint
extends MultiRowMutationProtos.MultiRowMutationService
implements RegionCoprocessor

This class demonstrates how to implement atomic multi row transactions using HRegion.mutateRowsWithLocks(Collection, Collection, long, long) and Coprocessor endpoints. Defines a protocol to perform multi row transactions. See MultiRowMutationEndpoint for the implementation.
See HRegion.mutateRowsWithLocks(Collection, Collection, long, long) for details and limitations.
Example: List<Mutation> mutations = ...; Put p1 = new Put(row1); Put p2 = new Put(row2); ... Mutate m1 = ProtobufUtil.toMutate(MutateType.PUT, p1); Mutate m2 = ProtobufUtil.toMutate(MutateType.PUT, p2); MutateRowsRequest.Builder mrmBuilder = MutateRowsRequest.newBuilder(); mrmBuilder.addMutationRequest(m1); mrmBuilder.addMutationRequest(m2); CoprocessorRpcChannel channel = t.coprocessorService(ROW); MultiRowMutationService.BlockingInterface service = MultiRowMutationService.newBlockingStub(channel); MutateRowsRequest mrm = mrmBuilder.build(); service.mutateRows(null, mrm);

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.hadoop.hbase.protobuf.generated.MultiRowMutationProtos.MultiRowMutationService

MultiRowMutationProtos.MultiRowMutationService.BlockingInterface, MultiRowMutationProtos.MultiRowMutationService.Interface, MultiRowMutationProtos.MultiRowMutationService.Stub

Nested classes/interfaces inherited from interface org.apache.hadoop.hbase.Coprocessor

Coprocessor.State

Field Summary

Fields inherited from interface org.apache.hadoop.hbase.Coprocessor

PRIORITY_HIGHEST, PRIORITY_LOWEST, PRIORITY_SYSTEM, PRIORITY_USER, VERSION

Constructor Summary

Constructors

Constructor and Description
MultiRowMutationEndpoint()

Method Summary

Modifier and Type	Method and Description
Iterable<com.google.protobuf.Service>	getServices() Coprocessor endpoints providing protobuf services should override this method.
void	mutateRows(com.google.protobuf.RpcController controller, MultiRowMutationProtos.MutateRowsRequest request, com.google.protobuf.RpcCallback<MultiRowMutationProtos.MutateRowsResponse> done) rpc MutateRows(.hbase.pb.MutateRowsRequest) returns (.hbase.pb.MutateRowsResponse);
void	start(CoprocessorEnvironment env) Stores a reference to the coprocessor environment provided by the RegionCoprocessorHost from the region where this coprocessor is loaded.
void	stop(CoprocessorEnvironment env) Called by the CoprocessorEnvironment during it's own shutdown to stop the coprocessor.

Methods inherited from class org.apache.hadoop.hbase.protobuf.generated.MultiRowMutationProtos.MultiRowMutationService

callMethod, getDescriptor, getDescriptorForType, getRequestPrototype, getResponsePrototype, newBlockingStub, newReflectiveBlockingService, newReflectiveService, newStub

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.hadoop.hbase.coprocessor.RegionCoprocessor

getBulkLoadObserver, getEndpointObserver, getRegionObserver

Constructor Detail

MultiRowMutationEndpoint

public MultiRowMutationEndpoint()

Method Detail

mutateRows

public void mutateRows(com.google.protobuf.RpcController controller,
                       MultiRowMutationProtos.MutateRowsRequest request,
                       com.google.protobuf.RpcCallback<MultiRowMutationProtos.MutateRowsResponse> done)

Description copied from class: MultiRowMutationProtos.MultiRowMutationService

rpc MutateRows(.hbase.pb.MutateRowsRequest) returns (.hbase.pb.MutateRowsResponse);

Specified by:

mutateRows in class MultiRowMutationProtos.MultiRowMutationService

getServices

public Iterable<com.google.protobuf.Service> getServices()

Description copied from interface: Coprocessor

Coprocessor endpoints providing protobuf services should override this method.

Specified by:

getServices in interface Coprocessor

Returns:

Iterable of Services or empty collection. Implementations should never return null.

start

public void start(CoprocessorEnvironment env)
           throws IOException

Stores a reference to the coprocessor environment provided by the RegionCoprocessorHost from the region where this coprocessor is loaded. Since this is a coprocessor endpoint, it always expects to be loaded on a table region, so always expects this to be an instance of RegionCoprocessorEnvironment.

Specified by:

start in interface Coprocessor

Parameters:

env - the environment provided by the coprocessor host

Throws:

IOException - if the provided environment is not an instance of RegionCoprocessorEnvironment

stop

public void stop(CoprocessorEnvironment env)
          throws IOException

Description copied from interface: Coprocessor

Called by the CoprocessorEnvironment during it's own shutdown to stop the coprocessor.

Specified by:

stop in interface Coprocessor

Throws:

IOException