milvus/client/index_options.go
congqixia 244d2c04f6
feat: Add milvusclient package and migrate GoSDK (#32907)
Related to #31293

Signed-off-by: Congqi Xia <congqi.xia@zilliz.com>
2024-05-10 18:01:30 +08:00

138 lines
3.6 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 client
import (
"github.com/milvus-io/milvus-proto/go-api/v2/milvuspb"
"github.com/milvus-io/milvus/client/v2/entity"
"github.com/milvus-io/milvus/client/v2/index"
)
type CreateIndexOption interface {
Request() *milvuspb.CreateIndexRequest
}
type createIndexOption struct {
collectionName string
fieldName string
indexName string
indexDef index.Index
}
func (opt *createIndexOption) Request() *milvuspb.CreateIndexRequest {
return &milvuspb.CreateIndexRequest{
CollectionName: opt.collectionName,
FieldName: opt.fieldName,
IndexName: opt.indexName,
ExtraParams: entity.MapKvPairs(opt.indexDef.Params()),
}
}
func (opt *createIndexOption) WithIndexName(indexName string) *createIndexOption {
opt.indexName = indexName
return opt
}
func NewCreateIndexOption(collectionName string, fieldName string, index index.Index) *createIndexOption {
return &createIndexOption{
collectionName: collectionName,
fieldName: fieldName,
indexDef: index,
}
}
type ListIndexOption interface {
Request() *milvuspb.DescribeIndexRequest
Matches(*milvuspb.IndexDescription) bool
}
var _ ListIndexOption = (*listIndexOption)(nil)
type listIndexOption struct {
collectionName string
fieldName string
}
func (opt *listIndexOption) WithFieldName(fieldName string) *listIndexOption {
opt.fieldName = fieldName
return opt
}
func (opt *listIndexOption) Matches(idxDef *milvuspb.IndexDescription) bool {
return opt.fieldName == "" || idxDef.GetFieldName() == opt.fieldName
}
func (opt *listIndexOption) Request() *milvuspb.DescribeIndexRequest {
return &milvuspb.DescribeIndexRequest{
CollectionName: opt.collectionName,
FieldName: opt.fieldName,
}
}
func NewListIndexOption(collectionName string) *listIndexOption {
return &listIndexOption{
collectionName: collectionName,
}
}
type DescribeIndexOption interface {
Request() *milvuspb.DescribeIndexRequest
}
type describeIndexOption struct {
collectionName string
fieldName string
indexName string
}
func (opt *describeIndexOption) Request() *milvuspb.DescribeIndexRequest {
return &milvuspb.DescribeIndexRequest{
CollectionName: opt.collectionName,
IndexName: opt.indexName,
}
}
func NewDescribeIndexOption(collectionName string, indexName string) *describeIndexOption {
return &describeIndexOption{
collectionName: collectionName,
indexName: indexName,
}
}
type DropIndexOption interface {
Request() *milvuspb.DropIndexRequest
}
type dropIndexOption struct {
collectionName string
indexName string
}
func (opt *dropIndexOption) Request() *milvuspb.DropIndexRequest {
return &milvuspb.DropIndexRequest{
CollectionName: opt.collectionName,
IndexName: opt.indexName,
}
}
func NewDropIndexOption(collectionName string, indexName string) *dropIndexOption {
return &dropIndexOption{
collectionName: collectionName,
indexName: indexName,
}
}