milvus

package
v0.4.4 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Aug 15, 2020 License: Apache-2.0 Imports: 6 Imported by: 1

Documentation

Overview

package milvus

package milvus

package milvus

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type CollectionParam 

type CollectionParam struct {
	// CollectionName collection name
	CollectionName string
	// Dimension Entity dimension, must be a positive value
	Dimension int64
	// IndexFileSize Index file size, must be a positive value
	IndexFileSize int64
	// MetricType Index metric type
	MetricType int64
}

CollectionParam informations of a collection

type ConnectParam 

type ConnectParam struct {
	// IPAddress Server IP address
	IPAddress string
	// Port Server port
	Port string
}

ConnectParam Parameters for connect

type Entity 

type Entity struct {
	FloatData  []float32
	BinaryData []byte
}

Entity record typy

type ErrorCode 

type ErrorCode int64

ErrorCode error code 

const (
	// OK status
	OK ErrorCode = 0

	// UnKnownError unknow error
	UnKnownError ErrorCode = 1
	// NotSupported not supported operation
	NotSupported ErrorCode = 2
	// NotConnected not connected
	NotConnected ErrorCode = 3

	// RPCFailed rpc failed
	RPCFailed ErrorCode = 4
	// ServerFailed server failed
	ServerFailed ErrorCode = 5
)

type IndexParam 

type IndexParam struct {
	// CollectionName collection name for create index
	CollectionName string
	// IndexType create index type
	IndexType IndexType
	// ExtraParams extra parameters
	// 	Note: extra_params is extra parameters list, it must be json format
	//        For different index type, parameter list is different accordingly, for example:
	//        FLAT/IVFLAT/SQ8:  "{nlist: '16384'}"
	//            ///< nlist range:[1, 999999]
	//        IVFPQ:  "{nlist: '16384', m: "12"}"
	//            ///< nlist range:[1, 999999]
	//            ///< m is decided by dim and have a couple of results.
	//        NSG:  "{search_length: '45', out_degree:'50', candidate_pool_size:'300', "knng":'100'}"
	//            ///< search_length range:[10, 300]
	//            ///< out_degree range:[5, 300]
	//            ///< candidate_pool_size range:[50, 1000]
	//            ///< knng range:[5, 300]
	//        HNSW  "{M: '16', efConstruction:'500'}"
	//            ///< M range:[5, 48]
	//            ///< efConstruction range:[topk, 4096]
	ExtraParams string
}

IndexParam index parameters

type IndexType 

type IndexType int64

IndexType index type 

const (
	// INVALID invald index type
	INVALID IndexType = 0
	// FLAT flat
	FLAT IndexType = 1
	// IVFFLAT ivfflat
	IVFFLAT IndexType = 2
	// IVFSQ8 ivfsq8
	IVFSQ8 IndexType = 3
	//RNSG rnsg
	RNSG IndexType = 4
	// IVFSQ8H ivfsq8h
	IVFSQ8H IndexType = 5
	// IVFPQ ivfpq
	IVFPQ IndexType = 6
	// SPTAGKDT sptagkdt
	SPTAGKDT IndexType = 7
	// SPTAGBKT sptagbkt
	SPTAGBKT IndexType = 8
	// HNSW hnsw
	HNSW IndexType = 11
	// ANNOY annoy
	ANNOY IndexType = 12
)

type InsertParam 

type InsertParam struct {
	// CollectionName collection name
	CollectionName string
	// PartitionTag partition tag
	PartitionTag string
	// RecordArray raw entities array
	RecordArray []Entity
	// IDArray id array
	IDArray []int64
}

InsertParam insert parameters

type ListIDInSegmentParam added in v0.4.0 

type ListIDInSegmentParam struct {
	CollectionName string
	SegmentName    string
}

type MetricType 

type MetricType int64

MetricType metric type 

const (
	// L2 euclidean distance
	L2 MetricType = 1
	// IP inner product
	IP MetricType = 2
	// HAMMING hamming distance
	HAMMING MetricType = 3
	// JACCARD jaccard distance
	JACCARD MetricType = 4
	// TANIMOTO tanimoto distance
	TANIMOTO MetricType = 5
	// SUBSTRUCTURE substructure distance
	SUBSTRUCTURE MetricType = 6
	// SUPERSTRUCTURE superstructure
	SUPERSTRUCTURE MetricType = 7
)

type MilvusClient 

