-
Notifications
You must be signed in to change notification settings - Fork 9
/
documents.go
274 lines (220 loc) · 8.26 KB
/
documents.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
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
package rockset
import (
"bytes"
"context"
"encoding/json"
"fmt"
"io"
"net/http"
"github.com/rs/zerolog"
rockerr "github.com/rockset/rockset-go-client/errors"
"github.com/rockset/rockset-go-client/openapi"
)
// https://docs.rockset.com/rest-api/#documents
// AddDocuments adds new documents to a collection
//
// REST API documentation https://docs.rockset.com/rest-api/#adddocuments
func (rc *RockClient) AddDocuments(ctx context.Context, workspace, collection string,
docs []interface{}) ([]openapi.DocumentStatus, error) {
resp, err := rc.AddDocumentsWithOffset(ctx, workspace, collection, docs)
if err != nil {
return nil, err
}
return resp.GetData(), nil
}
// AddDocumentsWithOffset adds new documents to a collection, and returns the response with the offset(s),
// which can be used to wait until the collection includes the documents at or after the specified offset(s).
//
// response, err := rs.AddDocumentsWithOffset(ctx, "commons", "users", docs)
// if err != nil {
// return err
// }
// w := wait.New(rs)
// err = w.UntilQueryable(ctx, "commons", "users", []string{response.GetLastOffset()})
//
// The added documents are now queryable in the collection.
func (rc *RockClient) AddDocumentsWithOffset(ctx context.Context, workspace, collection string,
docs []interface{}) (openapi.AddDocumentsResponse, error) {
var err error
var httpResp *http.Response
var resp *openapi.AddDocumentsResponse
q := rc.DocumentsApi.AddDocuments(ctx, workspace, collection)
// TODO should the method accept []map[string]interface{} instead?
payload := make([]map[string]interface{}, len(docs))
for i, d := range docs {
payload[i] = d.(map[string]interface{})
}
req := openapi.NewAddDocumentsRequest(payload)
err = rc.Retry(ctx, func() error {
resp, httpResp, err = q.Body(*req).Execute()
return rockerr.NewWithStatusCode(err, httpResp)
})
if err != nil {
return openapi.AddDocumentsResponse{}, err
}
log := zerolog.Ctx(ctx)
logDocumentStatuses(log.Trace(), resp.GetData()).Msg("added documents")
return *resp, nil
}
// AddDocumentsRaw is a convenience method that adds new documents to a collection using a raw JSON payload,
// which has to be an array of objects.
//
// This method is useful when the documents are already in JSON format and do not need to be converted to
// a []map[string]interface{} slice, which is required by AddDocuments() and AddDocumentsWithOffset().
func (rc *RockClient) AddDocumentsRaw(ctx context.Context, workspace, collection string,
docs json.RawMessage) ([]openapi.DocumentStatus, error) {
return rawDocuments[*openapi.AddDocumentsResponse](ctx, rc, workspace, collection, http.MethodPost,
io.MultiReader(bytes.NewBufferString(`{"data": `), bytes.NewReader(docs), bytes.NewBufferString("}")))
}
type patchDocumentRequest struct {
Data []PatchDocument `json:"data"`
}
type PatchDocument struct {
ID string `json:"_id"`
Patches []PatchOperation `json:"patch"`
}
type PatchOperation struct {
Op string `json:"op"`
Path string `json:"path"`
Value interface{} `json:"value"`
From *string `json:"from"`
}
// PatchDocuments patches (updates) existing documents in a collection. This convenience method does not use the
// generated client, as it takes values as map[string]interface{} which doesn't work when you want to patch e.g.
// a top-level boolean value.
//
// REST API documentation https://docs.rockset.com/rest-api/#patchdocuments
func (rc *RockClient) PatchDocuments(ctx context.Context, workspace, collection string,
patches []PatchDocument) ([]openapi.DocumentStatus, error) {
data := patchDocumentRequest{Data: patches}
payload := bytes.Buffer{}
e := json.NewEncoder(&payload)
if err := e.Encode(data); err != nil {
return nil, err
}
return rawDocuments[*openapi.PatchDocumentsResponse](ctx, rc, workspace, collection, http.MethodPatch, &payload)
}
type documentStatus interface {
GetData() []openapi.DocumentStatus
}
// rawDocuments is a generic method to send raw documents to the Rockset REST API
func rawDocuments[T documentStatus](ctx context.Context, rc *RockClient, workspace, collection, method string,
payload io.Reader) ([]openapi.DocumentStatus, error) {
var err error
var resp *http.Response
req, err := rawDocumentsRequest(ctx, rc.RockConfig, workspace, collection, method, payload)
if err != nil {
return nil, err
}
err = rc.Retry(ctx, func() error {
resp, err = rc.RockConfig.cfg.HTTPClient.Do(req)
return rockerr.NewWithStatusCode(err, resp)
})
if err != nil {
return nil, err
}
defer closeAndLog(ctx, resp.Body)
body, err := io.ReadAll(resp.Body)
if err != nil {
return nil, err
}
log := zerolog.Ctx(ctx)
// should this accept all 2xx status codes?
if resp.StatusCode == http.StatusOK {
var pdr T
if err = json.Unmarshal(body, &pdr); err != nil {
return nil, err
}
logDocumentStatuses(log.Trace(), pdr.GetData()).Msg("patched documents")
return pdr.GetData(), nil
}
// if we get here, something went wrong, see if the error can be extracted from the body
var em openapi.ErrorModel
if err = json.Unmarshal(body, &em); err != nil {
log.Error().Err(err).Str("body", string(body)).Msg("failed to unmarshal response")
return nil, fmt.Errorf("failed to unmarshal response: %w", err)
}
return nil, rockerr.Error{
ErrorModel: &em,
Cause: fmt.Errorf("unexpected http response (%d): %s", resp.StatusCode, resp.Status),
}
}
const docsURL = "https://%s/v1/orgs/self/ws/%s/collections/%s/docs"
func rawDocumentsRequest(ctx context.Context, rockConfig RockConfig, ws, collection, method string,
payload io.Reader) (*http.Request, error) {
// workspace and collection do not need to be escaped as they can only contain alphanumeric or dash characters
u := fmt.Sprintf(docsURL, rockConfig.APIServer, ws, collection)
req, err := http.NewRequestWithContext(ctx, method, u, payload)
if err != nil {
return nil, err
}
req.Header.Set("Content-Type", "application/json")
req.Header.Set("Accept", "application/json")
req.Header.Set("User-Agent", rockConfig.cfg.UserAgent)
// copy all default headers
for k, v := range rockConfig.cfg.DefaultHeader {
req.Header.Set(k, v)
}
return req, nil
}
func closeAndLog(ctx context.Context, c io.Closer) {
if err := c.Close(); err != nil {
log := zerolog.Ctx(ctx)
log.Error().Err(err).Msg("failed to close")
}
}
// DeleteDocuments deletes documents from a collection
//
// REST API documentation https://docs.rockset.com/rest-api/#deletedocuments
func (rc *RockClient) DeleteDocuments(ctx context.Context, workspace, collection string,
docIDs []string) ([]openapi.DocumentStatus, error) {
resp, err := rc.DeleteDocumentsWithOffset(ctx, workspace, collection, docIDs)
if err != nil {
return nil, err
}
return resp.GetData(), nil
}
// DeleteDocumentsWithOffset deletes documents from a collection, and returns the response with the offset(s),
// which can be used to wait until the collection has been updated to include the specified offset(s).
//
// response, err := rs.DeleteDocumentsWithOffset(ctx, "commons", "users", docIDs)
// if err != nil {
// return err
// }
// w := wait.New(rs)
// err = w.UntilQueryable(ctx, "commons", "users", []string{response.GetLastOffset()})
//
// The added documents are now queryable in the collection.
func (rc *RockClient) DeleteDocumentsWithOffset(ctx context.Context, workspace, collection string,
docIDs []string) (openapi.DeleteDocumentsResponse, error) {
var err error
var httpResp *http.Response
var resp *openapi.DeleteDocumentsResponse
q := rc.DocumentsApi.DeleteDocuments(ctx, workspace, collection)
ids := make([]openapi.DeleteDocumentsRequestData, len(docIDs))
for i, id := range docIDs {
ids[i] = openapi.DeleteDocumentsRequestData{Id: id}
}
req := openapi.NewDeleteDocumentsRequest(ids)
err = rc.Retry(ctx, func() error {
resp, httpResp, err = q.Body(*req).Execute()
return rockerr.NewWithStatusCode(err, httpResp)
})
if err != nil {
return openapi.DeleteDocumentsResponse{}, err
}
log := zerolog.Ctx(ctx)
logDocumentStatuses(log.Trace(), resp.GetData()).Msg("deleted documents")
return *resp, nil
}
func logDocumentStatuses(e *zerolog.Event, statuses []openapi.DocumentStatus) *zerolog.Event {
result := map[string]int{}
for _, s := range statuses {
i := result[s.GetStatus()]
result[s.GetStatus()] = i + 1
}
for k, v := range result {
e.Int(k, v)
}
return e
}