index field name

wayblink · Feb 14, 2023 · 6486d64 · 6486d64
1 parent 08d3b97
commit 6486d64
Show file tree

Hide file tree

Showing 8 changed files with 458 additions and 408 deletions.
diff --git a/client/client_grpc_index.go b/client/client_grpc_index.go
@@ -167,8 +167,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
@@ -56,6 +56,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
@@ -225,6 +230,7 @@ func TestIndex{{.IdxName}}SearchParam(t *testing.T) {
 type idxDef struct {
 	IdxName             string
 	IdxType             entity.IndexType
+	FieldName           string
 	VectorSupport       int8
 	ConstructParams     []idxParam
 	SearchParams        []idxParam
@@ -333,6 +339,7 @@ func main() {
 			{
 				IdxName:         "Flat",
 				IdxType:         entity.Flat,
+				FieldName:       "vec_field",
 				ConstructParams: []idxParam{},
 				SearchParams:    []idxParam{},
 				ValidExamples: []string{
@@ -348,6 +355,7 @@ func main() {
 			{
 				IdxName:       "BinFlat",
 				IdxType:       entity.BinFlat,
+				FieldName:     "vec_field",
 				VectorSupport: int8(binaryVectorSupport),
 				ConstructParams: []idxParam{
 					{
@@ -378,8 +386,9 @@ func main() {
 			},
 			// IVF_FLAT
 			{
-				IdxName: "IvfFlat",
-				IdxType: entity.IvfFlat,
+				IdxName:   "IvfFlat",
+				IdxType:   entity.IvfFlat,
+				FieldName: "vec_field",
 				ConstructParams: []idxParam{
 					{
 						Name:           "nlist",
@@ -411,6 +420,7 @@ func main() {
 			{
 				IdxName:       "BinIvfFlat",
 				IdxType:       entity.BinIvfFlat,
+				FieldName:     "vec_field",
 				VectorSupport: int8(binaryVectorSupport),
 				ConstructParams: []idxParam{
 					{
@@ -441,8 +451,9 @@ func main() {
 			},
 			// IVF_SQ8
 			{
-				IdxName: "IvfSQ8",
-				IdxType: entity.IvfSQ8,
+				IdxName:   "IvfSQ8",
+				IdxType:   entity.IvfSQ8,
+				FieldName: "vec_field",
 				ConstructParams: []idxParam{
 					{
 						Name:           "nlist",
@@ -472,8 +483,9 @@ func main() {
 			},
 			// IVF_PQ
 			{
-				IdxName: "IvfPQ",
-				IdxType: entity.IvfPQ,
+				IdxName:   "IvfPQ",
+				IdxType:   entity.IvfPQ,
+				FieldName: "vec_field",
 				ConstructParams: []idxParam{
 					{
 						Name:           "nlist",
@@ -513,8 +525,9 @@ func main() {
 			},
 			// HNSW
 			{
-				IdxName: "HNSW",
-				IdxType: entity.HNSW,
+				IdxName:   "HNSW",
+				IdxType:   entity.HNSW,
+				FieldName: "vec_field",
 				ConstructParams: []idxParam{
 					{
 						Name:           "M",
@@ -550,8 +563,9 @@ func main() {
 			},
 			// IVF_HNSW
 			{
-				IdxName: "IvfHNSW",
-				IdxType: entity.IvfHNSW,
+				IdxName:   "IvfHNSW",
+				IdxType:   entity.IvfHNSW,
+				FieldName: "vec_field",
 				ConstructParams: []idxParam{
 					{
 						Name:           "nlist",
@@ -599,8 +613,9 @@ func main() {
 			},
 			// ANNOY
 			{
-				IdxName: "ANNOY",
-				IdxType: entity.ANNOY,
+				IdxName:   "ANNOY",
+				IdxType:   entity.ANNOY,
+				FieldName: "vec_field",
 				ConstructParams: []idxParam{
 					{
 						Name:           "n_trees",
@@ -628,6 +643,7 @@ func main() {
 			{
 				IdxName:         "DISKANN",
 				IdxType:         entity.DISKANN,
+				FieldName:       "vec_field",
 				ConstructParams: []idxParam{},
 				SearchParams: []idxParam{
 					{
@@ -650,6 +666,7 @@ func main() {
 			{
 				IdxName:         "AUTOINDEX",
 				IdxType:         entity.AUTOINDEX,
+				FieldName:       "vec_field",
 				ConstructParams: []idxParam{},
 				SearchParams: []idxParam{
 					{
@@ -673,6 +690,7 @@ func main() {
 			{
 				IdxName:         "TRIE",
 				IdxType:         entity.TRIE,
+				FieldName:       "varchar_field",
 				ConstructParams: []idxParam{},
 			},
 		},

diff --git a/entity/index.go b/entity/index.go
@@ -37,7 +37,7 @@ const (
 	ANNOY      IndexType = "ANNOY"
 	AUTOINDEX  IndexType = "AUTOINDEX"
 	DISKANN    IndexType = "DISKANN"
-	TRIE    IndexType = "TRIE"
+	TRIE       IndexType = "TRIE"
 )
 
 // Metric Constants
@@ -62,6 +62,7 @@ type Index interface {
 	Name() string
 	IndexType() IndexType
 	Params() map[string]string
+	FieldName() string
 }
 
 // SearchParam interface for index related search param
@@ -71,8 +72,9 @@ type SearchParam interface {
 }
 
 type baseIndex struct {
-	it   IndexType
-	name string
+	it        IndexType
+	name      string
+	fieldName string
 }
 
 // Name implements Index
@@ -85,6 +87,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 {
@@ -104,11 +111,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,
 	}