type MilvusClient interface {

	// GetClientVersion method
	// This method is used to give the client version.
	// return Client version.
	GetClientVersion() string

	// Connect method
	// Create a connection instance and return it's shared pointer
	// return indicate if connect is successful
	Connect(connectParam ConnectParam) error

	// IsConnected method
	// This method is used to test whether server is connected
	// return indicate if connection status
	IsConnected() bool

	// Disconnect method
	// This method is used to disconnect server
	// return indicate if disconnect is successful
	Disconnect() error

	// CreateCollection method
	// This method is used to create collection
	// param collectionParam is used to provide collection information to be created.
	// return indicate if collection is created successfully
	CreateCollection(collectionParam CollectionParam) (Status, error)

	// HasCollection method
	// This method is used to create collection.
	//return indicate if collection is exist
	HasCollection(collectionName string) (bool, Status, error)

	// DropCollection method
	// This method is used to drop collection(and its partitions).
	// return indicate if collection is drop successfully.
	DropCollection(collectionName string) (Status, error)

	// CreateIndex method
	// This method is used to create index for whole collection(and its partitions).
	// return indicate if build index successfully.
	CreateIndex(indexParam *IndexParam) (Status, error)

	// Insert method
	// This method is used to query entity in collection.
	// return indicate if insert is successful.
	Insert(insertParam *InsertParam) ([]int64, Status, error)

	// GetEntityByID method
	// This method is used to get entity by entity id
	// return entity data
	GetEntityByID(collectionName string, entity_id []int64) ([]Entity, Status, error)

	// ListIDInSegment method
	// This method is used to get entity ids
	// return entity ids
	ListIDInSegment(listIDInSegmentParam ListIDInSegmentParam) ([]int64, Status, error)

	// Search method
	// This method is used to query entity in collection.
	// return indicate if query is successful.
	Search(searchParam SearchParam) (TopkQueryResult, Status, error)

	// DeleteEntityByID method
	// This method is used to delete entities by ids
	// return indicate if delete is successful
	DeleteEntityByID(collectionName string, id_array []int64) (Status, error)

	// GetCollectionInfo method
	// This method is used to show collection information.
	//return indicate if this operation is successful.
	GetCollectionInfo(collectionName string) (CollectionParam, Status, error)

	// CountEntities method
	// This method is used to get collection row count.
	// return indicate if this operation is successful.
	CountEntities(collectionName string) (int64, Status, error)

	// ListCollections method
	// This method is used to list all collections.
	// return indicate if this operation is successful.
	ListCollections() ([]string, Status, error)

	// GetCollectionStats method
	// This method is used to get collection informations
	// return collection informations
	GetCollectionStats(collectionName string) (string, Status, error)

	// ServerVersion method
	// This method is used to give the server version.
	// return server version.
	ServerVersion() (string, Status, error)

	// ServerStatus method
	// This method is used to give the server status.
	// return server status.
	ServerStatus() (string, Status, error)

	// LoadCollection method
	// This method is used to preload collection
	// return indicate if this operation is successful.
	LoadCollection(collectionName string) (Status, error)

	// GetIndexInfo method
	// This method is used to describe index
	// return indicate if this operation is successful.
	GetIndexInfo(collectionName string) (IndexParam, Status, error)

	// DropIndex method
	// This method is used to drop index of collection(and its partitions)
	// return indicate if this operation is successful.
	DropIndex(collectionName string) (Status, error)

	// CreatePartition method
	// This method is used to create collection partition
	// return indicate if partition is created successfully
	CreatePartition(partitionParam PartitionParam) (Status, error)

	// ListPartitions method
	// This method is used to create collection
	// return indicate if this operation is successful
	ListPartitions(collectionName string) ([]PartitionParam, Status, error)

	// DropPartition method
	// This method is used to delete collection partition.
	// return indicate if partition is delete successfully.
	DropPartition(partitionParam PartitionParam) (Status, error)

	// GetConfig
	// This method is used to get config
	// return indicate if this operation is successful.
	GetConfig(nodeName string) (string, Status, error)

	// SetConfig
	// This method is used to set config
	// return indicate if this operation is successful.
	SetConfig(nodeName string, value string) (Status, error)

	// Flush method
	// This method is used to flush collections
	// return indicate if flush is successful
	Flush(collectionNameArray []string) (Status, error)

	// Compact method
	// This method is used to compact collection
	// return indicate if compact is successful
	Compact(collectionName string) (Status, error)
}

MilvusClient SDK main interface

