common

Documentation

Index

• Constants
• Variables
• func IsCollectionNotExistError(e error) bool
• func IsCollectionNotExistErrorV2(e error) bool
• func IsIgnorableError(err error) bool
• func IsKeyNotExistError(err error) bool
• func IsStatusError(e error) bool
• func IsSystemField(fieldID int64) bool
• func NewCollectionNotExistError(msg string) *statusError
• func NewIgnorableError(err error) error
• func NewKeyNotExistError(key string) error
• func NewStatusError(code commonpb.ErrorCode, reason string) *statusError
• func StatusFromError(e error) *commonpb.Status
• func WrapNodeIDNotMatchError(targetID, nodeID int64) error
• func WrapNodeIDNotMatchMsg(targetID, nodeID int64) string
• type ByteSlice
  • func CloneByteSlice(s ByteSlice) ByteSlice
  • func (s ByteSlice) Clone() ByteSlice
  • func (s ByteSlice) Equal(other ByteSlice) bool
• type IgnorableError
  • func (i *IgnorableError) Error() string
• type Int64Tuple
• type KeyDataPairs
  • func CloneKeyDataPairs(pairs KeyDataPairs) KeyDataPairs
  • func (pairs KeyDataPairs) Clone() KeyDataPairs
  • func (pairs KeyDataPairs) Equal(other KeyDataPairs) bool
  • func (pairs KeyDataPairs) ToMap() map[string][]byte
• type KeyNotExistError
  • func (k *KeyNotExistError) Error() string
• type KeyValuePairs
  • func CloneKeyValuePairs(pairs KeyValuePairs) KeyValuePairs
  • func (pairs KeyValuePairs) Clone() KeyValuePairs
  • func (pairs KeyValuePairs) Equal(other KeyValuePairs) bool
  • func (pairs KeyValuePairs) ToMap() map[string]string
• type Str2Str
  • func CloneStr2Str(m Str2Str) Str2Str
  • func (m Str2Str) Clone() Str2Str
  • func (m Str2Str) Equal(other Str2Str) bool
• type StringList
  • func CloneStringList(l StringList) StringList
  • func (l StringList) Clone() StringList
  • func (l StringList) Equal(other StringList) bool

Constants

const (
	// StartOfUserFieldID represents the starting ID of the user-defined field
	StartOfUserFieldID = 100

	// RowIDField is the ID of the RowID field reserved by the system
	RowIDField = 0

	// TimeStampField is the ID of the Timestamp field reserved by the system
	TimeStampField = 1

	// RowIDFieldName defines the name of the RowID field
	RowIDFieldName = "RowID"

	// TimeStampFieldName defines the name of the Timestamp field
	TimeStampFieldName = "Timestamp"

	// MetaFieldName is the field name of dynamic schema
	MetaFieldName = "$meta"

	// DefaultShardsNum defines the default number of shards when creating a collection
	DefaultShardsNum = int32(1)

	// DefaultPartitionsWithPartitionKey defines the default number of partitions when use partition key
	DefaultPartitionsWithPartitionKey = int64(64)

	// InvalidPartitionID indicates that the partition is not specified. It will be set when the partitionName is empty
	InvalidPartitionID = int64(-1)

	// InvalidFieldID indicates that the field does not exist . It will be set when the field is not found.
	InvalidFieldID = int64(-1)

	// NotRegisteredID means node is not registered into etcd.
	NotRegisteredID = int64(-1)

	// InvalidNodeID indicates that node is not valid in querycoord replica or shard cluster.
	InvalidNodeID = int64(-1)
)

const (
	// SegmentInsertLogPath storage path const for segment insert binlog.
	SegmentInsertLogPath = `insert_log`

	// SegmentDeltaLogPath storage path const for segment delta log.
	SegmentDeltaLogPath = `delta_log`

	// SegmentStatslogPath storage path const for segment stats log.
	SegmentStatslogPath = `stats_log`

	// SegmentIndexPath storage path const for segment index files.
	SegmentIndexPath = `index_files`
)

const (
	TopKKey        = "topk"
	SearchParamKey = "search_param"
	SegmentNumKey  = "segment_num"
	WithFilterKey  = "with_filter"

	IndexParamsKey = "params"
	IndexTypeKey   = "index_type"
	MetricTypeKey  = "metric_type"
	DimKey         = "dim"
	MaxLengthKey   = "max_length"
)

