milvus/internal/proto/common.proto

syntax = "proto3";

package milvus.proto.common;
option go_package="github.com/zilliztech/milvus-distributed/internal/proto/commonpb";

enum ErrorCode {
    SUCCESS = 0;
    UNEXPECTED_ERROR = 1;
    CONNECT_FAILED = 2;
    PERMISSION_DENIED = 3;
    COLLECTION_NOT_EXISTS = 4;
    ILLEGAL_ARGUMENT = 5;
    ILLEGAL_DIMENSION = 7;
    ILLEGAL_INDEX_TYPE = 8;
    ILLEGAL_COLLECTION_NAME = 9;
    ILLEGAL_TOPK = 10;
    ILLEGAL_ROWRECORD = 11;
    ILLEGAL_VECTOR_ID = 12;
    ILLEGAL_SEARCH_RESULT = 13;
    FILE_NOT_FOUND = 14;
    META_FAILED = 15;
    CACHE_FAILED = 16;
    CANNOT_CREATE_FOLDER = 17;
    CANNOT_CREATE_FILE = 18;
    CANNOT_DELETE_FOLDER = 19;
    CANNOT_DELETE_FILE = 20;
    BUILD_INDEX_ERROR = 21;
    ILLEGAL_NLIST = 22;
    ILLEGAL_METRIC_TYPE = 23;
    OUT_OF_MEMORY = 24;
    INDEX_NOT_EXIST = 25;

    // internal error code.
    DD_REQUEST_RACE = 1000;
}

enum IndexState {
    NONE = 0;
    UNISSUED = 1;
    INPROGRESS = 2;
    FINISHED = 3;
    FAILED = 4;
    DELETED = 5;
}

enum SegmentState {
    SegmentNone = 0;
    SegmentNotExist = 1;
    SegmentGrowing = 2;
    SegmentSealed = 3;
    SegmentFlushed = 4;
}

message Empty{}


message Status {
    ErrorCode error_code = 1;
    string reason = 2;
}


message KeyValuePair {
    string key = 1;
    string value = 2;
}


message Blob {
    bytes value = 1;
}


message Address {
  string ip = 1;
  int64 port = 2;
}

enum MsgType {
    kNone = 0;
    /* Definition Requests: collection */
    kCreateCollection = 100;
    kDropCollection = 101;
    kHasCollection = 102;
    kDescribeCollection = 103;
    kShowCollections = 104;
    kGetSysConfigs = 105;
    kLoadCollection = 106;
    kReleaseCollection = 107;

    /* Definition Requests: partition */
    kCreatePartition = 200;
    kDropPartition = 201;
    kHasPartition = 202;
    kDescribePartition = 203;
    kShowPartitions = 204;
    kLoadPartition = 205;
    kReleasePartition = 206;

    /* Define Requests: segment */
    kShowSegment = 250;
    kDescribeSegment = 251;

    /* Definition Requests: Index */
    kCreateIndex = 300;
    kDescribeIndex = 301;
    kDropIndex = 302;

    /* Manipulation Requests */
    kInsert = 400;
    kDelete = 401;
    kFlush = 402;

    /* Query */
    kSearch = 500;
    kSearchResult = 501;
    kGetIndexState = 502;
    kGetCollectionStatistics = 503;
    kGetPartitionStatistics = 504;

    /* Data Service */
    kSegmentInfo = 600;

    /* System Control */
    kTimeTick = 1200;
    kQueryNodeStats = 1201; // GOOSE TODO: Remove kQueryNodeStats
    kLoadIndex = 1202;
    kRequestID = 1203;
    kRequestTSO = 1204;
    kAllocateSegment = 1205;
    kSegmentStatistics = 1206;
    kSegmentFlushDone = 1207;
}

message MsgBase {
    MsgType msg_type = 1;
    int64  msgID = 2;
    uint64 timestamp = 3;
    int64 sourceID = 4;
}


// Don't Modify This. @czs
message MsgHeader {
    common.MsgBase base = 1;
}