Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add wildcard outputfield expansion logic back #604

Merged
merged 1 commit into from
Oct 25, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 33 additions & 1 deletion client/data.go
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,8 @@ func (c *GrpcClient) Search(ctx context.Context, collName string, partitions []s
return sr, nil
}

func (c *GrpcClient) parseSearchResult(_ *entity.Schema, outputFields []string, fieldDataList []*schemapb.FieldData, _, from, to int) ([]entity.Column, error) {
func (c *GrpcClient) parseSearchResult(sch *entity.Schema, outputFields []string, fieldDataList []*schemapb.FieldData, _, from, to int) ([]entity.Column, error) {
outputFields = expandWildcard(sch, outputFields)
// duplicated name will have only one column now
outputSet := make(map[string]struct{})
for _, output := range outputFields {
Expand Down Expand Up @@ -141,6 +142,37 @@ func (c *GrpcClient) parseSearchResult(_ *entity.Schema, outputFields []string,
return columns, nil
}

func expandWildcard(schema *entity.Schema, outputFields []string) []string {
wildcard := false
for _, outputField := range outputFields {
if outputField == "*" {
wildcard = true
}
}
if !wildcard {
return outputFields
}

set := make(map[string]struct{})
result := make([]string, 0, len(schema.Fields))
for _, field := range schema.Fields {
result = append(result, field.Name)
set[field.Name] = struct{}{}
}

// add dynamic fields output
for _, output := range outputFields {
if output == "*" {
continue
}
_, ok := set[output]
if !ok {
result = append(result, output)
}
}
return result
}

func PKs2Expr(backName string, ids entity.Column) string {
var expr string
var pkName = ids.Name()
Expand Down
39 changes: 39 additions & 0 deletions client/data_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -1178,3 +1178,42 @@ func TestVector2PlaceHolder(t *testing.T) {
}
})
}

type WildcardSuite struct {
suite.Suite

schema *entity.Schema
}

func (s *WildcardSuite) SetupTest() {
s.schema = entity.NewSchema().
WithField(entity.NewField().WithName("pk").WithDataType(entity.FieldTypeInt64).WithIsPrimaryKey(true)).
WithField(entity.NewField().WithName("attr").WithDataType(entity.FieldTypeInt64)).
WithField(entity.NewField().WithName("$meta").WithDataType(entity.FieldTypeJSON).WithIsDynamic(true)).
WithField(entity.NewField().WithName("vector").WithDataType(entity.FieldTypeFloatVector).WithDim(128))
}

func (s *WildcardSuite) TestExpandWildcard() {
type testCase struct {
tag string
input []string
expect []string
}

cases := []testCase{
{tag: "normal", input: []string{"pk", "attr"}, expect: []string{"pk", "attr"}},
{tag: "with_wildcard", input: []string{"*"}, expect: []string{"pk", "attr", "$meta", "vector"}},
{tag: "wildcard_dynamic", input: []string{"*", "a"}, expect: []string{"pk", "attr", "$meta", "vector", "a"}},
}

for _, tc := range cases {
s.Run(tc.tag, func() {
output := expandWildcard(s.schema, tc.input)
s.ElementsMatch(tc.expect, output)
})
}
}

func TestExpandWildcard(t *testing.T) {
suite.Run(t, new(WildcardSuite))
}
12 changes: 4 additions & 8 deletions test/testcases/search_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -1099,8 +1099,7 @@ func TestSearchScannAllMetricsWithRawData(t *testing.T) {
sp,
)
common.CheckErr(t, errSearch, true)
// TODO output_fields include * ???
common.CheckOutputFields(t, resSearch[0].Fields, []string{"*", common.DefaultIntFieldName, common.DefaultFloatFieldName,
common.CheckOutputFields(t, resSearch[0].Fields, []string{common.DefaultIntFieldName, common.DefaultFloatFieldName,
common.DefaultJSONFieldName, common.DefaultFloatVecFieldName})
common.CheckSearchResult(t, resSearch, 1, common.DefaultTopK)
}
Expand Down Expand Up @@ -1148,8 +1147,7 @@ func TestRangeSearchScannL2(t *testing.T) {
// verify error nil, output all fields, range score
common.CheckErr(t, errSearch, true)
common.CheckSearchResult(t, resSearch, 1, common.DefaultTopK)
// TODO output_fields include * ??? https://github.com/milvus-io/milvus-sdk-go/issues/596
common.CheckOutputFields(t, resSearch[0].Fields, []string{"*", common.DefaultIntFieldName, common.DefaultFloatFieldName,
common.CheckOutputFields(t, resSearch[0].Fields, []string{common.DefaultIntFieldName, common.DefaultFloatFieldName,
common.DefaultJSONFieldName, common.DefaultFloatVecFieldName})
for _, s := range resSearch[0].Scores {
require.GreaterOrEqual(t, s, float32(15.0))
Expand Down Expand Up @@ -1208,8 +1206,7 @@ func TestRangeSearchScannIPCosine(t *testing.T) {
// verify error nil, output all fields, range score
common.CheckErr(t, errSearch, true)
common.CheckSearchResult(t, resSearch, 1, common.DefaultTopK)
// TODO output_fields include * ??? https://github.com/milvus-io/milvus-sdk-go/issues/596
common.CheckOutputFields(t, resSearch[0].Fields, []string{"*", common.DefaultIntFieldName, common.DefaultFloatFieldName,
common.CheckOutputFields(t, resSearch[0].Fields, []string{common.DefaultIntFieldName, common.DefaultFloatFieldName,
common.DefaultJSONFieldName, common.DefaultFloatVecFieldName})
for _, s := range resSearch[0].Scores {
require.GreaterOrEqual(t, s, float32(0))
Expand Down Expand Up @@ -1270,8 +1267,7 @@ func TestRangeSearchScannBinary(t *testing.T) {
// verify error nil, output all fields, range score
common.CheckErr(t, errSearch, true)
common.CheckSearchResult(t, resSearch, 1, common.DefaultTopK)
// TODO output_fields include * ??? https://github.com/milvus-io/milvus-sdk-go/issues/596
common.CheckOutputFields(t, resSearch[0].Fields, []string{"*", common.DefaultIntFieldName, common.DefaultFloatFieldName, common.DefaultBinaryVecFieldName})
common.CheckOutputFields(t, resSearch[0].Fields, []string{common.DefaultIntFieldName, common.DefaultFloatFieldName, common.DefaultBinaryVecFieldName})
for _, s := range resSearch[0].Scores {
require.GreaterOrEqual(t, s, float32(0))
require.Less(t, s, float32(100))
Expand Down
Loading