model

type Alias struct {
	Name         string
	CollectionID int64
	CreatedTime  uint64
	State        pb.AliasState
	DbID         int64
}

type Collection struct {
	TenantID             string
	DBID                 int64
	CollectionID         int64
	Partitions           []*Partition
	Name                 string
	DBName               string
	Description          string
	AutoID               bool
	Fields               []*Field
	StructArrayFields    []*StructArrayField
	Functions            []*Function
	VirtualChannelNames  []string
	PhysicalChannelNames []string
	ShardsNum            int32
	StartPositions       []*commonpb.KeyDataPair
	CreateTime           uint64
	ConsistencyLevel     commonpb.ConsistencyLevel
	Aliases              []string // TODO: deprecate this.
	Properties           []*commonpb.KeyValuePair
	State                pb.CollectionState
	EnableDynamicField   bool
	UpdateTimestamp      uint64
	SchemaVersion        int32
}

type CollectionLoadInfo struct {
	CollectionID         int64
	PartitionIDs         []int64
	ReleasedPartitionIDs []int64
	LoadType             querypb.LoadType
	LoadPercentage       int64
	Status               querypb.LoadStatus
	ReplicaNumber        int32
	FieldIndexID         map[int64]int64
}

type Credential struct {
	Username          string
	EncryptedPassword string
	Tenant            string
	IsSuper           bool
	Sha256Password    string
	TimeTick          uint64 // the timetick in wal which the credential updates
}

type Database struct {
	TenantID    string
	ID          int64
	Name        string
	State       pb.DatabaseState
	CreatedTime uint64
	Properties  []*commonpb.KeyValuePair
}

type Field struct {
	FieldID          int64
	Name             string
	IsPrimaryKey     bool
	Description      string
	DataType         schemapb.DataType
	TypeParams       []*commonpb.KeyValuePair
	IndexParams      []*commonpb.KeyValuePair
	AutoID           bool
	State            schemapb.FieldState
	IsDynamic        bool
	IsPartitionKey   bool // partition key mode, multi logic partitions share a physical partition
	IsClusteringKey  bool
	IsFunctionOutput bool
	DefaultValue     *schemapb.ValueField
	ElementType      schemapb.DataType
	Nullable         bool
}

type FileResource struct {
	ID   int64
	Name string
	Path string
}

type Function struct {
	Name        string
	ID          int64
	Description string

	Type schemapb.FunctionType

	InputFieldIDs   []int64
	InputFieldNames []string

	OutputFieldIDs   []int64
	OutputFieldNames []string

	Params []*commonpb.KeyValuePair
}

type Index struct {
	TenantID        string
	CollectionID    int64
	FieldID         int64
	IndexID         int64
	IndexName       string
	IsDeleted       bool
	CreateTime      uint64
	TypeParams      []*commonpb.KeyValuePair
	IndexParams     []*commonpb.KeyValuePair
	IsAutoIndex     bool
	UserIndexParams []*commonpb.KeyValuePair
}

type Option func(c *config)

type Partition struct {
	PartitionID               int64
	PartitionName             string
	PartitionCreatedTimestamp uint64
	CollectionID              int64
	State                     pb.PartitionState
}

type PartitionLoadInfo struct {
	CollectionID   int64
	PartitionID    int64
	LoadType       querypb.LoadType
	LoadPercentage int64
	Status         querypb.LoadStatus
	ReplicaNumber  int32
	FieldIndexID   map[int64]int64
}

type Segment struct {
	SegmentID           int64
	CollectionID        int64
	PartitionID         int64
	NumRows             int64
	BinLogs             []string
	MemSize             int64
	DmChannel           string
	CompactionFrom      []int64
	CreatedByCompaction bool
	SegmentState        commonpb.SegmentState
	// IndexInfos          []*SegmentIndex
	ReplicaIDs []int64
	NodeIDs    []int64
}

type SegmentIndex struct {
	SegmentID      int64
	CollectionID   int64
	PartitionID    int64
	NumRows        int64
	IndexID        int64
	BuildID        int64
	NodeID         int64
	IndexVersion   int64
	IndexState     commonpb.IndexState
	FailReason     string
	IsDeleted      bool
	CreatedUTCTime uint64
	IndexFileKeys  []string
	// The byte size of serialized index data at oos. (compressed)
	IndexSerializedSize uint64
	// The byte size of index data in memory. (uncompressed)
	// The IndexMemSize may not be stored at old milvus implementation, so it may be not accurate.
	// (generated by the IndexSerializedSize multiplied with a configured compress-ratio).
	IndexMemSize uint64
	// deprecated
	WriteHandoff              bool
	CurrentIndexVersion       int32
	IndexStoreVersion         int64
	FinishedUTCTime           uint64
	CurrentScalarIndexVersion int32
	IndexType                 string
}

type StructArrayField struct {
	FieldID     int64
	Name        string
	Description string
	Fields      []*Field
	TypeParams  []*commonpb.KeyValuePair
}