org.tikv.kvproto

Class ImportKVGrpc.ImportKVStub

java.lang.Object

io.grpc.stub.AbstractStub<S>

io.grpc.stub.AbstractAsyncStub<ImportKVGrpc.ImportKVStub>

org.tikv.kvproto.ImportKVGrpc.ImportKVStub

Enclosing class:

ImportKVGrpc

public static final class ImportKVGrpc.ImportKVStub
extends io.grpc.stub.AbstractAsyncStub<ImportKVGrpc.ImportKVStub>

A stub to allow clients to do asynchronous rpc calls to service ImportKV.

 ImportKV provides a service to import key-value pairs to TiKV.
 In order to import key-value pairs to TiKV, the user should:
 1. Open an engine identified by an UUID.
 2. Open write streams to write key-value batches to the opened engine.
    Different streams/clients can write to the same engine concurrently.
 3. Close the engine after all write batches have been finished. An
    engine can only be closed when all write streams are closed. An
    engine can only be closed once, and it can not be opened again
    once it is closed.
 4. Import the data in the engine to the target cluster. Note that
    the import process is not atomic, it requires the data to be
    idempotent on retry. An engine can only be imported after it is
    closed. An engine can be imported multiple times, but can not be
    imported concurrently.
 5. Clean up the engine after it has been imported. Delete all data
    in the engine. An engine can not be cleaned up when it is
    writing or importing.
 

Nested Class Summary

Nested classes/interfaces inherited from class io.grpc.stub.AbstractStub

io.grpc.stub.AbstractStub.StubFactory<T extends io.grpc.stub.AbstractStub<T>>

Method Summary

Modifier and Type	Method and Description
protected ImportKVGrpc.ImportKVStub	build(io.grpc.Channel channel, io.grpc.CallOptions callOptions)
void	cleanupEngine(ImportKvpb.CleanupEngineRequest request, io.grpc.stub.StreamObserver<ImportKvpb.CleanupEngineResponse> responseObserver) Clean up the engine.
void	closeEngine(ImportKvpb.CloseEngineRequest request, io.grpc.stub.StreamObserver<ImportKvpb.CloseEngineResponse> responseObserver) Close the engine.
void	compactCluster(ImportKvpb.CompactClusterRequest request, io.grpc.stub.StreamObserver<ImportKvpb.CompactClusterResponse> responseObserver) Compact the target cluster for better performance.
void	getMetrics(ImportKvpb.GetMetricsRequest request, io.grpc.stub.StreamObserver<ImportKvpb.GetMetricsResponse> responseObserver) Get importer metrics
void	getVersion(ImportKvpb.GetVersionRequest request, io.grpc.stub.StreamObserver<ImportKvpb.GetVersionResponse> responseObserver) Get current version and commit hash
void	importEngine(ImportKvpb.ImportEngineRequest request, io.grpc.stub.StreamObserver<ImportKvpb.ImportEngineResponse> responseObserver) Import the engine to the target cluster.
void	openEngine(ImportKvpb.OpenEngineRequest request, io.grpc.stub.StreamObserver<ImportKvpb.OpenEngineResponse> responseObserver) Open an engine.
void	switchMode(ImportKvpb.SwitchModeRequest request, io.grpc.stub.StreamObserver<ImportKvpb.SwitchModeResponse> responseObserver) Switch the target cluster to normal/import mode.
io.grpc.stub.StreamObserver<ImportKvpb.WriteEngineRequest>	writeEngine(io.grpc.stub.StreamObserver<ImportKvpb.WriteEngineResponse> responseObserver) Open a write stream to the engine.
void	writeEngineV3(ImportKvpb.WriteEngineV3Request request, io.grpc.stub.StreamObserver<ImportKvpb.WriteEngineResponse> responseObserver) Write to engine, single message version

Methods inherited from class io.grpc.stub.AbstractAsyncStub

newStub, newStub

Methods inherited from class io.grpc.stub.AbstractStub

getCallOptions, getChannel, withCallCredentials, withChannel, withCompression, withDeadline, withDeadlineAfter, withExecutor, withInterceptors, withMaxInboundMessageSize, withMaxOutboundMessageSize, withOption, withWaitForReady

Methods inherited from class java.lang.Object

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

Method Detail

build

protected ImportKVGrpc.ImportKVStub build(io.grpc.Channel channel,
                                          io.grpc.CallOptions callOptions)

Specified by:

build in class io.grpc.stub.AbstractStub<ImportKVGrpc.ImportKVStub>

switchMode

public void switchMode(ImportKvpb.SwitchModeRequest request,
                       io.grpc.stub.StreamObserver<ImportKvpb.SwitchModeResponse> responseObserver)

 Switch the target cluster to normal/import mode.
 

openEngine

public void openEngine(ImportKvpb.OpenEngineRequest request,
                       io.grpc.stub.StreamObserver<ImportKvpb.OpenEngineResponse> responseObserver)

 Open an engine.
 

writeEngine

public io.grpc.stub.StreamObserver<ImportKvpb.WriteEngineRequest> writeEngine(io.grpc.stub.StreamObserver<ImportKvpb.WriteEngineResponse> responseObserver)

 Open a write stream to the engine.
 

writeEngineV3

public void writeEngineV3(ImportKvpb.WriteEngineV3Request request,
                          io.grpc.stub.StreamObserver<ImportKvpb.WriteEngineResponse> responseObserver)

 Write to engine, single message version
 

closeEngine

public void closeEngine(ImportKvpb.CloseEngineRequest request,
                        io.grpc.stub.StreamObserver<ImportKvpb.CloseEngineResponse> responseObserver)

 Close the engine.
 

importEngine

public void importEngine(ImportKvpb.ImportEngineRequest request,
                         io.grpc.stub.StreamObserver<ImportKvpb.ImportEngineResponse> responseObserver)

 Import the engine to the target cluster.
 

cleanupEngine

public void cleanupEngine(ImportKvpb.CleanupEngineRequest request,
                          io.grpc.stub.StreamObserver<ImportKvpb.CleanupEngineResponse> responseObserver)

 Clean up the engine.
 

compactCluster

public void compactCluster(ImportKvpb.CompactClusterRequest request,
                           io.grpc.stub.StreamObserver<ImportKvpb.CompactClusterResponse> responseObserver)

 Compact the target cluster for better performance.
 

getVersion

public void getVersion(ImportKvpb.GetVersionRequest request,
                       io.grpc.stub.StreamObserver<ImportKvpb.GetVersionResponse> responseObserver)

 Get current version and commit hash
 

getMetrics

public void getMetrics(ImportKvpb.GetMetricsRequest request,
                       io.grpc.stub.StreamObserver<ImportKvpb.GetMetricsResponse> responseObserver)

 Get importer metrics