package openmldb.nameserver

Get desktop application:
View/edit binary Protocol Buffers messages

• rpc CreateTable (CreateTableRequest, GeneralResponse)

  name_server.proto:575

  message CreateTableRequest

  name_server.proto:110

  • required TableInfo table_info = 1

  • optional ZoneInfo zone_info = 2

  • optional api.TaskInfo task_info = 3

  • optional bool create_if_not_exist = 4

• rpc DropTable (DropTableRequest, GeneralResponse)

  name_server.proto:576

  message DropTableRequest

  name_server.proto:117

  • required string name = 1

  • optional ZoneInfo zone_info = 2

  • optional api.TaskInfo task_info = 3

  • optional string db = 4

• rpc TruncateTable (TruncateTableRequest, TruncateTableResponse)

  name_server.proto:577

  message TruncateTableRequest

  name_server.proto:124

  • optional string name = 1

  • optional string db = 2

  message TruncateTableResponse

  name_server.proto:129

  • optional int32 code = 1

  • optional string msg = 2

• rpc ShowTablet (ShowTabletRequest, ShowTabletResponse)

  name_server.proto:578

  message ShowTabletRequest

  name_server.proto:234

  (message has no fields)

  message ShowTabletResponse

  name_server.proto:249

  • repeated TabletStatus tablets = 1

  • optional int32 code = 2

  • optional string msg = 3

• rpc ShowTable (ShowTableRequest, ShowTableResponse)

  name_server.proto:579

  message ShowTableRequest

  name_server.proto:148

  • optional string name = 1

  • optional string db = 2

  • optional bool show_all = 3

  message ShowTableResponse

  name_server.proto:154

  • repeated TableInfo table_info = 1

  • required int32 code = 2

  • optional string msg = 3

• rpc MakeSnapshotNS (MakeSnapshotNSRequest, GeneralResponse)

  name_server.proto:580

  message MakeSnapshotNSRequest

  name_server.proto:160

  • required string name = 1

  • required uint32 pid = 2

  • optional uint64 offset = 3

  • optional string db = 4

• rpc AddReplicaNS (AddReplicaNSRequest, GeneralResponse)

  name_server.proto:581

• rpc DelReplicaNS (DelReplicaNSRequest, GeneralResponse)

  name_server.proto:582

  message DelReplicaNSRequest

  name_server.proto:262

  • required string name = 1

  • required uint32 pid = 2

  • required string endpoint = 3

  • repeated uint32 pid_group = 4

  • optional string db = 5

• rpc ShowOPStatus (ShowOPStatusRequest, ShowOPStatusResponse)

  name_server.proto:583

  message ShowOPStatusRequest

  name_server.proto:354

  • optional string name = 1

  • optional uint32 pid = 2

  • optional string db = 3

  • optional uint64 op_id = 4

  message ShowOPStatusResponse

  name_server.proto:370

  • optional int32 code = 1

  • optional string msg = 2

  • repeated OPStatus op_status = 3

• rpc CancelOP (CancelOPRequest, GeneralResponse)

  name_server.proto:584

  message CancelOPRequest

  name_server.proto:376

  • optional uint64 op_id = 1

• rpc DeleteOP (DeleteOPRequest, GeneralResponse)

  name_server.proto:585

  message DeleteOPRequest

  name_server.proto:361

  • optional string db = 1

  • optional uint64 op_id = 2

  • optional api.TaskStatus status = 3

• rpc ConfSet (ConfSetRequest, GeneralResponse)

  name_server.proto:586

  message ConfSetRequest

  name_server.proto:193

  • required Pair conf = 1

• rpc ConfGet (ConfGetRequest, ConfGetResponse)

  name_server.proto:587

  message ConfGetRequest

  name_server.proto:197

  (message has no fields)

  message ConfGetResponse

  name_server.proto:199

  • required int32 code = 1

  • optional string msg = 2

  • repeated Pair conf = 3

• rpc ChangeLeader (ChangeLeaderRequest, GeneralResponse)

  name_server.proto:588

  message ChangeLeaderRequest

  name_server.proto:205

  • required string name = 1

  • required uint32 pid = 2

  • optional string candidate_leader = 3

  • optional string db = 4

• rpc OfflineEndpoint (OfflineEndpointRequest, GeneralResponse)

  name_server.proto:589

  message OfflineEndpointRequest

  name_server.proto:212

  • required string endpoint = 1

  • optional uint32 concurrency = 2

