milvus/internal/proto/data_service.proto

syntax = "proto3";

package milvus.proto.data;

option go_package = "github.com/zilliztech/milvus-distributed/internal/proto/datapb";

import "common.proto";
import "internal.proto";
import "milvus.proto";


message RegisterNodeRequest {
  common.MsgBase base = 1;
  common.Address address = 2;
}

message RegisterNodeResponse {
  internal.InitParams init_params = 1;
  common.Status status = 2;
}


message SegIDRequest {
  uint32 count = 1;
  string channelName = 2;
  int64  collectionID = 3;
  int64 partitionID = 4;
  string coll_name = 5;// todo remove
  string partition_name = 6; // todo remove
}

message AssignSegIDRequest {
  int64 nodeID = 1;
  string peer_role = 2;
  repeated SegIDRequest segIDRequests = 3;
}


message SegIDAssignment {
  int64 segID = 1;
  string channelName = 2;
  uint32 count = 3;
  int64 collectionID = 4;
  int64 partitionID = 5;
  uint64 expire_time = 6;
  common.Status status = 7;
  string coll_name = 8;// todo remove
  string partition_name = 9;// todo remove
}

message AssignSegIDResponse {
  repeated SegIDAssignment segIDAssignments = 1;
  common.Status status = 2;
}

message FlushRequest {
  common.MsgBase base = 1;
  int64 dbID = 2;
  int64 collectionID = 4;
}

message ShowSegmentRequest {
  common.MsgBase base = 1;
  int64  collectionID = 2;
  int64  partitionID = 3;
  int64  dbID = 4;
}

message ShowSegmentResponse {
  repeated int64 segmentIDs = 1;
  common.Status status = 2;
}

message SegmentStatesRequest {
  common.MsgBase base = 1;
  repeated int64  segmentIDs = 2;
}

message SegmentStateInfo {
  int64 segmentID = 1;
  common.SegmentState state = 2;
  uint64 create_time = 3;
  uint64 sealed_time = 4;
  uint64 flushed_time = 5;
  internal.MsgPosition start_position = 6;
  internal.MsgPosition end_position = 7;
  common.Status status = 8;
}

message SegmentInfoRequest {
  common.MsgBase base = 1;
  repeated int64  segmentIDs = 2;
}

message SegmentInfoResponse {
  common.Status status = 1;
  repeated SegmentInfo infos = 2;
}

message SegmentStatesResponse {
  common.Status status = 1;
  repeated SegmentStateInfo states = 2;
}

message InsertBinlogPathRequest {
  common.MsgBase base = 1;
  int64 segmentID = 2;
}

message InsertBinlogPathsResponse {
  repeated int64 fieldIDs = 1;
  repeated internal.StringList paths = 2;
  common.Status status = 3;
}


message InsertChannelRequest  {
  common.MsgBase base = 1;
  int64  dbID = 2;
  int64  collectionID = 3;
}


message WatchDmChannelRequest {
  common.MsgBase base = 1;
  repeated string channelNames = 2;
}


message FlushSegRequest {
  common.MsgBase base = 1;
  int64  dbID = 2;
  int64 collectionID = 3;
  repeated int64 segmentIDs = 4;
}

message SegmentInfo {
  int64 segmentID = 1;
  int64 collectionID = 2;
  int64 partitionID = 3;
  string insert_channel = 4;
  uint64 open_time = 5;
  uint64 sealed_time = 6;
  uint64 flushed_time = 7;
  int64 num_rows = 8;
  int64 mem_size = 9;
  common.SegmentState state = 10;
  internal.MsgPosition start_position = 11;
  internal.MsgPosition end_position = 12;
}

message SegmentMsg{
  common.MsgBase base = 1;
  SegmentInfo segment = 2;
}

message CollectionStatsRequest{
  common.MsgBase base = 1;
  int64 dbID = 2;
  int64 collectionID = 3;
}

message CollectionStatsResponse {
  repeated common.KeyValuePair stats = 1;
  common.Status status = 2;
}

message PartitionStatsRequest{
  common.MsgBase base = 1;
  int64 dbID = 2;
  int64 collectionID = 3;
  int64 partitionID = 4;
}

message PartitionStatsResponse {
  repeated common.KeyValuePair stats = 1;
  common.Status status = 2;
}

message FieldFlushMeta {
  int64 fieldID = 1;
  repeated string binlog_paths = 2;
}

message SegmentFlushMeta{
  int64 segmentID = 1;
  bool is_flushed = 2;
  repeated FieldFlushMeta fields = 5;
}

message DDLFlushMeta {
  int64 collectionID = 1;
  repeated string binlog_paths = 2;
}

service DataService {

  rpc RegisterNode(RegisterNodeRequest) returns (RegisterNodeResponse) {}
  rpc Flush(FlushRequest) returns (common.Status) {}

  rpc AssignSegmentID(AssignSegIDRequest) returns (AssignSegIDResponse) {}
  rpc ShowSegments(ShowSegmentRequest) returns (ShowSegmentResponse) {}

  rpc GetSegmentInfo(SegmentInfoRequest) returns (SegmentInfoResponse) {}
  rpc GetSegmentStates(SegmentStatesRequest) returns (SegmentStatesResponse) {}
  rpc GetInsertBinlogPaths(InsertBinlogPathRequest) returns (InsertBinlogPathsResponse) {}

  rpc GetInsertChannels(InsertChannelRequest) returns (internal.StringList) {}
  rpc GetCollectionStatistics(CollectionStatsRequest) returns (CollectionStatsResponse) {}
  rpc GetPartitionStatistics(PartitionStatsRequest) returns (PartitionStatsResponse) {}

  rpc GetComponentStates(common.Empty) returns (internal.ComponentStates) {}
  rpc GetTimeTickChannel(common.Empty) returns(milvus.StringResponse) {}
  rpc GetStatisticsChannel(common.Empty) returns(milvus.StringResponse){}

  rpc GetSegmentInfoChannel(common.Empty) returns (milvus.StringResponse){}
}

service DataNode {
  rpc GetComponentStates(common.Empty) returns (internal.ComponentStates) {}
  rpc WatchDmChannels(WatchDmChannelRequest) returns (common.Status) {}
  rpc FlushSegments(FlushSegRequest) returns(common.Status) {}
}