func NewMilvusClient 

func NewMilvusClient(client MilvusGrpcClient) MilvusClient

NewMilvusClient is the constructor of MilvusClient

type MilvusGrpcClient 

type MilvusGrpcClient interface {
	CreateCollection(collectionSchema pb.CollectionSchema) (pb.Status, error)

	HasCollection(collectionName pb.CollectionName) (pb.BoolReply, error)

	DescribeCollection(collectionName pb.CollectionName) (pb.CollectionSchema, error)

	CountCollection(collectionName pb.CollectionName) (pb.CollectionRowCount, error)

	ShowCollections() (pb.CollectionNameList, error)

	ShowCollectionInfo(collectionName pb.CollectionName) (pb.CollectionInfo, error)

	DropCollection(collectionName pb.CollectionName) (pb.Status, error)

	CreateIndex(indexParam pb.IndexParam) (pb.Status, error)

	DescribeIndex(collectionName pb.CollectionName) (pb.IndexParam, error)

	DropIndex(collectionName pb.CollectionName) (pb.Status, error)

	CreatePartition(partitionParam pb.PartitionParam) (pb.Status, error)

	ShowPartitions(collectionName pb.CollectionName) (pb.PartitionList, error)

	DropPartition(partitionParam pb.PartitionParam) (pb.Status, error)

	Insert(insertParam pb.InsertParam) (pb.VectorIds, error)

	GetVectorsByID(identity pb.VectorsIdentity) (pb.VectorsData, error)

	GetVectorIDs(param pb.GetVectorIDsParam) (pb.VectorIds, error)

	Search(searchParam pb.SearchParam) (*pb.TopKQueryResult, error)

	SearchInFiles(searchInFilesParam pb.SearchInFilesParam) (*pb.TopKQueryResult, error)

	Cmd(command pb.Command) (pb.StringReply, error)

	DeleteByID(param pb.DeleteByIDParam) (pb.Status, error)

	PreloadCollection(collectionName pb.CollectionName) (pb.Status, error)

	Flush(param pb.FlushParam) (pb.Status, error)

	Compact(name pb.CollectionName) (pb.Status, error)
}

MilvusGrpcClient call grpc generated code interface

func NewMilvusGrpcClient 

func NewMilvusGrpcClient(client pb.MilvusServiceClient) MilvusGrpcClient

NewMilvusGrpcClient is the constructor of MilvusGrpcClient

type Milvusclient 

type Milvusclient struct {
	Instance MilvusGrpcClient
}

func (*Milvusclient) Compact 

func (client *Milvusclient) Compact(collectionName string) (Status, error)

func (*Milvusclient) Connect 

func (client *Milvusclient) Connect(connectParam ConnectParam) error

func (*Milvusclient) CountEntities added in v0.4.0 

func (client *Milvusclient) CountEntities(collectionName string) (int64, Status, error)

func (*Milvusclient) CreateCollection 

func (client *Milvusclient) CreateCollection(collectionParam CollectionParam) (Status, error)

func (*Milvusclient) CreateIndex 

func (client *Milvusclient) CreateIndex(indexParam *IndexParam) (Status, error)

func (*Milvusclient) CreatePartition 

func (client *Milvusclient) CreatePartition(partitionParam PartitionParam) (Status, error)

func (*Milvusclient) DeleteEntityByID added in v0.4.0 

func (client *Milvusclient) DeleteEntityByID(collectionName string, id_array []int64) (Status, error)

func (*Milvusclient) Disconnect 

func (client *Milvusclient) Disconnect() error

func (*Milvusclient) DropCollection 

func (client *Milvusclient) DropCollection(collectionName string) (Status, error)

func (*Milvusclient) DropIndex 

func (client *Milvusclient) DropIndex(collectionName string) (Status, error)

func (*Milvusclient) DropPartition 

func (client *Milvusclient) DropPartition(partitionParam PartitionParam) (Status, error)

func (*Milvusclient) Flush 

func (client *Milvusclient) Flush(collectionNameArray []string) (Status, error)

func (*Milvusclient) GetClientVersion 

func (client *Milvusclient) GetClientVersion() string

func (*Milvusclient) GetCollectionInfo added in v0.4.0 

func (client *Milvusclient) GetCollectionInfo(collectionName string) (CollectionParam, Status, error)

func (*Milvusclient) GetCollectionStats added in v0.4.0 

func (client *Milvusclient) GetCollectionStats(collectionName string) (string, Status, error)

