forked from milvus-io/milvus
-
Notifications
You must be signed in to change notification settings - Fork 0
/
collection_options.go
242 lines (203 loc) · 6.94 KB
/
collection_options.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
// 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 (
"google.golang.org/protobuf/proto"
"github.com/milvus-io/milvus-proto/go-api/v2/commonpb"
"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"
)
// CreateCollectionOption is the interface builds CreateCollectionRequest.
type CreateCollectionOption interface {
// Request is the method returns the composed request.
Request() *milvuspb.CreateCollectionRequest
// Indexes is the method returns IndexOption to create
Indexes() []CreateIndexOption
IsFast() bool
}
// createCollectionOption contains all the parameters to create collection.
type createCollectionOption struct {
name string
shardNum int32
// fast create collection params
varcharPK bool
varcharPKMaxLength int
pkFieldName string
vectorFieldName string
dim int64
autoID bool
enabledDynamicSchema bool
// advanced create collection params
schema *entity.Schema
consistencyLevel entity.ConsistencyLevel
properties map[string]string
// partition key
numPartitions int64
// is fast create collection
isFast bool
// fast creation with index
metricType entity.MetricType
}
func (opt *createCollectionOption) WithAutoID(autoID bool) *createCollectionOption {
opt.autoID = autoID
return opt
}
func (opt *createCollectionOption) WithShardNum(shardNum int32) *createCollectionOption {
opt.shardNum = shardNum
return opt
}
func (opt *createCollectionOption) WithDynamicSchema(dynamicSchema bool) *createCollectionOption {
opt.enabledDynamicSchema = dynamicSchema
return opt
}
func (opt *createCollectionOption) WithVarcharPK(varcharPK bool, maxLen int) *createCollectionOption {
opt.varcharPK = varcharPK
opt.varcharPKMaxLength = maxLen
return opt
}
func (opt *createCollectionOption) Request() *milvuspb.CreateCollectionRequest {
// fast create collection
if opt.isFast {
var pkField *entity.Field
if opt.varcharPK {
pkField = entity.NewField().WithDataType(entity.FieldTypeVarChar).WithMaxLength(int64(opt.varcharPKMaxLength))
} else {
pkField = entity.NewField().WithDataType(entity.FieldTypeInt64)
}
pkField = pkField.WithName(opt.pkFieldName).WithIsPrimaryKey(true).WithIsAutoID(opt.autoID)
opt.schema = entity.NewSchema().
WithName(opt.name).
WithAutoID(opt.autoID).
WithDynamicFieldEnabled(opt.enabledDynamicSchema).
WithField(pkField).
WithField(entity.NewField().WithName(opt.vectorFieldName).WithDataType(entity.FieldTypeFloatVector).WithDim(opt.dim))
}
var schemaBytes []byte
if opt.schema != nil {
schemaProto := opt.schema.ProtoMessage()
schemaBytes, _ = proto.Marshal(schemaProto)
}
return &milvuspb.CreateCollectionRequest{
DbName: "", // reserved fields, not used for now
CollectionName: opt.name,
Schema: schemaBytes,
ShardsNum: opt.shardNum,
ConsistencyLevel: commonpb.ConsistencyLevel(opt.consistencyLevel),
NumPartitions: opt.numPartitions,
Properties: entity.MapKvPairs(opt.properties),
}
}
func (opt *createCollectionOption) Indexes() []CreateIndexOption {
// fast create
if opt.isFast {
return []CreateIndexOption{
NewCreateIndexOption(opt.name, opt.vectorFieldName, index.NewGenericIndex("", map[string]string{})),
}
}
return nil
}
func (opt *createCollectionOption) IsFast() bool {
return opt.isFast
}
// SimpleCreateCollectionOptions returns a CreateCollectionOption with default fast collection options.
func SimpleCreateCollectionOptions(name string, dim int64) *createCollectionOption {
return &createCollectionOption{
name: name,
shardNum: 1,
pkFieldName: "id",
vectorFieldName: "vector",
autoID: true,
dim: dim,
enabledDynamicSchema: true,
consistencyLevel: entity.DefaultConsistencyLevel,
isFast: true,
metricType: entity.COSINE,
}
}
// NewCreateCollectionOption returns a CreateCollectionOption with customized collection schema
func NewCreateCollectionOption(name string, collectionSchema *entity.Schema) *createCollectionOption {
return &createCollectionOption{
name: name,
shardNum: 1,
schema: collectionSchema,
consistencyLevel: entity.DefaultConsistencyLevel,
metricType: entity.COSINE,
}
}
type ListCollectionOption interface {
Request() *milvuspb.ShowCollectionsRequest
}
type listCollectionOption struct{}
func (opt *listCollectionOption) Request() *milvuspb.ShowCollectionsRequest {
return &milvuspb.ShowCollectionsRequest{}
}
func NewListCollectionOption() *listCollectionOption {
return &listCollectionOption{}
}
// DescribeCollectionOption is the interface builds DescribeCollection request.
type DescribeCollectionOption interface {
// Request is the method returns the composed request.
Request() *milvuspb.DescribeCollectionRequest
}
type describeCollectionOption struct {
name string
}
func (opt *describeCollectionOption) Request() *milvuspb.DescribeCollectionRequest {
return &milvuspb.DescribeCollectionRequest{
CollectionName: opt.name,
}
}
// NewDescribeCollectionOption composes a describeCollectionOption with provided collection name.
func NewDescribeCollectionOption(name string) *describeCollectionOption {
return &describeCollectionOption{
name: name,
}
}
// HasCollectionOption is the interface to build DescribeCollectionRequest.
type HasCollectionOption interface {
Request() *milvuspb.DescribeCollectionRequest
}
type hasCollectionOpt struct {
name string
}
func (opt *hasCollectionOpt) Request() *milvuspb.DescribeCollectionRequest {
return &milvuspb.DescribeCollectionRequest{
CollectionName: opt.name,
}
}
func NewHasCollectionOption(name string) HasCollectionOption {
return &hasCollectionOpt{
name: name,
}
}
// The DropCollectionOption interface builds DropCollectionRequest.
type DropCollectionOption interface {
Request() *milvuspb.DropCollectionRequest
}
type dropCollectionOption struct {
name string
}
func (opt *dropCollectionOption) Request() *milvuspb.DropCollectionRequest {
return &milvuspb.DropCollectionRequest{
CollectionName: opt.name,
}
}
func NewDropCollectionOption(name string) *dropCollectionOption {
return &dropCollectionOption{
name: name,
}
}