org.tikv.kvproto

Class ImportSSTGrpc.ImportSSTFutureStub

java.lang.Object

io.grpc.stub.AbstractStub<S>

io.grpc.stub.AbstractFutureStub<ImportSSTGrpc.ImportSSTFutureStub>

org.tikv.kvproto.ImportSSTGrpc.ImportSSTFutureStub

Enclosing class:

ImportSSTGrpc

public static final class ImportSSTGrpc.ImportSSTFutureStub
extends io.grpc.stub.AbstractFutureStub<ImportSSTGrpc.ImportSSTFutureStub>

A stub to allow clients to do ListenableFuture-style 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.ImportSSTFutureStub	build(io.grpc.Channel channel, io.grpc.CallOptions callOptions)
com.google.common.util.concurrent.ListenableFuture<ImportSstpb.CompactResponse>	compact(ImportSstpb.CompactRequest request) Compact the specific range for better performance.
com.google.common.util.concurrent.ListenableFuture<ImportSstpb.DownloadResponse>	download(ImportSstpb.DownloadRequest request) Download an SST file from an external storage, and performs key-rewrite after downloading.
com.google.common.util.concurrent.ListenableFuture<ImportSstpb.IngestResponse>	ingest(ImportSstpb.IngestRequest request) Ingest an uploaded SST file to a region.
com.google.common.util.concurrent.ListenableFuture<ImportSstpb.IngestResponse>	multiIngest(ImportSstpb.MultiIngestRequest request) Ingest Multiple files in one request
com.google.common.util.concurrent.ListenableFuture<ImportSstpb.SetDownloadSpeedLimitResponse>	setDownloadSpeedLimit(ImportSstpb.SetDownloadSpeedLimitRequest request)
com.google.common.util.concurrent.ListenableFuture<ImportSstpb.SwitchModeResponse>	switchMode(ImportSstpb.SwitchModeRequest request) Switch to normal/import mode.

Methods inherited from class io.grpc.stub.AbstractFutureStub

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

Specified by:

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

switchMode

public com.google.common.util.concurrent.ListenableFuture<ImportSstpb.SwitchModeResponse> switchMode(ImportSstpb.SwitchModeRequest request)

 Switch to normal/import mode.
 

ingest

public com.google.common.util.concurrent.ListenableFuture<ImportSstpb.IngestResponse> ingest(ImportSstpb.IngestRequest request)

 Ingest an uploaded SST file to a region.
 

compact

public com.google.common.util.concurrent.ListenableFuture<ImportSstpb.CompactResponse> compact(ImportSstpb.CompactRequest request)

 Compact the specific range for better performance.
 

setDownloadSpeedLimit

public com.google.common.util.concurrent.ListenableFuture<ImportSstpb.SetDownloadSpeedLimitResponse> setDownloadSpeedLimit(ImportSstpb.SetDownloadSpeedLimitRequest request)

download

public com.google.common.util.concurrent.ListenableFuture<ImportSstpb.DownloadResponse> download(ImportSstpb.DownloadRequest request)

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

multiIngest

public com.google.common.util.concurrent.ListenableFuture<ImportSstpb.IngestResponse> multiIngest(ImportSstpb.MultiIngestRequest request)

 Ingest Multiple files in one request