public static interface ImportKVGrpc.AsyncService
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.
| Modifier and Type | Method and Description |
|---|---|
default void |
cleanupEngine(ImportKvpb.CleanupEngineRequest request,
io.grpc.stub.StreamObserver<ImportKvpb.CleanupEngineResponse> responseObserver)
Clean up the engine.
|
default void |
closeEngine(ImportKvpb.CloseEngineRequest request,
io.grpc.stub.StreamObserver<ImportKvpb.CloseEngineResponse> responseObserver)
Close the engine.
|
default void |
compactCluster(ImportKvpb.CompactClusterRequest request,
io.grpc.stub.StreamObserver<ImportKvpb.CompactClusterResponse> responseObserver)
Compact the target cluster for better performance.
|
default void |
getMetrics(ImportKvpb.GetMetricsRequest request,
io.grpc.stub.StreamObserver<ImportKvpb.GetMetricsResponse> responseObserver)
Get importer metrics
|
default void |
getVersion(ImportKvpb.GetVersionRequest request,
io.grpc.stub.StreamObserver<ImportKvpb.GetVersionResponse> responseObserver)
Get current version and commit hash
|
default void |
importEngine(ImportKvpb.ImportEngineRequest request,
io.grpc.stub.StreamObserver<ImportKvpb.ImportEngineResponse> responseObserver)
Import the engine to the target cluster.
|
default void |
openEngine(ImportKvpb.OpenEngineRequest request,
io.grpc.stub.StreamObserver<ImportKvpb.OpenEngineResponse> responseObserver)
Open an engine.
|
default void |
switchMode(ImportKvpb.SwitchModeRequest request,
io.grpc.stub.StreamObserver<ImportKvpb.SwitchModeResponse> responseObserver)
Switch the target cluster to normal/import mode.
|
default io.grpc.stub.StreamObserver<ImportKvpb.WriteEngineRequest> |
writeEngine(io.grpc.stub.StreamObserver<ImportKvpb.WriteEngineResponse> responseObserver)
Open a write stream to the engine.
|
default void |
writeEngineV3(ImportKvpb.WriteEngineV3Request request,
io.grpc.stub.StreamObserver<ImportKvpb.WriteEngineResponse> responseObserver)
Write to engine, single message version
|
default void switchMode(ImportKvpb.SwitchModeRequest request, io.grpc.stub.StreamObserver<ImportKvpb.SwitchModeResponse> responseObserver)
Switch the target cluster to normal/import mode.
default void openEngine(ImportKvpb.OpenEngineRequest request, io.grpc.stub.StreamObserver<ImportKvpb.OpenEngineResponse> responseObserver)
Open an engine.
default io.grpc.stub.StreamObserver<ImportKvpb.WriteEngineRequest> writeEngine(io.grpc.stub.StreamObserver<ImportKvpb.WriteEngineResponse> responseObserver)
Open a write stream to the engine.
default void writeEngineV3(ImportKvpb.WriteEngineV3Request request, io.grpc.stub.StreamObserver<ImportKvpb.WriteEngineResponse> responseObserver)
Write to engine, single message version
default void closeEngine(ImportKvpb.CloseEngineRequest request, io.grpc.stub.StreamObserver<ImportKvpb.CloseEngineResponse> responseObserver)
Close the engine.
default void importEngine(ImportKvpb.ImportEngineRequest request, io.grpc.stub.StreamObserver<ImportKvpb.ImportEngineResponse> responseObserver)
Import the engine to the target cluster.
default void cleanupEngine(ImportKvpb.CleanupEngineRequest request, io.grpc.stub.StreamObserver<ImportKvpb.CleanupEngineResponse> responseObserver)
Clean up the engine.
default void compactCluster(ImportKvpb.CompactClusterRequest request, io.grpc.stub.StreamObserver<ImportKvpb.CompactClusterResponse> responseObserver)
Compact the target cluster for better performance.
default void getVersion(ImportKvpb.GetVersionRequest request, io.grpc.stub.StreamObserver<ImportKvpb.GetVersionResponse> responseObserver)
Get current version and commit hash
default void getMetrics(ImportKvpb.GetMetricsRequest request, io.grpc.stub.StreamObserver<ImportKvpb.GetMetricsResponse> responseObserver)
Get importer metrics
Copyright © 2024 PingCAP. All rights reserved.