package openmldb.api

required uint64 op_id = 1
required OPType op_type = 2
required uint32 task_index = 3
required string data = 4
optional TaskStatus task_status = 5
optional uint64 start_time = 6
optional uint64 end_time = 7
optional string name = 8
optional uint32 pid = 9
optional uint64 parent_id = 10
optional uint32 vec_idx = 11
the index in task_vec
optional uint64 remote_op_id = 12
for multi cluster
optional int32 for_replica_cluster = 13
for multi cluster, default 0. if 1, for multi cluster
optional string db = 14

Used in: OPInfo, TaskInfo

kMakeSnapshotOP = 1
kAddReplicaOP = 2
kDelReplicaOP = 3
kChangeLeaderOP = 4
kOfflineReplicaOP = 5
kReAddReplicaOP = 6
kReAddReplicaNoSendOP = 7
need not send snapshot
kReAddReplicaWithDropOP = 8
should droptable before loadtable
kReAddReplicaSimplifyOP = 9
table is exist, need run addreplica task only
kUpdateTableAliveOP = 10
deleted
kMigrateOP = 11
kReLoadTableOP = 12
kUpdatePartitionStatusOP = 13
kRecoverTableOP = 14
kCreateTableRemoteOP = 15
kDropTableRemoteOP = 16
kAddReplicaSimplyRemoteOP = 17
kDelReplicaRemoteOP = 18
kAddReplicaRemoteOP = 19
kAddIndexOP = 20
kDeployOP = 21

Used in: TableSnapshotOffsetResponse.Table

optional uint32 pid = 2
optional uint64 offset = 3

Used in: CreateProcedureRequest, ShowProcedureResponse, nameserver.DeploySQLRequest

optional string db_name = 1
optional string sp_name = 2
optional string sql = 3
repeated common.ColumnDesc input_schema = 4
repeated common.ColumnDesc output_schema = 5
optional string main_table = 6
optional string main_db = 7
repeated common.DbTableNamePair tables = 8
dependent tables
optional type.ProcedureType type = 9
repeated google.protobuf.Option options = 10
repeated int32 router_col = 11

Used as request type in: TabletServer.Query, TabletServer.SubQuery

optional string sql = 1
optional string db = 2
optional bool is_batch = 3
optional bool is_debug = 4
optional string sp_name = 5
optional bool is_procedure = 6
optional uint64 task_id = 7
optional uint32 row_size = 8
optional uint32 row_slices = 9
optional uint32 parameter_row_size = 10
optional uint32 parameter_row_slices = 11
repeated type.DataType parameter_types = 12

Used as response type in: TabletServer.Query, TabletServer.SubQuery

optional int32 code = 1
optional string msg = 2
optional uint32 count = 3
optional uint32 byte_size = 4
optional bytes schema = 5
optional uint32 row_slices = 6

Used in: UpdateRealEndpointMapRequest

optional string name = 1
optional string real_endpoint = 2

Used as request type in: TabletServer.AddReplica, TabletServer.DelReplica

optional uint32 tid = 1
optional uint32 pid = 2
optional string endpoint = 3
optional TaskInfo task_info = 4
optional uint32 remote_tid = 5
for remote

* Batch request rows encoding: (1) Multiple rows are stored in attachment consecutively and use `row_sizes` to find each row's start offset in attachment buffer. Multiple slices in row are stored consecutively also, with slice size encoded just in slice data. (2) If non-trival common columns exist - `row_sizes` store N+1 integers, the first is the total size of common row part, the next N is total size of each non-common row part from batch. - `common_slices` represent common row's slices num. - `non_common_slices` represent non-common row's slices num. - the actual ith row is concat of common row part and ith non-common row part. (3) else - `row_sizes` store N integers, each record total size (sum of slice sizes) of one row from batch. - `common_slices` = 0 - `non_common_slices` represent slices num of each row.

Used as request type in: TabletServer.SQLBatchRequestQuery, TabletServer.SubBatchRequestQuery

optional string sql = 1
optional string db = 2
repeated uint32 common_column_indices = 3
optional bool is_debug = 4
optional string sp_name = 5
optional bool is_procedure = 6
repeated uint32 row_sizes = 7
optional uint32 common_slices = 8
optional uint32 non_common_slices = 9
optional uint64 task_id = 10