Search, Index parameter keys

const (
	CollectionTTLConfigKey      = "collection.ttl.seconds"
	CollectionAutoCompactionKey = "collection.autocompaction.enabled"
)

const (
	PropertiesKey string = "properties"
	TraceIDKey    string = "uber-trace-id"
)

const (
	// LatestVerision is the magic number for watch latest revision
	LatestRevision = int64(-1)
)

Variables

var Endian = binary.LittleEndian

Endian is type alias of binary.LittleEndian. Milvus uses little endian by default.

var (
	// ErrNodeIDNotMatch stands for the error that grpc target id and node session id not match.
	ErrNodeIDNotMatch = errors.New("target node id not match")
)

var Version semver.Version

Version current version for session

Functions

func IsCollectionNotExistError

func IsCollectionNotExistError(e error) bool

func IsCollectionNotExistErrorV2

func IsCollectionNotExistErrorV2(e error) bool

func IsIgnorableError

func IsIgnorableError(err error) bool

func IsKeyNotExistError

func IsKeyNotExistError(err error) bool

func IsStatusError

func IsStatusError(e error) bool

func IsSystemField

func IsSystemField(fieldID int64) bool

func NewCollectionNotExistError

func NewCollectionNotExistError(msg string) *statusError

func NewIgnorableError

func NewIgnorableError(err error) error

func NewKeyNotExistError

func NewKeyNotExistError(key string) error

func NewStatusError

func NewStatusError(code commonpb.ErrorCode, reason string) *statusError

func StatusFromError

func StatusFromError(e error) *commonpb.Status

func WrapNodeIDNotMatchError

func WrapNodeIDNotMatchError(targetID, nodeID int64) error

WrapNodeIDNotMatchError wraps `ErrNodeIDNotMatch` with targetID and sessionID.

func WrapNodeIDNotMatchMsg

func WrapNodeIDNotMatchMsg(targetID, nodeID int64) string

WrapNodeIDNotMatchMsg fmt error msg with `ErrNodeIDNotMatch`, targetID and sessionID.

Types

type ByteSlice

type ByteSlice []byte

func CloneByteSlice

func CloneByteSlice(s ByteSlice) ByteSlice

func (ByteSlice) Clone

func (s ByteSlice) Clone() ByteSlice

func (ByteSlice) Equal

func (s ByteSlice) Equal(other ByteSlice) bool

type IgnorableError

type IgnorableError struct {
	// contains filtered or unexported fields
}

func (*IgnorableError) Error

func (i *IgnorableError) Error() string

type Int64Tuple

type Int64Tuple struct {
	Key, Value int64
}

type KeyDataPairs

type KeyDataPairs []*commonpb.KeyDataPair

func CloneKeyDataPairs

func CloneKeyDataPairs(pairs KeyDataPairs) KeyDataPairs

func (KeyDataPairs) Clone

func (pairs KeyDataPairs) Clone() KeyDataPairs

func (KeyDataPairs) Equal

func (pairs KeyDataPairs) Equal(other KeyDataPairs) bool

func (KeyDataPairs) ToMap

func (pairs KeyDataPairs) ToMap() map[string][]byte

type KeyNotExistError

type KeyNotExistError struct {
	// contains filtered or unexported fields
}

func (*KeyNotExistError) Error

func (k *KeyNotExistError) Error() string

type KeyValuePairs

type KeyValuePairs []*commonpb.KeyValuePair

func CloneKeyValuePairs

func CloneKeyValuePairs(pairs KeyValuePairs) KeyValuePairs

func (KeyValuePairs) Clone

func (pairs KeyValuePairs) Clone() KeyValuePairs

func (KeyValuePairs) Equal

func (pairs KeyValuePairs) Equal(other KeyValuePairs) bool

func (KeyValuePairs) ToMap

func (pairs KeyValuePairs) ToMap() map[string]string

type Str2Str

type Str2Str map[string]string

func CloneStr2Str

func CloneStr2Str(m Str2Str) Str2Str

func (Str2Str) Clone

func (m Str2Str) Clone() Str2Str

func (Str2Str) Equal

func (m Str2Str) Equal(other Str2Str) bool

type StringList

type StringList []string

func CloneStringList

func CloneStringList(l StringList) StringList

func (StringList) Clone

func (l StringList) Clone() StringList

func (StringList) Equal

func (l StringList) Equal(other StringList) bool