org.tikv.kvproto

Class ImportSSTGrpc.ImportSSTStub

java.lang.Object

io.grpc.stub.AbstractStub<S>

io.grpc.stub.AbstractAsyncStub<ImportSSTGrpc.ImportSSTStub>

org.tikv.kvproto.ImportSSTGrpc.ImportSSTStub

Enclosing class:

ImportSSTGrpc

public static final class ImportSSTGrpc.ImportSSTStub
extends io.grpc.stub.AbstractAsyncStub<ImportSSTGrpc.ImportSSTStub>

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

 ImportSST provides a service to import a generated SST file to a region in TiKV.
 In order to import an SST file to a region, the user should:
 1. Retrieve the meta of the region according to the SST file's range.
 2. Upload the SST file to the servers where the region's peers locate in.
 3. Issue an ingest request to the region's leader with the SST file's metadata.
 It's the user's responsibility to make sure that the SST file is uploaded to
 the servers where the region's peers locate in, before issue the ingest
 request to the region's leader. However, the region can be scheduled (so the
 location of the region's peers will be changed) or split/merged (so the range
 of the region will be changed), after the SST file is uploaded, but before
 the SST file is ingested. So, the region's epoch is provided in the SST
 file's metadata, to guarantee that the region's epoch must be the same
 between the SST file is uploaded and ingested later.
 

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 ImportSSTGrpc.ImportSSTStub	build(io.grpc.Channel channel, io.grpc.CallOptions callOptions)
void	compact(ImportSstpb.CompactRequest request, io.grpc.stub.StreamObserver<ImportSstpb.CompactResponse> responseObserver) Compact the specific range for better performance.
void	download(ImportSstpb.DownloadRequest request, io.grpc.stub.StreamObserver<ImportSstpb.DownloadResponse> responseObserver) Download an SST file from an external storage, and performs key-rewrite after downloading.
void	duplicateDetect(ImportSstpb.DuplicateDetectRequest request, io.grpc.stub.StreamObserver<ImportSstpb.DuplicateDetectResponse> responseObserver) Collect duplicate data from TiKV.
void	ingest(ImportSstpb.IngestRequest request, io.grpc.stub.StreamObserver<ImportSstpb.IngestResponse> responseObserver) Ingest an uploaded SST file to a region.
void	multiIngest(ImportSstpb.MultiIngestRequest request, io.grpc.stub.StreamObserver<ImportSstpb.IngestResponse> responseObserver) Ingest Multiple files in one request
io.grpc.stub.StreamObserver<ImportSstpb.RawWriteRequest>	rawWrite(io.grpc.stub.StreamObserver<ImportSstpb.RawWriteResponse> responseObserver)
void	setDownloadSpeedLimit(ImportSstpb.SetDownloadSpeedLimitRequest request, io.grpc.stub.StreamObserver<ImportSstpb.SetDownloadSpeedLimitResponse> responseObserver)
void	switchMode(ImportSstpb.SwitchModeRequest request, io.grpc.stub.StreamObserver<ImportSstpb.SwitchModeResponse> responseObserver) Switch to normal/import mode.
io.grpc.stub.StreamObserver<ImportSstpb.UploadRequest>	upload(io.grpc.stub.StreamObserver<ImportSstpb.UploadResponse> responseObserver) Upload an SST file to a server.
io.grpc.stub.StreamObserver<ImportSstpb.WriteRequest>	write(io.grpc.stub.StreamObserver<ImportSstpb.WriteResponse> responseObserver) Open a write stream to generate sst files

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 ImportSSTGrpc.ImportSSTStub build(io.grpc.Channel channel,
                                            io.grpc.CallOptions callOptions)

Specified by:

build in class io.grpc.stub.AbstractStub<ImportSSTGrpc.ImportSSTStub>

switchMode

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

 Switch to normal/import mode.
 

upload

public io.grpc.stub.StreamObserver<ImportSstpb.UploadRequest> upload(io.grpc.stub.StreamObserver<ImportSstpb.UploadResponse> responseObserver)

 Upload an SST file to a server.
 

ingest

public void ingest(ImportSstpb.IngestRequest request,
                   io.grpc.stub.StreamObserver<ImportSstpb.IngestResponse> responseObserver)

 Ingest an uploaded SST file to a region.
 

compact

public void compact(ImportSstpb.CompactRequest request,
                    io.grpc.stub.StreamObserver<ImportSstpb.CompactResponse> responseObserver)

 Compact the specific range for better performance.
 

setDownloadSpeedLimit

public void setDownloadSpeedLimit(ImportSstpb.SetDownloadSpeedLimitRequest request,
                                  io.grpc.stub.StreamObserver<ImportSstpb.SetDownloadSpeedLimitResponse> responseObserver)

download

public void download(ImportSstpb.DownloadRequest request,
                     io.grpc.stub.StreamObserver<ImportSstpb.DownloadResponse> responseObserver)

 Download an SST file from an external storage, and performs key-rewrite
 after downloading.
 

write

public io.grpc.stub.StreamObserver<ImportSstpb.WriteRequest> write(io.grpc.stub.StreamObserver<ImportSstpb.WriteResponse> responseObserver)

 Open a write stream to generate sst files
 

rawWrite

public io.grpc.stub.StreamObserver<ImportSstpb.RawWriteRequest> rawWrite(io.grpc.stub.StreamObserver<ImportSstpb.RawWriteResponse> responseObserver)

multiIngest

public void multiIngest(ImportSstpb.MultiIngestRequest request,
                        io.grpc.stub.StreamObserver<ImportSstpb.IngestResponse> responseObserver)

 Ingest Multiple files in one request
 

duplicateDetect

public void duplicateDetect(ImportSstpb.DuplicateDetectRequest request,
                            io.grpc.stub.StreamObserver<ImportSstpb.DuplicateDetectResponse> responseObserver)

 Collect duplicate data from TiKV.