• rpc Migrate (MigrateRequest, GeneralResponse)

  name_server.proto:590

  message MigrateRequest

  name_server.proto:270

  • required string src_endpoint = 1

  • required string name = 2

  • repeated uint32 pid = 3

  • required string des_endpoint = 4

  • optional string db = 5

• rpc RecoverTable (RecoverTableRequest, GeneralResponse)

  name_server.proto:591

  message RecoverTableRequest

  name_server.proto:255

  • required string name = 1

  • required uint32 pid = 2

  • required string endpoint = 3

  • optional string db = 4

• rpc RecoverEndpoint (RecoverEndpointRequest, GeneralResponse)

  name_server.proto:592

  message RecoverEndpointRequest

  name_server.proto:217

  • required string endpoint = 1

  • optional bool need_restore = 2

  • optional uint32 concurrency = 3

• rpc ConnectZK (ConnectZKRequest, GeneralResponse)

  name_server.proto:593

  message ConnectZKRequest

  name_server.proto:367

  (message has no fields)

• rpc DisConnectZK (DisConnectZKRequest, GeneralResponse)

  name_server.proto:594

  message DisConnectZKRequest

  name_server.proto:368

  (message has no fields)

• rpc SetTablePartition (SetTablePartitionRequest, GeneralResponse)

  name_server.proto:595

  message SetTablePartitionRequest

  name_server.proto:340

  • optional string name = 1

  • optional TablePartition table_partition = 2

  • optional string db = 3

• rpc GetTablePartition (GetTablePartitionRequest, GetTablePartitionResponse)

  name_server.proto:596

  message GetTablePartitionRequest

  name_server.proto:328

  • optional string name = 1

  • optional uint32 pid = 2

  • optional string db = 3

  message GetTablePartitionResponse

  name_server.proto:334

  • optional int32 code = 1

  • optional string msg = 2

  • optional TablePartition table_partition = 3

• rpc UpdateTTL (UpdateTTLRequest, UpdateTTLResponse)

  name_server.proto:597

  message UpdateTTLRequest

  name_server.proto:69

  • optional string name = 1

  • optional string db = 2

  • optional string index_name = 3

  • optional common.TTLSt ttl_desc = 4

  message UpdateTTLResponse

  name_server.proto:76

  • optional int32 code = 1

  • optional string msg = 2

• rpc UpdateTableAliveStatus (UpdateTableAliveRequest, GeneralResponse)

  name_server.proto:598

  message UpdateTableAliveRequest

  name_server.proto:346

  • optional string name = 1

  • optional string endpoint = 2

  • optional uint32 pid = 3

  • optional bool is_alive = 4

  • optional string db = 5

• rpc AddTableField (AddTableFieldRequest, GeneralResponse)

  name_server.proto:599

  message AddTableFieldRequest

  name_server.proto:236

  • optional string name = 1

  • optional common.ColumnDesc column_desc = 2

  • optional string db = 3

• rpc AddReplicaCluster (ClusterAddress, GeneralResponse)

  name_server.proto:600

• rpc ShowReplicaCluster (GeneralRequest, ShowReplicaClusterResponse)

  name_server.proto:601

  message ShowReplicaClusterResponse

  name_server.proto:395

  • repeated ClusterAddAge replicas = 1

  • optional int32 code = 2

  • optional string msg = 3

• rpc RemoveReplicaCluster (RemoveReplicaOfRequest, GeneralResponse)

  name_server.proto:602

  message RemoveReplicaOfRequest

  name_server.proto:401

  • optional string alias = 1

• rpc AddReplicaClusterByNs (ReplicaClusterByNsRequest, AddReplicaClusterByNsResponse)

  name_server.proto:603

  message AddReplicaClusterByNsResponse

  name_server.proto:416

  • repeated TabletStatus tablets = 1

  • repeated TableInfo table_info = 2

  • required int32 code = 3

  • optional string msg = 4

• rpc RemoveReplicaClusterByNs (ReplicaClusterByNsRequest, GeneralResponse)

  name_server.proto:604

• rpc SwitchMode (SwitchModeRequest, GeneralResponse)

  name_server.proto:605

  message SwitchModeRequest

  name_server.proto:423

  • optional ServerMode sm = 1

• rpc GetTaskStatus (api.TaskStatusRequest, api.TaskStatusResponse)

  name_server.proto:606

• rpc DeleteOPTask (api.DeleteTaskRequest, api.GeneralResponse)

  name_server.proto:607

• rpc CreateTableInfo (CreateTableInfoRequest, CreateTableInfoResponse)

  name_server.proto:608

• rpc CreateTableInfoSimply (CreateTableInfoRequest, CreateTableInfoResponse)

  name_server.proto:609