Used as response type in: TabletServer.SQLBatchRequestQuery, TabletServer.SubBatchRequestQuery

optional int32 code = 1
optional string msg = 2
optional uint32 count = 3
optional bytes schema = 4
repeated uint32 common_column_indices = 5
repeated uint32 row_sizes = 6
optional uint32 common_slices = 7
optional uint32 non_common_slices = 8

Used in: BulkLoadIndex

optional uint32 id = 1
repeated Segment.KeyEntries key_entries = 2

Used in: Segment

optional bytes key = 1
repeated KeyEntries.KeyEntry key_entry = 2
ts_cnt_ == key_entry_size()

Used in: KeyEntries

optional uint32 key_entry_id = 1
repeated KeyEntry.TimeEntry time_entry = 2

Used in: KeyEntry

optional uint64 time = 1
optional uint32 block_id = 2

Used in: SendIndexDataRequest

optional uint32 pid = 1
optional string endpoint = 2

Used as request type in: nameserver.NameServer.ShowProcedure

optional string db_name = 1
optional string sp_name = 2

Used as response type in: nameserver.NameServer.ShowProcedure

required int32 code = 1
optional string msg = 2
repeated ProcedureInfo sp_info = 3

Used in: BinlogInfo, LogEntry, PutRequest

optional uint64 ts = 1
optional uint32 idx = 2

Used in: CreateAggregatorRequest, CreateTableRequest, GetTableSchemaResponse, LoadTableRequest

optional int32 tid = 1
optional string name = 2
optional int32 pid = 3
optional int32 seg_cnt = 4
repeated string replicas = 5
the slave endpoints
optional TableMode mode = 6
optional uint64 term = 7
optional type.CompressType compress_type = 8
optional uint32 key_entry_max_height = 9
repeated common.ColumnDesc column_desc = 10
repeated common.ColumnKey column_key = 11
repeated common.ColumnDesc added_column_desc = 12
optional uint32 format_version = 13
format_version 0 , the legacy format 1 ,the new one
optional string db = 14
repeated common.VersionPair schema_versions = 15
repeated common.TablePartition table_partition = 16
optional common.StorageMode storage_mode = 17
optional uint32 base_table_tid = 18

Used in: ChangeRoleRequest, TableMeta, TableStatus

kTableLeader = 1
kTableFollower = 2

Used in: TableSnapshotOffsetResponse

optional uint32 tid = 1
repeated PartSnapshotOffset parts = 2

Used in: TableStatus

kTableUndefined = 0
kTableNormal = 1
kTableLoading = 2
kMakingSnapshot = 3
kSnapshotPaused = 4

table status message

Used in: GetTableStatusResponse

optional uint32 tid = 1
optional uint32 pid = 2
optional uint64 offset = 3
optional TableMode mode = 4
optional TableState state = 5
optional bool is_expire = 7
optional int64 time_offset = 8
optional uint64 record_cnt = 9
optional uint64 idx_cnt = 10
repeated TsIdxStatus ts_idx_status = 11
optional string name = 12
optional uint64 record_byte_size = 13
optional uint64 record_idx_byte_size = 14
optional uint64 record_pk_cnt = 15
optional type.CompressType compress_type = 17
optional uint32 skiplist_height = 18
optional uint64 diskused = 19
optional common.StorageMode storage_mode = 20
optional string snapshot_path = 21
optional string binlog_path = 22

Used in: DropTableRequest, ExtractIndexDataRequest, GeneralRequest, LoadIndexDataRequest, LoadTableRequest, ReplicaRequest, SendIndexDataRequest, SendSnapshotRequest, TaskStatusResponse, nameserver.AddReplicaNSRequest, nameserver.CreateTableRequest, nameserver.DropTableRequest, nameserver.LoadTableRequest

required uint64 op_id = 1
required OPType op_type = 2
required TaskType task_type = 3
required TaskStatus status = 4
optional string endpoint = 5
optional bool is_rpc_send = 6
repeated uint64 rep_cluster_op_id = 7
for multi cluster
optional uint64 task_id = 8
optional uint32 tid = 9
optional uint32 pid = 10

