-
Notifications
You must be signed in to change notification settings - Fork 72
/
client.go
89 lines (78 loc) · 3.22 KB
/
client.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
//
// Copyright (C) 2019-2020 Vdaas.org Vald team ( kpango, rinx, kmrmt )
//
// Licensed 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
//
// https://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 provides vald component client interfaces
package client
import (
"context"
"github.com/vdaas/vald/apis/grpc/payload"
)
type (
ObjectID = payload.Object_ID
ObjectIDs = payload.Object_IDs
ObjectVector = payload.Object_Vector
ObjectVectors = payload.Object_Vectors
SearchRequest = payload.Search_Request
SearchIDRequest = payload.Search_IDRequest
SearchResponse = payload.Search_Response
ControlCreateIndexRequest = payload.Control_CreateIndexRequest
InfoIndex = payload.Info_Index
MetaObject = payload.Backup_MetaVector
Empty = payload.Empty
SearchConfig = payload.Search_Config
ObjectDistance = payload.Object_Distance
BackupMetaVector = payload.Backup_MetaVector
)
type Client interface {
Reader
Writer
}
type Reader interface {
Exists(context.Context, *ObjectID) (*ObjectID, error)
Search(context.Context, *SearchRequest) (*SearchResponse, error)
SearchByID(context.Context, *SearchIDRequest) (*SearchResponse, error)
StreamSearch(context.Context, func() *SearchRequest, func(*SearchResponse, error)) error
StreamSearchByID(context.Context, func() *SearchIDRequest, func(*SearchResponse, error)) error
}
type Writer interface {
Insert(context.Context, *ObjectVector) error
StreamInsert(context.Context, func() *ObjectVector, func(error)) error
MultiInsert(context.Context, *ObjectVectors) error
Update(context.Context, *ObjectVector) error
StreamUpdate(context.Context, func() *ObjectVector, func(error)) error
MultiUpdate(context.Context, *ObjectVectors) error
Remove(context.Context, *ObjectID) error
StreamRemove(context.Context, func() *ObjectID, func(error)) error
MultiRemove(context.Context, *ObjectIDs) error
}
type Upserter interface {
Upsert(context.Context, *ObjectVector) error
MultiUpsert(context.Context, *ObjectVectors) error
StreamUpsert(context.Context, func() *ObjectVector, func(error)) error
}
type ObjectReader interface {
GetObject(context.Context, *ObjectID) (*ObjectVector, error)
StreamGetObject(context.Context, func() *ObjectID, func(*ObjectVector, error)) error
}
type MetaObjectReader interface {
GetObject(context.Context, *ObjectID) (*MetaObject, error)
StreamGetObject(context.Context, func() *ObjectID, func(*MetaObject, error)) error
}
type Indexer interface {
CreateIndex(context.Context, *ControlCreateIndexRequest) error
SaveIndex(context.Context) error
CreateAndSaveIndex(context.Context, *ControlCreateIndexRequest) error
IndexInfo(context.Context) (*InfoIndex, error)
}