• rpc LoadTable (LoadTableRequest, GeneralResponse)

  name_server.proto:610

  message LoadTableRequest

  name_server.proto:134

  • optional string name = 1

  • optional string endpoint = 2

  • optional uint32 pid = 3

  • optional ZoneInfo zone_info = 4

  • optional api.TaskInfo task_info = 5

  • optional string db = 6

• rpc AddReplicaNSFromRemote (AddReplicaNSRequest, GeneralResponse)

  name_server.proto:611

• rpc SyncTable (SyncTableRequest, GeneralResponse)

  name_server.proto:612

  message SyncTableRequest

  name_server.proto:427

  • optional string name = 1

  • optional string cluster_alias = 2

  • optional uint32 pid = 3

  • optional string db = 4

• rpc AddIndex (AddIndexRequest, GeneralResponse)

  name_server.proto:613

  message AddIndexRequest

  name_server.proto:449

  • optional string name = 1

  • optional common.ColumnKey column_key = 2

  • optional string db = 3

  • repeated common.ColumnDesc cols = 4

  • repeated common.ColumnKey column_keys = 5

  • optional bool skip_load_data = 6

• rpc DeleteIndex (DeleteIndexRequest, GeneralResponse)

  name_server.proto:614

  message DeleteIndexRequest

  name_server.proto:458

  • optional string table_name = 1

  • optional string idx_name = 2

  • optional string db_name = 3

• rpc CreateDatabase (CreateDatabaseRequest, GeneralResponse)

  name_server.proto:615

  message CreateDatabaseRequest

  name_server.proto:464

  • optional string db = 1

  • optional bool if_not_exists = 2

  • optional ZoneInfo zone_info = 3

• rpc UseDatabase (UseDatabaseRequest, GeneralResponse)

  name_server.proto:616

  message UseDatabaseRequest

  name_server.proto:470

  • optional string db = 1

• rpc ShowDatabase (GeneralRequest, ShowDatabaseResponse)

  name_server.proto:617

  message ShowDatabaseResponse

  name_server.proto:474

  • optional int32 code = 1

  • optional string msg = 2

  • repeated string db = 3

• rpc DropDatabase (DropDatabaseRequest, GeneralResponse)

  name_server.proto:618

  message DropDatabaseRequest

  name_server.proto:480

  • optional string db = 1

  • optional ZoneInfo zone_info = 2

• rpc SetSdkEndpoint (SetSdkEndpointRequest, GeneralResponse)

  name_server.proto:619

  message SetSdkEndpointRequest

  name_server.proto:434

  • optional string server_name = 1

  • optional string sdk_endpoint = 2

• rpc ShowSdkEndpoint (ShowSdkEndpointRequest, ShowSdkEndpointResponse)

  name_server.proto:620

  message ShowSdkEndpointRequest

  name_server.proto:485

  (message has no fields)

  message ShowSdkEndpointResponse

  name_server.proto:487

  • repeated TabletStatus tablets = 1

  • optional int32 code = 2

  • optional string msg = 3

• rpc ShowCatalog (ShowCatalogRequest, ShowCatalogResponse)

  name_server.proto:621

  message ShowCatalogRequest

  name_server.proto:493

  (message has no fields)

  message ShowCatalogResponse

  name_server.proto:495

  • repeated common.CatalogInfo catalog = 1

  • optional int32 code = 2

  • optional string msg = 3

• rpc UpdateOfflineTableInfo (TableInfo, GeneralResponse)

  name_server.proto:622

• rpc CreateFunction (CreateFunctionRequest, CreateFunctionResponse)

  name_server.proto:623

  message CreateFunctionRequest

  name_server.proto:501

  • optional common.ExternalFun fun = 1

  message CreateFunctionResponse

  name_server.proto:505

  • optional int32 code = 1

  • optional string msg = 2

• rpc DropFunction (DropFunctionRequest, DropFunctionResponse)

  name_server.proto:624

  message DropFunctionRequest

  name_server.proto:510

  • optional string name = 1

  • optional bool if_exists = 2

  message DropFunctionResponse

  name_server.proto:515

  • optional int32 code = 1

  • optional string msg = 2

• rpc ShowFunction (ShowFunctionRequest, ShowFunctionResponse)

  name_server.proto:625

  message ShowFunctionRequest

  name_server.proto:520

  • optional string name = 1

  message ShowFunctionResponse

  name_server.proto:524

  • optional int32 code = 1

  • optional string msg = 2

  • repeated common.ExternalFun fun = 3

• rpc CreateProcedure (api.CreateProcedureRequest, GeneralResponse)

  name_server.proto:628

  sql procedure interfaces