Used in: OPInfo, TaskInfo, nameserver.DeleteOPRequest

kInited = 1
kDoing = 2
kDone = 3
kFailed = 4
kCanceled = 5

Used as request type in: TabletServer.GetTaskStatus, nameserver.NameServer.GetTaskStatus

(message has no fields)

Used as response type in: TabletServer.GetTaskStatus, nameserver.NameServer.GetTaskStatus

optional int32 code = 1
optional string msg = 2
repeated TaskInfo task = 3

Used in: TaskInfo

kMakeSnapshot = 1
kPauseSnapshot = 2
kRecoverSnapshot = 3
kSendSnapshot = 4
kLoadTable = 5
kAddReplica = 6
kAddTableInfo = 7
kDelReplica = 8
kDelTableInfo = 9
kChangeLeader = 10
kUpdatePartitionStatus = 11
kDropTable = 12
kUpdateTableAlive = 13
kUpdateTableInfo = 14
kSelectLeader = 15
kUpdateLeaderInfo = 16
kRecoverTable = 17
kCheckBinlogSyncProgress = 18
kCreateTableRemote = 19
kDropTableRemote = 20
kAddReplicaNSRemote = 21
kDumpIndexData = 22
kSendIndexData = 23
kLoadIndexData = 24
kExtractIndexData = 25
kAddIndexToTablet = 26
kTableSyncTask = 27
kSendIndexRequest = 28
kExtractIndexRequest = 29
kLoadIndexRequest = 30
kAddIndexToTabletRequest = 31
kAddIndexToTableInfo = 32
kAddMultiTableIndex = 33
kAddTableIndex = 34
kCreateProcedure = 35

Used in: TableStatus

optional string idx_name = 1
repeated uint64 seg_cnts = 2

package openmldb.api

service TabletServer

rpc Put (PutRequest, PutResponse)

message PutRequest

optional string pk = 1

optional int64 time = 2

optional bytes value = 3

optional uint32 tid = 4

optional uint32 pid = 5

repeated Dimension dimensions = 6

repeated TSDimension ts_dimensions = 7

optional uint32 format_version = 8

optional uint32 memory_limit = 9

optional bool put_if_absent = 10

optional bool check_exists = 11

message PutResponse

optional int32 code = 1

optional string msg = 2

rpc Get (GetRequest, GetResponse)

message GetRequest

optional uint32 tid = 1

optional uint32 pid = 2

optional string key = 3

optional uint64 ts = 4

optional string idx_name = 5

optional GetType type = 6

optional uint64 et = 7

optional GetType et_type = 8

repeated uint32 projection = 9

repeated uint32 pid_group = 10

message GetResponse

optional int32 code = 1

optional string msg = 2

optional string key = 3

optional uint64 ts = 4

optional bytes value = 5

rpc Scan (ScanRequest, ScanResponse)

message ScanRequest

optional string pk = 1

optional uint64 st = 2

optional uint64 et = 3

optional uint32 limit = 4

optional uint32 tid = 5

optional uint32 pid = 6

optional bool enable_remove_duplicated_record = 7

optional string idx_name = 8

optional bool enable_remove_ts = 9

repeated uint32 projection = 10

repeated uint32 pid_group = 11

optional bool use_attachment = 12

optional uint32 skip_record_num = 13

message ScanResponse

optional bytes pairs = 1

optional string msg = 2

optional int32 code = 3

optional uint32 count = 4

optional uint32 buf_size = 5

optional bool is_finish = 6

rpc Delete (DeleteRequest, GeneralResponse)

message DeleteRequest

optional uint32 tid = 1

optional uint32 pid = 2

optional string key = 3

optional string idx_name = 4

repeated Dimension dimensions = 5

optional uint64 ts = 6

optional uint64 end_ts = 7

optional string ts_name = 8

optional bool enable_decode_value = 9

rpc Count (CountRequest, CountResponse)

message CountRequest

optional uint32 tid = 1

optional uint32 pid = 2

optional string idx_name = 3

optional string key = 4

optional bool filter_expired_data = 5

optional bool enable_remove_duplicated_record = 6

optional uint64 st = 7

optional GetType st_type = 8

optional uint64 et = 9