func (*Milvusclient) GetConfig 

func (client *Milvusclient) GetConfig(nodeName string) (string, Status, error)

func (*Milvusclient) GetEntityByID 

func (client *Milvusclient) GetEntityByID(collectionName string, vector_id []int64) ([]Entity, Status, error)

func (*Milvusclient) GetIndexInfo added in v0.4.0 

func (client *Milvusclient) GetIndexInfo(collectionName string) (IndexParam, Status, error)

func (*Milvusclient) HasCollection 

func (client *Milvusclient) HasCollection(collectionName string) (bool, Status, error)

func (*Milvusclient) Insert 

func (client *Milvusclient) Insert(insertParam *InsertParam) ([]int64, Status, error)

func (*Milvusclient) IsConnected 

func (client *Milvusclient) IsConnected() bool

func (*Milvusclient) ListCollections added in v0.4.0 

func (client *Milvusclient) ListCollections() ([]string, Status, error)

func (*Milvusclient) ListIDInSegment added in v0.4.0 

func (client *Milvusclient) ListIDInSegment(listIDInSegmentParam ListIDInSegmentParam) ([]int64, Status, error)

func (*Milvusclient) ListPartitions added in v0.4.0 

func (client *Milvusclient) ListPartitions(collectionName string) ([]PartitionParam, Status, error)

func (*Milvusclient) LoadCollection added in v0.4.0 

func (client *Milvusclient) LoadCollection(collectionName string) (Status, error)

func (*Milvusclient) Search 

func (client *Milvusclient) Search(searchParam SearchParam) (TopkQueryResult, Status, error)

func (*Milvusclient) ServerStatus 

func (client *Milvusclient) ServerStatus() (string, Status, error)

func (*Milvusclient) ServerVersion 

func (client *Milvusclient) ServerVersion() (string, Status, error)

func (*Milvusclient) SetConfig 

func (client *Milvusclient) SetConfig(nodeName string, value string) (Status, error)

type PartitionParam 

type PartitionParam struct {
	// CollectionName partition collection name
	CollectionName string
	// PartitionTag partition tag
	PartitionTag string
}

PartitionParam partition parameters

type PartitionStat 

type PartitionStat struct {
	// Tag partition tag
	Tag string
	// RowCount row count of partition
	RowCount int64
	// SegmentsStat array of partition's SegmentStat
	SegmentsStat []SegmentStat
}

PartitionStat

type QueryResult 

type QueryResult struct {
	// Ids id array
	Ids []int64
	// Distances distance array
	Distances []float32
}

QueryResult Query result

type Range 

type Range struct {
	// StartValue Range start
	StartValue string
	// EndValue Range stop
	EndValue string
}

Range range information, for DATE range, the format is like: 'year-month-day'

type SearchParam 

type SearchParam struct {
	// CollectionName collection name for search
	CollectionName string
	// QueryEntities query entities raw array
	QueryEntities []Entity
	// Topk topk
	Topk int64
	// PartitionTag partition tag array
	PartitionTag []string
	// ExtraParams extra parameters
	//  Note: extra_params is extra parameters list, it must be json format, for example:
	//	 	  For different index type, parameter list is different accordingly
	//		  FLAT/IVFLAT/SQ8/IVFPQ:  "{nprobe: '32'}"
	//			  ///< nprobe range:[1,999999]
	// 		  NSG:  "{search_length:'100'}
	//	 	 	  ///< search_length range:[10, 300]
	//		  HNSW  "{ef: '64'}
	//		 	  ///< ef range:[k, 4096]
	ExtraParams string
}

SearchParam search parameters

type SegmentStat 

type SegmentStat struct {
	// SegmentName segment name
	SegmentName string
	// RowCount segment row count
	RowCount int64
	// IndexName index name
	IndexName string
	//DataSize data size
	DataSize int64
}

SegmentStat segment statistics

type Status 

type Status interface {
	Ok() bool
	GetStatus() status
	GetMessage() string
}

Status for SDK interface return

func NewStatus 

func NewStatus(_status status) Status

NewStatus constructor of Status

func NewStatus1 

func NewStatus1(errorCode ErrorCode, state string) Status

NewStatus1 constructor of Status

type TopkQueryResult 

type TopkQueryResult struct {
	// QueryResultList query result list
	QueryResultList []QueryResult
}

TopkQueryResult Topk query result

Source Files

View all Source files

Directories

Path Synopsis
grpc
gen

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.