• rpc DropProcedure (api.DropProcedureRequest, GeneralResponse)

  name_server.proto:629

• rpc ShowProcedure (api.ShowProcedureRequest, api.ShowProcedureResponse)

  name_server.proto:630

• rpc DeploySQL (DeploySQLRequest, DeploySQLResponse)

  name_server.proto:631

  message DeploySQLRequest

  name_server.proto:563

  • optional api.ProcedureInfo sp_info = 3

  • repeated TableIndex index = 4

  message DeploySQLResponse

  name_server.proto:568

  • optional int32 code = 1

  • optional string msg = 2

  • optional uint64 op_id = 3

• rpc PutUser (PutUserRequest, GeneralResponse)

  name_server.proto:634

  user related interfaces

  message PutUserRequest

  name_server.proto:536

  • required string host = 1

  • required string name = 2

  • required string password = 3

• rpc DeleteUser (DeleteUserRequest, GeneralResponse)

  name_server.proto:635

  message DeleteUserRequest

  name_server.proto:542

  • required string host = 1

  • required string name = 2

• rpc PutPrivilege (PutPrivilegeRequest, GeneralResponse)

  name_server.proto:638

  authz related interfaces

  message PutPrivilegeRequest

  name_server.proto:553

  • repeated string grantee = 1

  • repeated string privilege = 2

  • optional string target_type = 3

  • required string database = 4

  • required string target = 5

  • required bool is_all_privileges = 6

  • required PrivilegeLevel privilege_level = 7

• optional string name = 1

• optional uint32 pid = 2

• optional common.ColumnKey column_key = 3

• optional uint32 idx = 4

• optional string db = 5

• optional bool skip_data = 6

• repeated common.ColumnKey column_keys = 7

• required string name = 1

• required uint32 pid = 2

• optional string endpoint = 3

• optional uint32 remote_tid = 4

  for remote

• optional string alias = 5

  for remote

• optional TablePartition table_partition = 6

  for remote

• optional string db = 7

Used as request type in: NameServer.AddReplicaNS, NameServer.AddReplicaNSFromRemote

• required string name = 1

• required uint32 pid = 2

• required string endpoint = 3

• repeated uint32 pid_group = 4

• repeated string endpoint_group = 5

  for remote

• optional ZoneInfo zone_info = 6

  for remote

• optional api.TaskInfo task_info = 7

  for remote

• optional string db = 8

• optional string name = 1

• optional uint32 tid = 2

• optional uint32 pid = 3

• optional uint64 term = 4

• optional uint64 offset = 5

• optional string leader = 6

• repeated string follower = 7

• optional string candidate_leader = 8

• repeated common.EndpointAndTid remote_follower = 9

• optional string db = 10

Used in: ShowReplicaClusterResponse

• optional ClusterAddress replica = 1

• optional uint64 age = 2

• optional string state = 3

Used as request type in: NameServer.AddReplicaCluster

Used as field type in: ClusterAddAge

• optional string zk_endpoints = 1

• optional string zk_path = 2

• optional string alias = 3

• optional string zk_auth_schema = 4

• optional string zk_cert = 5

• kClusterHealthy = 0

• kClusterOffline = 1

• kClusterRemove = 2

• optional string alias = 1

• optional TableInfo table_info = 2

• optional TableInfo remote_table_info = 3

Used as request type in: NameServer.CreateTableInfo, NameServer.CreateTableInfoSimply

• optional TableInfo table_info = 1

• optional ZoneInfo zone_info = 2

Used as response type in: NameServer.CreateTableInfo, NameServer.CreateTableInfoSimply

• optional TableInfo table_info = 1

• required int32 code = 2

• optional string msg = 3

• optional string endpoint = 1

• optional bool is_leader = 2

• optional bool is_alive = 3

Used as request type in: NameServer.ShowDatabase, NameServer.ShowReplicaCluster

(message has no fields)

Used as response type in: NameServer.AddIndex, NameServer.AddReplicaCluster, NameServer.AddReplicaNS, NameServer.AddReplicaNSFromRemote, NameServer.AddTableField, NameServer.CancelOP, NameServer.ChangeLeader, NameServer.ConfSet, NameServer.ConnectZK, NameServer.CreateDatabase, NameServer.CreateProcedure, NameServer.CreateTable, NameServer.DelReplicaNS, NameServer.DeleteIndex, NameServer.DeleteOP, NameServer.DeleteUser, NameServer.DisConnectZK, NameServer.DropDatabase, NameServer.DropProcedure, NameServer.DropTable, NameServer.LoadTable, NameServer.MakeSnapshotNS, NameServer.Migrate, NameServer.OfflineEndpoint, NameServer.PutPrivilege, NameServer.PutUser, NameServer.RecoverEndpoint, NameServer.RecoverTable, NameServer.RemoveReplicaCluster, NameServer.RemoveReplicaClusterByNs, NameServer.SetSdkEndpoint, NameServer.SetTablePartition, NameServer.SwitchMode, NameServer.SyncTable, NameServer.UpdateOfflineTableInfo, NameServer.UpdateTableAliveStatus, NameServer.UseDatabase

