package import_kvpb

Get desktop application:
View/edit binary Protocol Buffers messages

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.

• rpc SwitchMode (SwitchModeRequest, SwitchModeResponse)

  import_kvpb.proto:40

  Switch the target cluster to normal/import mode.

  message SwitchModeRequest

  import_kvpb.proto:61

  • string pd_addr = 1

  • optional import_sstpb.SwitchModeRequest request = 2

  message SwitchModeResponse

  import_kvpb.proto:66

  (message has no fields)

• rpc OpenEngine (OpenEngineRequest, OpenEngineResponse)

  import_kvpb.proto:42

  Open an engine.

  message OpenEngineRequest

  import_kvpb.proto:69

  • bytes uuid = 1

  • bytes key_prefix = 2

  message OpenEngineResponse

  import_kvpb.proto:74

  (message has no fields)

• rpc WriteEngine (stream WriteEngineRequest, WriteEngineResponse)

  import_kvpb.proto:44

  Open a write stream to the engine.

  message WriteEngineRequest

  import_kvpb.proto:95

  • oneof chunk

    • WriteHead head = 1

    • WriteBatch batch = 2

• rpc WriteEngineV3 (WriteEngineV3Request, WriteEngineResponse)

  import_kvpb.proto:46

  Write to engine, single message version

  message WriteEngineV3Request

  import_kvpb.proto:107

  • bytes uuid = 1

  • uint64 commit_ts = 2

  • repeated KVPair pairs = 3

• rpc CloseEngine (CloseEngineRequest, CloseEngineResponse)

  import_kvpb.proto:48

  Close the engine.

  message CloseEngineRequest

  import_kvpb.proto:117

  • bytes uuid = 1

  message CloseEngineResponse

  import_kvpb.proto:121

  • optional Error error = 1

• rpc ImportEngine (ImportEngineRequest, ImportEngineResponse)

  import_kvpb.proto:50

  Import the engine to the target cluster.

  message ImportEngineRequest

  import_kvpb.proto:125

  • bytes uuid = 1

  • string pd_addr = 2

  message ImportEngineResponse

  import_kvpb.proto:130

  (message has no fields)

• rpc CleanupEngine (CleanupEngineRequest, CleanupEngineResponse)

  import_kvpb.proto:52

  Clean up the engine.

  message CleanupEngineRequest

  import_kvpb.proto:133

  • bytes uuid = 1

  message CleanupEngineResponse

  import_kvpb.proto:137

  (message has no fields)

• rpc CompactCluster (CompactClusterRequest, CompactClusterResponse)

  import_kvpb.proto:54

  Compact the target cluster for better performance.

  message CompactClusterRequest

  import_kvpb.proto:140

  • string pd_addr = 1

  • optional import_sstpb.CompactRequest request = 2

  message CompactClusterResponse

  import_kvpb.proto:145

  (message has no fields)

• rpc GetVersion (GetVersionRequest, GetVersionResponse)

  import_kvpb.proto:56

  Get current version and commit hash

  message GetVersionRequest

  import_kvpb.proto:148

  (message has no fields)

  message GetVersionResponse

  import_kvpb.proto:151

  • string version = 1

  • string commit = 2

• rpc GetMetrics (GetMetricsRequest, GetMetricsResponse)

  import_kvpb.proto:58

  Get importer metrics

  message GetMetricsRequest

  import_kvpb.proto:156

  (message has no fields)

  message GetMetricsResponse

  import_kvpb.proto:159

  • string prometheus = 1

Used in: CloseEngineResponse, WriteEngineResponse

• optional Error.EngineNotFound engine_not_found = 1

  This can happen if the client hasn't opened the engine, or the server restarts while the client is writing or closing. An unclosed engine will be removed on server restart, so the client should not continue but restart the previous job in that case.

Used in: Error

• bytes uuid = 1

Used in: WriteEngineV3Request

• bytes key = 1

• bytes value = 2

Used in: WriteBatch

• Mutation.OP op = 1

• bytes key = 2

• bytes value = 3

Used in: Mutation

• Put = 0

Used in: WriteEngineRequest

• uint64 commit_ts = 1

• repeated Mutation mutations = 2

Used as response type in: ImportKV.WriteEngine, ImportKV.WriteEngineV3

• optional Error error = 1

Used in: WriteEngineRequest

• bytes uuid = 1