Add fieldName in index

Signed-off-by: wayblink <[email protected]>
milvus-io · Nov 1, 2023 · 8f26de9 · 8f26de9
1 parent 18efb15
commit 8f26de9
Show file tree

Hide file tree

Showing 15 changed files with 3,126 additions and 670 deletions.
diff --git a/client/collection.go b/client/collection.go
@@ -112,7 +112,7 @@ func (c *GrpcClient) NewCollection(ctx context.Context, collName string, dimensi
 		return err
 	}
 
-	idx := entity.NewGenericIndex("", "", map[string]string{
+	idx := entity.NewGenericIndex("", "", "", map[string]string{
 		"metric_type": string(opt.MetricsType),
 	})
 

diff --git a/client/index.go b/client/index.go
@@ -149,8 +149,9 @@ func (c *GrpcClient) DescribeIndex(ctx context.Context, collName string, fieldNa
 		params := entity.KvPairsMap(info.Params)
 		it := params["index_type"] // TODO change to const
 		idx := entity.NewGenericIndex(
-			info.IndexName,
+			info.GetIndexName(),
 			entity.IndexType(it),
+			info.GetFieldName(),
 			params,
 		)
 		indexes = append(indexes, idx)

diff --git a/entity/genidx/genidx.go b/entity/genidx/genidx.go
@@ -1,6 +1,3 @@
-//go:build ignore
-// +build ignore
-
 // Copyright (C) 2019-2021 Zilliz. All rights reserved.
 //
 // Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance
@@ -55,6 +52,11 @@ func(i *Index{{.IdxName}}) IndexType() IndexType {
 	return IndexType("{{.IdxType}}")
 }
 
+// FieldName returns FieldName, implementing Index interface
+func(i *Index{{.IdxName}}) FieldName() string {
+	return "{{.FieldName}}"
+}
+
 // SupportBinary returns whether index type support binary vector
 func(i *Index{{.IdxName}}) SupportBinary() bool {
 	return {{.VectorSupport}} & 2 > 0
@@ -223,6 +225,7 @@ func TestIndex{{.IdxName}}SearchParam(t *testing.T) {
 type idxDef struct {
 	IdxName             string
 	IdxType             entity.IndexType
+	FieldName           string
 	VectorSupport       int8
 	ConstructParams     []idxParam
 	SearchParams        []idxParam
@@ -329,6 +332,7 @@ func main() {
 			{
 				IdxName:         "Flat",
 				IdxType:         entity.Flat,
+				FieldName:       "vec_field",
 				ConstructParams: []idxParam{},
 				SearchParams:    []idxParam{},
 				ValidExamples: []string{
@@ -344,6 +348,7 @@ func main() {
 			{
 				IdxName:       "BinFlat",
 				IdxType:       entity.BinFlat,
+				FieldName:     "vec_field",
 				VectorSupport: int8(binaryVectorSupport),
 				ConstructParams: []idxParam{
 					{
@@ -374,8 +379,9 @@ func main() {
 			},
 			// IVF_FLAT
 			{
-				IdxName: "IvfFlat",
-				IdxType: entity.IvfFlat,
+				IdxName:   "IvfFlat",
+				IdxType:   entity.IvfFlat,
+				FieldName: "vec_field",
 				ConstructParams: []idxParam{
 					{
 						Name:           "nlist",
@@ -407,6 +413,7 @@ func main() {
 			{
 				IdxName:       "BinIvfFlat",
 				IdxType:       entity.BinIvfFlat,
+				FieldName:     "vec_field",
 				VectorSupport: int8(binaryVectorSupport),
 				ConstructParams: []idxParam{
 					{
@@ -437,8 +444,9 @@ func main() {
 			},
 			// IVF_SQ8
 			{
-				IdxName: "IvfSQ8",
-				IdxType: entity.IvfSQ8,
+				IdxName:   "IvfSQ8",
+				IdxType:   entity.IvfSQ8,
+				FieldName: "vec_field",
 				ConstructParams: []idxParam{
 					{
 						Name:           "nlist",
@@ -468,8 +476,9 @@ func main() {
 			},
 			// IVF_PQ
 			{
-				IdxName: "IvfPQ",
-				IdxType: entity.IvfPQ,
+				IdxName:   "IvfPQ",
+				IdxType:   entity.IvfPQ,
+				FieldName: "vec_field",
 				ConstructParams: []idxParam{
 					{
 						Name:           "nlist",
@@ -509,8 +518,9 @@ func main() {
 			},
 			// HNSW
 			{
-				IdxName: "HNSW",
-				IdxType: entity.HNSW,
+				IdxName:   "HNSW",
+				IdxType:   entity.HNSW,
+				FieldName: "vec_field",
 				ConstructParams: []idxParam{
 					{
 						Name:           "M",
@@ -546,8 +556,9 @@ func main() {
 			},
 			// IVF_HNSW
 			{
-				IdxName: "IvfHNSW",
-				IdxType: entity.IvfHNSW,
+				IdxName:   "IvfHNSW",
+				IdxType:   entity.IvfHNSW,
+				FieldName: "vec_field",
 				ConstructParams: []idxParam{
 					{
 						Name:           "nlist",
@@ -596,6 +607,7 @@ func main() {
 			{
 				IdxName:         "DISKANN",
 				IdxType:         entity.DISKANN,
+				FieldName:       "vec_field",
 				ConstructParams: []idxParam{},
 				SearchParams: []idxParam{
 					{
@@ -618,6 +630,7 @@ func main() {
 			{
 				IdxName:         "AUTOINDEX",
 				IdxType:         entity.AUTOINDEX,
+				FieldName:       "vec_field",
 				ConstructParams: []idxParam{},
 				SearchParams: []idxParam{
 					{
@@ -639,8 +652,9 @@ func main() {
 				},
 			},
 			{
-				IdxName: "GPUIvfFlat",
-				IdxType: entity.GPUIvfFlat,
+				IdxName:   "GPUIvfFlat",
+				IdxType:   entity.GPUIvfFlat,
+				FieldName: "vec_field",
 				ConstructParams: []idxParam{
 					{
 						Name:           "nlist",
@@ -669,8 +683,9 @@ func main() {
 				},
 			},
 			{
-				IdxName: "GPUIvfPQ",
-				IdxType: entity.GPUIvfPQ,
+				IdxName:   "GPUIvfPQ",
+				IdxType:   entity.GPUIvfPQ,
+				FieldName: "vec_field",
 				ConstructParams: []idxParam{
 					{
 						Name:           "nlist",
@@ -709,8 +724,9 @@ func main() {
 				},
 			},
 			{
-				IdxName: "SCANN",
-				IdxType: entity.SCANN,
+				IdxName:   "SCANN",
+				IdxType:   entity.IvfFlat,
+				FieldName: "vec_field",
 				ConstructParams: []idxParam{
 					{
 						Name:           "nlist",

diff --git a/entity/index.go b/entity/index.go
@@ -67,6 +67,7 @@ type Index interface {
 	Name() string
 	IndexType() IndexType
 	Params() map[string]string
+	FieldName() string
 }
 
 // SearchParam interface for index related search param
@@ -104,8 +105,9 @@ func newBaseSearchParams() baseSearchParams {
 }
 
 type baseIndex struct {
-	it   IndexType
-	name string
+	it        IndexType
+	name      string
+	fieldName string
 }
 
 // Name implements Index
@@ -118,6 +120,11 @@ func (b baseIndex) IndexType() IndexType {
 	return b.it
 }
 
+// FieldName implements Index
+func (b baseIndex) FieldName() string {
+	return b.fieldName
+}
+
 // GenericIndex index struct for general usage
 // no constraint for index is applied
 type GenericIndex struct {
@@ -138,11 +145,12 @@ func (gi GenericIndex) Params() map[string]string {
 }
 
 // NewGenericIndex create generic index instance
-func NewGenericIndex(name string, it IndexType, params map[string]string) Index {
+func NewGenericIndex(name string, it IndexType, fieldName string, params map[string]string) Index {
 	return GenericIndex{
 		baseIndex: baseIndex{
-			it:   it,
-			name: name,
+			it:        it,
+			name:      name,
+			fieldName: fieldName,
 		},
 		params: params,
 	}

diff --git a/entity/index_test.go b/entity/index_test.go
@@ -23,7 +23,7 @@ import (
 func TestGenericIndex(t *testing.T) {
 	rand.Seed(time.Now().UnixNano())
 	name := fmt.Sprintf("generic_index_%d", rand.Int())
-	gi := NewGenericIndex(name, IvfFlat, map[string]string{
+	gi := NewGenericIndex(name, IvfFlat, "field", map[string]string{
 		tMetricType: string(IP),
 	})
 	assert.Equal(t, name, gi.Name())