• required int32 code = 1

• optional string msg = 2

• optional string src_endpoint = 1

• optional string des_endpoint = 2

Used in: ShowOPStatusResponse

• required uint64 op_id = 1

• required string op_type = 2

• required string status = 3

• required uint64 start_time = 4

• required uint64 end_time = 5

• required string task_type = 6

• optional string name = 7

• optional uint32 pid = 8

• optional int32 for_replica_cluster = 9

• optional string db = 10

Used in: TableInfo

• required string path = 1

• required string format = 2

• optional bool deep_copy = 3

• map<string, string> options = 4

• repeated string symbolic_paths = 5

Used in: ConfGetResponse, ConfSetRequest

• required string key = 1

• required string value = 2

Used in: TablePartition

• required string endpoint = 1

• required bool is_leader = 2

• optional bool is_alive = 3

• optional uint64 offset = 4

• optional uint64 record_cnt = 5

• optional uint64 record_byte_size = 6

• optional bool tablet_has_partition = 7

• optional uint64 diskused = 8

• optional uint32 remote_tid = 9

  4294967295 is UINT32 max value

• optional string alias = 10

Used in: PutPrivilegeRequest

• NO_PRIVILEGE = 0

• PRIVILEGE = 1

• PRIVILEGE_WITH_GRANT_OPTION = 2

• optional string endpoint = 1

• optional uint64 offset_delta = 2

• optional bool is_leader = 3

• optional uint32 concurrency = 4

Used as request type in: NameServer.AddReplicaClusterByNs, NameServer.RemoveReplicaClusterByNs

• optional ZoneInfo zone_info = 1

Used in: SwitchModeRequest, ZoneInfo

• kNORMAL = 0

• kLEADER = 1

• kFOLLOWER = 2

Used in: DeploySQLRequest

• optional string db = 1

• optional string name = 2

• repeated common.ColumnKey column_key = 3

Used as request type in: NameServer.UpdateOfflineTableInfo

Used as field type in: AddReplicaClusterByNsResponse, CreateTableData, CreateTableInfoRequest, CreateTableInfoResponse, CreateTableRequest, ShowTableResponse

• optional string name = 1

• optional uint32 seg_cnt = 2

• repeated TablePartition table_partition = 3

• optional uint32 tid = 4

• optional uint32 partition_num = 5

• optional uint32 replica_num = 6

  contain the leader

• optional type.CompressType compress_type = 7

• optional uint32 key_entry_max_height = 8

• repeated common.ColumnDesc column_desc = 9

• repeated common.ColumnKey column_key = 10

• repeated common.ColumnDesc added_column_desc = 11

• optional uint32 format_version = 12

• optional string db = 13

• repeated string partition_key = 14

• repeated common.VersionPair schema_versions = 15

• optional OfflineTableInfo offline_table_info = 16

• optional common.StorageMode storage_mode = 17

• optional uint32 base_table_tid = 18

Used in: AddReplicaData, GetTablePartitionResponse, SetTablePartitionRequest, TableInfo

• required uint32 pid = 1

• repeated PartitionMeta partition_meta = 2

• repeated TermPair term_offset = 3

• optional uint64 record_cnt = 4

• optional uint64 record_byte_size = 5

• optional uint64 diskused = 6

• repeated PartitionMeta remote_partition_meta = 7

Used in: AddReplicaClusterByNsResponse, ShowSdkEndpointResponse, ShowTabletResponse

• optional string endpoint = 1

• optional string state = 2

• optional uint64 age = 3

• optional string real_endpoint = 4

Used in: TablePartition

• required uint64 term = 1

• required uint64 offset = 2

Used in: AddReplicaNSRequest, CreateDatabaseRequest, CreateTableInfoRequest, CreateTableRequest, DropDatabaseRequest, DropTableRequest, LoadTableRequest, ReplicaClusterByNsRequest

• optional string zone_name = 1

• optional string replica_alias = 2

• optional uint64 zone_term = 3

• optional ServerMode mode = 4