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
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
// This file is @generated by prost-build.
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct GetRequest {
    #[prost(enumeration = "Db", tag = "1")]
    pub db: i32,
    #[prost(string, tag = "2")]
    pub cf: ::prost::alloc::string::String,
    #[prost(bytes = "vec", tag = "3")]
    pub key: ::prost::alloc::vec::Vec<u8>,
}
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct GetResponse {
    #[prost(bytes = "vec", tag = "1")]
    pub value: ::prost::alloc::vec::Vec<u8>,
}
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct RaftLogRequest {
    #[prost(uint64, tag = "1")]
    pub region_id: u64,
    #[prost(uint64, tag = "2")]
    pub log_index: u64,
}
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct RaftLogResponse {
    #[prost(message, optional, tag = "1")]
    pub entry: ::core::option::Option<super::eraftpb::Entry>,
}
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct RegionInfoRequest {
    #[prost(uint64, tag = "1")]
    pub region_id: u64,
}
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct RegionInfoResponse {
    #[prost(message, optional, tag = "1")]
    pub raft_local_state: ::core::option::Option<super::raft_serverpb::RaftLocalState>,
    #[prost(message, optional, tag = "2")]
    pub raft_apply_state: ::core::option::Option<super::raft_serverpb::RaftApplyState>,
    #[prost(message, optional, tag = "3")]
    pub region_local_state: ::core::option::Option<
        super::raft_serverpb::RegionLocalState,
    >,
}
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct RegionSizeRequest {
    #[prost(uint64, tag = "1")]
    pub region_id: u64,
    #[prost(string, repeated, tag = "2")]
    pub cfs: ::prost::alloc::vec::Vec<::prost::alloc::string::String>,
}
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct RegionSizeResponse {
    #[prost(message, repeated, tag = "1")]
    pub entries: ::prost::alloc::vec::Vec<region_size_response::Entry>,
}
/// Nested message and enum types in `RegionSizeResponse`.
pub mod region_size_response {
    #[allow(clippy::derive_partial_eq_without_eq)]
    #[derive(Clone, PartialEq, ::prost::Message)]
    pub struct Entry {
        #[prost(string, tag = "1")]
        pub cf: ::prost::alloc::string::String,
        #[prost(uint64, tag = "2")]
        pub size: u64,
    }
}
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ScanMvccRequest {
    #[prost(bytes = "vec", tag = "1")]
    pub from_key: ::prost::alloc::vec::Vec<u8>,
    #[prost(bytes = "vec", tag = "2")]
    pub to_key: ::prost::alloc::vec::Vec<u8>,
    #[prost(uint64, tag = "3")]
    pub limit: u64,
}
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ScanMvccResponse {
    #[prost(bytes = "vec", tag = "1")]
    pub key: ::prost::alloc::vec::Vec<u8>,
    #[prost(message, optional, tag = "2")]
    pub info: ::core::option::Option<super::kvrpcpb::MvccInfo>,
}
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct CompactRequest {
    #[prost(enumeration = "Db", tag = "1")]
    pub db: i32,
    #[prost(string, tag = "2")]
    pub cf: ::prost::alloc::string::String,
    #[prost(bytes = "vec", tag = "3")]
    pub from_key: ::prost::alloc::vec::Vec<u8>,
    #[prost(bytes = "vec", tag = "4")]
    pub to_key: ::prost::alloc::vec::Vec<u8>,
    #[prost(uint32, tag = "5")]
    pub threads: u32,
    #[prost(enumeration = "BottommostLevelCompaction", tag = "6")]
    pub bottommost_level_compaction: i32,
}
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct CompactResponse {}
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct InjectFailPointRequest {
    #[prost(string, tag = "1")]
    pub name: ::prost::alloc::string::String,
    #[prost(string, tag = "2")]
    pub actions: ::prost::alloc::string::String,
}
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct InjectFailPointResponse {}
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct RecoverFailPointRequest {
    #[prost(string, tag = "1")]
    pub name: ::prost::alloc::string::String,
}
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct RecoverFailPointResponse {}
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ListFailPointsRequest {}
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ListFailPointsResponse {
    #[prost(message, repeated, tag = "1")]
    pub entries: ::prost::alloc::vec::Vec<list_fail_points_response::Entry>,
}
/// Nested message and enum types in `ListFailPointsResponse`.
pub mod list_fail_points_response {
    #[allow(clippy::derive_partial_eq_without_eq)]
    #[derive(Clone, PartialEq, ::prost::Message)]
    pub struct Entry {
        #[prost(string, tag = "1")]
        pub name: ::prost::alloc::string::String,
        #[prost(string, tag = "2")]
        pub actions: ::prost::alloc::string::String,
    }
}
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct GetMetricsRequest {
    #[prost(bool, tag = "1")]
    pub all: bool,
}
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct GetMetricsResponse {
    #[prost(string, tag = "1")]
    pub prometheus: ::prost::alloc::string::String,
    #[prost(string, tag = "2")]
    pub rocksdb_kv: ::prost::alloc::string::String,
    #[prost(string, tag = "3")]
    pub rocksdb_raft: ::prost::alloc::string::String,
    #[prost(string, tag = "4")]
    pub jemalloc: ::prost::alloc::string::String,
    #[prost(uint64, tag = "5")]
    pub store_id: u64,
}
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct RegionConsistencyCheckRequest {
    #[prost(uint64, tag = "1")]
    pub region_id: u64,
}
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct RegionConsistencyCheckResponse {}
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ModifyTikvConfigRequest {
    #[prost(enumeration = "Module", tag = "1")]
    pub module: i32,
    #[prost(string, tag = "2")]
    pub config_name: ::prost::alloc::string::String,
    #[prost(string, tag = "3")]
    pub config_value: ::prost::alloc::string::String,
}
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ModifyTikvConfigResponse {}
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Property {
    #[prost(string, tag = "1")]
    pub name: ::prost::alloc::string::String,
    #[prost(string, tag = "2")]
    pub value: ::prost::alloc::string::String,
}
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct GetRegionPropertiesRequest {
    #[prost(uint64, tag = "1")]
    pub region_id: u64,
}
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct GetRegionPropertiesResponse {
    #[prost(message, repeated, tag = "1")]
    pub props: ::prost::alloc::vec::Vec<Property>,
}
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct GetStoreInfoRequest {}
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct GetStoreInfoResponse {
    #[prost(uint64, tag = "1")]
    pub store_id: u64,
    #[prost(enumeration = "super::kvrpcpb::ApiVersion", tag = "2")]
    pub api_version: i32,
}
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct GetClusterInfoRequest {}
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct GetClusterInfoResponse {
    #[prost(uint64, tag = "1")]
    pub cluster_id: u64,
}
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct GetAllRegionsInStoreRequest {}
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct GetAllRegionsInStoreResponse {
    #[prost(uint64, repeated, tag = "1")]
    pub regions: ::prost::alloc::vec::Vec<u64>,
}
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ResetToVersionRequest {
    #[prost(uint64, tag = "1")]
    pub ts: u64,
}
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ResetToVersionResponse {}
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct GetRangePropertiesRequest {
    #[prost(bytes = "vec", tag = "1")]
    pub start_key: ::prost::alloc::vec::Vec<u8>,
    #[prost(bytes = "vec", tag = "2")]
    pub end_key: ::prost::alloc::vec::Vec<u8>,
}
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct GetRangePropertiesResponse {
    #[prost(message, repeated, tag = "1")]
    pub properties: ::prost::alloc::vec::Vec<
        get_range_properties_response::RangeProperty,
    >,
}
/// Nested message and enum types in `GetRangePropertiesResponse`.
pub mod get_range_properties_response {
    #[allow(clippy::derive_partial_eq_without_eq)]
    #[derive(Clone, PartialEq, ::prost::Message)]
    pub struct RangeProperty {
        #[prost(string, tag = "1")]
        pub key: ::prost::alloc::string::String,
        #[prost(string, tag = "2")]
        pub value: ::prost::alloc::string::String,
    }
}
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct FlashbackToVersionRequest {
    #[prost(message, optional, tag = "1")]
    pub context: ::core::option::Option<super::kvrpcpb::Context>,
    #[prost(uint64, tag = "2")]
    pub version: u64,
    #[prost(uint64, tag = "3")]
    pub region_id: u64,
    #[prost(bytes = "vec", tag = "4")]
    pub start_key: ::prost::alloc::vec::Vec<u8>,
    #[prost(bytes = "vec", tag = "5")]
    pub end_key: ::prost::alloc::vec::Vec<u8>,
    #[prost(uint64, tag = "6")]
    pub start_ts: u64,
    #[prost(uint64, tag = "7")]
    pub commit_ts: u64,
}
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct FlashbackToVersionResponse {
    #[prost(string, tag = "1")]
    pub error: ::prost::alloc::string::String,
}
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct GetRegionReadProgressRequest {
    #[prost(uint64, tag = "1")]
    pub region_id: u64,
    /// when set to true, print a log of the locks with min start_ts in the resolver.
    #[prost(bool, tag = "2")]
    pub log_locks: bool,
    /// only print locks whose start_ts >= min_start_ts. Can be used to find certain transaction.
    #[prost(uint64, tag = "3")]
    pub min_start_ts: u64,
}
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct GetRegionReadProgressResponse {
    /// below are from region_read_progress module
    #[prost(uint64, tag = "1")]
    pub safe_ts: u64,
    #[prost(uint64, tag = "2")]
    pub applied_index: u64,
    #[prost(uint64, tag = "3")]
    pub pending_front_applied_index: u64,
    #[prost(uint64, tag = "4")]
    pub pending_front_ts: u64,
    #[prost(uint64, tag = "5")]
    pub pending_back_applied_index: u64,
    #[prost(uint64, tag = "6")]
    pub pending_back_ts: u64,
    #[prost(bool, tag = "7")]
    pub region_read_progress_paused: bool,
    #[prost(uint64, tag = "8")]
    pub duration_to_last_update_safe_ts_ms: u64,
    #[prost(uint64, tag = "9")]
    pub duration_to_last_consume_leader_ms: u64,
    #[prost(bool, tag = "10")]
    pub region_read_progress_exist: bool,
    #[prost(uint64, tag = "18")]
    pub read_state_ts: u64,
    #[prost(uint64, tag = "19")]
    pub read_state_apply_index: u64,
    #[prost(bool, tag = "20")]
    pub discard: bool,
    /// below are from resolved-ts module
    #[prost(uint64, tag = "11")]
    pub resolved_ts: u64,
    #[prost(uint64, tag = "12")]
    pub resolver_tracked_index: u64,
    #[prost(bool, tag = "13")]
    pub resolver_exist: bool,
    #[prost(bool, tag = "14")]
    pub resolver_stopped: bool,
    #[prost(uint64, tag = "16")]
    pub num_locks: u64,
    #[prost(uint64, tag = "17")]
    pub num_transactions: u64,
    #[prost(string, tag = "15")]
    pub error: ::prost::alloc::string::String,
}
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, PartialOrd, Ord, ::prost::Enumeration)]
#[repr(i32)]
pub enum Db {
    Invalid = 0,
    Kv = 1,
    Raft = 2,
}
impl Db {
    /// String value of the enum field names used in the ProtoBuf definition.
    ///
    /// The values are not transformed in any way and thus are considered stable
    /// (if the ProtoBuf definition does not change) and safe for programmatic use.
    pub fn as_str_name(&self) -> &'static str {
        match self {
            Db::Invalid => "INVALID",
            Db::Kv => "KV",
            Db::Raft => "RAFT",
        }
    }
    /// Creates an enum from field names used in the ProtoBuf definition.
    pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
        match value {
            "INVALID" => Some(Self::Invalid),
            "KV" => Some(Self::Kv),
            "RAFT" => Some(Self::Raft),
            _ => None,
        }
    }
}
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, PartialOrd, Ord, ::prost::Enumeration)]
#[repr(i32)]
pub enum Module {
    Unused = 0,
    Kvdb = 1,
    Raftdb = 2,
    Readpool = 3,
    Server = 4,
    Storage = 5,
    Pd = 6,
    Metric = 7,
    Coprocessor = 8,
    Security = 9,
    Import = 10,
}
impl Module {
    /// String value of the enum field names used in the ProtoBuf definition.
    ///
    /// The values are not transformed in any way and thus are considered stable
    /// (if the ProtoBuf definition does not change) and safe for programmatic use.
    pub fn as_str_name(&self) -> &'static str {
        match self {
            Module::Unused => "UNUSED",
            Module::Kvdb => "KVDB",
            Module::Raftdb => "RAFTDB",
            Module::Readpool => "READPOOL",
            Module::Server => "SERVER",
            Module::Storage => "STORAGE",
            Module::Pd => "PD",
            Module::Metric => "METRIC",
            Module::Coprocessor => "COPROCESSOR",
            Module::Security => "SECURITY",
            Module::Import => "IMPORT",
        }
    }
    /// Creates an enum from field names used in the ProtoBuf definition.
    pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
        match value {
            "UNUSED" => Some(Self::Unused),
            "KVDB" => Some(Self::Kvdb),
            "RAFTDB" => Some(Self::Raftdb),
            "READPOOL" => Some(Self::Readpool),
            "SERVER" => Some(Self::Server),
            "STORAGE" => Some(Self::Storage),
            "PD" => Some(Self::Pd),
            "METRIC" => Some(Self::Metric),
            "COPROCESSOR" => Some(Self::Coprocessor),
            "SECURITY" => Some(Self::Security),
            "IMPORT" => Some(Self::Import),
            _ => None,
        }
    }
}
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, PartialOrd, Ord, ::prost::Enumeration)]
#[repr(i32)]
pub enum BottommostLevelCompaction {
    /// Skip bottommost level compaction
    Skip = 0,
    /// Force bottommost level compaction
    Force = 1,
    /// Compact bottommost level if there is a compaction filter.
    IfHaveCompactionFilter = 2,
}
impl BottommostLevelCompaction {
    /// String value of the enum field names used in the ProtoBuf definition.
    ///
    /// The values are not transformed in any way and thus are considered stable
    /// (if the ProtoBuf definition does not change) and safe for programmatic use.
    pub fn as_str_name(&self) -> &'static str {
        match self {
            BottommostLevelCompaction::Skip => "Skip",
            BottommostLevelCompaction::Force => "Force",
            BottommostLevelCompaction::IfHaveCompactionFilter => "IfHaveCompactionFilter",
        }
    }
    /// Creates an enum from field names used in the ProtoBuf definition.
    pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
        match value {
            "Skip" => Some(Self::Skip),
            "Force" => Some(Self::Force),
            "IfHaveCompactionFilter" => Some(Self::IfHaveCompactionFilter),
            _ => None,
        }
    }
}
/// Generated client implementations.
pub mod debug_client {
    #![allow(unused_variables, dead_code, missing_docs, clippy::let_unit_value)]
    use tonic::codegen::*;
    use tonic::codegen::http::Uri;
    /// Debug service for TiKV.
    ///
    /// Errors are defined as follow:
    ///
    /// * OK: Okay, we are good!
    /// * UNKNOWN: For unknown error.
    /// * INVALID_ARGUMENT: Something goes wrong within requests.
    /// * NOT_FOUND: It is key or region not found, it's based on context, detailed
    ///  reason can be found in grpc message.
    ///  Note: It bypasses raft layer.
    #[derive(Debug, Clone)]
    pub struct DebugClient<T> {
        inner: tonic::client::Grpc<T>,
    }
    impl DebugClient<tonic::transport::Channel> {
        /// Attempt to create a new client by connecting to a given endpoint.
        pub async fn connect<D>(dst: D) -> Result<Self, tonic::transport::Error>
        where
            D: TryInto<tonic::transport::Endpoint>,
            D::Error: Into<StdError>,
        {
            let conn = tonic::transport::Endpoint::new(dst)?.connect().await?;
            Ok(Self::new(conn))
        }
    }
    impl<T> DebugClient<T>
    where
        T: tonic::client::GrpcService<tonic::body::BoxBody>,
        T::Error: Into<StdError>,
        T::ResponseBody: Body<Data = Bytes> + Send + 'static,
        <T::ResponseBody as Body>::Error: Into<StdError> + Send,
    {
        pub fn new(inner: T) -> Self {
            let inner = tonic::client::Grpc::new(inner);
            Self { inner }
        }
        pub fn with_origin(inner: T, origin: Uri) -> Self {
            let inner = tonic::client::Grpc::with_origin(inner, origin);
            Self { inner }
        }
        pub fn with_interceptor<F>(
            inner: T,
            interceptor: F,
        ) -> DebugClient<InterceptedService<T, F>>
        where
            F: tonic::service::Interceptor,
            T::ResponseBody: Default,
            T: tonic::codegen::Service<
                http::Request<tonic::body::BoxBody>,
                Response = http::Response<
                    <T as tonic::client::GrpcService<tonic::body::BoxBody>>::ResponseBody,
                >,
            >,
            <T as tonic::codegen::Service<
                http::Request<tonic::body::BoxBody>,
            >>::Error: Into<StdError> + Send + Sync,
        {
            DebugClient::new(InterceptedService::new(inner, interceptor))
        }
        /// Compress requests with the given encoding.
        ///
        /// This requires the server to support it otherwise it might respond with an
        /// error.
        #[must_use]
        pub fn send_compressed(mut self, encoding: CompressionEncoding) -> Self {
            self.inner = self.inner.send_compressed(encoding);
            self
        }
        /// Enable decompressing responses.
        #[must_use]
        pub fn accept_compressed(mut self, encoding: CompressionEncoding) -> Self {
            self.inner = self.inner.accept_compressed(encoding);
            self
        }
        /// Limits the maximum size of a decoded message.
        ///
        /// Default: `4MB`
        #[must_use]
        pub fn max_decoding_message_size(mut self, limit: usize) -> Self {
            self.inner = self.inner.max_decoding_message_size(limit);
            self
        }
        /// Limits the maximum size of an encoded message.
        ///
        /// Default: `usize::MAX`
        #[must_use]
        pub fn max_encoding_message_size(mut self, limit: usize) -> Self {
            self.inner = self.inner.max_encoding_message_size(limit);
            self
        }
        /// Read a value arbitrarily for a key.
        /// Note: Server uses key directly w/o any encoding.
        pub async fn get(
            &mut self,
            request: impl tonic::IntoRequest<super::GetRequest>,
        ) -> std::result::Result<tonic::Response<super::GetResponse>, tonic::Status> {
            self.inner
                .ready()
                .await
                .map_err(|e| {
                    tonic::Status::new(
                        tonic::Code::Unknown,
                        format!("Service was not ready: {}", e.into()),
                    )
                })?;
            let codec = tonic::codec::ProstCodec::default();
            let path = http::uri::PathAndQuery::from_static("/debugpb.Debug/Get");
            let mut req = request.into_request();
            req.extensions_mut().insert(GrpcMethod::new("debugpb.Debug", "Get"));
            self.inner.unary(req, path, codec).await
        }
        /// Read raft info.
        pub async fn raft_log(
            &mut self,
            request: impl tonic::IntoRequest<super::RaftLogRequest>,
        ) -> std::result::Result<
            tonic::Response<super::RaftLogResponse>,
            tonic::Status,
        > {
            self.inner
                .ready()
                .await
                .map_err(|e| {
                    tonic::Status::new(
                        tonic::Code::Unknown,
                        format!("Service was not ready: {}", e.into()),
                    )
                })?;
            let codec = tonic::codec::ProstCodec::default();
            let path = http::uri::PathAndQuery::from_static("/debugpb.Debug/RaftLog");
            let mut req = request.into_request();
            req.extensions_mut().insert(GrpcMethod::new("debugpb.Debug", "RaftLog"));
            self.inner.unary(req, path, codec).await
        }
        pub async fn region_info(
            &mut self,
            request: impl tonic::IntoRequest<super::RegionInfoRequest>,
        ) -> std::result::Result<
            tonic::Response<super::RegionInfoResponse>,
            tonic::Status,
        > {
            self.inner
                .ready()
                .await
                .map_err(|e| {
                    tonic::Status::new(
                        tonic::Code::Unknown,
                        format!("Service was not ready: {}", e.into()),
                    )
                })?;
            let codec = tonic::codec::ProstCodec::default();
            let path = http::uri::PathAndQuery::from_static("/debugpb.Debug/RegionInfo");
            let mut req = request.into_request();
            req.extensions_mut().insert(GrpcMethod::new("debugpb.Debug", "RegionInfo"));
            self.inner.unary(req, path, codec).await
        }
        /// Calculate size of a region.
        /// Note: DO NOT CALL IT IN PRODUCTION, it's really expensive.
        pub async fn region_size(
            &mut self,
            request: impl tonic::IntoRequest<super::RegionSizeRequest>,
        ) -> std::result::Result<
            tonic::Response<super::RegionSizeResponse>,
            tonic::Status,
        > {
            self.inner
                .ready()
                .await
                .map_err(|e| {
                    tonic::Status::new(
                        tonic::Code::Unknown,
                        format!("Service was not ready: {}", e.into()),
                    )
                })?;
            let codec = tonic::codec::ProstCodec::default();
            let path = http::uri::PathAndQuery::from_static("/debugpb.Debug/RegionSize");
            let mut req = request.into_request();
            req.extensions_mut().insert(GrpcMethod::new("debugpb.Debug", "RegionSize"));
            self.inner.unary(req, path, codec).await
        }
        /// Scan a specific range.
        /// Note: DO NOT CALL IT IN PRODUCTION, it's really expensive.
        /// Server uses keys directly w/o any encoding.
        pub async fn scan_mvcc(
            &mut self,
            request: impl tonic::IntoRequest<super::ScanMvccRequest>,
        ) -> std::result::Result<
            tonic::Response<tonic::codec::Streaming<super::ScanMvccResponse>>,
            tonic::Status,
        > {
            self.inner
                .ready()
                .await
                .map_err(|e| {
                    tonic::Status::new(
                        tonic::Code::Unknown,
                        format!("Service was not ready: {}", e.into()),
                    )
                })?;
            let codec = tonic::codec::ProstCodec::default();
            let path = http::uri::PathAndQuery::from_static("/debugpb.Debug/ScanMvcc");
            let mut req = request.into_request();
            req.extensions_mut().insert(GrpcMethod::new("debugpb.Debug", "ScanMvcc"));
            self.inner.server_streaming(req, path, codec).await
        }
        /// Compact a column family in a specified range.
        /// Note: Server uses keys directly w/o any encoding.
        pub async fn compact(
            &mut self,
            request: impl tonic::IntoRequest<super::CompactRequest>,
        ) -> std::result::Result<
            tonic::Response<super::CompactResponse>,
            tonic::Status,
        > {
            self.inner
                .ready()
                .await
                .map_err(|e| {
                    tonic::Status::new(
                        tonic::Code::Unknown,
                        format!("Service was not ready: {}", e.into()),
                    )
                })?;
            let codec = tonic::codec::ProstCodec::default();
            let path = http::uri::PathAndQuery::from_static("/debugpb.Debug/Compact");
            let mut req = request.into_request();
            req.extensions_mut().insert(GrpcMethod::new("debugpb.Debug", "Compact"));
            self.inner.unary(req, path, codec).await
        }
        /// Inject a fail point. Currently, it's only used in tests.
        /// Note: DO NOT CALL IT IN PRODUCTION.
        pub async fn inject_fail_point(
            &mut self,
            request: impl tonic::IntoRequest<super::InjectFailPointRequest>,
        ) -> std::result::Result<
            tonic::Response<super::InjectFailPointResponse>,
            tonic::Status,
        > {
            self.inner
                .ready()
                .await
                .map_err(|e| {
                    tonic::Status::new(
                        tonic::Code::Unknown,
                        format!("Service was not ready: {}", e.into()),
                    )
                })?;
            let codec = tonic::codec::ProstCodec::default();
            let path = http::uri::PathAndQuery::from_static(
                "/debugpb.Debug/InjectFailPoint",
            );
            let mut req = request.into_request();
            req.extensions_mut()
                .insert(GrpcMethod::new("debugpb.Debug", "InjectFailPoint"));
            self.inner.unary(req, path, codec).await
        }
        /// Recover from a fail point.
        pub async fn recover_fail_point(
            &mut self,
            request: impl tonic::IntoRequest<super::RecoverFailPointRequest>,
        ) -> std::result::Result<
            tonic::Response<super::RecoverFailPointResponse>,
            tonic::Status,
        > {
            self.inner
                .ready()
                .await
                .map_err(|e| {
                    tonic::Status::new(
                        tonic::Code::Unknown,
                        format!("Service was not ready: {}", e.into()),
                    )
                })?;
            let codec = tonic::codec::ProstCodec::default();
            let path = http::uri::PathAndQuery::from_static(
                "/debugpb.Debug/RecoverFailPoint",
            );
            let mut req = request.into_request();
            req.extensions_mut()
                .insert(GrpcMethod::new("debugpb.Debug", "RecoverFailPoint"));
            self.inner.unary(req, path, codec).await
        }
        /// List all fail points.
        pub async fn list_fail_points(
            &mut self,
            request: impl tonic::IntoRequest<super::ListFailPointsRequest>,
        ) -> std::result::Result<
            tonic::Response<super::ListFailPointsResponse>,
            tonic::Status,
        > {
            self.inner
                .ready()
                .await
                .map_err(|e| {
                    tonic::Status::new(
                        tonic::Code::Unknown,
                        format!("Service was not ready: {}", e.into()),
                    )
                })?;
            let codec = tonic::codec::ProstCodec::default();
            let path = http::uri::PathAndQuery::from_static(
                "/debugpb.Debug/ListFailPoints",
            );
            let mut req = request.into_request();
            req.extensions_mut()
                .insert(GrpcMethod::new("debugpb.Debug", "ListFailPoints"));
            self.inner.unary(req, path, codec).await
        }
        /// Get Metrics
        pub async fn get_metrics(
            &mut self,
            request: impl tonic::IntoRequest<super::GetMetricsRequest>,
        ) -> std::result::Result<
            tonic::Response<super::GetMetricsResponse>,
            tonic::Status,
        > {
            self.inner
                .ready()
                .await
                .map_err(|e| {
                    tonic::Status::new(
                        tonic::Code::Unknown,
                        format!("Service was not ready: {}", e.into()),
                    )
                })?;
            let codec = tonic::codec::ProstCodec::default();
            let path = http::uri::PathAndQuery::from_static("/debugpb.Debug/GetMetrics");
            let mut req = request.into_request();
            req.extensions_mut().insert(GrpcMethod::new("debugpb.Debug", "GetMetrics"));
            self.inner.unary(req, path, codec).await
        }
        /// Do a consistent check for a region.
        pub async fn check_region_consistency(
            &mut self,
            request: impl tonic::IntoRequest<super::RegionConsistencyCheckRequest>,
        ) -> std::result::Result<
            tonic::Response<super::RegionConsistencyCheckResponse>,
            tonic::Status,
        > {
            self.inner
                .ready()
                .await
                .map_err(|e| {
                    tonic::Status::new(
                        tonic::Code::Unknown,
                        format!("Service was not ready: {}", e.into()),
                    )
                })?;
            let codec = tonic::codec::ProstCodec::default();
            let path = http::uri::PathAndQuery::from_static(
                "/debugpb.Debug/CheckRegionConsistency",
            );
            let mut req = request.into_request();
            req.extensions_mut()
                .insert(GrpcMethod::new("debugpb.Debug", "CheckRegionConsistency"));
            self.inner.unary(req, path, codec).await
        }
        /// dynamically modify tikv's config
        pub async fn modify_tikv_config(
            &mut self,
            request: impl tonic::IntoRequest<super::ModifyTikvConfigRequest>,
        ) -> std::result::Result<
            tonic::Response<super::ModifyTikvConfigResponse>,
            tonic::Status,
        > {
            self.inner
                .ready()
                .await
                .map_err(|e| {
                    tonic::Status::new(
                        tonic::Code::Unknown,
                        format!("Service was not ready: {}", e.into()),
                    )
                })?;
            let codec = tonic::codec::ProstCodec::default();
            let path = http::uri::PathAndQuery::from_static(
                "/debugpb.Debug/ModifyTikvConfig",
            );
            let mut req = request.into_request();
            req.extensions_mut()
                .insert(GrpcMethod::new("debugpb.Debug", "ModifyTikvConfig"));
            self.inner.unary(req, path, codec).await
        }
        /// Get region properties
        pub async fn get_region_properties(
            &mut self,
            request: impl tonic::IntoRequest<super::GetRegionPropertiesRequest>,
        ) -> std::result::Result<
            tonic::Response<super::GetRegionPropertiesResponse>,
            tonic::Status,
        > {
            self.inner
                .ready()
                .await
                .map_err(|e| {
                    tonic::Status::new(
                        tonic::Code::Unknown,
                        format!("Service was not ready: {}", e.into()),
                    )
                })?;
            let codec = tonic::codec::ProstCodec::default();
            let path = http::uri::PathAndQuery::from_static(
                "/debugpb.Debug/GetRegionProperties",
            );
            let mut req = request.into_request();
            req.extensions_mut()
                .insert(GrpcMethod::new("debugpb.Debug", "GetRegionProperties"));
            self.inner.unary(req, path, codec).await
        }
        /// Get store ID
        pub async fn get_store_info(
            &mut self,
            request: impl tonic::IntoRequest<super::GetStoreInfoRequest>,
        ) -> std::result::Result<
            tonic::Response<super::GetStoreInfoResponse>,
            tonic::Status,
        > {
            self.inner
                .ready()
                .await
                .map_err(|e| {
                    tonic::Status::new(
                        tonic::Code::Unknown,
                        format!("Service was not ready: {}", e.into()),
                    )
                })?;
            let codec = tonic::codec::ProstCodec::default();
            let path = http::uri::PathAndQuery::from_static(
                "/debugpb.Debug/GetStoreInfo",
            );
            let mut req = request.into_request();
            req.extensions_mut()
                .insert(GrpcMethod::new("debugpb.Debug", "GetStoreInfo"));
            self.inner.unary(req, path, codec).await
        }
        /// Get cluster ID
        pub async fn get_cluster_info(
            &mut self,
            request: impl tonic::IntoRequest<super::GetClusterInfoRequest>,
        ) -> std::result::Result<
            tonic::Response<super::GetClusterInfoResponse>,
            tonic::Status,
        > {
            self.inner
                .ready()
                .await
                .map_err(|e| {
                    tonic::Status::new(
                        tonic::Code::Unknown,
                        format!("Service was not ready: {}", e.into()),
                    )
                })?;
            let codec = tonic::codec::ProstCodec::default();
            let path = http::uri::PathAndQuery::from_static(
                "/debugpb.Debug/GetClusterInfo",
            );
            let mut req = request.into_request();
            req.extensions_mut()
                .insert(GrpcMethod::new("debugpb.Debug", "GetClusterInfo"));
            self.inner.unary(req, path, codec).await
        }
        /// Get all region IDs in the store
        pub async fn get_all_regions_in_store(
            &mut self,
            request: impl tonic::IntoRequest<super::GetAllRegionsInStoreRequest>,
        ) -> std::result::Result<
            tonic::Response<super::GetAllRegionsInStoreResponse>,
            tonic::Status,
        > {
            self.inner
                .ready()
                .await
                .map_err(|e| {
                    tonic::Status::new(
                        tonic::Code::Unknown,
                        format!("Service was not ready: {}", e.into()),
                    )
                })?;
            let codec = tonic::codec::ProstCodec::default();
            let path = http::uri::PathAndQuery::from_static(
                "/debugpb.Debug/GetAllRegionsInStore",
            );
            let mut req = request.into_request();
            req.extensions_mut()
                .insert(GrpcMethod::new("debugpb.Debug", "GetAllRegionsInStore"));
            self.inner.unary(req, path, codec).await
        }
        /// Make this TiKV node return to the status on this node to certain ts.
        pub async fn reset_to_version(
            &mut self,
            request: impl tonic::IntoRequest<super::ResetToVersionRequest>,
        ) -> std::result::Result<
            tonic::Response<super::ResetToVersionResponse>,
            tonic::Status,
        > {
            self.inner
                .ready()
                .await
                .map_err(|e| {
                    tonic::Status::new(
                        tonic::Code::Unknown,
                        format!("Service was not ready: {}", e.into()),
                    )
                })?;
            let codec = tonic::codec::ProstCodec::default();
            let path = http::uri::PathAndQuery::from_static(
                "/debugpb.Debug/ResetToVersion",
            );
            let mut req = request.into_request();
            req.extensions_mut()
                .insert(GrpcMethod::new("debugpb.Debug", "ResetToVersion"));
            self.inner.unary(req, path, codec).await
        }
        /// Get range properties
        pub async fn get_range_properties(
            &mut self,
            request: impl tonic::IntoRequest<super::GetRangePropertiesRequest>,
        ) -> std::result::Result<
            tonic::Response<super::GetRangePropertiesResponse>,
            tonic::Status,
        > {
            self.inner
                .ready()
                .await
                .map_err(|e| {
                    tonic::Status::new(
                        tonic::Code::Unknown,
                        format!("Service was not ready: {}", e.into()),
                    )
                })?;
            let codec = tonic::codec::ProstCodec::default();
            let path = http::uri::PathAndQuery::from_static(
                "/debugpb.Debug/GetRangeProperties",
            );
            let mut req = request.into_request();
            req.extensions_mut()
                .insert(GrpcMethod::new("debugpb.Debug", "GetRangeProperties"));
            self.inner.unary(req, path, codec).await
        }
        /// Flashback given key range to a specified version.
        pub async fn flashback_to_version(
            &mut self,
            request: impl tonic::IntoRequest<super::FlashbackToVersionRequest>,
        ) -> std::result::Result<
            tonic::Response<super::FlashbackToVersionResponse>,
            tonic::Status,
        > {
            self.inner
                .ready()
                .await
                .map_err(|e| {
                    tonic::Status::new(
                        tonic::Code::Unknown,
                        format!("Service was not ready: {}", e.into()),
                    )
                })?;
            let codec = tonic::codec::ProstCodec::default();
            let path = http::uri::PathAndQuery::from_static(
                "/debugpb.Debug/FlashbackToVersion",
            );
            let mut req = request.into_request();
            req.extensions_mut()
                .insert(GrpcMethod::new("debugpb.Debug", "FlashbackToVersion"));
            self.inner.unary(req, path, codec).await
        }
        /// GetRegionReadProgress returns the some useful info in RegionReadProgress
        pub async fn get_region_read_progress(
            &mut self,
            request: impl tonic::IntoRequest<super::GetRegionReadProgressRequest>,
        ) -> std::result::Result<
            tonic::Response<super::GetRegionReadProgressResponse>,
            tonic::Status,
        > {
            self.inner
                .ready()
                .await
                .map_err(|e| {
                    tonic::Status::new(
                        tonic::Code::Unknown,
                        format!("Service was not ready: {}", e.into()),
                    )
                })?;
            let codec = tonic::codec::ProstCodec::default();
            let path = http::uri::PathAndQuery::from_static(
                "/debugpb.Debug/GetRegionReadProgress",
            );
            let mut req = request.into_request();
            req.extensions_mut()
                .insert(GrpcMethod::new("debugpb.Debug", "GetRegionReadProgress"));
            self.inner.unary(req, path, codec).await
        }
    }
}