tikv-client 0.4.0

The Rust language implementation of TiKV client.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170

// This file is @generated by prost-build.
/// \[start, end)
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct KeyRange {
    #[prost(bytes = "vec", tag = "1")]
    pub start: ::prost::alloc::vec::Vec<u8>,
    #[prost(bytes = "vec", tag = "2")]
    pub end: ::prost::alloc::vec::Vec<u8>,
}
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Request {
    #[prost(message, optional, tag = "1")]
    pub context: ::core::option::Option<super::kvrpcpb::Context>,
    #[prost(int64, tag = "2")]
    pub tp: i64,
    #[prost(bytes = "vec", tag = "3")]
    pub data: ::prost::alloc::vec::Vec<u8>,
    #[prost(uint64, tag = "7")]
    pub start_ts: u64,
    #[prost(message, repeated, tag = "4")]
    pub ranges: ::prost::alloc::vec::Vec<KeyRange>,
    /// If cache is enabled, TiKV returns cache hit instead of data if
    /// its last version matches this `cache_if_match_version`.
    #[prost(bool, tag = "5")]
    pub is_cache_enabled: bool,
    #[prost(uint64, tag = "6")]
    pub cache_if_match_version: u64,
    /// Any schema-ful storage to validate schema correctness if necessary.
    #[prost(int64, tag = "8")]
    pub schema_ver: i64,
    #[prost(bool, tag = "9")]
    pub is_trace_enabled: bool,
    /// paging_size is 0 when it's disabled, otherwise, it should be a positive number.
    #[prost(uint64, tag = "10")]
    pub paging_size: u64,
    /// tasks stores the batched coprocessor tasks sent to the same tikv store.
    #[prost(message, repeated, tag = "11")]
    pub tasks: ::prost::alloc::vec::Vec<StoreBatchTask>,
    /// This is the session id between a client and tidb
    #[prost(uint64, tag = "12")]
    pub connection_id: u64,
    /// This is the session alias between a client and tidb
    #[prost(string, tag = "13")]
    pub connection_alias: ::prost::alloc::string::String,
}
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Response {
    #[prost(bytes = "vec", tag = "1")]
    pub data: ::prost::alloc::vec::Vec<u8>,
    #[prost(message, optional, tag = "2")]
    pub region_error: ::core::option::Option<super::errorpb::Error>,
    #[prost(message, optional, tag = "3")]
    pub locked: ::core::option::Option<super::kvrpcpb::LockInfo>,
    #[prost(string, tag = "4")]
    pub other_error: ::prost::alloc::string::String,
    #[prost(message, optional, tag = "5")]
    pub range: ::core::option::Option<KeyRange>,
    /// This field is always filled for compatibility consideration. However
    /// newer TiDB should respect `exec_details_v2` field instead.
    #[prost(message, optional, tag = "6")]
    pub exec_details: ::core::option::Option<super::kvrpcpb::ExecDetails>,
    /// This field is provided in later versions, containing more detailed
    /// information.
    #[prost(message, optional, tag = "11")]
    pub exec_details_v2: ::core::option::Option<super::kvrpcpb::ExecDetailsV2>,
    #[prost(bool, tag = "7")]
    pub is_cache_hit: bool,
    #[prost(uint64, tag = "8")]
    pub cache_last_version: u64,
    #[prost(bool, tag = "9")]
    pub can_be_cached: bool,
    /// Contains the latest buckets version of the region.
    /// Clients should query PD to update buckets in cache if its is stale.
    #[prost(uint64, tag = "12")]
    pub latest_buckets_version: u64,
    /// StoreBatchTaskResponse is the collection of batch task responses.
    #[prost(message, repeated, tag = "13")]
    pub batch_responses: ::prost::alloc::vec::Vec<StoreBatchTaskResponse>,
}
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct RegionInfo {
    #[prost(uint64, tag = "1")]
    pub region_id: u64,
    #[prost(message, optional, tag = "2")]
    pub region_epoch: ::core::option::Option<super::metapb::RegionEpoch>,
    #[prost(message, repeated, tag = "3")]
    pub ranges: ::prost::alloc::vec::Vec<KeyRange>,
}
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct TableRegions {
    #[prost(int64, tag = "1")]
    pub physical_table_id: i64,
    #[prost(message, repeated, tag = "2")]
    pub regions: ::prost::alloc::vec::Vec<RegionInfo>,
}
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct BatchRequest {
    #[prost(message, optional, tag = "1")]
    pub context: ::core::option::Option<super::kvrpcpb::Context>,
    #[prost(int64, tag = "2")]
    pub tp: i64,
    #[prost(bytes = "vec", tag = "3")]
    pub data: ::prost::alloc::vec::Vec<u8>,
    #[prost(message, repeated, tag = "4")]
    pub regions: ::prost::alloc::vec::Vec<RegionInfo>,
    #[prost(uint64, tag = "5")]
    pub start_ts: u64,
    /// Any schema-ful storage to validate schema correctness if necessary.
    #[prost(int64, tag = "6")]
    pub schema_ver: i64,
    /// Used for partition table scan
    #[prost(message, repeated, tag = "7")]
    pub table_regions: ::prost::alloc::vec::Vec<TableRegions>,
    #[prost(string, tag = "8")]
    pub log_id: ::prost::alloc::string::String,
    /// This is the session id between a client and tidb
    #[prost(uint64, tag = "9")]
    pub connection_id: u64,
    /// This is the session alias between a client and tidb
    #[prost(string, tag = "10")]
    pub connection_alias: ::prost::alloc::string::String,
}
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct BatchResponse {
    #[prost(bytes = "vec", tag = "1")]
    pub data: ::prost::alloc::vec::Vec<u8>,
    #[prost(string, tag = "2")]
    pub other_error: ::prost::alloc::string::String,
    #[prost(message, optional, tag = "3")]
    pub exec_details: ::core::option::Option<super::kvrpcpb::ExecDetails>,
    #[prost(message, repeated, tag = "4")]
    pub retry_regions: ::prost::alloc::vec::Vec<super::metapb::Region>,
}
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct StoreBatchTask {
    #[prost(uint64, tag = "1")]
    pub region_id: u64,
    #[prost(message, optional, tag = "2")]
    pub region_epoch: ::core::option::Option<super::metapb::RegionEpoch>,
    #[prost(message, optional, tag = "3")]
    pub peer: ::core::option::Option<super::metapb::Peer>,
    #[prost(message, repeated, tag = "4")]
    pub ranges: ::prost::alloc::vec::Vec<KeyRange>,
    #[prost(uint64, tag = "5")]
    pub task_id: u64,
}
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct StoreBatchTaskResponse {
    #[prost(bytes = "vec", tag = "1")]
    pub data: ::prost::alloc::vec::Vec<u8>,
    #[prost(message, optional, tag = "2")]
    pub region_error: ::core::option::Option<super::errorpb::Error>,
    #[prost(message, optional, tag = "3")]
    pub locked: ::core::option::Option<super::kvrpcpb::LockInfo>,
    #[prost(string, tag = "4")]
    pub other_error: ::prost::alloc::string::String,
    #[prost(uint64, tag = "5")]
    pub task_id: u64,
    #[prost(message, optional, tag = "6")]
    pub exec_details_v2: ::core::option::Option<super::kvrpcpb::ExecDetailsV2>,
}