cai.zhang 19346fa389
feat: Geospatial Data Type and GIS Function support for milvus (#44547)
issue: #43427

This pr's main goal is merge #37417 to milvus 2.5 without conflicts.

# Main Goals

1. Create and describe collections with geospatial type
2. Insert geospatial data into the insert binlog
3. Load segments containing geospatial data into memory
4. Enable query and search can display  geospatial data
5. Support using GIS funtions like ST_EQUALS in query
6. Support R-Tree index for geometry type

# Solution

1. **Add Type**: Modify the Milvus core by adding a Geospatial type in
both the C++ and Go code layers, defining the Geospatial data structure
and the corresponding interfaces.
2. **Dependency Libraries**: Introduce necessary geospatial data
processing libraries. In the C++ source code, use Conan package
management to include the GDAL library. In the Go source code, add the
go-geom library to the go.mod file.
3. **Protocol Interface**: Revise the Milvus protocol to provide
mechanisms for Geospatial message serialization and deserialization.
4. **Data Pipeline**: Facilitate interaction between the client and
proxy using the WKT format for geospatial data. The proxy will convert
all data into WKB format for downstream processing, providing column
data interfaces, segment encapsulation, segment loading, payload
writing, and cache block management.
5. **Query Operators**: Implement simple display and support for filter
queries. Initially, focus on filtering based on spatial relationships
for a single column of geospatial literal values, providing parsing and
execution for query expressions.Now only support brutal search
7. **Client Modification**: Enable the client to handle user input for
geospatial data and facilitate end-to-end testing.Check the modification
in pymilvus.

---------

Signed-off-by: Yinwei Li <yinwei.li@zilliz.com>
Signed-off-by: Cai Zhang <cai.zhang@zilliz.com>
Co-authored-by: ZhuXi <150327960+Yinwei-Yu@users.noreply.github.com>
2025-09-28 19:43:05 +08:00

877 lines
32 KiB
Go

// Licensed to the LF AI & Data foundation under one
// or more contributor license agreements. See the NOTICE file
// distributed with this work for additional information
// regarding copyright ownership. The ASF licenses this file
// to you under the Apache License, Version 2.0 (the
// "License"); you may not use this file except in compliance
// with the License. You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package parquet
import (
"context"
"fmt"
"io"
"math/rand"
"os"
"testing"
"github.com/apache/arrow/go/v17/arrow"
"github.com/apache/arrow/go/v17/arrow/array"
"github.com/apache/arrow/go/v17/arrow/memory"
"github.com/apache/arrow/go/v17/parquet"
"github.com/apache/arrow/go/v17/parquet/pqarrow"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/mock"
"github.com/stretchr/testify/suite"
"golang.org/x/exp/slices"
"github.com/milvus-io/milvus-proto/go-api/v2/commonpb"
"github.com/milvus-io/milvus-proto/go-api/v2/schemapb"
"github.com/milvus-io/milvus/internal/mocks"
"github.com/milvus-io/milvus/internal/storage"
"github.com/milvus-io/milvus/internal/util/nullutil"
"github.com/milvus-io/milvus/internal/util/testutil"
"github.com/milvus-io/milvus/pkg/v2/common"
"github.com/milvus-io/milvus/pkg/v2/objectstorage"
"github.com/milvus-io/milvus/pkg/v2/util/merr"
"github.com/milvus-io/milvus/pkg/v2/util/paramtable"
"github.com/milvus-io/milvus/pkg/v2/util/typeutil"
)
const (
testOutputPath = "/tmp/milvus_test/test_parquet_reader"
)
type ReaderSuite struct {
suite.Suite
numRows int
pkDataType schemapb.DataType
vecDataType schemapb.DataType
}
func (s *ReaderSuite) SetupSuite() {
paramtable.Get().Init(paramtable.NewBaseTable())
}
func (s *ReaderSuite) SetupTest() {
// default suite params
s.numRows = 100
s.pkDataType = schemapb.DataType_Int64
s.vecDataType = schemapb.DataType_FloatVector
}
func randomString(length int) string {
letterRunes := []rune("abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ")
b := make([]rune, length)
for i := range b {
b[i] = letterRunes[rand.Intn(len(letterRunes))]
}
return string(b)
}
func writeParquet(w io.Writer, schema *schemapb.CollectionSchema, numRows int, nullPercent int) (*storage.InsertData, error) {
useNullType := false
if nullPercent == 100 {
useNullType = true
}
pqSchema, err := ConvertToArrowSchemaForUT(schema, useNullType)
if err != nil {
return nil, err
}
fw, err := pqarrow.NewFileWriter(pqSchema, w, parquet.NewWriterProperties(parquet.WithMaxRowGroupLength(int64(numRows))), pqarrow.DefaultWriterProps())
if err != nil {
return nil, err
}
defer fw.Close()
insertData, err := testutil.CreateInsertData(schema, numRows, nullPercent)
if err != nil {
return nil, err
}
columns, err := testutil.BuildArrayData(schema, insertData, useNullType)
if err != nil {
return nil, err
}
recordBatch := array.NewRecord(pqSchema, columns, int64(numRows))
err = fw.Write(recordBatch)
if err != nil {
return nil, err
}
return insertData, nil
}
func (s *ReaderSuite) run(dataType schemapb.DataType, elemType schemapb.DataType, nullable bool, nullPercent int) {
schema := &schemapb.CollectionSchema{
Fields: []*schemapb.FieldSchema{
{
FieldID: 100,
Name: "pk",
IsPrimaryKey: true,
DataType: s.pkDataType,
TypeParams: []*commonpb.KeyValuePair{
{
Key: "max_length",
Value: "256",
},
},
},
{
FieldID: 101,
Name: "vec",
DataType: s.vecDataType,
TypeParams: []*commonpb.KeyValuePair{
{
Key: common.DimKey,
Value: "8",
},
},
},
{
FieldID: 102,
Name: dataType.String(),
DataType: dataType,
ElementType: elemType,
TypeParams: []*commonpb.KeyValuePair{
{
Key: "max_length",
Value: "256",
},
{
Key: common.MaxCapacityKey,
Value: "256",
},
},
Nullable: nullable,
},
},
}
if dataType == schemapb.DataType_VarChar {
// Add a BM25 function if data type is VarChar
schema.Fields = append(schema.Fields, &schemapb.FieldSchema{
FieldID: 103,
Name: "sparse",
DataType: schemapb.DataType_SparseFloatVector,
IsFunctionOutput: true,
})
schema.Functions = append(schema.Functions, &schemapb.FunctionSchema{
Id: 1000,
Name: "bm25",
Type: schemapb.FunctionType_BM25,
InputFieldIds: []int64{102},
InputFieldNames: []string{dataType.String()},
OutputFieldIds: []int64{103},
OutputFieldNames: []string{"sparse"},
})
}
filePath := fmt.Sprintf("/tmp/test_%d_reader.parquet", rand.Int())
defer os.Remove(filePath)
wf, err := os.OpenFile(filePath, os.O_RDWR|os.O_CREATE, 0o666)
assert.NoError(s.T(), err)
insertData, err := writeParquet(wf, schema, s.numRows, nullPercent)
assert.NoError(s.T(), err)
ctx := context.Background()
f := storage.NewChunkManagerFactory("local", objectstorage.RootPath(testOutputPath))
cm, err := f.NewPersistentStorageChunkManager(ctx)
assert.NoError(s.T(), err)
reader, err := NewReader(ctx, cm, schema, filePath, 64*1024*1024)
s.NoError(err)
s.NotNil(reader)
defer reader.Close()
size, err := reader.Size()
s.NoError(err)
s.True(size > int64(0))
size2, err := reader.Size() // size is cached
s.NoError(err)
s.Equal(size, size2)
checkFn := func(actualInsertData *storage.InsertData, offsetBegin, expectRows int) {
expectInsertData := insertData
for fieldID, data := range actualInsertData.Data {
s.Equal(expectRows, data.RowNum())
fieldDataType := typeutil.GetField(schema, fieldID).GetDataType()
elementType := typeutil.GetField(schema, fieldID).GetElementType()
for i := 0; i < expectRows; i++ {
expect := expectInsertData.Data[fieldID].GetRow(i + offsetBegin)
actual := data.GetRow(i)
if fieldDataType == schemapb.DataType_Array && expect != nil {
switch elementType {
case schemapb.DataType_Bool:
actualArray := actual.(*schemapb.ScalarField).GetBoolData().GetData()
s.True(slices.Equal(expect.(*schemapb.ScalarField).GetBoolData().GetData(), actualArray))
s.LessOrEqual(len(actualArray), len(expect.(*schemapb.ScalarField).GetBoolData().GetData()), "array size %d exceeds max_size %d", len(actualArray), len(expect.(*schemapb.ScalarField).GetBoolData().GetData()))
case schemapb.DataType_Int8, schemapb.DataType_Int16, schemapb.DataType_Int32, schemapb.DataType_Int64:
actualArray := actual.(*schemapb.ScalarField).GetIntData().GetData()
s.True(slices.Equal(expect.(*schemapb.ScalarField).GetIntData().GetData(), actualArray))
s.LessOrEqual(len(actualArray), len(expect.(*schemapb.ScalarField).GetIntData().GetData()), "array size %d exceeds max_size %d", len(actualArray), len(expect.(*schemapb.ScalarField).GetIntData().GetData()))
case schemapb.DataType_Float:
actualArray := actual.(*schemapb.ScalarField).GetFloatData().GetData()
s.True(slices.Equal(expect.(*schemapb.ScalarField).GetFloatData().GetData(), actualArray))
s.LessOrEqual(len(actualArray), len(expect.(*schemapb.ScalarField).GetFloatData().GetData()), "array size %d exceeds max_size %d", len(actualArray), len(expect.(*schemapb.ScalarField).GetFloatData().GetData()))
case schemapb.DataType_Double:
actualArray := actual.(*schemapb.ScalarField).GetDoubleData().GetData()
s.True(slices.Equal(expect.(*schemapb.ScalarField).GetDoubleData().GetData(), actualArray))
s.LessOrEqual(len(actualArray), len(expect.(*schemapb.ScalarField).GetDoubleData().GetData()), "array size %d exceeds max_size %d", len(actualArray), len(expect.(*schemapb.ScalarField).GetDoubleData().GetData()))
case schemapb.DataType_String:
actualArray := actual.(*schemapb.ScalarField).GetStringData().GetData()
s.True(slices.Equal(expect.(*schemapb.ScalarField).GetStringData().GetData(), actualArray))
s.LessOrEqual(len(actualArray), len(expect.(*schemapb.ScalarField).GetStringData().GetData()), "array size %d exceeds max_size %d", len(actualArray), len(expect.(*schemapb.ScalarField).GetStringData().GetData()))
default:
s.Fail("unsupported array element type")
}
} else {
s.Equal(expect, actual)
}
}
}
}
res, err := reader.Read()
s.NoError(err)
checkFn(res, 0, s.numRows)
}
func (s *ReaderSuite) failRun(dt schemapb.DataType, isDynamic bool) {
schema := &schemapb.CollectionSchema{
Fields: []*schemapb.FieldSchema{
{
FieldID: 100,
Name: "pk",
IsPrimaryKey: true,
DataType: s.pkDataType,
TypeParams: []*commonpb.KeyValuePair{
{
Key: "max_length",
Value: "256",
},
},
},
{
FieldID: 101,
Name: "vec",
DataType: s.vecDataType,
TypeParams: []*commonpb.KeyValuePair{
{
Key: common.DimKey,
Value: "8",
},
},
},
{
FieldID: 102,
Name: dt.String(),
DataType: dt,
ElementType: schemapb.DataType_Int32,
TypeParams: []*commonpb.KeyValuePair{
{
Key: "max_length",
Value: "256",
},
},
IsDynamic: isDynamic,
},
},
}
filePath := fmt.Sprintf("/tmp/test_%d_reader.parquet", rand.Int())
defer os.Remove(filePath)
wf, err := os.OpenFile(filePath, os.O_RDWR|os.O_CREATE, 0o666)
assert.NoError(s.T(), err)
_, err = writeParquet(wf, schema, s.numRows, 50)
assert.NoError(s.T(), err)
ctx := context.Background()
f := storage.NewChunkManagerFactory("local", objectstorage.RootPath(testOutputPath))
cm, err := f.NewPersistentStorageChunkManager(ctx)
assert.NoError(s.T(), err)
reader, err := NewReader(ctx, cm, schema, filePath, 64*1024*1024)
s.NoError(err)
_, err = reader.Read()
s.Error(err)
}
func (s *ReaderSuite) runWithDefaultValue(dataType schemapb.DataType, elemType schemapb.DataType, nullable bool, nullPercent int) {
schema := &schemapb.CollectionSchema{
Fields: []*schemapb.FieldSchema{
{
FieldID: 100,
Name: "pk",
IsPrimaryKey: true,
DataType: s.pkDataType,
TypeParams: []*commonpb.KeyValuePair{
{
Key: "max_length",
Value: "256",
},
},
},
{
FieldID: 101,
Name: "vec",
DataType: s.vecDataType,
TypeParams: []*commonpb.KeyValuePair{
{
Key: common.DimKey,
Value: "8",
},
},
},
},
}
// here always set nullable==true just for test, insertData will store validData only nullable==true
// if expectInsertData is nulls and set default value
// actualData will be default_value
fieldSchema, err := testutil.CreateFieldWithDefaultValue(dataType, 102, true)
s.NoError(err)
schema.Fields = append(schema.Fields, fieldSchema)
filePath := fmt.Sprintf("/tmp/test_%d_reader.parquet", rand.Int())
defer os.Remove(filePath)
wf, err := os.OpenFile(filePath, os.O_RDWR|os.O_CREATE, 0o666)
assert.NoError(s.T(), err)
insertData, err := writeParquet(wf, schema, s.numRows, nullPercent)
assert.NoError(s.T(), err)
ctx := context.Background()
f := storage.NewChunkManagerFactory("local", objectstorage.RootPath(testOutputPath))
cm, err := f.NewPersistentStorageChunkManager(ctx)
assert.NoError(s.T(), err)
schema.Fields[2].Nullable = nullable
reader, err := NewReader(ctx, cm, schema, filePath, 64*1024*1024)
s.NoError(err)
checkFn := func(actualInsertData *storage.InsertData, offsetBegin, expectRows int) {
expectInsertData := insertData
for fieldID, data := range actualInsertData.Data {
s.Equal(expectRows, data.RowNum())
for i := 0; i < expectRows; i++ {
expect := expectInsertData.Data[fieldID].GetRow(i + offsetBegin)
actual := data.GetRow(i)
if expect == nil {
expect, err = nullutil.GetDefaultValue(fieldSchema)
s.NoError(err)
}
s.Equal(expect, actual)
}
}
}
res, err := reader.Read()
s.NoError(err)
checkFn(res, 0, s.numRows)
}
func (s *ReaderSuite) runWithSparseVector(indicesType arrow.DataType, valuesType arrow.DataType) {
// milvus schema
schema := &schemapb.CollectionSchema{
Fields: []*schemapb.FieldSchema{
{
FieldID: 100,
Name: "pk",
IsPrimaryKey: true,
DataType: schemapb.DataType_Int64,
AutoID: false,
},
{
FieldID: 101,
Name: "sparse",
DataType: schemapb.DataType_SparseFloatVector,
},
},
}
// arrow schema
arrowFields := make([]arrow.Field, 0)
arrowFields = append(arrowFields, arrow.Field{
Name: "pk",
Type: &arrow.Int64Type{},
Nullable: false,
Metadata: arrow.Metadata{},
})
sparseFields := []arrow.Field{
{Name: sparseVectorIndice, Type: arrow.ListOf(indicesType)},
{Name: sparseVectorValues, Type: arrow.ListOf(valuesType)},
}
arrowFields = append(arrowFields, arrow.Field{
Name: "sparse",
Type: arrow.StructOf(sparseFields...),
Nullable: false,
Metadata: arrow.Metadata{},
})
pqSchema := arrow.NewSchema(arrowFields, nil)
// parquet writer
filePath := fmt.Sprintf("/tmp/test_%d_reader.parquet", rand.Int())
defer os.Remove(filePath)
// prepare milvus data
insertData, err := testutil.CreateInsertData(schema, s.numRows, 0)
assert.NoError(s.T(), err)
// use a function here because the fw.Close() must be called before we read the parquet file
func() {
wf, err := os.OpenFile(filePath, os.O_RDWR|os.O_CREATE, 0o666)
assert.NoError(s.T(), err)
fw, err := pqarrow.NewFileWriter(pqSchema, wf, parquet.NewWriterProperties(parquet.WithMaxRowGroupLength(int64(s.numRows))), pqarrow.DefaultWriterProps())
assert.NoError(s.T(), err)
defer fw.Close()
// prepare parquet data
arrowColumns := make([]arrow.Array, 0, len(schema.Fields))
mem := memory.NewGoAllocator()
builder := array.NewInt64Builder(mem)
int64Data := insertData.Data[schema.Fields[0].FieldID].(*storage.Int64FieldData).Data
validData := insertData.Data[schema.Fields[0].FieldID].(*storage.Int64FieldData).ValidData
builder.AppendValues(int64Data, validData)
arrowColumns = append(arrowColumns, builder.NewInt64Array())
contents := insertData.Data[schema.Fields[1].FieldID].(*storage.SparseFloatVectorFieldData).GetContents()
arr, err := testutil.BuildSparseVectorData(mem, contents, arrowFields[1].Type)
assert.NoError(s.T(), err)
arrowColumns = append(arrowColumns, arr)
// write parquet
recordBatch := array.NewRecord(pqSchema, arrowColumns, int64(s.numRows))
err = fw.Write(recordBatch)
assert.NoError(s.T(), err)
}()
// read parquet
ctx := context.Background()
f := storage.NewChunkManagerFactory("local", objectstorage.RootPath(testOutputPath))
cm, err := f.NewPersistentStorageChunkManager(ctx)
assert.NoError(s.T(), err)
reader, err := NewReader(ctx, cm, schema, filePath, 64*1024*1024)
assert.NoError(s.T(), err)
checkFn := func(actualInsertData *storage.InsertData, offsetBegin, expectRows int) {
expectInsertData := insertData
for fieldID, data := range actualInsertData.Data {
s.Equal(expectRows, data.RowNum())
for i := 0; i < expectRows; i++ {
expect := expectInsertData.Data[fieldID].GetRow(i + offsetBegin)
actual := data.GetRow(i)
s.Equal(expect, actual)
}
}
}
res, err := reader.Read()
assert.NoError(s.T(), err)
checkFn(res, 0, s.numRows)
}
func (s *ReaderSuite) TestReadScalarFieldsWithDefaultValue() {
s.runWithDefaultValue(schemapb.DataType_Bool, schemapb.DataType_None, true, 0)
s.runWithDefaultValue(schemapb.DataType_Int8, schemapb.DataType_None, true, 0)
s.runWithDefaultValue(schemapb.DataType_Int16, schemapb.DataType_None, true, 0)
s.runWithDefaultValue(schemapb.DataType_Int32, schemapb.DataType_None, true, 0)
s.runWithDefaultValue(schemapb.DataType_Int64, schemapb.DataType_None, true, 0)
s.runWithDefaultValue(schemapb.DataType_Float, schemapb.DataType_None, true, 0)
s.runWithDefaultValue(schemapb.DataType_Double, schemapb.DataType_None, true, 0)
s.runWithDefaultValue(schemapb.DataType_String, schemapb.DataType_None, true, 0)
s.runWithDefaultValue(schemapb.DataType_VarChar, schemapb.DataType_None, true, 0)
s.runWithDefaultValue(schemapb.DataType_Bool, schemapb.DataType_None, true, 50)
s.runWithDefaultValue(schemapb.DataType_Int8, schemapb.DataType_None, true, 50)
s.runWithDefaultValue(schemapb.DataType_Int16, schemapb.DataType_None, true, 50)
s.runWithDefaultValue(schemapb.DataType_Int32, schemapb.DataType_None, true, 50)
s.runWithDefaultValue(schemapb.DataType_Int64, schemapb.DataType_None, true, 50)
s.runWithDefaultValue(schemapb.DataType_Float, schemapb.DataType_None, true, 50)
s.runWithDefaultValue(schemapb.DataType_String, schemapb.DataType_None, true, 50)
s.runWithDefaultValue(schemapb.DataType_VarChar, schemapb.DataType_None, true, 50)
s.runWithDefaultValue(schemapb.DataType_Bool, schemapb.DataType_None, true, 100)
s.runWithDefaultValue(schemapb.DataType_Int8, schemapb.DataType_None, true, 100)
s.runWithDefaultValue(schemapb.DataType_Int16, schemapb.DataType_None, true, 100)
s.runWithDefaultValue(schemapb.DataType_Int32, schemapb.DataType_None, true, 100)
s.runWithDefaultValue(schemapb.DataType_Int64, schemapb.DataType_None, true, 100)
s.runWithDefaultValue(schemapb.DataType_Float, schemapb.DataType_None, true, 100)
s.runWithDefaultValue(schemapb.DataType_String, schemapb.DataType_None, true, 100)
s.runWithDefaultValue(schemapb.DataType_VarChar, schemapb.DataType_None, true, 100)
s.runWithDefaultValue(schemapb.DataType_Bool, schemapb.DataType_None, false, 0)
s.runWithDefaultValue(schemapb.DataType_Int8, schemapb.DataType_None, false, 0)
s.runWithDefaultValue(schemapb.DataType_Int16, schemapb.DataType_None, false, 0)
s.runWithDefaultValue(schemapb.DataType_Int32, schemapb.DataType_None, false, 0)
s.runWithDefaultValue(schemapb.DataType_Int64, schemapb.DataType_None, false, 0)
s.runWithDefaultValue(schemapb.DataType_Float, schemapb.DataType_None, false, 0)
s.runWithDefaultValue(schemapb.DataType_Double, schemapb.DataType_None, false, 0)
s.runWithDefaultValue(schemapb.DataType_String, schemapb.DataType_None, false, 0)
s.runWithDefaultValue(schemapb.DataType_VarChar, schemapb.DataType_None, false, 0)
s.runWithDefaultValue(schemapb.DataType_Bool, schemapb.DataType_None, false, 50)
s.runWithDefaultValue(schemapb.DataType_Int8, schemapb.DataType_None, false, 50)
s.runWithDefaultValue(schemapb.DataType_Int16, schemapb.DataType_None, false, 50)
s.runWithDefaultValue(schemapb.DataType_Int32, schemapb.DataType_None, false, 50)
s.runWithDefaultValue(schemapb.DataType_Int64, schemapb.DataType_None, false, 50)
s.runWithDefaultValue(schemapb.DataType_Float, schemapb.DataType_None, false, 50)
s.runWithDefaultValue(schemapb.DataType_String, schemapb.DataType_None, false, 50)
s.runWithDefaultValue(schemapb.DataType_VarChar, schemapb.DataType_None, false, 50)
s.runWithDefaultValue(schemapb.DataType_Bool, schemapb.DataType_None, false, 100)
s.runWithDefaultValue(schemapb.DataType_Int8, schemapb.DataType_None, false, 100)
s.runWithDefaultValue(schemapb.DataType_Int16, schemapb.DataType_None, false, 100)
s.runWithDefaultValue(schemapb.DataType_Int32, schemapb.DataType_None, false, 100)
s.runWithDefaultValue(schemapb.DataType_Int64, schemapb.DataType_None, false, 100)
s.runWithDefaultValue(schemapb.DataType_Float, schemapb.DataType_None, false, 100)
s.runWithDefaultValue(schemapb.DataType_String, schemapb.DataType_None, false, 100)
s.runWithDefaultValue(schemapb.DataType_VarChar, schemapb.DataType_None, false, 100)
}
func (s *ReaderSuite) TestReadScalarFields() {
s.run(schemapb.DataType_Bool, schemapb.DataType_None, false, 0)
s.run(schemapb.DataType_Int8, schemapb.DataType_None, false, 0)
s.run(schemapb.DataType_Int16, schemapb.DataType_None, false, 0)
s.run(schemapb.DataType_Int32, schemapb.DataType_None, false, 0)
s.run(schemapb.DataType_Int64, schemapb.DataType_None, false, 0)
s.run(schemapb.DataType_Float, schemapb.DataType_None, false, 0)
s.run(schemapb.DataType_Double, schemapb.DataType_None, false, 0)
s.run(schemapb.DataType_String, schemapb.DataType_None, false, 0)
s.run(schemapb.DataType_VarChar, schemapb.DataType_None, false, 0)
s.run(schemapb.DataType_JSON, schemapb.DataType_None, false, 0)
s.run(schemapb.DataType_Geometry, schemapb.DataType_None, false, 0)
s.run(schemapb.DataType_Array, schemapb.DataType_Bool, false, 0)
s.run(schemapb.DataType_Array, schemapb.DataType_Int8, false, 0)
s.run(schemapb.DataType_Array, schemapb.DataType_Int16, false, 0)
s.run(schemapb.DataType_Array, schemapb.DataType_Int32, false, 0)
s.run(schemapb.DataType_Array, schemapb.DataType_Int64, false, 0)
s.run(schemapb.DataType_Array, schemapb.DataType_Float, false, 0)
s.run(schemapb.DataType_Array, schemapb.DataType_Double, false, 0)
s.run(schemapb.DataType_Array, schemapb.DataType_String, false, 0)
s.run(schemapb.DataType_Bool, schemapb.DataType_None, true, 50)
s.run(schemapb.DataType_Int8, schemapb.DataType_None, true, 50)
s.run(schemapb.DataType_Int16, schemapb.DataType_None, true, 50)
s.run(schemapb.DataType_Int32, schemapb.DataType_None, true, 50)
s.run(schemapb.DataType_Int64, schemapb.DataType_None, true, 50)
s.run(schemapb.DataType_Float, schemapb.DataType_None, true, 50)
s.run(schemapb.DataType_String, schemapb.DataType_None, true, 50)
s.run(schemapb.DataType_VarChar, schemapb.DataType_None, true, 50)
s.run(schemapb.DataType_JSON, schemapb.DataType_None, true, 50)
s.run(schemapb.DataType_Array, schemapb.DataType_Bool, true, 50)
s.run(schemapb.DataType_Array, schemapb.DataType_Int8, true, 50)
s.run(schemapb.DataType_Array, schemapb.DataType_Int16, true, 50)
s.run(schemapb.DataType_Array, schemapb.DataType_Int32, true, 50)
s.run(schemapb.DataType_Array, schemapb.DataType_Int64, true, 50)
s.run(schemapb.DataType_Array, schemapb.DataType_Float, true, 50)
s.run(schemapb.DataType_Array, schemapb.DataType_Double, true, 50)
s.run(schemapb.DataType_Array, schemapb.DataType_String, true, 50)
s.run(schemapb.DataType_Bool, schemapb.DataType_None, true, 100)
s.run(schemapb.DataType_Int8, schemapb.DataType_None, true, 100)
s.run(schemapb.DataType_Int16, schemapb.DataType_None, true, 100)
s.run(schemapb.DataType_Int32, schemapb.DataType_None, true, 100)
s.run(schemapb.DataType_Int64, schemapb.DataType_None, true, 100)
s.run(schemapb.DataType_Float, schemapb.DataType_None, true, 100)
s.run(schemapb.DataType_String, schemapb.DataType_None, true, 100)
s.run(schemapb.DataType_VarChar, schemapb.DataType_None, true, 100)
s.run(schemapb.DataType_JSON, schemapb.DataType_None, true, 100)
s.run(schemapb.DataType_Geometry, schemapb.DataType_None, true, 100)
s.run(schemapb.DataType_Array, schemapb.DataType_Bool, true, 100)
s.run(schemapb.DataType_Array, schemapb.DataType_Int8, true, 100)
s.run(schemapb.DataType_Array, schemapb.DataType_Int16, true, 100)
s.run(schemapb.DataType_Array, schemapb.DataType_Int32, true, 100)
s.run(schemapb.DataType_Array, schemapb.DataType_Int64, true, 100)
s.run(schemapb.DataType_Array, schemapb.DataType_Float, true, 100)
s.run(schemapb.DataType_Array, schemapb.DataType_Double, true, 100)
s.run(schemapb.DataType_Array, schemapb.DataType_String, true, 100)
s.failRun(schemapb.DataType_JSON, true)
}
func (s *ReaderSuite) TestStringPK() {
s.pkDataType = schemapb.DataType_VarChar
s.run(schemapb.DataType_Int32, schemapb.DataType_None, false, 0)
s.run(schemapb.DataType_Int32, schemapb.DataType_None, true, 50)
s.run(schemapb.DataType_Int32, schemapb.DataType_None, true, 100)
}
func (s *ReaderSuite) TestVector() {
s.vecDataType = schemapb.DataType_BinaryVector
s.run(schemapb.DataType_Int32, schemapb.DataType_None, false, 0)
s.vecDataType = schemapb.DataType_FloatVector
s.run(schemapb.DataType_Int32, schemapb.DataType_None, false, 0)
s.vecDataType = schemapb.DataType_Float16Vector
s.run(schemapb.DataType_Int32, schemapb.DataType_None, false, 0)
s.vecDataType = schemapb.DataType_BFloat16Vector
s.run(schemapb.DataType_Int32, schemapb.DataType_None, false, 0)
// this test case only test parsing sparse vector from JSON-format string
s.vecDataType = schemapb.DataType_SparseFloatVector
s.run(schemapb.DataType_Int32, schemapb.DataType_None, false, 0)
s.vecDataType = schemapb.DataType_Int8Vector
s.run(schemapb.DataType_Int32, schemapb.DataType_None, false, 0)
}
func (s *ReaderSuite) TestSparseVector() {
s.runWithSparseVector(arrow.PrimitiveTypes.Int32, arrow.PrimitiveTypes.Float32)
s.runWithSparseVector(arrow.PrimitiveTypes.Int32, arrow.PrimitiveTypes.Float64)
s.runWithSparseVector(arrow.PrimitiveTypes.Uint32, arrow.PrimitiveTypes.Float32)
s.runWithSparseVector(arrow.PrimitiveTypes.Uint32, arrow.PrimitiveTypes.Float64)
s.runWithSparseVector(arrow.PrimitiveTypes.Int64, arrow.PrimitiveTypes.Float32)
s.runWithSparseVector(arrow.PrimitiveTypes.Int64, arrow.PrimitiveTypes.Float64)
s.runWithSparseVector(arrow.PrimitiveTypes.Uint64, arrow.PrimitiveTypes.Float32)
s.runWithSparseVector(arrow.PrimitiveTypes.Uint64, arrow.PrimitiveTypes.Float64)
}
func TestParquetReader(t *testing.T) {
suite.Run(t, new(ReaderSuite))
}
func TestParquetReaderWithStructArray(t *testing.T) {
ctx := context.Background()
t.Run("test struct array field reading", func(t *testing.T) {
// Create schema with StructArrayField
schema := &schemapb.CollectionSchema{
Name: "test_struct_array",
Fields: []*schemapb.FieldSchema{
{
FieldID: 100,
Name: "id",
IsPrimaryKey: true,
DataType: schemapb.DataType_Int64,
},
{
FieldID: 101,
Name: "varchar_field",
DataType: schemapb.DataType_VarChar,
TypeParams: []*commonpb.KeyValuePair{
{Key: common.MaxLengthKey, Value: "100"},
},
},
},
StructArrayFields: []*schemapb.StructArrayFieldSchema{
{
FieldID: 200,
Name: "struct_array",
Fields: []*schemapb.FieldSchema{
{
FieldID: 201,
Name: "int_array",
DataType: schemapb.DataType_Array,
ElementType: schemapb.DataType_Int32,
TypeParams: []*commonpb.KeyValuePair{
{Key: common.MaxCapacityKey, Value: "20"},
},
},
{
FieldID: 202,
Name: "float_array",
DataType: schemapb.DataType_Array,
ElementType: schemapb.DataType_Float,
TypeParams: []*commonpb.KeyValuePair{
{Key: common.MaxCapacityKey, Value: "20"},
},
},
{
FieldID: 203,
Name: "vector_array",
DataType: schemapb.DataType_ArrayOfVector,
ElementType: schemapb.DataType_FloatVector,
TypeParams: []*commonpb.KeyValuePair{
{Key: common.DimKey, Value: "4"},
{Key: common.MaxCapacityKey, Value: "20"},
},
},
},
},
},
}
// Create test data file
filePath := fmt.Sprintf("/tmp/test_struct_array_%d.parquet", rand.Int())
defer os.Remove(filePath)
numRows := 10
f, err := os.Create(filePath)
assert.NoError(t, err)
// Use writeParquet to create test file
insertData, err := writeParquet(f, schema, numRows, 0)
assert.NoError(t, err)
f.Close()
// Verify the insert data contains struct fields
assert.Contains(t, insertData.Data, int64(201)) // int_array field
assert.Contains(t, insertData.Data, int64(202)) // float_array field
assert.Contains(t, insertData.Data, int64(203)) // vector_array field
// Now test reading the file using ChunkManager
factory := storage.NewChunkManagerFactory("local", objectstorage.RootPath("/tmp"))
cm, err := factory.NewPersistentStorageChunkManager(ctx)
assert.NoError(t, err)
reader, err := NewReader(ctx, cm, schema, filePath, 64*1024*1024)
assert.NoError(t, err)
defer reader.Close()
// Read data
readData, err := reader.Read()
assert.NoError(t, err)
assert.NotNil(t, readData)
// Verify the data includes struct fields
assert.Contains(t, readData.Data, int64(201)) // int_array field ID
assert.Contains(t, readData.Data, int64(202)) // float_array field ID
assert.Contains(t, readData.Data, int64(203)) // vector_array field ID
// Check row count matches
assert.Equal(t, numRows, readData.Data[100].RowNum()) // id field
assert.Equal(t, numRows, readData.Data[101].RowNum()) // varchar_field
assert.Equal(t, numRows, readData.Data[201].RowNum()) // int_array
assert.Equal(t, numRows, readData.Data[202].RowNum()) // float_array
assert.Equal(t, numRows, readData.Data[203].RowNum()) // vector_array
// Verify data content matches
for fieldID, originalData := range insertData.Data {
readFieldData, ok := readData.Data[fieldID]
assert.True(t, ok, "field %d not found in read data", fieldID)
assert.Equal(t, originalData.RowNum(), readFieldData.RowNum(), "row count mismatch for field %d", fieldID)
}
})
}
func TestParquetReaderError(t *testing.T) {
ctx := context.Background()
cm := mocks.NewChunkManager(t)
cm.EXPECT().Reader(mock.Anything, mock.Anything).Return(nil, merr.WrapErrImportFailed("read error"))
// io error
schema := &schemapb.CollectionSchema{
Fields: []*schemapb.FieldSchema{
{
FieldID: 100,
Name: "pk",
IsPrimaryKey: true,
DataType: schemapb.DataType_Int64,
AutoID: false,
},
{
FieldID: 101,
Name: "vec",
DataType: schemapb.DataType_SparseFloatVector,
IsFunctionOutput: false,
},
},
}
_, err := NewReader(ctx, cm, schema, "dummy path", 64*1024*1024)
assert.Error(t, err)
// temp tunction to write parquet file
writeParquetFunc := func(colSchema *schemapb.CollectionSchema, numRows int) string {
filePath := fmt.Sprintf("/tmp/test_%d_reader.parquet", rand.Int())
wf, err := os.OpenFile(filePath, os.O_RDWR|os.O_CREATE, 0o666)
assert.NoError(t, err)
pqSchema, err := ConvertToArrowSchemaForUT(colSchema, false)
assert.NoError(t, err)
fw, err := pqarrow.NewFileWriter(pqSchema, wf, parquet.NewWriterProperties(parquet.WithMaxRowGroupLength(int64(numRows))), pqarrow.DefaultWriterProps())
assert.NoError(t, err)
defer fw.Close()
insertData, err := testutil.CreateInsertData(schema, numRows, 0)
assert.NoError(t, err)
columns, err := testutil.BuildArrayData(schema, insertData, false)
assert.NoError(t, err)
recordBatch := array.NewRecord(pqSchema, columns, int64(numRows))
err = fw.Write(recordBatch)
assert.NoError(t, err)
return filePath
}
checkFunc := func(colSchema *schemapb.CollectionSchema, filePath string, succeed bool) {
f := storage.NewChunkManagerFactory("local", objectstorage.RootPath(testOutputPath))
c, err := f.NewPersistentStorageChunkManager(ctx)
assert.NoError(t, err)
_, err = NewReader(ctx, c, schema, filePath, 64*1024*1024)
if succeed {
assert.NoError(t, err)
} else {
assert.Error(t, err)
}
}
// the parquet file contains "pk" and "vec"
numRows := 3
filePath := writeParquetFunc(schema, numRows)
defer os.Remove(filePath)
// now set the pk to be AutoID
// NewReader will return error "the primary key is auto-generated, no need to provide"
schema.Fields[0].AutoID = true
checkFunc(schema, filePath, false)
// allow_insert_autoid=true should allow providing PK even if AutoID
schema.Fields[0].AutoID = true
schema.Properties = []*commonpb.KeyValuePair{{Key: common.AllowInsertAutoIDKey, Value: "true"}}
checkFunc(schema, filePath, true)
// reset properties
schema.Properties = nil
// now set the vec to be FunctionOutput
// NewReader will return error "the field is output by function, no need to provide"
schema.Fields[0].AutoID = false
schema.Fields[1].IsFunctionOutput = true
checkFunc(schema, filePath, false)
// now add a nullable field in the schema
// NewReader will succeed
schema.Fields[1].IsFunctionOutput = false
schema.Fields = append(schema.Fields, &schemapb.FieldSchema{
FieldID: 200,
Name: "new",
DataType: schemapb.DataType_Float,
Nullable: true,
})
checkFunc(schema, filePath, true)
// the new field is not nullable
// NewReader will return error "schema not equal"
schema.Fields[2].Nullable = false
checkFunc(schema, filePath, false)
// now add a dynamic field in the schema
// NewReader will succeed
schema.Fields[2].Nullable = true
schema.Fields = append(schema.Fields, &schemapb.FieldSchema{
FieldID: 300,
Name: "dynamic",
DataType: schemapb.DataType_JSON,
IsDynamic: true,
})
checkFunc(schema, filePath, true)
// the new file contains 4 fields: pk, vec, new, dynamic
filePath = writeParquetFunc(schema, numRows)
defer os.Remove(filePath)
// the schema has 2 fields: pk, vec
// NewReader will succeed
schema.Fields = schema.Fields[0:2]
checkFunc(schema, filePath, true)
}