Documentation ¶
Overview ¶
Package entity defines entities used in sdk
Code generated by go generate; DO NOT EDIT This file is generated by go generated
Index ¶
- Constants
- func CollectionAutoCompactionEnabled(enabled bool) autoCompactionCollAttr
- func CollectionPartitionKeyIsolation(enabled bool) partitionKeyIsolationCollAttr
- func CollectionTTL(ttl int64) ttlCollAttr
- func DatabaseReplica(replica int64) databaseReplicaAttr
- func DatabaseResourceGroups(resourceGroups []string) databaseResourceGroupsAttr
- func KvPairsMap(kvps []*common.KeyValuePair) map[string]string
- func MapKvPairs(m map[string]string) []*common.KeyValuePair
- func Mmap(enabled bool) mmapAttr
- func ParseTagSetting(str string, sep string) map[string]string
- type BFloat16Vector
- type BinaryVector
- type BulkInsertState
- type BulkInsertTaskState
- type Collection
- type CollectionAttribute
- type Column
- func AnyToColumns(rows []interface{}, schemas ...*Schema) ([]Column, error)
- func DefaultValueColumn(name string, dataType FieldType) (Column, error)
- func FieldDataColumn(fd *schemapb.FieldData, begin, end int) (Column, error)
- func FieldDataVector(fd *schemapb.FieldData) (Column, error)
- func IDColumns(schema *Schema, idField *schemapb.IDs, begin, end int) (Column, error)
- func NewArrayColumn(f *Field) Column
- func RowsToColumns(rows []Row, schemas ...*Schema) ([]Column, error)
- type ColumnBFloat16Vector
- func (c *ColumnBFloat16Vector) AppendValue(i interface{}) error
- func (c *ColumnBFloat16Vector) Data() [][]byte
- func (c *ColumnBFloat16Vector) Dim() int
- func (c *ColumnBFloat16Vector) FieldData() *schema.FieldData
- func (c *ColumnBFloat16Vector) Get(idx int) (interface{}, error)
- func (c *ColumnBFloat16Vector) Len() int
- func (c *ColumnBFloat16Vector) Name() string
- func (c *ColumnBFloat16Vector) Slice(start, end int) Column
- func (c *ColumnBFloat16Vector) Type() FieldType
- type ColumnBase
- type ColumnBinaryVector
- func (c *ColumnBinaryVector) AppendValue(i interface{}) error
- func (c *ColumnBinaryVector) Data() [][]byte
- func (c *ColumnBinaryVector) Dim() int
- func (c *ColumnBinaryVector) FieldData() *schema.FieldData
- func (c *ColumnBinaryVector) Get(idx int) (interface{}, error)
- func (c *ColumnBinaryVector) Len() int
- func (c *ColumnBinaryVector) Name() string
- func (c *ColumnBinaryVector) Slice(start, end int) Column
- func (c *ColumnBinaryVector) Type() FieldType
- type ColumnBool
- func (c *ColumnBool) AppendValue(i interface{}) error
- func (c *ColumnBool) Data() []bool
- func (c *ColumnBool) FieldData() *schema.FieldData
- func (c *ColumnBool) Get(idx int) (interface{}, error)
- func (c *ColumnBool) GetAsBool(idx int) (bool, error)
- func (c *ColumnBool) Len() int
- func (c *ColumnBool) Name() string
- func (c *ColumnBool) Slice(start, end int) Column
- func (c *ColumnBool) Type() FieldType
- func (c *ColumnBool) ValueByIdx(idx int) (bool, error)
- type ColumnBoolArray
- func (c *ColumnBoolArray) AppendValue(i interface{}) error
- func (c *ColumnBoolArray) Data() [][]bool
- func (c *ColumnBoolArray) FieldData() *schemapb.FieldData
- func (c *ColumnBoolArray) Get(idx int) (interface{}, error)
- func (c *ColumnBoolArray) Len() int
- func (c *ColumnBoolArray) Name() string
- func (c *ColumnBoolArray) Slice(start, end int) Column
- func (c *ColumnBoolArray) Type() FieldType
- func (c *ColumnBoolArray) ValueByIdx(idx int) ([]bool, error)
- type ColumnDouble
- func (c *ColumnDouble) AppendValue(i interface{}) error
- func (c *ColumnDouble) Data() []float64
- func (c *ColumnDouble) FieldData() *schema.FieldData
- func (c *ColumnDouble) Get(idx int) (interface{}, error)
- func (c *ColumnDouble) GetAsDouble(idx int) (float64, error)
- func (c *ColumnDouble) Len() int
- func (c *ColumnDouble) Name() string
- func (c *ColumnDouble) Slice(start, end int) Column
- func (c *ColumnDouble) Type() FieldType
- func (c *ColumnDouble) ValueByIdx(idx int) (float64, error)
- type ColumnDoubleArray
- func (c *ColumnDoubleArray) AppendValue(i interface{}) error
- func (c *ColumnDoubleArray) Data() [][]float64
- func (c *ColumnDoubleArray) FieldData() *schemapb.FieldData
- func (c *ColumnDoubleArray) Get(idx int) (interface{}, error)
- func (c *ColumnDoubleArray) Len() int
- func (c *ColumnDoubleArray) Name() string
- func (c *ColumnDoubleArray) Slice(start, end int) Column
- func (c *ColumnDoubleArray) Type() FieldType
- func (c *ColumnDoubleArray) ValueByIdx(idx int) ([]float64, error)
- type ColumnDynamic
- func (c *ColumnDynamic) Get(idx int) (interface{}, error)
- func (c *ColumnDynamic) GetAsBool(idx int) (bool, error)
- func (c *ColumnDynamic) GetAsDouble(idx int) (float64, error)
- func (c *ColumnDynamic) GetAsInt64(idx int) (int64, error)
- func (c *ColumnDynamic) GetAsString(idx int) (string, error)
- func (c *ColumnDynamic) Name() string
- type ColumnFloat
- func (c *ColumnFloat) AppendValue(i interface{}) error
- func (c *ColumnFloat) Data() []float32
- func (c *ColumnFloat) FieldData() *schema.FieldData
- func (c *ColumnFloat) Get(idx int) (interface{}, error)
- func (c *ColumnFloat) GetAsDouble(idx int) (float64, error)
- func (c *ColumnFloat) Len() int
- func (c *ColumnFloat) Name() string
- func (c *ColumnFloat) Slice(start, end int) Column
- func (c *ColumnFloat) Type() FieldType
- func (c *ColumnFloat) ValueByIdx(idx int) (float32, error)
- type ColumnFloat16Vector
- func (c *ColumnFloat16Vector) AppendValue(i interface{}) error
- func (c *ColumnFloat16Vector) Data() [][]byte
- func (c *ColumnFloat16Vector) Dim() int
- func (c *ColumnFloat16Vector) FieldData() *schema.FieldData
- func (c *ColumnFloat16Vector) Get(idx int) (interface{}, error)
- func (c *ColumnFloat16Vector) Len() int
- func (c *ColumnFloat16Vector) Name() string
- func (c *ColumnFloat16Vector) Slice(start, end int) Column
- func (c *ColumnFloat16Vector) Type() FieldType
- type ColumnFloatArray
- func (c *ColumnFloatArray) AppendValue(i interface{}) error
- func (c *ColumnFloatArray) Data() [][]float32
- func (c *ColumnFloatArray) FieldData() *schemapb.FieldData
- func (c *ColumnFloatArray) Get(idx int) (interface{}, error)
- func (c *ColumnFloatArray) Len() int
- func (c *ColumnFloatArray) Name() string
- func (c *ColumnFloatArray) Slice(start, end int) Column
- func (c *ColumnFloatArray) Type() FieldType
- func (c *ColumnFloatArray) ValueByIdx(idx int) ([]float32, error)
- type ColumnFloatVector
- func (c *ColumnFloatVector) AppendValue(i interface{}) error
- func (c *ColumnFloatVector) Data() [][]float32
- func (c *ColumnFloatVector) Dim() int
- func (c *ColumnFloatVector) FieldData() *schema.FieldData
- func (c *ColumnFloatVector) Get(idx int) (interface{}, error)
- func (c *ColumnFloatVector) Len() int
- func (c *ColumnFloatVector) Name() string
- func (c *ColumnFloatVector) Slice(start, end int) Column
- func (c *ColumnFloatVector) Type() FieldType
- type ColumnInt16
- func (c *ColumnInt16) AppendValue(i interface{}) error
- func (c *ColumnInt16) Data() []int16
- func (c *ColumnInt16) FieldData() *schema.FieldData
- func (c *ColumnInt16) Get(idx int) (interface{}, error)
- func (c *ColumnInt16) GetAsInt64(idx int) (int64, error)
- func (c *ColumnInt16) Len() int
- func (c *ColumnInt16) Name() string
- func (c *ColumnInt16) Slice(start, end int) Column
- func (c *ColumnInt16) Type() FieldType
- func (c *ColumnInt16) ValueByIdx(idx int) (int16, error)
- type ColumnInt16Array
- func (c *ColumnInt16Array) AppendValue(i interface{}) error
- func (c *ColumnInt16Array) Data() [][]int16
- func (c *ColumnInt16Array) FieldData() *schemapb.FieldData
- func (c *ColumnInt16Array) Get(idx int) (interface{}, error)
- func (c *ColumnInt16Array) Len() int
- func (c *ColumnInt16Array) Name() string
- func (c *ColumnInt16Array) Slice(start, end int) Column
- func (c *ColumnInt16Array) Type() FieldType
- func (c *ColumnInt16Array) ValueByIdx(idx int) ([]int16, error)
- type ColumnInt32
- func (c *ColumnInt32) AppendValue(i interface{}) error
- func (c *ColumnInt32) Data() []int32
- func (c *ColumnInt32) FieldData() *schema.FieldData
- func (c *ColumnInt32) Get(idx int) (interface{}, error)
- func (c *ColumnInt32) GetAsInt64(idx int) (int64, error)
- func (c *ColumnInt32) Len() int
- func (c *ColumnInt32) Name() string
- func (c *ColumnInt32) Slice(start, end int) Column
- func (c *ColumnInt32) Type() FieldType
- func (c *ColumnInt32) ValueByIdx(idx int) (int32, error)
- type ColumnInt32Array
- func (c *ColumnInt32Array) AppendValue(i interface{}) error
- func (c *ColumnInt32Array) Data() [][]int32
- func (c *ColumnInt32Array) FieldData() *schemapb.FieldData
- func (c *ColumnInt32Array) Get(idx int) (interface{}, error)
- func (c *ColumnInt32Array) Len() int
- func (c *ColumnInt32Array) Name() string
- func (c *ColumnInt32Array) Slice(start, end int) Column
- func (c *ColumnInt32Array) Type() FieldType
- func (c *ColumnInt32Array) ValueByIdx(idx int) ([]int32, error)
- type ColumnInt64
- func (c *ColumnInt64) AppendValue(i interface{}) error
- func (c *ColumnInt64) Data() []int64
- func (c *ColumnInt64) FieldData() *schema.FieldData
- func (c *ColumnInt64) Get(idx int) (interface{}, error)
- func (c *ColumnInt64) GetAsInt64(idx int) (int64, error)
- func (c *ColumnInt64) Len() int
- func (c *ColumnInt64) Name() string
- func (c *ColumnInt64) Slice(start, end int) Column
- func (c *ColumnInt64) Type() FieldType
- func (c *ColumnInt64) ValueByIdx(idx int) (int64, error)
- type ColumnInt64Array
- func (c *ColumnInt64Array) AppendValue(i interface{}) error
- func (c *ColumnInt64Array) Data() [][]int64
- func (c *ColumnInt64Array) FieldData() *schemapb.FieldData
- func (c *ColumnInt64Array) Get(idx int) (interface{}, error)
- func (c *ColumnInt64Array) Len() int
- func (c *ColumnInt64Array) Name() string
- func (c *ColumnInt64Array) Slice(start, end int) Column
- func (c *ColumnInt64Array) Type() FieldType
- func (c *ColumnInt64Array) ValueByIdx(idx int) ([]int64, error)
- type ColumnInt8
- func (c *ColumnInt8) AppendValue(i interface{}) error
- func (c *ColumnInt8) Data() []int8
- func (c *ColumnInt8) FieldData() *schema.FieldData
- func (c *ColumnInt8) Get(idx int) (interface{}, error)
- func (c *ColumnInt8) GetAsInt64(idx int) (int64, error)
- func (c *ColumnInt8) Len() int
- func (c *ColumnInt8) Name() string
- func (c *ColumnInt8) Slice(start, end int) Column
- func (c *ColumnInt8) Type() FieldType
- func (c *ColumnInt8) ValueByIdx(idx int) (int8, error)
- type ColumnInt8Array
- func (c *ColumnInt8Array) AppendValue(i interface{}) error
- func (c *ColumnInt8Array) Data() [][]int8
- func (c *ColumnInt8Array) FieldData() *schemapb.FieldData
- func (c *ColumnInt8Array) Get(idx int) (interface{}, error)
- func (c *ColumnInt8Array) Len() int
- func (c *ColumnInt8Array) Name() string
- func (c *ColumnInt8Array) Slice(start, end int) Column
- func (c *ColumnInt8Array) Type() FieldType
- func (c *ColumnInt8Array) ValueByIdx(idx int) ([]int8, error)
- type ColumnJSONBytes
- func (c *ColumnJSONBytes) AppendValue(i interface{}) error
- func (c *ColumnJSONBytes) Data() [][]byte
- func (c *ColumnJSONBytes) FieldData() *schema.FieldData
- func (c *ColumnJSONBytes) Get(idx int) (interface{}, error)
- func (c *ColumnJSONBytes) GetAsString(idx int) (string, error)
- func (c *ColumnJSONBytes) IsDynamic() bool
- func (c *ColumnJSONBytes) Len() int
- func (c *ColumnJSONBytes) Name() string
- func (c *ColumnJSONBytes) Slice(start, end int) Column
- func (c *ColumnJSONBytes) Type() FieldType
- func (c *ColumnJSONBytes) ValueByIdx(idx int) ([]byte, error)
- func (c *ColumnJSONBytes) WithIsDynamic(isDynamic bool) *ColumnJSONBytes
- type ColumnSparseFloatVector
- func (c *ColumnSparseFloatVector) AppendValue(i interface{}) error
- func (c *ColumnSparseFloatVector) Data() []SparseEmbedding
- func (c *ColumnSparseFloatVector) FieldData() *schema.FieldData
- func (c *ColumnSparseFloatVector) Get(idx int) (interface{}, error)
- func (c *ColumnSparseFloatVector) Len() int
- func (c *ColumnSparseFloatVector) Name() string
- func (c *ColumnSparseFloatVector) Slice(start, end int) Column
- func (c *ColumnSparseFloatVector) Type() FieldType
- func (c *ColumnSparseFloatVector) ValueByIdx(idx int) (SparseEmbedding, error)
- type ColumnString
- func (c *ColumnString) AppendValue(i interface{}) error
- func (c *ColumnString) Data() []string
- func (c *ColumnString) FieldData() *schema.FieldData
- func (c *ColumnString) Get(idx int) (interface{}, error)
- func (c *ColumnString) GetAsString(idx int) (string, error)
- func (c *ColumnString) Len() int
- func (c *ColumnString) Name() string
- func (c *ColumnString) Slice(start, end int) Column
- func (c *ColumnString) Type() FieldType
- func (c *ColumnString) ValueByIdx(idx int) (string, error)
- type ColumnVarChar
- func (c *ColumnVarChar) AppendValue(i interface{}) error
- func (c *ColumnVarChar) Data() []string
- func (c *ColumnVarChar) FieldData() *schema.FieldData
- func (c *ColumnVarChar) Get(idx int) (interface{}, error)
- func (c *ColumnVarChar) GetAsString(idx int) (string, error)
- func (c *ColumnVarChar) Len() int
- func (c *ColumnVarChar) Name() string
- func (c *ColumnVarChar) Slice(start, end int) Column
- func (c *ColumnVarChar) Type() FieldType
- func (c *ColumnVarChar) ValueByIdx(idx int) (string, error)
- type ColumnVarCharArray
- func (c *ColumnVarCharArray) AppendValue(i interface{}) error
- func (c *ColumnVarCharArray) Data() [][][]byte
- func (c *ColumnVarCharArray) FieldData() *schemapb.FieldData
- func (c *ColumnVarCharArray) Get(idx int) (interface{}, error)
- func (c *ColumnVarCharArray) Len() int
- func (c *ColumnVarCharArray) Name() string
- func (c *ColumnVarCharArray) Slice(start, end int) Column
- func (c *ColumnVarCharArray) Type() FieldType
- func (c *ColumnVarCharArray) ValueByIdx(idx int) ([][]byte, error)
- type CompactionPlan
- type CompactionPlanType
- type CompactionState
- type ConsistencyLevel
- type Database
- type DatabaseAttribute
- type Field
- func (f *Field) ProtoMessage() *schema.FieldSchema
- func (f *Field) ReadProto(p *schema.FieldSchema) *Field
- func (f *Field) WithDataType(dataType FieldType) *Field
- func (f *Field) WithDescription(desc string) *Field
- func (f *Field) WithDim(dim int64) *Field
- func (f *Field) WithElementType(eleType FieldType) *Field
- func (f *Field) WithIsAutoID(isAutoID bool) *Field
- func (f *Field) WithIsClusteringKey(isClusteringKey bool) *Field
- func (f *Field) WithIsDynamic(isDynamic bool) *Field
- func (f *Field) WithIsPartitionKey(isPartitionKey bool) *Field
- func (f *Field) WithIsPrimaryKey(isPrimaryKey bool) *Field
- func (f *Field) WithMaxCapacity(maxCap int64) *Field
- func (f *Field) WithMaxLength(maxLen int64) *Field
- func (f *Field) WithName(name string) *Field
- func (f *Field) WithTypeParams(key string, value string) *Field
- type FieldType
- type Float16Vector
- type FloatVector
- type GenericIndex
- type Index
- type IndexAUTOINDEX
- type IndexAUTOINDEXSearchParam
- type IndexBinFlat
- type IndexBinFlatSearchParam
- type IndexBinIvfFlat
- type IndexBinIvfFlatSearchParam
- type IndexDISKANN
- type IndexDISKANNSearchParam
- type IndexFlat
- type IndexFlatSearchParam
- type IndexGPUBruteForce
- type IndexGPUBruteForceSearchParam
- type IndexGPUCagra
- type IndexGPUCagraSearchParam
- type IndexGPUIvfFlat
- type IndexGPUIvfFlatSearchParam
- type IndexGPUIvfPQ
- type IndexGPUIvfPQSearchParam
- type IndexHNSW
- type IndexHNSWSearchParam
- type IndexIvfFlat
- type IndexIvfFlatSearchParam
- type IndexIvfHNSW
- type IndexIvfHNSWSearchParam
- type IndexIvfPQ
- type IndexIvfPQSearchParam
- type IndexIvfSQ8
- type IndexIvfSQ8SearchParam
- type IndexSCANN
- type IndexSCANNSearchParam
- type IndexSparseInverted
- type IndexSparseInvertedSearchParam
- type IndexSparseWAND
- type IndexSparseWANDSearchParam
- type IndexState
- type IndexType
- type LoadState
- type MapRow
- type MessageInfo
- type MetricType
- type MilvusState
- type NodeInfo
- type OperatePrivilegeOpt
- type OperatePrivilegeOption
- type Partition
- type PriviledgeObjectType
- type QuotaState
- type RBACMeta
- type ReplicaGroup
- type ResourceGroup
- type ResourceGroupConfig
- type ResourceGroupLimit
- type ResourceGroupTransfer
- type Role
- type RoleGrants
- type Row
- type RowBase
- type Schema
- func (s *Schema) PKField() *Field
- func (s *Schema) PKFieldName() string
- func (s *Schema) ProtoMessage() *schema.CollectionSchema
- func (s *Schema) ReadProto(p *schema.CollectionSchema) *Schema
- func (s *Schema) WithAutoID(autoID bool) *Schema
- func (s *Schema) WithDescription(desc string) *Schema
- func (s *Schema) WithDynamicFieldEnabled(dynamicEnabled bool) *Schema
- func (s *Schema) WithField(f *Field) *Schema
- func (s *Schema) WithName(name string) *Schema
- type SearchParam
- type Segment
- type ShardReplica
- type SparseEmbedding
- type User
- type UserDescription
- type UserInfo
- type Vector
Constants ¶
const ( // MilvusTag struct tag const for milvus row based struct MilvusTag = `milvus` // MilvusSkipTagValue struct tag const for skip this field. MilvusSkipTagValue = `-` // MilvusTagSep struct tag const for attribute separator MilvusTagSep = `;` // MilvusTagName struct tag const for field name MilvusTagName = `NAME` // VectorDimTag struct tag const for vector dimension VectorDimTag = `DIM` // VectorTypeTag struct tag const for binary vector type VectorTypeTag = `VECTOR_TYPE` // MilvusPrimaryKey struct tag const for primary key indicator MilvusPrimaryKey = `PRIMARY_KEY` // MilvusAutoID struct tag const for auto id indicator MilvusAutoID = `AUTO_ID` // DimMax dimension max value DimMax = 65535 )
const ( // TypeParamDim is the const for field type param dimension TypeParamDim = "dim" // TypeParamMaxLength is the const for varchar type maximal length TypeParamMaxLength = "max_length" // TypeParamMaxCapacity is the const for array type max capacity TypeParamMaxCapacity = `max_capacity` // ClStrong strong consistency level ClStrong ConsistencyLevel = ConsistencyLevel(common.ConsistencyLevel_Strong) // ClBounded bounded consistency level with default tolerance of 5 seconds ClBounded ConsistencyLevel = ConsistencyLevel(common.ConsistencyLevel_Bounded) // ClSession session consistency level ClSession ConsistencyLevel = ConsistencyLevel(common.ConsistencyLevel_Session) // ClEvenually eventually consistency level ClEventually ConsistencyLevel = ConsistencyLevel(common.ConsistencyLevel_Eventually) // ClCustomized customized consistency level and users pass their own `guarantee_timestamp`. ClCustomized ConsistencyLevel = ConsistencyLevel(common.ConsistencyLevel_Customized) )
const DefaultShardNumber int32 = 0
DefaultShardNumber const value for using Milvus default shard number.
Variables ¶
This section is empty.
Functions ¶
func CollectionAutoCompactionEnabled ¶ added in v2.3.0
func CollectionAutoCompactionEnabled(enabled bool) autoCompactionCollAttr
CollectionAutoCompactionEnabled returns collection attribute to set collection auto compaction enabled.
func CollectionPartitionKeyIsolation ¶ added in v2.4.2
func CollectionPartitionKeyIsolation(enabled bool) partitionKeyIsolationCollAttr
func CollectionTTL ¶ added in v2.2.2
func CollectionTTL(ttl int64) ttlCollAttr
CollectionTTL returns collection attribute to set collection ttl in seconds.
func DatabaseReplica ¶ added in v2.4.1
func DatabaseReplica(replica int64) databaseReplicaAttr
func DatabaseResourceGroups ¶ added in v2.4.1
func DatabaseResourceGroups(resourceGroups []string) databaseResourceGroupsAttr
func KvPairsMap ¶
func KvPairsMap(kvps []*common.KeyValuePair) map[string]string
KvPairsMap converts common.KeyValuePair slices into map
func MapKvPairs ¶
func MapKvPairs(m map[string]string) []*common.KeyValuePair
MapKvPairs converts map into common.KeyValuePair slice
Types ¶
type BFloat16Vector ¶ added in v2.4.0
type BFloat16Vector []byte
FloatVector float32 vector wrapper.
func (BFloat16Vector) Dim ¶ added in v2.4.0
func (fv BFloat16Vector) Dim() int
Dim returns vector dimension.
func (BFloat16Vector) FieldType ¶ added in v2.4.0
func (fv BFloat16Vector) FieldType() FieldType
FieldType returns coresponding field type.
func (BFloat16Vector) Serialize ¶ added in v2.4.0
func (fv BFloat16Vector) Serialize() []byte
type BinaryVector ¶
type BinaryVector []byte
BinaryVector []byte vector wrapper
func (BinaryVector) Dim ¶
func (bv BinaryVector) Dim() int
Dim return vector dimension, note that binary vector is bits count
func (BinaryVector) FieldType ¶ added in v2.1.0
func (bv BinaryVector) FieldType() FieldType
FieldType returns coresponding field type.
func (BinaryVector) Serialize ¶
func (bv BinaryVector) Serialize() []byte
Serialize just return bytes
type BulkInsertState ¶ added in v2.2.0
type BulkInsertState int32
const ( BulkInsertPending BulkInsertState = 0 // the task in in pending list of rootCoord, waiting to be executed BulkInsertFailed BulkInsertState = 1 // the task failed for some reason, get detail reason from GetImportStateResponse.infos BulkInsertStarted BulkInsertState = 2 // the task has been sent to datanode to execute BulkInsertPersisted BulkInsertState = 5 // all data files have been parsed and data already persisted BulkInsertCompleted BulkInsertState = 6 // all indexes are successfully built and segments are able to be compacted as normal. BulkInsertFailedAndCleaned BulkInsertState = 7 // the task failed and all segments it generated are cleaned up. ImportProgress = "progress_percent" )
type BulkInsertTaskState ¶ added in v2.2.0
type BulkInsertTaskState struct { ID int64 // id of an import task State BulkInsertState // is this import task finished or not RowCount int64 // if the task is finished, this value is how many rows are imported. if the task is not finished, this value is how many rows are parsed. return 0 if failed. IDList []int64 // auto generated ids if the primary key is autoid Infos map[string]string // more information about the task, progress percent, file path, failed reason, etc. CollectionID int64 // collection ID of the import task. SegmentIDs []int64 // a list of segment IDs created by the import task. CreateTs int64 //timestamp when the import task is created. }
func (BulkInsertTaskState) Progress ¶ added in v2.2.2
func (state BulkInsertTaskState) Progress() int
type Collection ¶
type Collection struct { ID int64 // collection id Name string // collection name Schema *Schema // collection schema, with fields schema and primary key definition PhysicalChannels []string VirtualChannels []string Loaded bool ConsistencyLevel ConsistencyLevel ShardNum int32 Properties map[string]string }
Collection represent collection meta in Milvus
type CollectionAttribute ¶ added in v2.2.2
CollectionAttribute is the interface for altering collection attributes.
type Column ¶
type Column interface { Name() string Type() FieldType Len() int Slice(int, int) Column FieldData() *schemapb.FieldData AppendValue(interface{}) error Get(int) (interface{}, error) GetAsInt64(int) (int64, error) GetAsString(int) (string, error) GetAsDouble(int) (float64, error) GetAsBool(int) (bool, error) }
Column interface field type for column-based data frame
func AnyToColumns ¶ added in v2.2.3
func DefaultValueColumn ¶ added in v2.3.0
defaultValueColumn will return the empty scalars column which will be fill with default value
func FieldDataColumn ¶
FieldDataColumn converts schemapb.FieldData to Column, used int search result conversion logic begin, end specifies the start and end positions
func FieldDataVector ¶
FieldDataColumn converts schemapb.FieldData to vector Column
func IDColumns ¶
IDColumns converts schemapb.IDs to corresponding column currently Int64 / string may be in IDs
func NewArrayColumn ¶ added in v2.3.3
type ColumnBFloat16Vector ¶ added in v2.4.0
type ColumnBFloat16Vector struct { ColumnBase // contains filtered or unexported fields }
ColumnBFloat16Vector generated columns type for BFloat16Vector
func NewColumnBFloat16Vector ¶ added in v2.4.0
func NewColumnBFloat16Vector(name string, dim int, values [][]byte) *ColumnBFloat16Vector
NewColumnBFloat16Vector auto generated constructor
func (*ColumnBFloat16Vector) AppendValue ¶ added in v2.4.0
func (c *ColumnBFloat16Vector) AppendValue(i interface{}) error
AppendValue append value into column
func (*ColumnBFloat16Vector) Data ¶ added in v2.4.0
func (c *ColumnBFloat16Vector) Data() [][]byte
Data returns column data
func (*ColumnBFloat16Vector) Dim ¶ added in v2.4.0
func (c *ColumnBFloat16Vector) Dim() int
Dim returns vector dimension
func (*ColumnBFloat16Vector) FieldData ¶ added in v2.4.0
func (c *ColumnBFloat16Vector) FieldData() *schema.FieldData
FieldData return column data mapped to schema.FieldData
func (*ColumnBFloat16Vector) Get ¶ added in v2.4.0
func (c *ColumnBFloat16Vector) Get(idx int) (interface{}, error)
Get returns values at index as interface{}.
func (*ColumnBFloat16Vector) Len ¶ added in v2.4.0
func (c *ColumnBFloat16Vector) Len() int
Len returns column data length
func (*ColumnBFloat16Vector) Name ¶ added in v2.4.0
func (c *ColumnBFloat16Vector) Name() string
Name returns column name
func (*ColumnBFloat16Vector) Slice ¶ added in v2.4.1
func (c *ColumnBFloat16Vector) Slice(start, end int) Column
func (*ColumnBFloat16Vector) Type ¶ added in v2.4.0
func (c *ColumnBFloat16Vector) Type() FieldType
Type returns column FieldType
type ColumnBase ¶ added in v2.2.3
type ColumnBase struct{}
ColumnBase adds conversion methods support for fixed-type columns.
func (ColumnBase) GetAsDouble ¶ added in v2.2.3
func (b ColumnBase) GetAsDouble(_ int) (float64, error)
func (ColumnBase) GetAsInt64 ¶ added in v2.2.3
func (b ColumnBase) GetAsInt64(_ int) (int64, error)
func (ColumnBase) GetAsString ¶ added in v2.2.3
func (b ColumnBase) GetAsString(_ int) (string, error)
type ColumnBinaryVector ¶
type ColumnBinaryVector struct { ColumnBase // contains filtered or unexported fields }
ColumnBinaryVector generated columns type for BinaryVector
func NewColumnBinaryVector ¶
func NewColumnBinaryVector(name string, dim int, values [][]byte) *ColumnBinaryVector
NewColumnBinaryVector auto generated constructor
func (*ColumnBinaryVector) AppendValue ¶
func (c *ColumnBinaryVector) AppendValue(i interface{}) error
AppendValue append value into column
func (*ColumnBinaryVector) Data ¶
func (c *ColumnBinaryVector) Data() [][]byte
Data returns column data
func (*ColumnBinaryVector) Dim ¶
func (c *ColumnBinaryVector) Dim() int
Dim returns vector dimension
func (*ColumnBinaryVector) FieldData ¶
func (c *ColumnBinaryVector) FieldData() *schema.FieldData
FieldData return column data mapped to schema.FieldData
func (*ColumnBinaryVector) Get ¶ added in v2.2.3
func (c *ColumnBinaryVector) Get(idx int) (interface{}, error)
Get returns values at index as interface{}.
func (*ColumnBinaryVector) Len ¶
func (c *ColumnBinaryVector) Len() int
Len returns column data length
func (*ColumnBinaryVector) Name ¶
func (c *ColumnBinaryVector) Name() string
Name returns column name
func (*ColumnBinaryVector) Slice ¶ added in v2.4.1
func (c *ColumnBinaryVector) Slice(start, end int) Column
func (*ColumnBinaryVector) Type ¶
func (c *ColumnBinaryVector) Type() FieldType
Type returns column FieldType
type ColumnBool ¶
type ColumnBool struct { ColumnBase // contains filtered or unexported fields }
ColumnBool generated columns type for Bool
func NewColumnBool ¶
func NewColumnBool(name string, values []bool) *ColumnBool
NewColumnBool auto generated constructor
func (*ColumnBool) AppendValue ¶
func (c *ColumnBool) AppendValue(i interface{}) error
AppendValue append value into column
func (*ColumnBool) FieldData ¶
func (c *ColumnBool) FieldData() *schema.FieldData
FieldData return column data mapped to schema.FieldData
func (*ColumnBool) Get ¶ added in v2.2.3
func (c *ColumnBool) Get(idx int) (interface{}, error)
Get returns value at index as interface{}.
func (*ColumnBool) GetAsBool ¶ added in v2.2.3
func (c *ColumnBool) GetAsBool(idx int) (bool, error)
func (*ColumnBool) Slice ¶ added in v2.4.1
func (c *ColumnBool) Slice(start, end int) Column
func (*ColumnBool) ValueByIdx ¶
func (c *ColumnBool) ValueByIdx(idx int) (bool, error)
ValueByIdx returns value of the provided index error occurs when index out of range
type ColumnBoolArray ¶ added in v2.3.2
type ColumnBoolArray struct { ColumnBase // contains filtered or unexported fields }
ColumnBoolArray generated columns type for Bool
func NewColumnBoolArray ¶ added in v2.3.2
func NewColumnBoolArray(name string, values [][]bool) *ColumnBoolArray
NewColumnBool auto generated constructor
func (*ColumnBoolArray) AppendValue ¶ added in v2.3.2
func (c *ColumnBoolArray) AppendValue(i interface{}) error
AppendValue append value into column
func (*ColumnBoolArray) Data ¶ added in v2.3.2
func (c *ColumnBoolArray) Data() [][]bool
Data returns column data
func (*ColumnBoolArray) FieldData ¶ added in v2.3.2
func (c *ColumnBoolArray) FieldData() *schemapb.FieldData
FieldData return column data mapped to schemapb.FieldData
func (*ColumnBoolArray) Get ¶ added in v2.3.2
func (c *ColumnBoolArray) Get(idx int) (interface{}, error)
Get returns value at index as interface{}.
func (*ColumnBoolArray) Len ¶ added in v2.3.2
func (c *ColumnBoolArray) Len() int
Len returns column values length
func (*ColumnBoolArray) Name ¶ added in v2.3.2
func (c *ColumnBoolArray) Name() string
Name returns column name
func (*ColumnBoolArray) Slice ¶ added in v2.4.1
func (c *ColumnBoolArray) Slice(start, end int) Column
func (*ColumnBoolArray) Type ¶ added in v2.3.2
func (c *ColumnBoolArray) Type() FieldType
Type returns column FieldType
func (*ColumnBoolArray) ValueByIdx ¶ added in v2.3.2
func (c *ColumnBoolArray) ValueByIdx(idx int) ([]bool, error)
ValueByIdx returns value of the provided index error occurs when index out of range
type ColumnDouble ¶
type ColumnDouble struct { ColumnBase // contains filtered or unexported fields }
ColumnDouble generated columns type for Double
func NewColumnDouble ¶
func NewColumnDouble(name string, values []float64) *ColumnDouble
NewColumnDouble auto generated constructor
func (*ColumnDouble) AppendValue ¶
func (c *ColumnDouble) AppendValue(i interface{}) error
AppendValue append value into column
func (*ColumnDouble) FieldData ¶
func (c *ColumnDouble) FieldData() *schema.FieldData
FieldData return column data mapped to schema.FieldData
func (*ColumnDouble) Get ¶ added in v2.2.3
func (c *ColumnDouble) Get(idx int) (interface{}, error)
Get returns value at index as interface{}.
func (*ColumnDouble) GetAsDouble ¶ added in v2.2.3
func (c *ColumnDouble) GetAsDouble(idx int) (float64, error)
func (*ColumnDouble) Slice ¶ added in v2.4.1
func (c *ColumnDouble) Slice(start, end int) Column
func (*ColumnDouble) ValueByIdx ¶
func (c *ColumnDouble) ValueByIdx(idx int) (float64, error)
ValueByIdx returns value of the provided index error occurs when index out of range
type ColumnDoubleArray ¶ added in v2.3.2
type ColumnDoubleArray struct { ColumnBase // contains filtered or unexported fields }
ColumnDoubleArray generated columns type for Double
func NewColumnDoubleArray ¶ added in v2.3.2
func NewColumnDoubleArray(name string, values [][]float64) *ColumnDoubleArray
NewColumnDouble auto generated constructor
func (*ColumnDoubleArray) AppendValue ¶ added in v2.3.2
func (c *ColumnDoubleArray) AppendValue(i interface{}) error
AppendValue append value into column
func (*ColumnDoubleArray) Data ¶ added in v2.3.2
func (c *ColumnDoubleArray) Data() [][]float64
Data returns column data
func (*ColumnDoubleArray) FieldData ¶ added in v2.3.2
func (c *ColumnDoubleArray) FieldData() *schemapb.FieldData
FieldData return column data mapped to schemapb.FieldData
func (*ColumnDoubleArray) Get ¶ added in v2.3.2
func (c *ColumnDoubleArray) Get(idx int) (interface{}, error)
Get returns value at index as interface{}.
func (*ColumnDoubleArray) Len ¶ added in v2.3.2
func (c *ColumnDoubleArray) Len() int
Len returns column values length
func (*ColumnDoubleArray) Name ¶ added in v2.3.2
func (c *ColumnDoubleArray) Name() string
Name returns column name
func (*ColumnDoubleArray) Slice ¶ added in v2.4.1
func (c *ColumnDoubleArray) Slice(start, end int) Column
func (*ColumnDoubleArray) Type ¶ added in v2.3.2
func (c *ColumnDoubleArray) Type() FieldType
Type returns column FieldType
func (*ColumnDoubleArray) ValueByIdx ¶ added in v2.3.2
func (c *ColumnDoubleArray) ValueByIdx(idx int) ([]float64, error)
ValueByIdx returns value of the provided index error occurs when index out of range
type ColumnDynamic ¶ added in v2.2.3
type ColumnDynamic struct { *ColumnJSONBytes // contains filtered or unexported fields }
ColumnDynamic is a logically wrapper for dynamic json field with provided output field.
func NewColumnDynamic ¶ added in v2.2.3
func NewColumnDynamic(column *ColumnJSONBytes, outputField string) *ColumnDynamic
func (*ColumnDynamic) Get ¶ added in v2.2.3
func (c *ColumnDynamic) Get(idx int) (interface{}, error)
Get returns element at idx as interface{}. Overrides internal json column behavior, returns raw json data.
func (*ColumnDynamic) GetAsBool ¶ added in v2.2.3
func (c *ColumnDynamic) GetAsBool(idx int) (bool, error)
func (*ColumnDynamic) GetAsDouble ¶ added in v2.2.3
func (c *ColumnDynamic) GetAsDouble(idx int) (float64, error)
func (*ColumnDynamic) GetAsInt64 ¶ added in v2.2.3
func (c *ColumnDynamic) GetAsInt64(idx int) (int64, error)
func (*ColumnDynamic) GetAsString ¶ added in v2.2.3
func (c *ColumnDynamic) GetAsString(idx int) (string, error)
func (*ColumnDynamic) Name ¶ added in v2.2.3
func (c *ColumnDynamic) Name() string
type ColumnFloat ¶
type ColumnFloat struct { ColumnBase // contains filtered or unexported fields }
ColumnFloat generated columns type for Float
func NewColumnFloat ¶
func NewColumnFloat(name string, values []float32) *ColumnFloat
NewColumnFloat auto generated constructor
func (*ColumnFloat) AppendValue ¶
func (c *ColumnFloat) AppendValue(i interface{}) error
AppendValue append value into column
func (*ColumnFloat) FieldData ¶
func (c *ColumnFloat) FieldData() *schema.FieldData
FieldData return column data mapped to schema.FieldData
func (*ColumnFloat) Get ¶ added in v2.2.3
func (c *ColumnFloat) Get(idx int) (interface{}, error)
Get returns value at index as interface{}.
func (*ColumnFloat) GetAsDouble ¶ added in v2.2.3
func (c *ColumnFloat) GetAsDouble(idx int) (float64, error)
func (*ColumnFloat) Slice ¶ added in v2.4.1
func (c *ColumnFloat) Slice(start, end int) Column
func (*ColumnFloat) ValueByIdx ¶
func (c *ColumnFloat) ValueByIdx(idx int) (float32, error)
ValueByIdx returns value of the provided index error occurs when index out of range
type ColumnFloat16Vector ¶ added in v2.4.0
type ColumnFloat16Vector struct { ColumnBase // contains filtered or unexported fields }
ColumnFloat16Vector generated columns type for Float16Vector
func NewColumnFloat16Vector ¶ added in v2.4.0
func NewColumnFloat16Vector(name string, dim int, values [][]byte) *ColumnFloat16Vector
NewColumnFloat16Vector auto generated constructor
func (*ColumnFloat16Vector) AppendValue ¶ added in v2.4.0
func (c *ColumnFloat16Vector) AppendValue(i interface{}) error
AppendValue append value into column
func (*ColumnFloat16Vector) Data ¶ added in v2.4.0
func (c *ColumnFloat16Vector) Data() [][]byte
Data returns column data
func (*ColumnFloat16Vector) Dim ¶ added in v2.4.0
func (c *ColumnFloat16Vector) Dim() int
Dim returns vector dimension
func (*ColumnFloat16Vector) FieldData ¶ added in v2.4.0
func (c *ColumnFloat16Vector) FieldData() *schema.FieldData
FieldData return column data mapped to schema.FieldData
func (*ColumnFloat16Vector) Get ¶ added in v2.4.0
func (c *ColumnFloat16Vector) Get(idx int) (interface{}, error)
Get returns values at index as interface{}.
func (*ColumnFloat16Vector) Len ¶ added in v2.4.0
func (c *ColumnFloat16Vector) Len() int
Len returns column data length
func (*ColumnFloat16Vector) Name ¶ added in v2.4.0
func (c *ColumnFloat16Vector) Name() string
Name returns column name
func (*ColumnFloat16Vector) Slice ¶ added in v2.4.1
func (c *ColumnFloat16Vector) Slice(start, end int) Column
func (*ColumnFloat16Vector) Type ¶ added in v2.4.0
func (c *ColumnFloat16Vector) Type() FieldType
Type returns column FieldType
type ColumnFloatArray ¶ added in v2.3.2
type ColumnFloatArray struct { ColumnBase // contains filtered or unexported fields }
ColumnFloatArray generated columns type for Float
func NewColumnFloatArray ¶ added in v2.3.2
func NewColumnFloatArray(name string, values [][]float32) *ColumnFloatArray
NewColumnFloat auto generated constructor
func (*ColumnFloatArray) AppendValue ¶ added in v2.3.2
func (c *ColumnFloatArray) AppendValue(i interface{}) error
AppendValue append value into column
func (*ColumnFloatArray) Data ¶ added in v2.3.2
func (c *ColumnFloatArray) Data() [][]float32
Data returns column data
func (*ColumnFloatArray) FieldData ¶ added in v2.3.2
func (c *ColumnFloatArray) FieldData() *schemapb.FieldData
FieldData return column data mapped to schemapb.FieldData
func (*ColumnFloatArray) Get ¶ added in v2.3.2
func (c *ColumnFloatArray) Get(idx int) (interface{}, error)
Get returns value at index as interface{}.
func (*ColumnFloatArray) Len ¶ added in v2.3.2
func (c *ColumnFloatArray) Len() int
Len returns column values length
func (*ColumnFloatArray) Name ¶ added in v2.3.2
func (c *ColumnFloatArray) Name() string
Name returns column name
func (*ColumnFloatArray) Slice ¶ added in v2.4.1
func (c *ColumnFloatArray) Slice(start, end int) Column
func (*ColumnFloatArray) Type ¶ added in v2.3.2
func (c *ColumnFloatArray) Type() FieldType
Type returns column FieldType
func (*ColumnFloatArray) ValueByIdx ¶ added in v2.3.2
func (c *ColumnFloatArray) ValueByIdx(idx int) ([]float32, error)
ValueByIdx returns value of the provided index error occurs when index out of range
type ColumnFloatVector ¶
type ColumnFloatVector struct { ColumnBase // contains filtered or unexported fields }
ColumnFloatVector generated columns type for FloatVector
func NewColumnFloatVector ¶
func NewColumnFloatVector(name string, dim int, values [][]float32) *ColumnFloatVector
NewColumnFloatVector auto generated constructor
func (*ColumnFloatVector) AppendValue ¶
func (c *ColumnFloatVector) AppendValue(i interface{}) error
AppendValue append value into column
func (*ColumnFloatVector) Data ¶
func (c *ColumnFloatVector) Data() [][]float32
Data returns column data
func (*ColumnFloatVector) FieldData ¶
func (c *ColumnFloatVector) FieldData() *schema.FieldData
FieldData return column data mapped to schema.FieldData
func (*ColumnFloatVector) Get ¶ added in v2.2.3
func (c *ColumnFloatVector) Get(idx int) (interface{}, error)
Get returns values at index as interface{}.
func (*ColumnFloatVector) Len ¶
func (c *ColumnFloatVector) Len() int
Len returns column data length
func (*ColumnFloatVector) Slice ¶ added in v2.4.1
func (c *ColumnFloatVector) Slice(start, end int) Column
func (*ColumnFloatVector) Type ¶
func (c *ColumnFloatVector) Type() FieldType
Type returns column FieldType
type ColumnInt16 ¶
type ColumnInt16 struct { ColumnBase // contains filtered or unexported fields }
ColumnInt16 generated columns type for Int16
func NewColumnInt16 ¶
func NewColumnInt16(name string, values []int16) *ColumnInt16
NewColumnInt16 auto generated constructor
func (*ColumnInt16) AppendValue ¶
func (c *ColumnInt16) AppendValue(i interface{}) error
AppendValue append value into column
func (*ColumnInt16) FieldData ¶
func (c *ColumnInt16) FieldData() *schema.FieldData
FieldData return column data mapped to schema.FieldData
func (*ColumnInt16) Get ¶ added in v2.2.3
func (c *ColumnInt16) Get(idx int) (interface{}, error)
Get returns value at index as interface{}.
func (*ColumnInt16) GetAsInt64 ¶ added in v2.2.3
func (c *ColumnInt16) GetAsInt64(idx int) (int64, error)
func (*ColumnInt16) Slice ¶ added in v2.4.1
func (c *ColumnInt16) Slice(start, end int) Column
func (*ColumnInt16) ValueByIdx ¶
func (c *ColumnInt16) ValueByIdx(idx int) (int16, error)
ValueByIdx returns value of the provided index error occurs when index out of range
type ColumnInt16Array ¶ added in v2.3.2
type ColumnInt16Array struct { ColumnBase // contains filtered or unexported fields }
ColumnInt16Array generated columns type for Int16
func NewColumnInt16Array ¶ added in v2.3.2
func NewColumnInt16Array(name string, values [][]int16) *ColumnInt16Array
NewColumnInt16 auto generated constructor
func (*ColumnInt16Array) AppendValue ¶ added in v2.3.2
func (c *ColumnInt16Array) AppendValue(i interface{}) error
AppendValue append value into column
func (*ColumnInt16Array) Data ¶ added in v2.3.2
func (c *ColumnInt16Array) Data() [][]int16
Data returns column data
func (*ColumnInt16Array) FieldData ¶ added in v2.3.2
func (c *ColumnInt16Array) FieldData() *schemapb.FieldData
FieldData return column data mapped to schemapb.FieldData
func (*ColumnInt16Array) Get ¶ added in v2.3.2
func (c *ColumnInt16Array) Get(idx int) (interface{}, error)
Get returns value at index as interface{}.
func (*ColumnInt16Array) Len ¶ added in v2.3.2
func (c *ColumnInt16Array) Len() int
Len returns column values length
func (*ColumnInt16Array) Name ¶ added in v2.3.2
func (c *ColumnInt16Array) Name() string
Name returns column name
func (*ColumnInt16Array) Slice ¶ added in v2.4.1
func (c *ColumnInt16Array) Slice(start, end int) Column
func (*ColumnInt16Array) Type ¶ added in v2.3.2
func (c *ColumnInt16Array) Type() FieldType
Type returns column FieldType
func (*ColumnInt16Array) ValueByIdx ¶ added in v2.3.2
func (c *ColumnInt16Array) ValueByIdx(idx int) ([]int16, error)
ValueByIdx returns value of the provided index error occurs when index out of range
type ColumnInt32 ¶
type ColumnInt32 struct { ColumnBase // contains filtered or unexported fields }
ColumnInt32 generated columns type for Int32
func NewColumnInt32 ¶
func NewColumnInt32(name string, values []int32) *ColumnInt32
NewColumnInt32 auto generated constructor
func (*ColumnInt32) AppendValue ¶
func (c *ColumnInt32) AppendValue(i interface{}) error
AppendValue append value into column
func (*ColumnInt32) FieldData ¶
func (c *ColumnInt32) FieldData() *schema.FieldData
FieldData return column data mapped to schema.FieldData
func (*ColumnInt32) Get ¶ added in v2.2.3
func (c *ColumnInt32) Get(idx int) (interface{}, error)
Get returns value at index as interface{}.
func (*ColumnInt32) GetAsInt64 ¶ added in v2.2.3
func (c *ColumnInt32) GetAsInt64(idx int) (int64, error)
func (*ColumnInt32) Slice ¶ added in v2.4.1
func (c *ColumnInt32) Slice(start, end int) Column
func (*ColumnInt32) ValueByIdx ¶
func (c *ColumnInt32) ValueByIdx(idx int) (int32, error)
ValueByIdx returns value of the provided index error occurs when index out of range
type ColumnInt32Array ¶ added in v2.3.2
type ColumnInt32Array struct { ColumnBase // contains filtered or unexported fields }
ColumnInt32Array generated columns type for Int32
func NewColumnInt32Array ¶ added in v2.3.2
func NewColumnInt32Array(name string, values [][]int32) *ColumnInt32Array
NewColumnInt32 auto generated constructor
func (*ColumnInt32Array) AppendValue ¶ added in v2.3.2
func (c *ColumnInt32Array) AppendValue(i interface{}) error
AppendValue append value into column
func (*ColumnInt32Array) Data ¶ added in v2.3.2
func (c *ColumnInt32Array) Data() [][]int32
Data returns column data
func (*ColumnInt32Array) FieldData ¶ added in v2.3.2
func (c *ColumnInt32Array) FieldData() *schemapb.FieldData
FieldData return column data mapped to schemapb.FieldData
func (*ColumnInt32Array) Get ¶ added in v2.3.2
func (c *ColumnInt32Array) Get(idx int) (interface{}, error)
Get returns value at index as interface{}.
func (*ColumnInt32Array) Len ¶ added in v2.3.2
func (c *ColumnInt32Array) Len() int
Len returns column values length
func (*ColumnInt32Array) Name ¶ added in v2.3.2
func (c *ColumnInt32Array) Name() string
Name returns column name
func (*ColumnInt32Array) Slice ¶ added in v2.4.1
func (c *ColumnInt32Array) Slice(start, end int) Column
func (*ColumnInt32Array) Type ¶ added in v2.3.2
func (c *ColumnInt32Array) Type() FieldType
Type returns column FieldType
func (*ColumnInt32Array) ValueByIdx ¶ added in v2.3.2
func (c *ColumnInt32Array) ValueByIdx(idx int) ([]int32, error)
ValueByIdx returns value of the provided index error occurs when index out of range
type ColumnInt64 ¶
type ColumnInt64 struct { ColumnBase // contains filtered or unexported fields }
ColumnInt64 generated columns type for Int64
func NewColumnInt64 ¶
func NewColumnInt64(name string, values []int64) *ColumnInt64
NewColumnInt64 auto generated constructor
func (*ColumnInt64) AppendValue ¶
func (c *ColumnInt64) AppendValue(i interface{}) error
AppendValue append value into column
func (*ColumnInt64) FieldData ¶
func (c *ColumnInt64) FieldData() *schema.FieldData
FieldData return column data mapped to schema.FieldData
func (*ColumnInt64) Get ¶ added in v2.2.3
func (c *ColumnInt64) Get(idx int) (interface{}, error)
Get returns value at index as interface{}.
func (*ColumnInt64) GetAsInt64 ¶ added in v2.2.3
func (c *ColumnInt64) GetAsInt64(idx int) (int64, error)
func (*ColumnInt64) Slice ¶ added in v2.4.1
func (c *ColumnInt64) Slice(start, end int) Column
func (*ColumnInt64) ValueByIdx ¶
func (c *ColumnInt64) ValueByIdx(idx int) (int64, error)
ValueByIdx returns value of the provided index error occurs when index out of range
type ColumnInt64Array ¶ added in v2.3.2
type ColumnInt64Array struct { ColumnBase // contains filtered or unexported fields }
ColumnInt64Array generated columns type for Int64
func NewColumnInt64Array ¶ added in v2.3.2
func NewColumnInt64Array(name string, values [][]int64) *ColumnInt64Array
NewColumnInt64 auto generated constructor
func (*ColumnInt64Array) AppendValue ¶ added in v2.3.2
func (c *ColumnInt64Array) AppendValue(i interface{}) error
AppendValue append value into column
func (*ColumnInt64Array) Data ¶ added in v2.3.2
func (c *ColumnInt64Array) Data() [][]int64
Data returns column data
func (*ColumnInt64Array) FieldData ¶ added in v2.3.2
func (c *ColumnInt64Array) FieldData() *schemapb.FieldData
FieldData return column data mapped to schemapb.FieldData
func (*ColumnInt64Array) Get ¶ added in v2.3.2
func (c *ColumnInt64Array) Get(idx int) (interface{}, error)
Get returns value at index as interface{}.
func (*ColumnInt64Array) Len ¶ added in v2.3.2
func (c *ColumnInt64Array) Len() int
Len returns column values length
func (*ColumnInt64Array) Name ¶ added in v2.3.2
func (c *ColumnInt64Array) Name() string
Name returns column name
func (*ColumnInt64Array) Slice ¶ added in v2.4.1
func (c *ColumnInt64Array) Slice(start, end int) Column
func (*ColumnInt64Array) Type ¶ added in v2.3.2
func (c *ColumnInt64Array) Type() FieldType
Type returns column FieldType
func (*ColumnInt64Array) ValueByIdx ¶ added in v2.3.2
func (c *ColumnInt64Array) ValueByIdx(idx int) ([]int64, error)
ValueByIdx returns value of the provided index error occurs when index out of range
type ColumnInt8 ¶
type ColumnInt8 struct { ColumnBase // contains filtered or unexported fields }
ColumnInt8 generated columns type for Int8
func NewColumnInt8 ¶
func NewColumnInt8(name string, values []int8) *ColumnInt8
NewColumnInt8 auto generated constructor
func (*ColumnInt8) AppendValue ¶
func (c *ColumnInt8) AppendValue(i interface{}) error
AppendValue append value into column
func (*ColumnInt8) FieldData ¶
func (c *ColumnInt8) FieldData() *schema.FieldData
FieldData return column data mapped to schema.FieldData
func (*ColumnInt8) Get ¶ added in v2.2.3
func (c *ColumnInt8) Get(idx int) (interface{}, error)
Get returns value at index as interface{}.
func (*ColumnInt8) GetAsInt64 ¶ added in v2.2.3
func (c *ColumnInt8) GetAsInt64(idx int) (int64, error)
func (*ColumnInt8) Slice ¶ added in v2.4.1
func (c *ColumnInt8) Slice(start, end int) Column
func (*ColumnInt8) ValueByIdx ¶
func (c *ColumnInt8) ValueByIdx(idx int) (int8, error)
ValueByIdx returns value of the provided index error occurs when index out of range
type ColumnInt8Array ¶ added in v2.3.2
type ColumnInt8Array struct { ColumnBase // contains filtered or unexported fields }
ColumnInt8Array generated columns type for Int8
func NewColumnInt8Array ¶ added in v2.3.2
func NewColumnInt8Array(name string, values [][]int8) *ColumnInt8Array
NewColumnInt8 auto generated constructor
func (*ColumnInt8Array) AppendValue ¶ added in v2.3.2
func (c *ColumnInt8Array) AppendValue(i interface{}) error
AppendValue append value into column
func (*ColumnInt8Array) Data ¶ added in v2.3.2
func (c *ColumnInt8Array) Data() [][]int8
Data returns column data
func (*ColumnInt8Array) FieldData ¶ added in v2.3.2
func (c *ColumnInt8Array) FieldData() *schemapb.FieldData
FieldData return column data mapped to schemapb.FieldData
func (*ColumnInt8Array) Get ¶ added in v2.3.2
func (c *ColumnInt8Array) Get(idx int) (interface{}, error)
Get returns value at index as interface{}.
func (*ColumnInt8Array) Len ¶ added in v2.3.2
func (c *ColumnInt8Array) Len() int
Len returns column values length
func (*ColumnInt8Array) Name ¶ added in v2.3.2
func (c *ColumnInt8Array) Name() string
Name returns column name
func (*ColumnInt8Array) Slice ¶ added in v2.4.1
func (c *ColumnInt8Array) Slice(start, end int) Column
func (*ColumnInt8Array) Type ¶ added in v2.3.2
func (c *ColumnInt8Array) Type() FieldType
Type returns column FieldType
func (*ColumnInt8Array) ValueByIdx ¶ added in v2.3.2
func (c *ColumnInt8Array) ValueByIdx(idx int) ([]int8, error)
ValueByIdx returns value of the provided index error occurs when index out of range
type ColumnJSONBytes ¶ added in v2.2.3
type ColumnJSONBytes struct { ColumnBase // contains filtered or unexported fields }
ColumnJSONBytes column type for JSON. all items are marshaled json bytes.
func NewColumnJSONBytes ¶ added in v2.2.3
func NewColumnJSONBytes(name string, values [][]byte) *ColumnJSONBytes
NewColumnJSONBytes composes a Column with json bytes.
func (*ColumnJSONBytes) AppendValue ¶ added in v2.2.3
func (c *ColumnJSONBytes) AppendValue(i interface{}) error
AppendValue append value into column.
func (*ColumnJSONBytes) Data ¶ added in v2.2.3
func (c *ColumnJSONBytes) Data() [][]byte
Data returns column data.
func (*ColumnJSONBytes) FieldData ¶ added in v2.2.3
func (c *ColumnJSONBytes) FieldData() *schema.FieldData
FieldData return column data mapped to schema.FieldData.
func (*ColumnJSONBytes) Get ¶ added in v2.2.3
func (c *ColumnJSONBytes) Get(idx int) (interface{}, error)
Get returns value at index as interface{}.
func (*ColumnJSONBytes) GetAsString ¶ added in v2.2.3
func (c *ColumnJSONBytes) GetAsString(idx int) (string, error)
func (*ColumnJSONBytes) IsDynamic ¶ added in v2.4.2
func (c *ColumnJSONBytes) IsDynamic() bool
func (*ColumnJSONBytes) Len ¶ added in v2.2.3
func (c *ColumnJSONBytes) Len() int
Len returns column values length.
func (*ColumnJSONBytes) Name ¶ added in v2.2.3
func (c *ColumnJSONBytes) Name() string
Name returns column name.
func (*ColumnJSONBytes) Slice ¶ added in v2.4.1
func (c *ColumnJSONBytes) Slice(start, end int) Column
func (*ColumnJSONBytes) Type ¶ added in v2.2.3
func (c *ColumnJSONBytes) Type() FieldType
Type returns column FieldType.
func (*ColumnJSONBytes) ValueByIdx ¶ added in v2.2.3
func (c *ColumnJSONBytes) ValueByIdx(idx int) ([]byte, error)
ValueByIdx returns value of the provided index.
func (*ColumnJSONBytes) WithIsDynamic ¶ added in v2.2.3
func (c *ColumnJSONBytes) WithIsDynamic(isDynamic bool) *ColumnJSONBytes
type ColumnSparseFloatVector ¶ added in v2.4.0
type ColumnSparseFloatVector struct { ColumnBase // contains filtered or unexported fields }
func NewColumnSparseVectors ¶ added in v2.4.0
func NewColumnSparseVectors(name string, values []SparseEmbedding) *ColumnSparseFloatVector
func (*ColumnSparseFloatVector) AppendValue ¶ added in v2.4.0
func (c *ColumnSparseFloatVector) AppendValue(i interface{}) error
func (*ColumnSparseFloatVector) Data ¶ added in v2.4.0
func (c *ColumnSparseFloatVector) Data() []SparseEmbedding
func (*ColumnSparseFloatVector) FieldData ¶ added in v2.4.0
func (c *ColumnSparseFloatVector) FieldData() *schema.FieldData
func (*ColumnSparseFloatVector) Get ¶ added in v2.4.0
func (c *ColumnSparseFloatVector) Get(idx int) (interface{}, error)
Get returns value at index as interface{}.
func (*ColumnSparseFloatVector) Len ¶ added in v2.4.0
func (c *ColumnSparseFloatVector) Len() int
Len returns column values length.
func (*ColumnSparseFloatVector) Name ¶ added in v2.4.0
func (c *ColumnSparseFloatVector) Name() string
Name returns column name.
func (*ColumnSparseFloatVector) Slice ¶ added in v2.4.1
func (c *ColumnSparseFloatVector) Slice(start, end int) Column
func (*ColumnSparseFloatVector) Type ¶ added in v2.4.0
func (c *ColumnSparseFloatVector) Type() FieldType
Type returns column FieldType.
func (*ColumnSparseFloatVector) ValueByIdx ¶ added in v2.4.0
func (c *ColumnSparseFloatVector) ValueByIdx(idx int) (SparseEmbedding, error)
ValueByIdx returns value of the provided index error occurs when index out of range
type ColumnString ¶
type ColumnString struct { ColumnBase // contains filtered or unexported fields }
ColumnString generated columns type for String
func NewColumnString ¶
func NewColumnString(name string, values []string) *ColumnString
NewColumnString auto generated constructor
func (*ColumnString) AppendValue ¶
func (c *ColumnString) AppendValue(i interface{}) error
AppendValue append value into column
func (*ColumnString) FieldData ¶
func (c *ColumnString) FieldData() *schema.FieldData
FieldData return column data mapped to schema.FieldData
func (*ColumnString) Get ¶ added in v2.2.3
func (c *ColumnString) Get(idx int) (interface{}, error)
Get returns value at index as interface{}.
func (*ColumnString) GetAsString ¶ added in v2.2.3
func (c *ColumnString) GetAsString(idx int) (string, error)
func (*ColumnString) Slice ¶ added in v2.4.1
func (c *ColumnString) Slice(start, end int) Column
func (*ColumnString) ValueByIdx ¶
func (c *ColumnString) ValueByIdx(idx int) (string, error)
ValueByIdx returns value of the provided index error occurs when index out of range
type ColumnVarChar ¶ added in v2.1.0
type ColumnVarChar struct { ColumnBase // contains filtered or unexported fields }
ColumnVarChar generated columns type for VarChar
func NewColumnVarChar ¶ added in v2.1.0
func NewColumnVarChar(name string, values []string) *ColumnVarChar
NewColumnVarChar auto generated constructor
func (*ColumnVarChar) AppendValue ¶ added in v2.1.0
func (c *ColumnVarChar) AppendValue(i interface{}) error
AppendValue append value into column
func (*ColumnVarChar) Data ¶ added in v2.1.0
func (c *ColumnVarChar) Data() []string
Data returns column data
func (*ColumnVarChar) FieldData ¶ added in v2.1.0
func (c *ColumnVarChar) FieldData() *schema.FieldData
FieldData return column data mapped to schema.FieldData
func (*ColumnVarChar) Get ¶ added in v2.2.3
func (c *ColumnVarChar) Get(idx int) (interface{}, error)
Get returns value at index as interface{}.
func (*ColumnVarChar) GetAsString ¶ added in v2.2.3
func (c *ColumnVarChar) GetAsString(idx int) (string, error)
GetAsString returns value at idx.
func (*ColumnVarChar) Len ¶ added in v2.1.0
func (c *ColumnVarChar) Len() int
Len returns column values length
func (*ColumnVarChar) Name ¶ added in v2.1.0
func (c *ColumnVarChar) Name() string
Name returns column name
func (*ColumnVarChar) Slice ¶ added in v2.4.1
func (c *ColumnVarChar) Slice(start, end int) Column
func (*ColumnVarChar) Type ¶ added in v2.1.0
func (c *ColumnVarChar) Type() FieldType
Type returns column FieldType
func (*ColumnVarChar) ValueByIdx ¶ added in v2.1.0
func (c *ColumnVarChar) ValueByIdx(idx int) (string, error)
ValueByIdx returns value of the provided index error occurs when index out of range
type ColumnVarCharArray ¶ added in v2.3.2
type ColumnVarCharArray struct { ColumnBase // contains filtered or unexported fields }
ColumnVarCharArray generated columns type for VarChar
func NewColumnVarCharArray ¶ added in v2.3.2
func NewColumnVarCharArray(name string, values [][][]byte) *ColumnVarCharArray
NewColumnVarChar auto generated constructor
func (*ColumnVarCharArray) AppendValue ¶ added in v2.3.2
func (c *ColumnVarCharArray) AppendValue(i interface{}) error
AppendValue append value into column
func (*ColumnVarCharArray) Data ¶ added in v2.3.2
func (c *ColumnVarCharArray) Data() [][][]byte
Data returns column data
func (*ColumnVarCharArray) FieldData ¶ added in v2.3.2
func (c *ColumnVarCharArray) FieldData() *schemapb.FieldData
FieldData return column data mapped to schemapb.FieldData
func (*ColumnVarCharArray) Get ¶ added in v2.3.2
func (c *ColumnVarCharArray) Get(idx int) (interface{}, error)
Get returns value at index as interface{}.
func (*ColumnVarCharArray) Len ¶ added in v2.3.2
func (c *ColumnVarCharArray) Len() int
Len returns column values length
func (*ColumnVarCharArray) Name ¶ added in v2.3.2
func (c *ColumnVarCharArray) Name() string
Name returns column name
func (*ColumnVarCharArray) Slice ¶ added in v2.4.1
func (c *ColumnVarCharArray) Slice(start, end int) Column
func (*ColumnVarCharArray) Type ¶ added in v2.3.2
func (c *ColumnVarCharArray) Type() FieldType
Type returns column FieldType
func (*ColumnVarCharArray) ValueByIdx ¶ added in v2.3.2
func (c *ColumnVarCharArray) ValueByIdx(idx int) ([][]byte, error)
ValueByIdx returns value of the provided index error occurs when index out of range
type CompactionPlan ¶
type CompactionPlan struct { Source []int64 Target int64 PlanType CompactionPlanType }
CompactionMergePlan contains compaction plan of merging multple segments
type CompactionPlanType ¶
type CompactionPlanType int32
const ( // CompactionPlanUndefined zero value placeholder CompactionPlanUndefined CompactionPlanType = 0 // CompactionPlanApplyDelete apply delete log CompactionPlanApplyDelete CompactionPlanType = 1 // CompactionPlanMergeSegments merge multiple segments CompactionPlanMergeSegments CompactionPlanType = 2 )
See https://wiki.lfaidata.foundation/display/MIL/MEP+16+--+Compaction
type CompactionState ¶
type CompactionState int32
CompactionState is enum of compaction execution state should match definition in common.proto
const ( //CompcationStateUndefined zero value placeholder CompcationStateUndefined CompactionState = 0 //CompactionStateExecuting compaction in progress CompactionStateExecuting CompactionState = 1 // CompactionStateCompleted compcation done CompactionStateCompleted CompactionState = 2 )
type ConsistencyLevel ¶ added in v2.1.0
type ConsistencyLevel common.ConsistencyLevel
ConsistencyLevel enum type for collection Consistency Level
const DefaultConsistencyLevel ConsistencyLevel = ClBounded
DefaultConsistencyLevel const value for using Milvus default consistency level setting.
func (ConsistencyLevel) CommonConsistencyLevel ¶ added in v2.1.0
func (cl ConsistencyLevel) CommonConsistencyLevel() common.ConsistencyLevel
CommonConsistencyLevel returns corresponding common.ConsistencyLevel
type Database ¶ added in v2.2.3
type Database struct { Name string // Database name. Properties []*commonpb.KeyValuePair }
Database represents a database in a remote Milvus cluster.
type DatabaseAttribute ¶ added in v2.4.1
type DatabaseAttribute = CollectionAttribute
type Field ¶
type Field struct { ID int64 // field id, generated when collection is created, input value is ignored Name string // field name PrimaryKey bool // is primary key AutoID bool // is auto id Description string DataType FieldType TypeParams map[string]string IndexParams map[string]string IsDynamic bool IsPartitionKey bool IsClusteringKey bool ElementType FieldType }
Field represent field schema in milvus
func NewField ¶ added in v2.2.3
func NewField() *Field
NewField creates a new Field with map initialized.
func (*Field) ProtoMessage ¶
func (f *Field) ProtoMessage() *schema.FieldSchema
ProtoMessage generates corresponding FieldSchema
func (*Field) ReadProto ¶
func (f *Field) ReadProto(p *schema.FieldSchema) *Field
ReadProto parses FieldSchema
func (*Field) WithDataType ¶ added in v2.2.3
func (*Field) WithDescription ¶ added in v2.2.3
func (*Field) WithElementType ¶ added in v2.3.2
func (*Field) WithIsAutoID ¶ added in v2.2.3
func (*Field) WithIsClusteringKey ¶ added in v2.4.2
func (*Field) WithIsDynamic ¶ added in v2.2.3
func (*Field) WithIsPartitionKey ¶ added in v2.2.3
func (*Field) WithIsPrimaryKey ¶ added in v2.2.3
func (*Field) WithMaxCapacity ¶ added in v2.3.2
func (*Field) WithMaxLength ¶ added in v2.2.3
type FieldType ¶
type FieldType int32
FieldType field data type alias type used in go:generate trick, DO NOT modify names & string
const ( // FieldTypeNone zero value place holder FieldTypeNone FieldType = 0 // zero value place holder // FieldTypeBool field type boolean FieldTypeBool FieldType = 1 // FieldTypeInt8 field type int8 FieldTypeInt8 FieldType = 2 // FieldTypeInt16 field type int16 FieldTypeInt16 FieldType = 3 // FieldTypeInt32 field type int32 FieldTypeInt32 FieldType = 4 // FieldTypeInt64 field type int64 FieldTypeInt64 FieldType = 5 // FieldTypeFloat field type float FieldTypeFloat FieldType = 10 // FieldTypeDouble field type double FieldTypeDouble FieldType = 11 // FieldTypeString field type string FieldTypeString FieldType = 20 // FieldTypeVarChar field type varchar FieldTypeVarChar FieldType = 21 // variable-length strings with a specified maximum length // FieldTypeArray field type Array FieldTypeArray FieldType = 22 // FieldTypeJSON field type JSON FieldTypeJSON FieldType = 23 // FieldTypeBinaryVector field type binary vector FieldTypeBinaryVector FieldType = 100 // FieldTypeFloatVector field type float vector FieldTypeFloatVector FieldType = 101 // FieldTypeBinaryVector field type float16 vector FieldTypeFloat16Vector FieldType = 102 // FieldTypeBinaryVector field type bf16 vector FieldTypeBFloat16Vector FieldType = 103 // FieldTypeBinaryVector field type sparse vector FieldTypeSparseVector FieldType = 104 )
Match schema definition
func (FieldType) PbFieldType ¶
PbFieldType represents FieldType corresponding schema pb type
type Float16Vector ¶ added in v2.4.0
type Float16Vector []byte
FloatVector float32 vector wrapper.
func (Float16Vector) Dim ¶ added in v2.4.0
func (fv Float16Vector) Dim() int
Dim returns vector dimension.
func (Float16Vector) FieldType ¶ added in v2.4.0
func (fv Float16Vector) FieldType() FieldType
FieldType returns coresponding field type.
func (Float16Vector) Serialize ¶ added in v2.4.0
func (fv Float16Vector) Serialize() []byte
type FloatVector ¶
type FloatVector []float32
FloatVector float32 vector wrapper.
func (FloatVector) FieldType ¶ added in v2.1.0
func (fv FloatVector) FieldType() FieldType
FieldType returns coresponding field type.
func (FloatVector) Serialize ¶
func (fv FloatVector) Serialize() []byte
Serialize serializes vector into byte slice, used in search placeholder LittleEndian is used for convention
type GenericIndex ¶
type GenericIndex struct {
// contains filtered or unexported fields
}
GenericIndex index struct for general usage no constraint for index is applied
func (GenericIndex) IndexType ¶
func (b GenericIndex) IndexType() IndexType
IndexType implements Index
func (GenericIndex) Params ¶
func (gi GenericIndex) Params() map[string]string
Params implements Index
type Index ¶
Index represent index in milvus
func NewGenericIndex ¶
NewGenericIndex create generic index instance
func NewScalarIndex ¶ added in v2.2.5
func NewScalarIndex() Index
func NewScalarIndexWithType ¶ added in v2.4.0
type IndexAUTOINDEX ¶ added in v2.2.0
type IndexAUTOINDEX struct {
// contains filtered or unexported fields
}
IndexAUTOINDEX idx type for AUTOINDEX
func NewIndexAUTOINDEX ¶ added in v2.2.0
func NewIndexAUTOINDEX(metricType MetricType) (*IndexAUTOINDEX, error)
NewIndexAUTOINDEX create index with construction parameters
func (*IndexAUTOINDEX) IndexType ¶ added in v2.2.0
func (i *IndexAUTOINDEX) IndexType() IndexType
IndexType returns IndexType, implementing Index interface
func (*IndexAUTOINDEX) Name ¶ added in v2.2.0
func (i *IndexAUTOINDEX) Name() string
Name returns index type name, implementing Index interface
func (*IndexAUTOINDEX) Params ¶ added in v2.2.0
func (i *IndexAUTOINDEX) Params() map[string]string
Params returns index construction params, implementing Index interface
func (*IndexAUTOINDEX) SupportBinary ¶ added in v2.2.0
func (i *IndexAUTOINDEX) SupportBinary() bool
SupportBinary returns whether index type support binary vector
type IndexAUTOINDEXSearchParam ¶ added in v2.2.0
type IndexAUTOINDEXSearchParam struct {
// contains filtered or unexported fields
}
IndexAUTOINDEXSearchParam search param struct for index type AUTOINDEX
func NewIndexAUTOINDEXSearchParam ¶ added in v2.2.0
func NewIndexAUTOINDEXSearchParam( level int, ) (*IndexAUTOINDEXSearchParam, error)
NewIndexAUTOINDEXSearchParam create index search param
func (*IndexAUTOINDEXSearchParam) AddRadius ¶ added in v2.3.0
func (sp *IndexAUTOINDEXSearchParam) AddRadius(radius float64)
func (*IndexAUTOINDEXSearchParam) AddRangeFilter ¶ added in v2.3.0
func (sp *IndexAUTOINDEXSearchParam) AddRangeFilter(rangeFilter float64)
type IndexBinFlat ¶
type IndexBinFlat struct {
// contains filtered or unexported fields
}
IndexBinFlat idx type for BIN_FLAT
func NewIndexBinFlat ¶
func NewIndexBinFlat(metricType MetricType, nlist int, ) (*IndexBinFlat, error)
NewIndexBinFlat create index with construction parameters
func (*IndexBinFlat) IndexType ¶
func (i *IndexBinFlat) IndexType() IndexType
IndexType returns IndexType, implementing Index interface
func (*IndexBinFlat) Name ¶
func (i *IndexBinFlat) Name() string
Name returns index type name, implementing Index interface
func (*IndexBinFlat) Params ¶
func (i *IndexBinFlat) Params() map[string]string
Params returns index construction params, implementing Index interface
func (*IndexBinFlat) SupportBinary ¶
func (i *IndexBinFlat) SupportBinary() bool
SupportBinary returns whether index type support binary vector
type IndexBinFlatSearchParam ¶
type IndexBinFlatSearchParam struct {
// contains filtered or unexported fields
}
IndexBinFlatSearchParam search param struct for index type BIN_FLAT
func NewIndexBinFlatSearchParam ¶
func NewIndexBinFlatSearchParam( nprobe int, ) (*IndexBinFlatSearchParam, error)
NewIndexBinFlatSearchParam create index search param
func (*IndexBinFlatSearchParam) AddRadius ¶ added in v2.3.0
func (sp *IndexBinFlatSearchParam) AddRadius(radius float64)
func (*IndexBinFlatSearchParam) AddRangeFilter ¶ added in v2.3.0
func (sp *IndexBinFlatSearchParam) AddRangeFilter(rangeFilter float64)
type IndexBinIvfFlat ¶
type IndexBinIvfFlat struct {
// contains filtered or unexported fields
}
IndexBinIvfFlat idx type for BIN_IVF_FLAT
func NewIndexBinIvfFlat ¶
func NewIndexBinIvfFlat(metricType MetricType, nlist int, ) (*IndexBinIvfFlat, error)
NewIndexBinIvfFlat create index with construction parameters
func (*IndexBinIvfFlat) IndexType ¶
func (i *IndexBinIvfFlat) IndexType() IndexType
IndexType returns IndexType, implementing Index interface
func (*IndexBinIvfFlat) Name ¶
func (i *IndexBinIvfFlat) Name() string
Name returns index type name, implementing Index interface
func (*IndexBinIvfFlat) Params ¶
func (i *IndexBinIvfFlat) Params() map[string]string
Params returns index construction params, implementing Index interface
func (*IndexBinIvfFlat) SupportBinary ¶
func (i *IndexBinIvfFlat) SupportBinary() bool
SupportBinary returns whether index type support binary vector
type IndexBinIvfFlatSearchParam ¶
type IndexBinIvfFlatSearchParam struct {
// contains filtered or unexported fields
}
IndexBinIvfFlatSearchParam search param struct for index type BIN_IVF_FLAT
func NewIndexBinIvfFlatSearchParam ¶
func NewIndexBinIvfFlatSearchParam( nprobe int, ) (*IndexBinIvfFlatSearchParam, error)
NewIndexBinIvfFlatSearchParam create index search param
func (*IndexBinIvfFlatSearchParam) AddRadius ¶ added in v2.3.0
func (sp *IndexBinIvfFlatSearchParam) AddRadius(radius float64)
func (*IndexBinIvfFlatSearchParam) AddRangeFilter ¶ added in v2.3.0
func (sp *IndexBinIvfFlatSearchParam) AddRangeFilter(rangeFilter float64)
type IndexDISKANN ¶ added in v2.2.0
type IndexDISKANN struct {
// contains filtered or unexported fields
}
IndexDISKANN idx type for DISKANN
func NewIndexDISKANN ¶ added in v2.2.0
func NewIndexDISKANN(metricType MetricType) (*IndexDISKANN, error)
NewIndexDISKANN create index with construction parameters
func (*IndexDISKANN) IndexType ¶ added in v2.2.0
func (i *IndexDISKANN) IndexType() IndexType
IndexType returns IndexType, implementing Index interface
func (*IndexDISKANN) Name ¶ added in v2.2.0
func (i *IndexDISKANN) Name() string
Name returns index type name, implementing Index interface
func (*IndexDISKANN) Params ¶ added in v2.2.0
func (i *IndexDISKANN) Params() map[string]string
Params returns index construction params, implementing Index interface
func (*IndexDISKANN) SupportBinary ¶ added in v2.2.0
func (i *IndexDISKANN) SupportBinary() bool
SupportBinary returns whether index type support binary vector
type IndexDISKANNSearchParam ¶ added in v2.2.0
type IndexDISKANNSearchParam struct {
// contains filtered or unexported fields
}
IndexDISKANNSearchParam search param struct for index type DISKANN
func NewIndexDISKANNSearchParam ¶ added in v2.2.0
func NewIndexDISKANNSearchParam( search_list int, ) (*IndexDISKANNSearchParam, error)
NewIndexDISKANNSearchParam create index search param
func (*IndexDISKANNSearchParam) AddRadius ¶ added in v2.3.0
func (sp *IndexDISKANNSearchParam) AddRadius(radius float64)
func (*IndexDISKANNSearchParam) AddRangeFilter ¶ added in v2.3.0
func (sp *IndexDISKANNSearchParam) AddRangeFilter(rangeFilter float64)
type IndexFlat ¶
type IndexFlat struct {
// contains filtered or unexported fields
}
IndexFlat idx type for FLAT
func NewIndexFlat ¶
func NewIndexFlat(metricType MetricType) (*IndexFlat, error)
NewIndexFlat create index with construction parameters
func (*IndexFlat) SupportBinary ¶
SupportBinary returns whether index type support binary vector
type IndexFlatSearchParam ¶
type IndexFlatSearchParam struct {
// contains filtered or unexported fields
}
IndexFlatSearchParam search param struct for index type FLAT
func NewIndexFlatSearchParam ¶
func NewIndexFlatSearchParam() (*IndexFlatSearchParam, error)
NewIndexFlatSearchParam create index search param
func (*IndexFlatSearchParam) AddRadius ¶ added in v2.3.0
func (sp *IndexFlatSearchParam) AddRadius(radius float64)
func (*IndexFlatSearchParam) AddRangeFilter ¶ added in v2.3.0
func (sp *IndexFlatSearchParam) AddRangeFilter(rangeFilter float64)
type IndexGPUBruteForce ¶ added in v2.4.0
type IndexGPUBruteForce struct {
// contains filtered or unexported fields
}
IndexGPUBruteForce index type for GPU brute force search.
func NewIndexGPUBruteForce ¶ added in v2.4.0
func NewIndexGPUBruteForce(metricType MetricType) (*IndexGPUBruteForce, error)
func (*IndexGPUBruteForce) IndexType ¶ added in v2.4.0
func (i *IndexGPUBruteForce) IndexType() IndexType
IndexType returns IndexType, implementing Index interface
func (*IndexGPUBruteForce) Name ¶ added in v2.4.0
func (i *IndexGPUBruteForce) Name() string
Name returns index type name, implementing Index interface
func (*IndexGPUBruteForce) Params ¶ added in v2.4.0
func (i *IndexGPUBruteForce) Params() map[string]string
Params returns index construction params, implementing Index interface
func (*IndexGPUBruteForce) SupportBinary ¶ added in v2.4.0
func (i *IndexGPUBruteForce) SupportBinary() bool
SupportBinary returns whether index type support binary vector
type IndexGPUBruteForceSearchParam ¶ added in v2.4.0
type IndexGPUBruteForceSearchParam struct {
// contains filtered or unexported fields
}
func NewIndexGPUBruteForceSearchParam ¶ added in v2.4.0
func NewIndexGPUBruteForceSearchParam() (*IndexGPUBruteForceSearchParam, error)
func (*IndexGPUBruteForceSearchParam) AddRadius ¶ added in v2.4.0
func (sp *IndexGPUBruteForceSearchParam) AddRadius(radius float64)
func (*IndexGPUBruteForceSearchParam) AddRangeFilter ¶ added in v2.4.0
func (sp *IndexGPUBruteForceSearchParam) AddRangeFilter(rangeFilter float64)
type IndexGPUCagra ¶ added in v2.4.0
type IndexGPUCagra struct {
// contains filtered or unexported fields
}
IndexGPUCagra index type for GPU Cagra index.
func NewIndexGPUCagra ¶ added in v2.4.0
func NewIndexGPUCagra(metricType MetricType, intermediateGraphDegree, graphDegree int) (*IndexGPUCagra, error)
NewIndexGPUCagra returns an Index with GPU_CAGRA type.
- intermediate_graph_degree: The number of k-nearest neighbors (k) of this intermediate k-NN graph, trade off the quality of the final searchable CAGRA graph;
- graph_degree: CAGRA's optimized graph fixed-degree number;
func (*IndexGPUCagra) IndexType ¶ added in v2.4.0
func (i *IndexGPUCagra) IndexType() IndexType
IndexType returns IndexType, implementing Index interface
func (*IndexGPUCagra) Name ¶ added in v2.4.0
func (i *IndexGPUCagra) Name() string
Name returns index type name, implementing Index interface
func (*IndexGPUCagra) Params ¶ added in v2.4.0
func (i *IndexGPUCagra) Params() map[string]string
Params returns index construction params, implementing Index interface
func (*IndexGPUCagra) SupportBinary ¶ added in v2.4.0
func (i *IndexGPUCagra) SupportBinary() bool
SupportBinary returns whether index type support binary vector
type IndexGPUCagraSearchParam ¶ added in v2.4.0
type IndexGPUCagraSearchParam struct {
// contains filtered or unexported fields
}
func NewIndexGPUCagraSearchParam ¶ added in v2.4.0
func NewIndexGPUCagraSearchParam( itopkSize int, searchWidth int, minIterations int, maxIterations int, teamSize int, ) (*IndexGPUCagraSearchParam, error)
- itopk_size: the main parameter that can be adjusted to trade off search speed, which specifies the size of an internal sorted list that stores the nodes that can be explored in the next iteration; - search_width: the number of the closest parent vertices that are traversed to expand their children in each search iteration; - min_iterations: Lower limit of search iterations; - max_iterations: Upper limit of search iterations. Auto select when 0; - team_size: Number of threads used to calculate a single distance.
func (*IndexGPUCagraSearchParam) AddRadius ¶ added in v2.4.0
func (sp *IndexGPUCagraSearchParam) AddRadius(radius float64)
func (*IndexGPUCagraSearchParam) AddRangeFilter ¶ added in v2.4.0
func (sp *IndexGPUCagraSearchParam) AddRangeFilter(rangeFilter float64)
type IndexGPUIvfFlat ¶ added in v2.3.0
type IndexGPUIvfFlat struct {
// contains filtered or unexported fields
}
IndexGPUIvfFlat idx type for GPU_IVF_FLAT
func NewIndexGPUIvfFlat ¶ added in v2.3.0
func NewIndexGPUIvfFlat(metricType MetricType, nlist int, ) (*IndexGPUIvfFlat, error)
NewIndexGPUIvfFlat create index with construction parameters
func (*IndexGPUIvfFlat) IndexType ¶ added in v2.3.0
func (i *IndexGPUIvfFlat) IndexType() IndexType
IndexType returns IndexType, implementing Index interface
func (*IndexGPUIvfFlat) Name ¶ added in v2.3.0
func (i *IndexGPUIvfFlat) Name() string
Name returns index type name, implementing Index interface
func (*IndexGPUIvfFlat) Params ¶ added in v2.3.0
func (i *IndexGPUIvfFlat) Params() map[string]string
Params returns index construction params, implementing Index interface
func (*IndexGPUIvfFlat) SupportBinary ¶ added in v2.3.0
func (i *IndexGPUIvfFlat) SupportBinary() bool
SupportBinary returns whether index type support binary vector
type IndexGPUIvfFlatSearchParam ¶ added in v2.3.0
type IndexGPUIvfFlatSearchParam struct {
// contains filtered or unexported fields
}
IndexGPUIvfFlatSearchParam search param struct for index type GPU_IVF_FLAT
func NewIndexGPUIvfFlatSearchParam ¶ added in v2.3.0
func NewIndexGPUIvfFlatSearchParam( nprobe int, ) (*IndexGPUIvfFlatSearchParam, error)
NewIndexGPUIvfFlatSearchParam create index search param
func (*IndexGPUIvfFlatSearchParam) AddRadius ¶ added in v2.3.0
func (sp *IndexGPUIvfFlatSearchParam) AddRadius(radius float64)
func (*IndexGPUIvfFlatSearchParam) AddRangeFilter ¶ added in v2.3.0
func (sp *IndexGPUIvfFlatSearchParam) AddRangeFilter(rangeFilter float64)
type IndexGPUIvfPQ ¶ added in v2.3.0
type IndexGPUIvfPQ struct {
// contains filtered or unexported fields
}
IndexGPUIvfPQ idx type for GPU_IVF_PQ
func NewIndexGPUIvfPQ ¶ added in v2.3.0
func NewIndexGPUIvfPQ(metricType MetricType, nlist int, m int, nbits int, ) (*IndexGPUIvfPQ, error)
NewIndexGPUIvfPQ create index with construction parameters
func (*IndexGPUIvfPQ) IndexType ¶ added in v2.3.0
func (i *IndexGPUIvfPQ) IndexType() IndexType
IndexType returns IndexType, implementing Index interface
func (*IndexGPUIvfPQ) Name ¶ added in v2.3.0
func (i *IndexGPUIvfPQ) Name() string
Name returns index type name, implementing Index interface
func (*IndexGPUIvfPQ) Params ¶ added in v2.3.0
func (i *IndexGPUIvfPQ) Params() map[string]string
Params returns index construction params, implementing Index interface
func (*IndexGPUIvfPQ) SupportBinary ¶ added in v2.3.0
func (i *IndexGPUIvfPQ) SupportBinary() bool
SupportBinary returns whether index type support binary vector
type IndexGPUIvfPQSearchParam ¶ added in v2.3.0
type IndexGPUIvfPQSearchParam struct {
// contains filtered or unexported fields
}
IndexGPUIvfPQSearchParam search param struct for index type GPU_IVF_PQ
func NewIndexGPUIvfPQSearchParam ¶ added in v2.3.0
func NewIndexGPUIvfPQSearchParam( nprobe int, ) (*IndexGPUIvfPQSearchParam, error)
NewIndexGPUIvfPQSearchParam create index search param
func (*IndexGPUIvfPQSearchParam) AddRadius ¶ added in v2.3.0
func (sp *IndexGPUIvfPQSearchParam) AddRadius(radius float64)
func (*IndexGPUIvfPQSearchParam) AddRangeFilter ¶ added in v2.3.0
func (sp *IndexGPUIvfPQSearchParam) AddRangeFilter(rangeFilter float64)
type IndexHNSW ¶
type IndexHNSW struct { M int // contains filtered or unexported fields }
IndexHNSW idx type for HNSW
func NewIndexHNSW ¶
func NewIndexHNSW(metricType MetricType, M int, efConstruction int, ) (*IndexHNSW, error)
NewIndexHNSW create index with construction parameters
func (*IndexHNSW) SupportBinary ¶
SupportBinary returns whether index type support binary vector
type IndexHNSWSearchParam ¶
type IndexHNSWSearchParam struct {
// contains filtered or unexported fields
}
IndexHNSWSearchParam search param struct for index type HNSW
func NewIndexHNSWSearchParam ¶
func NewIndexHNSWSearchParam( ef int, ) (*IndexHNSWSearchParam, error)
NewIndexHNSWSearchParam create index search param
func (*IndexHNSWSearchParam) AddRadius ¶ added in v2.3.0
func (sp *IndexHNSWSearchParam) AddRadius(radius float64)
func (*IndexHNSWSearchParam) AddRangeFilter ¶ added in v2.3.0
func (sp *IndexHNSWSearchParam) AddRangeFilter(rangeFilter float64)
type IndexIvfFlat ¶
type IndexIvfFlat struct {
// contains filtered or unexported fields
}
IndexIvfFlat idx type for IVF_FLAT
func NewIndexIvfFlat ¶
func NewIndexIvfFlat(metricType MetricType, nlist int, ) (*IndexIvfFlat, error)
NewIndexIvfFlat create index with construction parameters
func (*IndexIvfFlat) IndexType ¶
func (i *IndexIvfFlat) IndexType() IndexType
IndexType returns IndexType, implementing Index interface
func (*IndexIvfFlat) Name ¶
func (i *IndexIvfFlat) Name() string
Name returns index type name, implementing Index interface
func (*IndexIvfFlat) Params ¶
func (i *IndexIvfFlat) Params() map[string]string
Params returns index construction params, implementing Index interface
func (*IndexIvfFlat) SupportBinary ¶
func (i *IndexIvfFlat) SupportBinary() bool
SupportBinary returns whether index type support binary vector
type IndexIvfFlatSearchParam ¶
type IndexIvfFlatSearchParam struct {
// contains filtered or unexported fields
}
IndexIvfFlatSearchParam search param struct for index type IVF_FLAT
func NewIndexIvfFlatSearchParam ¶
func NewIndexIvfFlatSearchParam( nprobe int, ) (*IndexIvfFlatSearchParam, error)
NewIndexIvfFlatSearchParam create index search param
func (*IndexIvfFlatSearchParam) AddRadius ¶ added in v2.3.0
func (sp *IndexIvfFlatSearchParam) AddRadius(radius float64)
func (*IndexIvfFlatSearchParam) AddRangeFilter ¶ added in v2.3.0
func (sp *IndexIvfFlatSearchParam) AddRangeFilter(rangeFilter float64)
type IndexIvfHNSW ¶
type IndexIvfHNSW struct { M int // contains filtered or unexported fields }
IndexIvfHNSW idx type for IVF_HNSW
func NewIndexIvfHNSW ¶
func NewIndexIvfHNSW(metricType MetricType, nlist int, M int, efConstruction int, ) (*IndexIvfHNSW, error)
NewIndexIvfHNSW create index with construction parameters
func (*IndexIvfHNSW) IndexType ¶
func (i *IndexIvfHNSW) IndexType() IndexType
IndexType returns IndexType, implementing Index interface
func (*IndexIvfHNSW) Name ¶
func (i *IndexIvfHNSW) Name() string
Name returns index type name, implementing Index interface
func (*IndexIvfHNSW) Params ¶
func (i *IndexIvfHNSW) Params() map[string]string
Params returns index construction params, implementing Index interface
func (*IndexIvfHNSW) SupportBinary ¶
func (i *IndexIvfHNSW) SupportBinary() bool
SupportBinary returns whether index type support binary vector
type IndexIvfHNSWSearchParam ¶
type IndexIvfHNSWSearchParam struct {
// contains filtered or unexported fields
}
IndexIvfHNSWSearchParam search param struct for index type IVF_HNSW
func NewIndexIvfHNSWSearchParam ¶
func NewIndexIvfHNSWSearchParam( nprobe int, ef int, ) (*IndexIvfHNSWSearchParam, error)
NewIndexIvfHNSWSearchParam create index search param
func (*IndexIvfHNSWSearchParam) AddRadius ¶ added in v2.3.0
func (sp *IndexIvfHNSWSearchParam) AddRadius(radius float64)
func (*IndexIvfHNSWSearchParam) AddRangeFilter ¶ added in v2.3.0
func (sp *IndexIvfHNSWSearchParam) AddRangeFilter(rangeFilter float64)
type IndexIvfPQ ¶
type IndexIvfPQ struct {
// contains filtered or unexported fields
}
IndexIvfPQ idx type for IVF_PQ
func NewIndexIvfPQ ¶
func NewIndexIvfPQ(metricType MetricType, nlist int, m int, nbits int, ) (*IndexIvfPQ, error)
NewIndexIvfPQ create index with construction parameters
func (*IndexIvfPQ) IndexType ¶
func (i *IndexIvfPQ) IndexType() IndexType
IndexType returns IndexType, implementing Index interface
func (*IndexIvfPQ) Name ¶
func (i *IndexIvfPQ) Name() string
Name returns index type name, implementing Index interface
func (*IndexIvfPQ) Params ¶
func (i *IndexIvfPQ) Params() map[string]string
Params returns index construction params, implementing Index interface
func (*IndexIvfPQ) SupportBinary ¶
func (i *IndexIvfPQ) SupportBinary() bool
SupportBinary returns whether index type support binary vector
type IndexIvfPQSearchParam ¶
type IndexIvfPQSearchParam struct {
// contains filtered or unexported fields
}
IndexIvfPQSearchParam search param struct for index type IVF_PQ
func NewIndexIvfPQSearchParam ¶
func NewIndexIvfPQSearchParam( nprobe int, ) (*IndexIvfPQSearchParam, error)
NewIndexIvfPQSearchParam create index search param
func (*IndexIvfPQSearchParam) AddRadius ¶ added in v2.3.0
func (sp *IndexIvfPQSearchParam) AddRadius(radius float64)
func (*IndexIvfPQSearchParam) AddRangeFilter ¶ added in v2.3.0
func (sp *IndexIvfPQSearchParam) AddRangeFilter(rangeFilter float64)
type IndexIvfSQ8 ¶
type IndexIvfSQ8 struct {
// contains filtered or unexported fields
}
IndexIvfSQ8 idx type for IVF_SQ8
func NewIndexIvfSQ8 ¶
func NewIndexIvfSQ8(metricType MetricType, nlist int, ) (*IndexIvfSQ8, error)
NewIndexIvfSQ8 create index with construction parameters
func (*IndexIvfSQ8) IndexType ¶
func (i *IndexIvfSQ8) IndexType() IndexType
IndexType returns IndexType, implementing Index interface
func (*IndexIvfSQ8) Name ¶
func (i *IndexIvfSQ8) Name() string
Name returns index type name, implementing Index interface
func (*IndexIvfSQ8) Params ¶
func (i *IndexIvfSQ8) Params() map[string]string
Params returns index construction params, implementing Index interface
func (*IndexIvfSQ8) SupportBinary ¶
func (i *IndexIvfSQ8) SupportBinary() bool
SupportBinary returns whether index type support binary vector
type IndexIvfSQ8SearchParam ¶
type IndexIvfSQ8SearchParam struct {
// contains filtered or unexported fields
}
IndexIvfSQ8SearchParam search param struct for index type IVF_SQ8
func NewIndexIvfSQ8SearchParam ¶
func NewIndexIvfSQ8SearchParam( nprobe int, ) (*IndexIvfSQ8SearchParam, error)
NewIndexIvfSQ8SearchParam create index search param
func (*IndexIvfSQ8SearchParam) AddRadius ¶ added in v2.3.0
func (sp *IndexIvfSQ8SearchParam) AddRadius(radius float64)
func (*IndexIvfSQ8SearchParam) AddRangeFilter ¶ added in v2.3.0
func (sp *IndexIvfSQ8SearchParam) AddRangeFilter(rangeFilter float64)
type IndexSCANN ¶ added in v2.3.0
type IndexSCANN struct {
// contains filtered or unexported fields
}
IndexSCANN idx type for SCANN
func NewIndexSCANN ¶ added in v2.3.0
func NewIndexSCANN(metricType MetricType, nlist int, with_raw_data bool, ) (*IndexSCANN, error)
NewIndexSCANN create index with construction parameters
func (*IndexSCANN) IndexType ¶ added in v2.3.0
func (i *IndexSCANN) IndexType() IndexType
IndexType returns IndexType, implementing Index interface
func (*IndexSCANN) Name ¶ added in v2.3.0
func (i *IndexSCANN) Name() string
Name returns index type name, implementing Index interface
func (*IndexSCANN) Params ¶ added in v2.3.0
func (i *IndexSCANN) Params() map[string]string
Params returns index construction params, implementing Index interface
func (*IndexSCANN) SupportBinary ¶ added in v2.3.0
func (i *IndexSCANN) SupportBinary() bool
SupportBinary returns whether index type support binary vector
type IndexSCANNSearchParam ¶ added in v2.3.0
type IndexSCANNSearchParam struct {
// contains filtered or unexported fields
}
IndexSCANNSearchParam search param struct for index type SCANN
func NewIndexSCANNSearchParam ¶ added in v2.3.0
func NewIndexSCANNSearchParam( nprobe int, reorder_k int, ) (*IndexSCANNSearchParam, error)
NewIndexSCANNSearchParam create index search param
func (*IndexSCANNSearchParam) AddRadius ¶ added in v2.3.0
func (sp *IndexSCANNSearchParam) AddRadius(radius float64)
func (*IndexSCANNSearchParam) AddRangeFilter ¶ added in v2.3.0
func (sp *IndexSCANNSearchParam) AddRangeFilter(rangeFilter float64)
type IndexSparseInverted ¶ added in v2.4.0
type IndexSparseInverted struct {
// contains filtered or unexported fields
}
IndexSparseInverted index type for SPARSE_INVERTED_INDEX
func NewIndexSparseInverted ¶ added in v2.4.0
func NewIndexSparseInverted(metricType MetricType, dropRatio float64) (*IndexSparseInverted, error)
IndexSparseInverted index type for SPARSE_INVERTED_INDEX
func (*IndexSparseInverted) IndexType ¶ added in v2.4.0
func (i *IndexSparseInverted) IndexType() IndexType
func (*IndexSparseInverted) Name ¶ added in v2.4.0
func (i *IndexSparseInverted) Name() string
func (*IndexSparseInverted) Params ¶ added in v2.4.0
func (i *IndexSparseInverted) Params() map[string]string
type IndexSparseInvertedSearchParam ¶ added in v2.4.0
type IndexSparseInvertedSearchParam struct {
// contains filtered or unexported fields
}
func NewIndexSparseInvertedSearchParam ¶ added in v2.4.0
func NewIndexSparseInvertedSearchParam(dropRatio float64) (*IndexSparseInvertedSearchParam, error)
func (*IndexSparseInvertedSearchParam) AddRadius ¶ added in v2.4.0
func (sp *IndexSparseInvertedSearchParam) AddRadius(radius float64)
func (*IndexSparseInvertedSearchParam) AddRangeFilter ¶ added in v2.4.0
func (sp *IndexSparseInvertedSearchParam) AddRangeFilter(rangeFilter float64)
type IndexSparseWAND ¶ added in v2.4.0
type IndexSparseWAND struct {
// contains filtered or unexported fields
}
func NewIndexSparseWAND ¶ added in v2.4.0
func NewIndexSparseWAND(metricType MetricType, dropRatio float64) (*IndexSparseWAND, error)
IndexSparseWAND index type for SPARSE_WAND, weak-and
func (*IndexSparseWAND) IndexType ¶ added in v2.4.0
func (i *IndexSparseWAND) IndexType() IndexType
func (*IndexSparseWAND) Name ¶ added in v2.4.0
func (i *IndexSparseWAND) Name() string
func (*IndexSparseWAND) Params ¶ added in v2.4.0
func (i *IndexSparseWAND) Params() map[string]string
type IndexSparseWANDSearchParam ¶ added in v2.4.0
type IndexSparseWANDSearchParam struct {
// contains filtered or unexported fields
}
func NewIndexSparseWANDSearchParam ¶ added in v2.4.0
func NewIndexSparseWANDSearchParam(dropRatio float64) (*IndexSparseWANDSearchParam, error)
func (*IndexSparseWANDSearchParam) AddRadius ¶ added in v2.4.0
func (sp *IndexSparseWANDSearchParam) AddRadius(radius float64)
func (*IndexSparseWANDSearchParam) AddRangeFilter ¶ added in v2.4.0
func (sp *IndexSparseWANDSearchParam) AddRangeFilter(rangeFilter float64)
type IndexType ¶
type IndexType string
IndexType index type
const ( Flat IndexType = "FLAT" //faiss BinFlat IndexType = "BIN_FLAT" IvfFlat IndexType = "IVF_FLAT" //faiss BinIvfFlat IndexType = "BIN_IVF_FLAT" IvfPQ IndexType = "IVF_PQ" //faiss IvfSQ8 IndexType = "IVF_SQ8" HNSW IndexType = "HNSW" IvfHNSW IndexType = "IVF_HNSW" AUTOINDEX IndexType = "AUTOINDEX" DISKANN IndexType = "DISKANN" SCANN IndexType = "SCANN" GPUIvfFlat IndexType = "GPU_IVF_FLAT" GPUIvfPQ IndexType = "GPU_IVF_PQ" GPUCagra IndexType = "GPU_CAGRA" GPUBruteForce IndexType = "GPU_BRUTE_FORCE" // Sparse SparseInverted IndexType = "SPARSE_INVERTED_INDEX" SparseWAND IndexType = "SPARSE_WAND" // DEPRECATED Scalar IndexType = "" Trie IndexType = "Trie" Sorted IndexType = "STL_SORT" Inverted IndexType = "INVERTED" Bitmap IndexType = "BITMAP" )
Index Constants
type MapRow ¶ added in v2.2.3
type MapRow map[string]interface{}
MapRow is the alias type for map[string]interface{} implementing `Row` inteface with empty methods.
func (MapRow) Collection ¶ added in v2.2.3
func (MapRow) Description ¶ added in v2.2.3
type MessageInfo ¶ added in v2.3.3
type MessageInfo struct {
Position string
}
type MetricType ¶
type MetricType string
MetricType metric type
const ( L2 MetricType = "L2" IP MetricType = "IP" COSINE MetricType = "COSINE" HAMMING MetricType = "HAMMING" JACCARD MetricType = "JACCARD" TANIMOTO MetricType = "TANIMOTO" SUBSTRUCTURE MetricType = "SUBSTRUCTURE" SUPERSTRUCTURE MetricType = "SUPERSTRUCTURE" )
Metric Constants
type MilvusState ¶ added in v2.3.2
type MilvusState struct { IsHealthy bool Reasons []string QuotaStates []QuotaState }
type OperatePrivilegeOpt ¶ added in v2.4.2
type OperatePrivilegeOption ¶ added in v2.4.2
type OperatePrivilegeOption func(o *OperatePrivilegeOpt)
func WithOperatePrivilegeBase ¶ added in v2.4.2
func WithOperatePrivilegeBase(base *common.MsgBase) OperatePrivilegeOption
func WithOperatePrivilegeDatabase ¶ added in v2.4.2
func WithOperatePrivilegeDatabase(database string) OperatePrivilegeOption
type Partition ¶
type Partition struct { ID int64 // partition id Name string // partition name Loaded bool // partition loaded }
Partition represent partition meta in Milvus
type PriviledgeObjectType ¶ added in v2.2.0
type PriviledgeObjectType common.ObjectType
PriviledgeObjectType is an alias of common.ObjectType. used in RBAC related API.
const ( // PriviledegeObjectTypeCollection const value for collection. PriviledegeObjectTypeCollection PriviledgeObjectType = PriviledgeObjectType(common.ObjectType_Collection) // PriviledegeObjectTypeUser const value for user. PriviledegeObjectTypeUser PriviledgeObjectType = PriviledgeObjectType(common.ObjectType_User) // PriviledegeObjectTypeGlobal const value for Global. PriviledegeObjectTypeGlobal PriviledgeObjectType = PriviledgeObjectType(common.ObjectType_Global) )
type QuotaState ¶ added in v2.3.2
type QuotaState int32
const ( // QuotaStateUnknown zero value placeholder QuotaStateUnknown QuotaState = 0 // QuotaStateReadLimited too many read tasks, read requests are limited QuotaStateReadLimited QuotaState = 2 // QuotaStateWriteLimited too many write tasks, write requests are limited QuotaStateWriteLimited QuotaState = 3 // QuotaStateDenyToRead too many read tasks, temporarily unable to process read requests QuotaStateDenyToRead QuotaState = 4 // QuotaStateDenyToWrite too many write tasks, temporarily unable to process write requests QuotaStateDenyToWrite QuotaState = 5 )
type RBACMeta ¶ added in v2.4.2
type RBACMeta struct { Users []*UserInfo Roles []*Role RoleGrants []*RoleGrants }
type ReplicaGroup ¶ added in v2.1.0
type ReplicaGroup struct { ReplicaID int64 NodeIDs []int64 ShardReplicas []*ShardReplica }
ReplicaGroup represents a replica group
type ResourceGroup ¶ added in v2.2.1
type ResourceGroup struct { Name string Capacity int32 AvailableNodesNumber int32 LoadedReplica map[string]int32 OutgoingNodeNum map[string]int32 IncomingNodeNum map[string]int32 Config *ResourceGroupConfig Nodes []*NodeInfo }
ResourceGroup information model struct.
type ResourceGroupConfig ¶ added in v2.4.2
type ResourceGroupConfig = rgpb.ResourceGroupConfig
type ResourceGroupLimit ¶ added in v2.4.2
type ResourceGroupLimit = rgpb.ResourceGroupLimit
type ResourceGroupTransfer ¶ added in v2.4.2
type ResourceGroupTransfer = rgpb.ResourceGroupTransfer
type Role ¶ added in v2.2.0
type Role struct {
Name string
}
Role is the model for RBAC role object.
type RoleGrants ¶ added in v2.4.1
type RoleGrants struct { Object string ObjectName string RoleName string GrantorName string PrivilegeName string DbName string }
RoleGrants is the model for RBAC role description object.
type RowBase ¶
type RowBase struct{}
RowBase row base, returns default collection, partition name which is empty string
func (RowBase) Collection ¶
Collection row base default collection name, which is empty string when empty string is passed, the parent struct type name is used
func (RowBase) Description ¶
Description implement Row interface, default value is empty string
type Schema ¶
type Schema struct { CollectionName string Description string AutoID bool Fields []*Field EnableDynamicField bool // contains filtered or unexported fields }
Schema represents schema info of collection in milvus
func ParseSchema ¶
ParseSchema parse Schema from row interface
func ParseSchemaAny ¶ added in v2.2.3
ParseSchemaAny parses schema from interface{}.
func (*Schema) PKFieldName ¶ added in v2.2.3
PKFieldName returns pk field name for this schema.
func (*Schema) ProtoMessage ¶
func (s *Schema) ProtoMessage() *schema.CollectionSchema
ProtoMessage returns corresponding server.CollectionSchema
func (*Schema) ReadProto ¶
func (s *Schema) ReadProto(p *schema.CollectionSchema) *Schema
ReadProto parses proto Collection Schema
func (*Schema) WithAutoID ¶ added in v2.2.3
func (*Schema) WithDescription ¶ added in v2.2.3
WithDescription sets the description value of schema, returns schema itself.
func (*Schema) WithDynamicFieldEnabled ¶ added in v2.2.3
type SearchParam ¶
type SearchParam interface { // returns parameters for search/query Params() map[string]interface{} AddRadius(radius float64) AddRangeFilter(rangeFilter float64) }
SearchParam interface for index related search param
type Segment ¶
type Segment struct { ID int64 CollectionID int64 ParititionID int64 IndexID int64 NumRows int64 State common.SegmentState }
Segment represent segment in milvus
type ShardReplica ¶ added in v2.1.0
ShardReplica represents a shard in the ReplicaGroup
type SparseEmbedding ¶ added in v2.4.0
type SparseEmbedding interface { Dim() int // the dimension Len() int // the actual items in this vector Get(idx int) (pos uint32, value float32, ok bool) Serialize() []byte FieldType() FieldType }
func NewSliceSparseEmbedding ¶ added in v2.4.0
func NewSliceSparseEmbedding(positions []uint32, values []float32) (SparseEmbedding, error)
type User ¶ added in v2.2.0
type User struct {
Name string
}
User is the model for RBAC user object.
type UserDescription ¶ added in v2.4.0
UserDescription is the model for RBAC user description object.
type UserInfo ¶ added in v2.4.2
type UserInfo struct { UserDescription Password string }
Source Files ¶
- bulkinsert.go
- check_health.go
- collection.go
- collection_attr.go
- columns.go
- columns_array.go
- columns_array_gen.go
- columns_conversion.go
- columns_dynamic.go
- columns_json.go
- columns_scalar_gen.go
- columns_sparse.go
- columns_varchar.go
- columns_vector_gen.go
- compaction.go
- database.go
- index.go
- index_cagra.go
- index_scalar.go
- index_sparse.go
- indexes_gen.go
- indexes_search_param_gen.go
- load.go
- mq_message.go
- rbac.go
- resource_group.go
- rows.go
- schema.go
- segment.go