forked from cockroachdb/cockroach
/
admin.pb.go
7254 lines (6979 loc) · 185 KB
/
admin.pb.go
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
// Code generated by protoc-gen-gogo.
// source: cockroach/pkg/server/serverpb/admin.proto
// DO NOT EDIT!
/*
Package serverpb is a generated protocol buffer package.
It is generated from these files:
cockroach/pkg/server/serverpb/admin.proto
cockroach/pkg/server/serverpb/status.proto
It has these top-level messages:
DatabasesRequest
DatabasesResponse
DatabaseDetailsRequest
DatabaseDetailsResponse
TableDetailsRequest
TableDetailsResponse
TableStatsRequest
TableStatsResponse
UsersRequest
UsersResponse
EventsRequest
EventsResponse
SetUIDataRequest
SetUIDataResponse
GetUIDataRequest
GetUIDataResponse
ClusterRequest
ClusterResponse
DrainRequest
DrainResponse
SettingsRequest
SettingsResponse
HealthRequest
HealthResponse
LivenessRequest
LivenessResponse
DetailsRequest
DetailsResponse
NodesRequest
NodesResponse
NodeRequest
RaftState
RangeProblems
RangeInfo
RangesRequest
RangesResponse
GossipRequest
JSONResponse
LogsRequest
LogEntriesResponse
LogFilesListRequest
LogFilesListResponse
LogFileRequest
StacksRequest
MetricsRequest
RaftRangeNode
RaftRangeError
RaftRangeStatus
RaftDebugRequest
RaftDebugResponse
SpanStatsRequest
SpanStatsResponse
PrettySpan
*/
package serverpb
import proto "github.com/gogo/protobuf/proto"
import fmt "fmt"
import math "math"
import cockroach_config "github.com/cockroachdb/cockroach/pkg/config"
import cockroach_storage_engine_enginepb "github.com/cockroachdb/cockroach/pkg/storage/engine/enginepb"
import cockroach_storage "github.com/cockroachdb/cockroach/pkg/storage"
import time "time"
import (
context "golang.org/x/net/context"
grpc "google.golang.org/grpc"
)
import github_com_gogo_protobuf_sortkeys "github.com/gogo/protobuf/sortkeys"
import github_com_gogo_protobuf_types "github.com/gogo/protobuf/types"
import io "io"
// Reference imports to suppress errors if they are not otherwise used.
var _ = proto.Marshal
var _ = fmt.Errorf
var _ = math.Inf
var _ = time.Kitchen
// This is a compile-time assertion to ensure that this generated file
// is compatible with the proto package it is being compiled against.
// A compilation error at this line likely means your copy of the
// proto package needs to be updated.
const _ = proto.GoGoProtoPackageIsVersion2 // please upgrade the proto package
// ZoneConfigurationLevel indicates, for objects with a Zone Configuration,
// the object level at which the configuration is defined. This is needed
// because objects without a specifically indicated Zone Configuration will
// inherit the configuration of their "parent".
type ZoneConfigurationLevel int32
const (
ZoneConfigurationLevel_UNKNOWN ZoneConfigurationLevel = 0
// CLUSTER indicates that this object uses the cluster default Zone Configuration.
ZoneConfigurationLevel_CLUSTER ZoneConfigurationLevel = 1
// DATABASE indicates that this object uses a database-level Zone Configuration.
ZoneConfigurationLevel_DATABASE ZoneConfigurationLevel = 2
// TABLE indicates that this object uses a table-level Zone Configuration.
ZoneConfigurationLevel_TABLE ZoneConfigurationLevel = 3
)
var ZoneConfigurationLevel_name = map[int32]string{
0: "UNKNOWN",
1: "CLUSTER",
2: "DATABASE",
3: "TABLE",
}
var ZoneConfigurationLevel_value = map[string]int32{
"UNKNOWN": 0,
"CLUSTER": 1,
"DATABASE": 2,
"TABLE": 3,
}
func (x ZoneConfigurationLevel) String() string {
return proto.EnumName(ZoneConfigurationLevel_name, int32(x))
}
func (ZoneConfigurationLevel) EnumDescriptor() ([]byte, []int) { return fileDescriptorAdmin, []int{0} }
type DrainMode int32
const (
// CLIENT instructs the server to refuse new SQL clients.
// TODO(tschottdorf): also terminate existing clients in a graceful manner.
DrainMode_CLIENT DrainMode = 0
// LEADERSHIP instructs the server to gracefully let all its Replicas'
// range leases expire.
DrainMode_LEASES DrainMode = 1
)
var DrainMode_name = map[int32]string{
0: "CLIENT",
1: "LEASES",
}
var DrainMode_value = map[string]int32{
"CLIENT": 0,
"LEASES": 1,
}
func (x DrainMode) String() string {
return proto.EnumName(DrainMode_name, int32(x))
}
func (DrainMode) EnumDescriptor() ([]byte, []int) { return fileDescriptorAdmin, []int{1} }
// DatabasesRequest requests a list of databases.
type DatabasesRequest struct {
}
func (m *DatabasesRequest) Reset() { *m = DatabasesRequest{} }
func (m *DatabasesRequest) String() string { return proto.CompactTextString(m) }
func (*DatabasesRequest) ProtoMessage() {}
func (*DatabasesRequest) Descriptor() ([]byte, []int) { return fileDescriptorAdmin, []int{0} }
// DatabasesResponse contains a list of databases.
type DatabasesResponse struct {
Databases []string `protobuf:"bytes,1,rep,name=databases" json:"databases,omitempty"`
}
func (m *DatabasesResponse) Reset() { *m = DatabasesResponse{} }
func (m *DatabasesResponse) String() string { return proto.CompactTextString(m) }
func (*DatabasesResponse) ProtoMessage() {}
func (*DatabasesResponse) Descriptor() ([]byte, []int) { return fileDescriptorAdmin, []int{1} }
// DatabaseDetailsRequest requests detailed information about the specified
// database
type DatabaseDetailsRequest struct {
// database is the name of the database we are querying.
Database string `protobuf:"bytes,1,opt,name=database,proto3" json:"database,omitempty"`
}
func (m *DatabaseDetailsRequest) Reset() { *m = DatabaseDetailsRequest{} }
func (m *DatabaseDetailsRequest) String() string { return proto.CompactTextString(m) }
func (*DatabaseDetailsRequest) ProtoMessage() {}
func (*DatabaseDetailsRequest) Descriptor() ([]byte, []int) { return fileDescriptorAdmin, []int{2} }
// DatabaseDetailsResponse contains grant information and table names for a
// database.
type DatabaseDetailsResponse struct {
// grants are the results of SHOW GRANTS for this database.
Grants []DatabaseDetailsResponse_Grant `protobuf:"bytes,1,rep,name=grants" json:"grants"`
// table_names contains the names of all tables (SHOW TABLES) in this
// database.
TableNames []string `protobuf:"bytes,2,rep,name=table_names,json=tableNames" json:"table_names,omitempty"`
// descriptor_id is an identifier used to uniquely identify this database.
// It can be used to find events pertaining to this database by filtering on
// the 'target_id' field of events.
DescriptorID int64 `protobuf:"varint,3,opt,name=descriptor_id,json=descriptorId,proto3" json:"descriptor_id,omitempty"`
// The zone configuration in effect for this database.
ZoneConfig cockroach_config.ZoneConfig `protobuf:"bytes,4,opt,name=zone_config,json=zoneConfig" json:"zone_config"`
// The level at which this object's zone configuration is set.
ZoneConfigLevel ZoneConfigurationLevel `protobuf:"varint,5,opt,name=zone_config_level,json=zoneConfigLevel,proto3,enum=cockroach.server.serverpb.ZoneConfigurationLevel" json:"zone_config_level,omitempty"`
}
func (m *DatabaseDetailsResponse) Reset() { *m = DatabaseDetailsResponse{} }
func (m *DatabaseDetailsResponse) String() string { return proto.CompactTextString(m) }
func (*DatabaseDetailsResponse) ProtoMessage() {}
func (*DatabaseDetailsResponse) Descriptor() ([]byte, []int) { return fileDescriptorAdmin, []int{3} }
type DatabaseDetailsResponse_Grant struct {
// user is the user that this grant applies to.
User string `protobuf:"bytes,1,opt,name=user,proto3" json:"user,omitempty"`
// privileges are the abilities this grant gives to the user.
Privileges []string `protobuf:"bytes,2,rep,name=privileges" json:"privileges,omitempty"`
}
func (m *DatabaseDetailsResponse_Grant) Reset() { *m = DatabaseDetailsResponse_Grant{} }
func (m *DatabaseDetailsResponse_Grant) String() string { return proto.CompactTextString(m) }
func (*DatabaseDetailsResponse_Grant) ProtoMessage() {}
func (*DatabaseDetailsResponse_Grant) Descriptor() ([]byte, []int) {
return fileDescriptorAdmin, []int{3, 0}
}
// TableDetailsRequest is a request for detailed information about a table.
type TableDetailsRequest struct {
// database is the database that contains the table we're interested in.
Database string `protobuf:"bytes,1,opt,name=database,proto3" json:"database,omitempty"`
// table is the name of the table that we're querying.
Table string `protobuf:"bytes,2,opt,name=table,proto3" json:"table,omitempty"`
}
func (m *TableDetailsRequest) Reset() { *m = TableDetailsRequest{} }
func (m *TableDetailsRequest) String() string { return proto.CompactTextString(m) }
func (*TableDetailsRequest) ProtoMessage() {}
func (*TableDetailsRequest) Descriptor() ([]byte, []int) { return fileDescriptorAdmin, []int{4} }
// TableDetailsResponse contains grants, column names, and indexes for
// a table.
type TableDetailsResponse struct {
Grants []TableDetailsResponse_Grant `protobuf:"bytes,1,rep,name=grants" json:"grants"`
Columns []TableDetailsResponse_Column `protobuf:"bytes,2,rep,name=columns" json:"columns"`
Indexes []TableDetailsResponse_Index `protobuf:"bytes,3,rep,name=indexes" json:"indexes"`
// range_count is the size of the table in ranges. This provides a rough
// estimate of the storage requirements for the table.
// TODO(mrtracy): The TableStats method also returns a range_count field which
// is more accurate than this one; TableDetails calculates this number using
// a potentially faster method that is subject to cache staleness. We should
// consider removing or renaming this field to reflect that difference. See
// Github issue #5435 for more information.
RangeCount int64 `protobuf:"varint,4,opt,name=range_count,json=rangeCount,proto3" json:"range_count,omitempty"`
// create_table_statement is the output of "SHOW CREATE TABLE" for this table;
// it is a SQL statement that would re-create the table's current schema if
// executed.
CreateTableStatement string `protobuf:"bytes,5,opt,name=create_table_statement,json=createTableStatement,proto3" json:"create_table_statement,omitempty"`
// The zone configuration in effect for this table.
ZoneConfig cockroach_config.ZoneConfig `protobuf:"bytes,6,opt,name=zone_config,json=zoneConfig" json:"zone_config"`
// The level at which this object's zone configuration is set.
ZoneConfigLevel ZoneConfigurationLevel `protobuf:"varint,7,opt,name=zone_config_level,json=zoneConfigLevel,proto3,enum=cockroach.server.serverpb.ZoneConfigurationLevel" json:"zone_config_level,omitempty"`
// descriptor_id is an identifier used to uniquely identify this table.
// It can be used to find events pertaining to this table by filtering on
// the 'target_id' field of events.
DescriptorID int64 `protobuf:"varint,8,opt,name=descriptor_id,json=descriptorId,proto3" json:"descriptor_id,omitempty"`
}
func (m *TableDetailsResponse) Reset() { *m = TableDetailsResponse{} }
func (m *TableDetailsResponse) String() string { return proto.CompactTextString(m) }
func (*TableDetailsResponse) ProtoMessage() {}
func (*TableDetailsResponse) Descriptor() ([]byte, []int) { return fileDescriptorAdmin, []int{5} }
// Grant is an entry from SHOW GRANTS.
type TableDetailsResponse_Grant struct {
// user is the user that this grant applies to.
User string `protobuf:"bytes,1,opt,name=user,proto3" json:"user,omitempty"`
// privileges are the abilities this grant gives to the user.
Privileges []string `protobuf:"bytes,2,rep,name=privileges" json:"privileges,omitempty"`
}
func (m *TableDetailsResponse_Grant) Reset() { *m = TableDetailsResponse_Grant{} }
func (m *TableDetailsResponse_Grant) String() string { return proto.CompactTextString(m) }
func (*TableDetailsResponse_Grant) ProtoMessage() {}
func (*TableDetailsResponse_Grant) Descriptor() ([]byte, []int) {
return fileDescriptorAdmin, []int{5, 0}
}
type TableDetailsResponse_Column struct {
// name is the name of the column.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// type is the SQL type (INT, STRING, etc.) of this column.
Type string `protobuf:"bytes,2,opt,name=type,proto3" json:"type,omitempty"`
// nullable is whether this column can contain NULL.
Nullable bool `protobuf:"varint,3,opt,name=nullable,proto3" json:"nullable,omitempty"`
// default_value is the default value of this column.
DefaultValue string `protobuf:"bytes,4,opt,name=default_value,json=defaultValue,proto3" json:"default_value,omitempty"`
}
func (m *TableDetailsResponse_Column) Reset() { *m = TableDetailsResponse_Column{} }
func (m *TableDetailsResponse_Column) String() string { return proto.CompactTextString(m) }
func (*TableDetailsResponse_Column) ProtoMessage() {}
func (*TableDetailsResponse_Column) Descriptor() ([]byte, []int) {
return fileDescriptorAdmin, []int{5, 1}
}
type TableDetailsResponse_Index struct {
// name is the name of this index.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// unique is whether this a unique index (i.e. CREATE UNIQUE INDEX).
Unique bool `protobuf:"varint,2,opt,name=unique,proto3" json:"unique,omitempty"`
// seq is an internal variable that's passed along.
Seq int64 `protobuf:"varint,3,opt,name=seq,proto3" json:"seq,omitempty"`
// column is the column that this index indexes.
Column string `protobuf:"bytes,4,opt,name=column,proto3" json:"column,omitempty"`
// direction is either "ASC" (ascending) or "DESC" (descending).
Direction string `protobuf:"bytes,5,opt,name=direction,proto3" json:"direction,omitempty"`
// storing is an internal variable that's passed along.
Storing bool `protobuf:"varint,6,opt,name=storing,proto3" json:"storing,omitempty"`
// implicit is an internal variable that's passed along.
Implicit bool `protobuf:"varint,7,opt,name=implicit,proto3" json:"implicit,omitempty"`
}
func (m *TableDetailsResponse_Index) Reset() { *m = TableDetailsResponse_Index{} }
func (m *TableDetailsResponse_Index) String() string { return proto.CompactTextString(m) }
func (*TableDetailsResponse_Index) ProtoMessage() {}
func (*TableDetailsResponse_Index) Descriptor() ([]byte, []int) {
return fileDescriptorAdmin, []int{5, 2}
}
// TableStatsRequest is a request for detailed, computationally expensive
// information about a table.
type TableStatsRequest struct {
// database is the database that contains the table we're interested in.
Database string `protobuf:"bytes,1,opt,name=database,proto3" json:"database,omitempty"`
// table is the name of the table that we're querying.
Table string `protobuf:"bytes,2,opt,name=table,proto3" json:"table,omitempty"`
}
func (m *TableStatsRequest) Reset() { *m = TableStatsRequest{} }
func (m *TableStatsRequest) String() string { return proto.CompactTextString(m) }
func (*TableStatsRequest) ProtoMessage() {}
func (*TableStatsRequest) Descriptor() ([]byte, []int) { return fileDescriptorAdmin, []int{6} }
// TableStatsResponse contains detailed, computationally expensive information
// about a table.
type TableStatsResponse struct {
// range_count is the number of ranges, as determined from a query of range
// meta keys.
RangeCount int64 `protobuf:"varint,1,opt,name=range_count,json=rangeCount,proto3" json:"range_count,omitempty"`
// replica_count is the number of replicas of any range of this table, as
// found by querying nodes which are known to have replicas. When compared
// with range_count, this can be used to estimate the current replication
// factor of the table.
ReplicaCount int64 `protobuf:"varint,2,opt,name=replica_count,json=replicaCount,proto3" json:"replica_count,omitempty"`
// node_count is the number of nodes which contain data for this table,
// according to a query of range meta keys.
NodeCount int64 `protobuf:"varint,3,opt,name=node_count,json=nodeCount,proto3" json:"node_count,omitempty"`
// stats is the summation of MVCCStats for all replicas of this table
// across the cluster.
Stats cockroach_storage_engine_enginepb.MVCCStats `protobuf:"bytes,4,opt,name=stats" json:"stats"`
// A list of nodes which should contain data for this table (according to
// cluster metadata), but could not be contacted during this request.
MissingNodes []TableStatsResponse_MissingNode `protobuf:"bytes,5,rep,name=missing_nodes,json=missingNodes" json:"missing_nodes"`
}
func (m *TableStatsResponse) Reset() { *m = TableStatsResponse{} }
func (m *TableStatsResponse) String() string { return proto.CompactTextString(m) }
func (*TableStatsResponse) ProtoMessage() {}
func (*TableStatsResponse) Descriptor() ([]byte, []int) { return fileDescriptorAdmin, []int{7} }
// MissingNode represents information on a node which should contain data
// for this table, but could not be contacted during this request.
type TableStatsResponse_MissingNode struct {
// The ID of the missing node.
NodeID string `protobuf:"bytes,1,opt,name=node_id,json=nodeId,proto3" json:"node_id,omitempty"`
// The error message that resulted when the query sent to this node failed.
ErrorMessage string `protobuf:"bytes,2,opt,name=error_message,json=errorMessage,proto3" json:"error_message,omitempty"`
}
func (m *TableStatsResponse_MissingNode) Reset() { *m = TableStatsResponse_MissingNode{} }
func (m *TableStatsResponse_MissingNode) String() string { return proto.CompactTextString(m) }
func (*TableStatsResponse_MissingNode) ProtoMessage() {}
func (*TableStatsResponse_MissingNode) Descriptor() ([]byte, []int) {
return fileDescriptorAdmin, []int{7, 0}
}
// UsersRequest requests a list of users.
type UsersRequest struct {
}
func (m *UsersRequest) Reset() { *m = UsersRequest{} }
func (m *UsersRequest) String() string { return proto.CompactTextString(m) }
func (*UsersRequest) ProtoMessage() {}
func (*UsersRequest) Descriptor() ([]byte, []int) { return fileDescriptorAdmin, []int{8} }
// UsersResponse returns a list of users.
type UsersResponse struct {
// usernames is a list of users for the CockroachDB cluster.
Users []UsersResponse_User `protobuf:"bytes,1,rep,name=users" json:"users"`
}
func (m *UsersResponse) Reset() { *m = UsersResponse{} }
func (m *UsersResponse) String() string { return proto.CompactTextString(m) }
func (*UsersResponse) ProtoMessage() {}
func (*UsersResponse) Descriptor() ([]byte, []int) { return fileDescriptorAdmin, []int{9} }
// User is a CockroachDB user.
type UsersResponse_User struct {
Username string `protobuf:"bytes,1,opt,name=username,proto3" json:"username,omitempty"`
}
func (m *UsersResponse_User) Reset() { *m = UsersResponse_User{} }
func (m *UsersResponse_User) String() string { return proto.CompactTextString(m) }
func (*UsersResponse_User) ProtoMessage() {}
func (*UsersResponse_User) Descriptor() ([]byte, []int) { return fileDescriptorAdmin, []int{9, 0} }
// EventsRequest is a request for event log entries, optionally filtered
// by the specified event type and/or target_id.
type EventsRequest struct {
Type string `protobuf:"bytes,1,opt,name=type,proto3" json:"type,omitempty"`
TargetId int64 `protobuf:"varint,2,opt,name=target_id,json=targetId,proto3" json:"target_id,omitempty"`
}
func (m *EventsRequest) Reset() { *m = EventsRequest{} }
func (m *EventsRequest) String() string { return proto.CompactTextString(m) }
func (*EventsRequest) ProtoMessage() {}
func (*EventsRequest) Descriptor() ([]byte, []int) { return fileDescriptorAdmin, []int{10} }
// EventsResponse contains a set of event log entries. This is always limited
// to the latest N entries (N is enforced in the associated endpoint).
type EventsResponse struct {
Events []EventsResponse_Event `protobuf:"bytes,1,rep,name=events" json:"events"`
}
func (m *EventsResponse) Reset() { *m = EventsResponse{} }
func (m *EventsResponse) String() string { return proto.CompactTextString(m) }
func (*EventsResponse) ProtoMessage() {}
func (*EventsResponse) Descriptor() ([]byte, []int) { return fileDescriptorAdmin, []int{11} }
type EventsResponse_Event struct {
// timestamp is the time at which the event occurred.
Timestamp time.Time `protobuf:"bytes,1,opt,name=timestamp,stdtime" json:"timestamp"`
// event_type is the type of the event (e.g. "create_table", "drop_table".
EventType string `protobuf:"bytes,2,opt,name=event_type,json=eventType,proto3" json:"event_type,omitempty"`
// target_id is the target for this event.
TargetID int64 `protobuf:"varint,3,opt,name=target_id,json=targetId,proto3" json:"target_id,omitempty"`
// reporting_id is the reporting ID for this event.
ReportingID int64 `protobuf:"varint,4,opt,name=reporting_id,json=reportingId,proto3" json:"reporting_id,omitempty"`
// info has more detailed information for the event. The contents vary
// depending on the vent.
Info string `protobuf:"bytes,5,opt,name=info,proto3" json:"info,omitempty"`
// unique_id is a unique identifier for this event.
UniqueID []byte `protobuf:"bytes,6,opt,name=unique_id,json=uniqueId,proto3" json:"unique_id,omitempty"`
}
func (m *EventsResponse_Event) Reset() { *m = EventsResponse_Event{} }
func (m *EventsResponse_Event) String() string { return proto.CompactTextString(m) }
func (*EventsResponse_Event) ProtoMessage() {}
func (*EventsResponse_Event) Descriptor() ([]byte, []int) { return fileDescriptorAdmin, []int{11, 0} }
// SetUIDataRequest stores the given key/value pairs in the system.ui table.
type SetUIDataRequest struct {
// key_values is a map of keys to bytes values. Each key will be stored
// with its corresponding value as a separate row in system.ui.
KeyValues map[string][]byte `protobuf:"bytes,1,rep,name=key_values,json=keyValues" json:"key_values,omitempty" protobuf_key:"bytes,1,opt,name=key,proto3" protobuf_val:"bytes,2,opt,name=value,proto3"`
}
func (m *SetUIDataRequest) Reset() { *m = SetUIDataRequest{} }
func (m *SetUIDataRequest) String() string { return proto.CompactTextString(m) }
func (*SetUIDataRequest) ProtoMessage() {}
func (*SetUIDataRequest) Descriptor() ([]byte, []int) { return fileDescriptorAdmin, []int{12} }
// SetUIDataResponse is currently an empty response.
type SetUIDataResponse struct {
}
func (m *SetUIDataResponse) Reset() { *m = SetUIDataResponse{} }
func (m *SetUIDataResponse) String() string { return proto.CompactTextString(m) }
func (*SetUIDataResponse) ProtoMessage() {}
func (*SetUIDataResponse) Descriptor() ([]byte, []int) { return fileDescriptorAdmin, []int{13} }
// GETUIDataRequest requests the values for the given keys from the system.ui
// table.
type GetUIDataRequest struct {
Keys []string `protobuf:"bytes,1,rep,name=keys" json:"keys,omitempty"`
}
func (m *GetUIDataRequest) Reset() { *m = GetUIDataRequest{} }
func (m *GetUIDataRequest) String() string { return proto.CompactTextString(m) }
func (*GetUIDataRequest) ProtoMessage() {}
func (*GetUIDataRequest) Descriptor() ([]byte, []int) { return fileDescriptorAdmin, []int{14} }
// GetUIDataResponse contains the requested values and the times at which
// the values were last updated.
type GetUIDataResponse struct {
// key_values maps keys to their retrieved values. If this doesn't contain a
// a requested key, that key was not found.
KeyValues map[string]GetUIDataResponse_Value `protobuf:"bytes,1,rep,name=key_values,json=keyValues" json:"key_values" protobuf_key:"bytes,1,opt,name=key,proto3" protobuf_val:"bytes,2,opt,name=value"`
}
func (m *GetUIDataResponse) Reset() { *m = GetUIDataResponse{} }
func (m *GetUIDataResponse) String() string { return proto.CompactTextString(m) }
func (*GetUIDataResponse) ProtoMessage() {}
func (*GetUIDataResponse) Descriptor() ([]byte, []int) { return fileDescriptorAdmin, []int{15} }
type GetUIDataResponse_Value struct {
// value is the value of the requested key.
Value []byte `protobuf:"bytes,1,opt,name=value,proto3" json:"value,omitempty"`
// last_updated is the time at which the value was last updated.
LastUpdated time.Time `protobuf:"bytes,2,opt,name=last_updated,json=lastUpdated,stdtime" json:"last_updated"`
}
func (m *GetUIDataResponse_Value) Reset() { *m = GetUIDataResponse_Value{} }
func (m *GetUIDataResponse_Value) String() string { return proto.CompactTextString(m) }
func (*GetUIDataResponse_Value) ProtoMessage() {}
func (*GetUIDataResponse_Value) Descriptor() ([]byte, []int) { return fileDescriptorAdmin, []int{15, 0} }
// ClusterRequest requests metadata for the cluster.
type ClusterRequest struct {
}
func (m *ClusterRequest) Reset() { *m = ClusterRequest{} }
func (m *ClusterRequest) String() string { return proto.CompactTextString(m) }
func (*ClusterRequest) ProtoMessage() {}
func (*ClusterRequest) Descriptor() ([]byte, []int) { return fileDescriptorAdmin, []int{16} }
// ClusterResponse contains metadata for the cluster.
type ClusterResponse struct {
ClusterID string `protobuf:"bytes,1,opt,name=cluster_id,json=clusterId,proto3" json:"cluster_id,omitempty"`
}
func (m *ClusterResponse) Reset() { *m = ClusterResponse{} }
func (m *ClusterResponse) String() string { return proto.CompactTextString(m) }
func (*ClusterResponse) ProtoMessage() {}
func (*ClusterResponse) Descriptor() ([]byte, []int) { return fileDescriptorAdmin, []int{17} }
// DrainRequest requests the server to enter the specified draining mode. The
// server first deactivates all the modes specified in 'off' and then activates
// all those in 'on'.
type DrainRequest struct {
// These are actually of type DrainMode, but grpc-gateway does not support
// proxying enum fields (yet:
// https://github.com/grpc-ecosystem/grpc-gateway/issues/5) and it fails in
// pretty dramatic ways (panics the server).
On []int32 `protobuf:"varint,1,rep,packed,name=on" json:"on,omitempty"`
Off []int32 `protobuf:"varint,2,rep,packed,name=off" json:"off,omitempty"`
// When true, terminates the process after the given drain modes have been
// activated.
Shutdown bool `protobuf:"varint,3,opt,name=shutdown,proto3" json:"shutdown,omitempty"`
}
func (m *DrainRequest) Reset() { *m = DrainRequest{} }
func (m *DrainRequest) String() string { return proto.CompactTextString(m) }
func (*DrainRequest) ProtoMessage() {}
func (*DrainRequest) Descriptor() ([]byte, []int) { return fileDescriptorAdmin, []int{18} }
// DrainResponse is the response to a successful DrainRequest and lists the
// modes which are activated after having processing the request.
type DrainResponse struct {
On []int32 `protobuf:"varint,1,rep,packed,name=on" json:"on,omitempty"`
}
func (m *DrainResponse) Reset() { *m = DrainResponse{} }
func (m *DrainResponse) String() string { return proto.CompactTextString(m) }
func (*DrainResponse) ProtoMessage() {}
func (*DrainResponse) Descriptor() ([]byte, []int) { return fileDescriptorAdmin, []int{19} }
// SettingsRequest inquires what are the current settings in the cluster.
type SettingsRequest struct {
// The array of setting names to retrieve.
// An empty keys array means "all".
Keys []string `protobuf:"bytes,1,rep,name=keys" json:"keys,omitempty"`
}
func (m *SettingsRequest) Reset() { *m = SettingsRequest{} }
func (m *SettingsRequest) String() string { return proto.CompactTextString(m) }
func (*SettingsRequest) ProtoMessage() {}
func (*SettingsRequest) Descriptor() ([]byte, []int) { return fileDescriptorAdmin, []int{20} }
// SettingsResponse is the response to SettingsRequest.
type SettingsResponse struct {
KeyValues map[string]SettingsResponse_Value `protobuf:"bytes,1,rep,name=key_values,json=keyValues" json:"key_values" protobuf_key:"bytes,1,opt,name=key,proto3" protobuf_val:"bytes,2,opt,name=value"`
}
func (m *SettingsResponse) Reset() { *m = SettingsResponse{} }
func (m *SettingsResponse) String() string { return proto.CompactTextString(m) }
func (*SettingsResponse) ProtoMessage() {}
func (*SettingsResponse) Descriptor() ([]byte, []int) { return fileDescriptorAdmin, []int{21} }
type SettingsResponse_Value struct {
Value string `protobuf:"bytes,1,opt,name=value,proto3" json:"value,omitempty"`
Type string `protobuf:"bytes,2,opt,name=type,proto3" json:"type,omitempty"`
Description string `protobuf:"bytes,3,opt,name=description,proto3" json:"description,omitempty"`
}
func (m *SettingsResponse_Value) Reset() { *m = SettingsResponse_Value{} }
func (m *SettingsResponse_Value) String() string { return proto.CompactTextString(m) }
func (*SettingsResponse_Value) ProtoMessage() {}
func (*SettingsResponse_Value) Descriptor() ([]byte, []int) { return fileDescriptorAdmin, []int{21, 0} }
// HealthRequest inquires whether the addressed node is healthy.
type HealthRequest struct {
}
func (m *HealthRequest) Reset() { *m = HealthRequest{} }
func (m *HealthRequest) String() string { return proto.CompactTextString(m) }
func (*HealthRequest) ProtoMessage() {}
func (*HealthRequest) Descriptor() ([]byte, []int) { return fileDescriptorAdmin, []int{22} }
// HealthResponse is the response to HealthRequest. It currently does not
// contain any information. The request fails however if the node is not live.
// TODO(tschottdorf): Should it contain information, and if so, what?
type HealthResponse struct {
}
func (m *HealthResponse) Reset() { *m = HealthResponse{} }
func (m *HealthResponse) String() string { return proto.CompactTextString(m) }
func (*HealthResponse) ProtoMessage() {}
func (*HealthResponse) Descriptor() ([]byte, []int) { return fileDescriptorAdmin, []int{23} }
// LivenessRequest requests liveness data for all nodes on the cluster.
type LivenessRequest struct {
}
func (m *LivenessRequest) Reset() { *m = LivenessRequest{} }
func (m *LivenessRequest) String() string { return proto.CompactTextString(m) }
func (*LivenessRequest) ProtoMessage() {}
func (*LivenessRequest) Descriptor() ([]byte, []int) { return fileDescriptorAdmin, []int{24} }
// LivenessResponse contains the liveness status of each node on the cluster.
type LivenessResponse struct {
Livenesses []cockroach_storage.Liveness `protobuf:"bytes,1,rep,name=livenesses" json:"livenesses"`
}
func (m *LivenessResponse) Reset() { *m = LivenessResponse{} }
func (m *LivenessResponse) String() string { return proto.CompactTextString(m) }
func (*LivenessResponse) ProtoMessage() {}
func (*LivenessResponse) Descriptor() ([]byte, []int) { return fileDescriptorAdmin, []int{25} }
func init() {
proto.RegisterType((*DatabasesRequest)(nil), "cockroach.server.serverpb.DatabasesRequest")
proto.RegisterType((*DatabasesResponse)(nil), "cockroach.server.serverpb.DatabasesResponse")
proto.RegisterType((*DatabaseDetailsRequest)(nil), "cockroach.server.serverpb.DatabaseDetailsRequest")
proto.RegisterType((*DatabaseDetailsResponse)(nil), "cockroach.server.serverpb.DatabaseDetailsResponse")
proto.RegisterType((*DatabaseDetailsResponse_Grant)(nil), "cockroach.server.serverpb.DatabaseDetailsResponse.Grant")
proto.RegisterType((*TableDetailsRequest)(nil), "cockroach.server.serverpb.TableDetailsRequest")
proto.RegisterType((*TableDetailsResponse)(nil), "cockroach.server.serverpb.TableDetailsResponse")
proto.RegisterType((*TableDetailsResponse_Grant)(nil), "cockroach.server.serverpb.TableDetailsResponse.Grant")
proto.RegisterType((*TableDetailsResponse_Column)(nil), "cockroach.server.serverpb.TableDetailsResponse.Column")
proto.RegisterType((*TableDetailsResponse_Index)(nil), "cockroach.server.serverpb.TableDetailsResponse.Index")
proto.RegisterType((*TableStatsRequest)(nil), "cockroach.server.serverpb.TableStatsRequest")
proto.RegisterType((*TableStatsResponse)(nil), "cockroach.server.serverpb.TableStatsResponse")
proto.RegisterType((*TableStatsResponse_MissingNode)(nil), "cockroach.server.serverpb.TableStatsResponse.MissingNode")
proto.RegisterType((*UsersRequest)(nil), "cockroach.server.serverpb.UsersRequest")
proto.RegisterType((*UsersResponse)(nil), "cockroach.server.serverpb.UsersResponse")
proto.RegisterType((*UsersResponse_User)(nil), "cockroach.server.serverpb.UsersResponse.User")
proto.RegisterType((*EventsRequest)(nil), "cockroach.server.serverpb.EventsRequest")
proto.RegisterType((*EventsResponse)(nil), "cockroach.server.serverpb.EventsResponse")
proto.RegisterType((*EventsResponse_Event)(nil), "cockroach.server.serverpb.EventsResponse.Event")
proto.RegisterType((*SetUIDataRequest)(nil), "cockroach.server.serverpb.SetUIDataRequest")
proto.RegisterType((*SetUIDataResponse)(nil), "cockroach.server.serverpb.SetUIDataResponse")
proto.RegisterType((*GetUIDataRequest)(nil), "cockroach.server.serverpb.GetUIDataRequest")
proto.RegisterType((*GetUIDataResponse)(nil), "cockroach.server.serverpb.GetUIDataResponse")
proto.RegisterType((*GetUIDataResponse_Value)(nil), "cockroach.server.serverpb.GetUIDataResponse.Value")
proto.RegisterType((*ClusterRequest)(nil), "cockroach.server.serverpb.ClusterRequest")
proto.RegisterType((*ClusterResponse)(nil), "cockroach.server.serverpb.ClusterResponse")
proto.RegisterType((*DrainRequest)(nil), "cockroach.server.serverpb.DrainRequest")
proto.RegisterType((*DrainResponse)(nil), "cockroach.server.serverpb.DrainResponse")
proto.RegisterType((*SettingsRequest)(nil), "cockroach.server.serverpb.SettingsRequest")
proto.RegisterType((*SettingsResponse)(nil), "cockroach.server.serverpb.SettingsResponse")
proto.RegisterType((*SettingsResponse_Value)(nil), "cockroach.server.serverpb.SettingsResponse.Value")
proto.RegisterType((*HealthRequest)(nil), "cockroach.server.serverpb.HealthRequest")
proto.RegisterType((*HealthResponse)(nil), "cockroach.server.serverpb.HealthResponse")
proto.RegisterType((*LivenessRequest)(nil), "cockroach.server.serverpb.LivenessRequest")
proto.RegisterType((*LivenessResponse)(nil), "cockroach.server.serverpb.LivenessResponse")
proto.RegisterEnum("cockroach.server.serverpb.ZoneConfigurationLevel", ZoneConfigurationLevel_name, ZoneConfigurationLevel_value)
proto.RegisterEnum("cockroach.server.serverpb.DrainMode", DrainMode_name, DrainMode_value)
}
// Reference imports to suppress errors if they are not otherwise used.
var _ context.Context
var _ grpc.ClientConn
// This is a compile-time assertion to ensure that this generated file
// is compatible with the grpc package it is being compiled against.
const _ = grpc.SupportPackageIsVersion4
// Client API for Admin service
type AdminClient interface {
// URL: /_admin/v1/users
Users(ctx context.Context, in *UsersRequest, opts ...grpc.CallOption) (*UsersResponse, error)
// URL: /_admin/v1/databases
Databases(ctx context.Context, in *DatabasesRequest, opts ...grpc.CallOption) (*DatabasesResponse, error)
// Example URL: /_admin/v1/databases/system
DatabaseDetails(ctx context.Context, in *DatabaseDetailsRequest, opts ...grpc.CallOption) (*DatabaseDetailsResponse, error)
// Example URL: /_admin/v1/databases/system/tables/ui
TableDetails(ctx context.Context, in *TableDetailsRequest, opts ...grpc.CallOption) (*TableDetailsResponse, error)
// Example URL: /_admin/v1/databases/system/tables/ui/stats
TableStats(ctx context.Context, in *TableStatsRequest, opts ...grpc.CallOption) (*TableStatsResponse, error)
// Example URLs:
// - /_admin/v1/events?type=create_table
// - /_admin/v1/events?type=drop_table&target_id=4
// - /_admin/v1/events
Events(ctx context.Context, in *EventsRequest, opts ...grpc.CallOption) (*EventsResponse, error)
// This requires a POST. Because of the libraries we're using, the POST body
// must be in the following format:
//
// {"key_values":
// { "key1": "base64_encoded_value1"},
// ...
// { "keyN": "base64_encoded_valueN"},
// }
//
// Note that all keys are quoted strings and that all values are base64-
// encoded.
//
// Together, SetUIData and GetUIData provide access to a "cookie jar" for the
// admin UI. The structure of the underlying data is meant to be opaque to the
// server.
SetUIData(ctx context.Context, in *SetUIDataRequest, opts ...grpc.CallOption) (*SetUIDataResponse, error)
// Example URLs:
// - /_admin/v1/uidata?keys=MYKEY
// - /_admin/v1/uidata?keys=MYKEY1&keys=MYKEY2
//
// Yes, it's a little odd that the query parameter is named "keys" instead of
// "key". I would've preferred that the URL parameter be named "key". However,
// it's clearer for the protobuf field to be named "keys," which makes the URL
// parameter "keys" as well.
GetUIData(ctx context.Context, in *GetUIDataRequest, opts ...grpc.CallOption) (*GetUIDataResponse, error)
// Cluster returns metadata for the cluster.
Cluster(ctx context.Context, in *ClusterRequest, opts ...grpc.CallOption) (*ClusterResponse, error)
// Settings returns the cluster-wide settings for the cluster.
Settings(ctx context.Context, in *SettingsRequest, opts ...grpc.CallOption) (*SettingsResponse, error)
// Health returns liveness for the node target of the request.
Health(ctx context.Context, in *HealthRequest, opts ...grpc.CallOption) (*HealthResponse, error)
// Liveness returns the liveness state of all nodes on the cluster.
Liveness(ctx context.Context, in *LivenessRequest, opts ...grpc.CallOption) (*LivenessResponse, error)
// Drain puts the node into the specified drain mode(s) and optionally
// instructs the process to terminate.
Drain(ctx context.Context, in *DrainRequest, opts ...grpc.CallOption) (Admin_DrainClient, error)
}
type adminClient struct {
cc *grpc.ClientConn
}
func NewAdminClient(cc *grpc.ClientConn) AdminClient {
return &adminClient{cc}
}
func (c *adminClient) Users(ctx context.Context, in *UsersRequest, opts ...grpc.CallOption) (*UsersResponse, error) {
out := new(UsersResponse)
err := grpc.Invoke(ctx, "/cockroach.server.serverpb.Admin/Users", in, out, c.cc, opts...)
if err != nil {
return nil, err
}
return out, nil
}
func (c *adminClient) Databases(ctx context.Context, in *DatabasesRequest, opts ...grpc.CallOption) (*DatabasesResponse, error) {
out := new(DatabasesResponse)
err := grpc.Invoke(ctx, "/cockroach.server.serverpb.Admin/Databases", in, out, c.cc, opts...)
if err != nil {
return nil, err
}
return out, nil
}
func (c *adminClient) DatabaseDetails(ctx context.Context, in *DatabaseDetailsRequest, opts ...grpc.CallOption) (*DatabaseDetailsResponse, error) {
out := new(DatabaseDetailsResponse)
err := grpc.Invoke(ctx, "/cockroach.server.serverpb.Admin/DatabaseDetails", in, out, c.cc, opts...)
if err != nil {
return nil, err
}
return out, nil
}
func (c *adminClient) TableDetails(ctx context.Context, in *TableDetailsRequest, opts ...grpc.CallOption) (*TableDetailsResponse, error) {
out := new(TableDetailsResponse)
err := grpc.Invoke(ctx, "/cockroach.server.serverpb.Admin/TableDetails", in, out, c.cc, opts...)
if err != nil {
return nil, err
}
return out, nil
}
func (c *adminClient) TableStats(ctx context.Context, in *TableStatsRequest, opts ...grpc.CallOption) (*TableStatsResponse, error) {
out := new(TableStatsResponse)
err := grpc.Invoke(ctx, "/cockroach.server.serverpb.Admin/TableStats", in, out, c.cc, opts...)
if err != nil {
return nil, err
}
return out, nil
}
func (c *adminClient) Events(ctx context.Context, in *EventsRequest, opts ...grpc.CallOption) (*EventsResponse, error) {
out := new(EventsResponse)
err := grpc.Invoke(ctx, "/cockroach.server.serverpb.Admin/Events", in, out, c.cc, opts...)
if err != nil {
return nil, err
}
return out, nil
}
func (c *adminClient) SetUIData(ctx context.Context, in *SetUIDataRequest, opts ...grpc.CallOption) (*SetUIDataResponse, error) {
out := new(SetUIDataResponse)
err := grpc.Invoke(ctx, "/cockroach.server.serverpb.Admin/SetUIData", in, out, c.cc, opts...)
if err != nil {
return nil, err
}
return out, nil
}
func (c *adminClient) GetUIData(ctx context.Context, in *GetUIDataRequest, opts ...grpc.CallOption) (*GetUIDataResponse, error) {
out := new(GetUIDataResponse)
err := grpc.Invoke(ctx, "/cockroach.server.serverpb.Admin/GetUIData", in, out, c.cc, opts...)
if err != nil {
return nil, err
}
return out, nil
}
func (c *adminClient) Cluster(ctx context.Context, in *ClusterRequest, opts ...grpc.CallOption) (*ClusterResponse, error) {
out := new(ClusterResponse)
err := grpc.Invoke(ctx, "/cockroach.server.serverpb.Admin/Cluster", in, out, c.cc, opts...)
if err != nil {
return nil, err
}
return out, nil
}
func (c *adminClient) Settings(ctx context.Context, in *SettingsRequest, opts ...grpc.CallOption) (*SettingsResponse, error) {
out := new(SettingsResponse)
err := grpc.Invoke(ctx, "/cockroach.server.serverpb.Admin/Settings", in, out, c.cc, opts...)
if err != nil {
return nil, err
}
return out, nil
}
func (c *adminClient) Health(ctx context.Context, in *HealthRequest, opts ...grpc.CallOption) (*HealthResponse, error) {
out := new(HealthResponse)
err := grpc.Invoke(ctx, "/cockroach.server.serverpb.Admin/Health", in, out, c.cc, opts...)
if err != nil {
return nil, err
}
return out, nil
}
func (c *adminClient) Liveness(ctx context.Context, in *LivenessRequest, opts ...grpc.CallOption) (*LivenessResponse, error) {
out := new(LivenessResponse)
err := grpc.Invoke(ctx, "/cockroach.server.serverpb.Admin/Liveness", in, out, c.cc, opts...)
if err != nil {
return nil, err
}
return out, nil
}
func (c *adminClient) Drain(ctx context.Context, in *DrainRequest, opts ...grpc.CallOption) (Admin_DrainClient, error) {
stream, err := grpc.NewClientStream(ctx, &_Admin_serviceDesc.Streams[0], c.cc, "/cockroach.server.serverpb.Admin/Drain", opts...)
if err != nil {
return nil, err
}
x := &adminDrainClient{stream}
if err := x.ClientStream.SendMsg(in); err != nil {
return nil, err
}
if err := x.ClientStream.CloseSend(); err != nil {
return nil, err
}
return x, nil
}
type Admin_DrainClient interface {
Recv() (*DrainResponse, error)
grpc.ClientStream
}
type adminDrainClient struct {
grpc.ClientStream
}
func (x *adminDrainClient) Recv() (*DrainResponse, error) {
m := new(DrainResponse)
if err := x.ClientStream.RecvMsg(m); err != nil {
return nil, err
}
return m, nil
}
// Server API for Admin service
type AdminServer interface {
// URL: /_admin/v1/users
Users(context.Context, *UsersRequest) (*UsersResponse, error)
// URL: /_admin/v1/databases
Databases(context.Context, *DatabasesRequest) (*DatabasesResponse, error)
// Example URL: /_admin/v1/databases/system
DatabaseDetails(context.Context, *DatabaseDetailsRequest) (*DatabaseDetailsResponse, error)
// Example URL: /_admin/v1/databases/system/tables/ui
TableDetails(context.Context, *TableDetailsRequest) (*TableDetailsResponse, error)
// Example URL: /_admin/v1/databases/system/tables/ui/stats
TableStats(context.Context, *TableStatsRequest) (*TableStatsResponse, error)
// Example URLs:
// - /_admin/v1/events?type=create_table
// - /_admin/v1/events?type=drop_table&target_id=4
// - /_admin/v1/events
Events(context.Context, *EventsRequest) (*EventsResponse, error)
// This requires a POST. Because of the libraries we're using, the POST body
// must be in the following format:
//
// {"key_values":
// { "key1": "base64_encoded_value1"},
// ...
// { "keyN": "base64_encoded_valueN"},
// }
//
// Note that all keys are quoted strings and that all values are base64-
// encoded.
//
// Together, SetUIData and GetUIData provide access to a "cookie jar" for the
// admin UI. The structure of the underlying data is meant to be opaque to the
// server.
SetUIData(context.Context, *SetUIDataRequest) (*SetUIDataResponse, error)
// Example URLs:
// - /_admin/v1/uidata?keys=MYKEY
// - /_admin/v1/uidata?keys=MYKEY1&keys=MYKEY2
//
// Yes, it's a little odd that the query parameter is named "keys" instead of
// "key". I would've preferred that the URL parameter be named "key". However,
// it's clearer for the protobuf field to be named "keys," which makes the URL
// parameter "keys" as well.
GetUIData(context.Context, *GetUIDataRequest) (*GetUIDataResponse, error)
// Cluster returns metadata for the cluster.
Cluster(context.Context, *ClusterRequest) (*ClusterResponse, error)
// Settings returns the cluster-wide settings for the cluster.
Settings(context.Context, *SettingsRequest) (*SettingsResponse, error)
// Health returns liveness for the node target of the request.
Health(context.Context, *HealthRequest) (*HealthResponse, error)
// Liveness returns the liveness state of all nodes on the cluster.
Liveness(context.Context, *LivenessRequest) (*LivenessResponse, error)
// Drain puts the node into the specified drain mode(s) and optionally
// instructs the process to terminate.
Drain(*DrainRequest, Admin_DrainServer) error
}
func RegisterAdminServer(s *grpc.Server, srv AdminServer) {
s.RegisterService(&_Admin_serviceDesc, srv)
}
func _Admin_Users_Handler(srv interface{}, ctx context.Context, dec func(interface{}) error, interceptor grpc.UnaryServerInterceptor) (interface{}, error) {
in := new(UsersRequest)
if err := dec(in); err != nil {
return nil, err
}
if interceptor == nil {
return srv.(AdminServer).Users(ctx, in)
}
info := &grpc.UnaryServerInfo{
Server: srv,
FullMethod: "/cockroach.server.serverpb.Admin/Users",
}
handler := func(ctx context.Context, req interface{}) (interface{}, error) {
return srv.(AdminServer).Users(ctx, req.(*UsersRequest))
}
return interceptor(ctx, in, info, handler)
}
func _Admin_Databases_Handler(srv interface{}, ctx context.Context, dec func(interface{}) error, interceptor grpc.UnaryServerInterceptor) (interface{}, error) {
in := new(DatabasesRequest)
if err := dec(in); err != nil {
return nil, err
}
if interceptor == nil {
return srv.(AdminServer).Databases(ctx, in)
}
info := &grpc.UnaryServerInfo{
Server: srv,
FullMethod: "/cockroach.server.serverpb.Admin/Databases",
}
handler := func(ctx context.Context, req interface{}) (interface{}, error) {
return srv.(AdminServer).Databases(ctx, req.(*DatabasesRequest))
}
return interceptor(ctx, in, info, handler)
}
func _Admin_DatabaseDetails_Handler(srv interface{}, ctx context.Context, dec func(interface{}) error, interceptor grpc.UnaryServerInterceptor) (interface{}, error) {
in := new(DatabaseDetailsRequest)
if err := dec(in); err != nil {
return nil, err
}
if interceptor == nil {
return srv.(AdminServer).DatabaseDetails(ctx, in)
}
info := &grpc.UnaryServerInfo{
Server: srv,
FullMethod: "/cockroach.server.serverpb.Admin/DatabaseDetails",
}
handler := func(ctx context.Context, req interface{}) (interface{}, error) {