org.tikv.kvproto

Interface ImportSSTGrpc.AsyncService

All Known Implementing Classes:

ImportSSTGrpc.ImportSSTImplBase

Enclosing class:

ImportSSTGrpc

public static interface ImportSSTGrpc.AsyncService

 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.
 

Method Summary

Modifier and Type	Method and Description
default void	compact(ImportSstpb.CompactRequest request, io.grpc.stub.StreamObserver<ImportSstpb.CompactResponse> responseObserver) Compact the specific range for better performance.
default 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.
default void	duplicateDetect(ImportSstpb.DuplicateDetectRequest request, io.grpc.stub.StreamObserver<ImportSstpb.DuplicateDetectResponse> responseObserver) Collect duplicate data from TiKV.
default void	ingest(ImportSstpb.IngestRequest request, io.grpc.stub.StreamObserver<ImportSstpb.IngestResponse> responseObserver) Ingest an uploaded SST file to a region.
default void	multiIngest(ImportSstpb.MultiIngestRequest request, io.grpc.stub.StreamObserver<ImportSstpb.IngestResponse> responseObserver) Ingest Multiple files in one request
default io.grpc.stub.StreamObserver<ImportSstpb.RawWriteRequest>	rawWrite(io.grpc.stub.StreamObserver<ImportSstpb.RawWriteResponse> responseObserver)
default void	setDownloadSpeedLimit(ImportSstpb.SetDownloadSpeedLimitRequest request, io.grpc.stub.StreamObserver<ImportSstpb.SetDownloadSpeedLimitResponse> responseObserver)
default void	switchMode(ImportSstpb.SwitchModeRequest request, io.grpc.stub.StreamObserver<ImportSstpb.SwitchModeResponse> responseObserver) Switch to normal/import mode.
default io.grpc.stub.StreamObserver<ImportSstpb.UploadRequest>	upload(io.grpc.stub.StreamObserver<ImportSstpb.UploadResponse> responseObserver) Upload an SST file to a server.
default io.grpc.stub.StreamObserver<ImportSstpb.WriteRequest>	write(io.grpc.stub.StreamObserver<ImportSstpb.WriteResponse> responseObserver) Open a write stream to generate sst files

Method Detail

switchMode

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

 Switch to normal/import mode.
 

upload

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

 Upload an SST file to a server.
 

ingest

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

 Ingest an uploaded SST file to a region.
 

compact

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

 Compact the specific range for better performance.
 

setDownloadSpeedLimit

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

download

default 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

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

 Open a write stream to generate sst files
 

rawWrite

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

multiIngest

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

 Ingest Multiple files in one request
 

duplicateDetect

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

 Collect duplicate data from TiKV.