forked from couchbase/indexing
-
Notifications
You must be signed in to change notification settings - Fork 0
/
secondaryindexmanagement.go
458 lines (405 loc) · 12.3 KB
/
secondaryindexmanagement.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
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
package secondaryindex
import (
"errors"
"fmt"
c "github.com/couchbase/indexing/secondary/common"
qc "github.com/couchbase/indexing/secondary/queryport/client"
tc "github.com/couchbase/indexing/secondary/tests/framework/common"
"github.com/couchbase/query/expression"
"github.com/couchbase/query/parser/n1ql"
"log"
"time"
)
var IndexUsing = "gsi"
func CreateClient(server, serviceAddr string) (*qc.GsiClient, error) {
config := c.SystemConfig.SectionConfig("queryport.client.", true)
client, err := qc.NewGsiClient(server, config)
if err != nil {
log.Printf("Error while creating gsi client: ", err)
return nil, err
}
return client, nil
}
func GetDefnID(client *qc.GsiClient, bucket, indexName string) (defnID uint64, ok bool) {
indexes, _, _, err := client.Refresh()
tc.HandleError(err, "Error while listing the indexes")
for _, index := range indexes {
defn := index.Definition
if defn.Bucket == bucket && defn.Name == indexName {
return uint64(index.Definition.DefnId), true
}
}
return uint64(c.IndexDefnId(0)), false
}
// Creates an index and waits for it to become active
func CreateSecondaryIndex(
indexName, bucketName, server, whereExpr string, indexFields []string, isPrimary bool, with []byte,
skipIfExists bool, indexActiveTimeoutSeconds int64, client *qc.GsiClient) error {
if client == nil {
c, e := CreateClient(server, "2itest")
if e != nil {
return e
}
client = c
defer client.Close()
}
indexExists := IndexExistsWithClient(indexName, bucketName, server, client)
if skipIfExists == true && indexExists == true {
return nil
}
var secExprs []string
if isPrimary == false {
for _, indexField := range indexFields {
expr, err := n1ql.ParseExpression(indexField)
if err != nil {
log.Printf("Creating index %v. Error while parsing the expression (%v) : %v", indexName, indexField, err)
}
secExprs = append(secExprs, expression.NewStringer().Visit(expr))
}
}
exprType := "N1QL"
partnExp := ""
start := time.Now()
defnID, err := client.CreateIndex(indexName, bucketName, IndexUsing, exprType, partnExp, whereExpr, secExprs, isPrimary, with)
if err == nil {
log.Printf("Created the secondary index %v. Waiting for it become active", indexName)
e := WaitTillIndexActive(defnID, client, indexActiveTimeoutSeconds)
if e != nil {
return e
} else {
elapsed := time.Since(start)
tc.LogPerfStat("CreateAndBuildIndex", elapsed)
return nil
}
}
return err
}
// Creates an index and waits for it to become active
func CreateSecondaryIndex2(
indexName, bucketName, server, whereExpr string, indexFields []string, desc []bool, isPrimary bool, with []byte,
skipIfExists bool, indexActiveTimeoutSeconds int64, client *qc.GsiClient) error {
if client == nil {
c, e := CreateClient(server, "2itest")
if e != nil {
return e
}
client = c
defer client.Close()
}
indexExists := IndexExistsWithClient(indexName, bucketName, server, client)
if skipIfExists == true && indexExists == true {
return nil
}
var secExprs []string
if isPrimary == false {
for _, indexField := range indexFields {
expr, err := n1ql.ParseExpression(indexField)
if err != nil {
log.Printf("Creating index %v. Error while parsing the expression (%v) : %v", indexName, indexField, err)
}
secExprs = append(secExprs, expression.NewStringer().Visit(expr))
}
}
exprType := "N1QL"
partnExp := ""
start := time.Now()
defnID, err := client.CreateIndex2(indexName, bucketName, IndexUsing, exprType, partnExp, whereExpr, secExprs, desc, isPrimary, with)
if err == nil {
log.Printf("Created the secondary index %v. Waiting for it become active", indexName)
e := WaitTillIndexActive(defnID, client, indexActiveTimeoutSeconds)
if e != nil {
return e
} else {
elapsed := time.Since(start)
tc.LogPerfStat("CreateAndBuildIndex", elapsed)
return nil
}
}
return err
}
// Creates an index and DOES NOT wait for it to become active
func CreateSecondaryIndexAsync(
indexName, bucketName, server, whereExpr string, indexFields []string, isPrimary bool, with []byte,
skipIfExists bool, client *qc.GsiClient) error {
if client == nil {
c, e := CreateClient(server, "2itest")
if e != nil {
return e
}
client = c
defer client.Close()
}
indexExists := IndexExistsWithClient(indexName, bucketName, server, client)
if skipIfExists == true && indexExists == true {
return nil
}
var secExprs []string
if isPrimary == false {
for _, indexField := range indexFields {
expr, err := n1ql.ParseExpression(indexField)
if err != nil {
log.Printf("Creating index %v. Error while parsing the expression (%v) : %v", indexName, indexField, err)
}
secExprs = append(secExprs, expression.NewStringer().Visit(expr))
}
}
exprType := "N1QL"
partnExp := ""
_, err := client.CreateIndex(indexName, bucketName, IndexUsing, exprType, partnExp, whereExpr, secExprs, isPrimary, with)
if err == nil {
log.Printf("Created the secondary index %v", indexName)
return nil
}
return err
}
// Todo: Remove this function and update functional tests to use BuildIndexes
func BuildIndex(indexName, bucketName, server string, indexActiveTimeoutSeconds int64) error {
client, e := CreateClient(server, "2itest")
if e != nil {
return e
}
defer client.Close()
defnID, _ := GetDefnID(client, bucketName, indexName)
start := time.Now()
err := client.BuildIndexes([]uint64{defnID})
time.Sleep(2 * time.Second) // This wait is required for index state to get updated from error to initial, for example
if err == nil {
log.Printf("Build the deferred index %v. Waiting for the index to become active", indexName)
e := WaitTillIndexActive(defnID, client, indexActiveTimeoutSeconds)
if e != nil {
return e
} else {
elapsed := time.Since(start)
tc.LogPerfStat("BuildIndex", elapsed)
return nil
}
}
return err
}
func BuildIndexes(indexNames []string, bucketName, server string, indexActiveTimeoutSeconds int64) error {
client, e := CreateClient(server, "2itest")
if e != nil {
return e
}
defer client.Close()
defnIds := make([]uint64, len(indexNames))
for i := range indexNames {
defnIds[i], _ = GetDefnID(client, bucketName, indexNames[i])
}
err := client.BuildIndexes(defnIds)
log.Printf("Build command issued for the deferred indexes %v", indexNames)
if err == nil {
for i := range indexNames {
log.Printf("Waiting for the index %v to become active", indexNames[i])
e := WaitTillIndexActive(defnIds[i], client, indexActiveTimeoutSeconds)
if e != nil {
return e
}
}
}
return err
}
func BuildIndexesAsync(defnIds []uint64, server string, indexActiveTimeoutSeconds int64) error {
client, e := CreateClient(server, "2itest")
if e != nil {
return e
}
defer client.Close()
err := client.BuildIndexes(defnIds)
log.Printf("Build command issued for the deferred indexes %v", defnIds)
return err
}
func WaitTillIndexActive(defnID uint64, client *qc.GsiClient, indexActiveTimeoutSeconds int64) error {
start := time.Now()
for {
elapsed := time.Since(start)
if elapsed.Seconds() >= float64(indexActiveTimeoutSeconds) {
err := errors.New(fmt.Sprintf("Index did not become active after %d seconds", indexActiveTimeoutSeconds))
return err
}
state, _ := client.IndexState(defnID)
if state == c.INDEX_STATE_ACTIVE {
log.Printf("Index is now active")
return nil
} else {
log.Printf("Waiting for index to go active ...")
time.Sleep(1 * time.Second)
}
}
return nil
}
func WaitTillAllIndexNodesActive(server string, indexerActiveTimeoutSeconds int64) error {
client, e := CreateClient(server, "2itest")
if e != nil {
return e
}
start := time.Now()
for {
elapsed := time.Since(start)
if elapsed.Seconds() >= float64(indexerActiveTimeoutSeconds) {
err := errors.New(fmt.Sprintf("Indexer(s) did not become online after %d seconds", indexerActiveTimeoutSeconds))
return err
}
indexers, e := client.Nodes()
if e != nil {
log.Printf("Error while fetching Nodes() %v", e)
return e
}
allIndexersActive := true
for _, indexer := range indexers {
if indexer.Status != "online" {
allIndexersActive = false
}
}
if allIndexersActive == true {
log.Printf("All indexers are active")
return nil
}
}
return nil
}
func IndexState(indexName, bucketName, server string) (string, error) {
client, e := CreateClient(server, "2itest")
if e != nil {
return "", e
}
defer client.Close()
defnID, _ := GetDefnID(client, bucketName, indexName)
state, e := client.IndexState(defnID)
if e != nil {
log.Printf("Error while fetching index state for defnID %v", defnID)
return "", e
}
return state.String(), nil
}
func IndexExists(indexName, bucketName, server string) (bool, error) {
client, e := CreateClient(server, "2itest")
if e != nil {
return false, e
}
defer client.Close()
indexes, _, _, err := client.Refresh()
tc.HandleError(err, "Error while listing the secondary indexes")
for _, index := range indexes {
defn := index.Definition
if defn.Name == indexName && defn.Bucket == bucketName {
log.Printf("Index found: %v", indexName)
return true, nil
}
}
return false, nil
}
func IndexExistsWithClient(indexName, bucketName, server string, client *qc.GsiClient) bool {
indexes, _, _, err := client.Refresh()
tc.HandleError(err, "Error while listing the secondary indexes")
for _, index := range indexes {
defn := index.Definition
if defn.Name == indexName && defn.Bucket == bucketName {
log.Printf("Index found: %v", indexName)
return true
}
}
return false
}
func DropSecondaryIndex(indexName, bucketName, server string) error {
log.Printf("Dropping the secondary index %v", indexName)
client, e := CreateClient(server, "2itest")
if e != nil {
return e
}
defer client.Close()
indexes, _, _, err := client.Refresh()
tc.HandleError(err, "Error while listing the secondary indexes")
for _, index := range indexes {
defn := index.Definition
if (defn.Name == indexName) && (defn.Bucket == bucketName) {
start := time.Now()
e := client.DropIndex(uint64(defn.DefnId))
elapsed := time.Since(start)
if e == nil {
log.Printf("Index dropped")
tc.LogPerfStat("DropIndex", elapsed)
} else {
return e
}
}
}
return nil
}
func DropSecondaryIndexWithClient(indexName, bucketName, server string, client *qc.GsiClient) error {
log.Printf("Dropping the secondary index %v", indexName)
indexes, _, _, err := client.Refresh()
tc.HandleError(err, "Error while listing the secondary indexes")
for _, index := range indexes {
defn := index.Definition
if (defn.Name == indexName) && (defn.Bucket == bucketName) {
start := time.Now()
e := client.DropIndex(uint64(defn.DefnId))
elapsed := time.Since(start)
if e == nil {
log.Printf("Index dropped")
tc.LogPerfStat("DropIndex", elapsed)
} else {
return e
}
}
}
return nil
}
func DropAllSecondaryIndexes(server string) error {
log.Printf("In DropAllSecondaryIndexes()")
client, e := CreateClient(server, "2itest")
if e != nil {
return e
}
defer client.Close()
indexes, _, _, err := client.Refresh()
tc.HandleError(err, "Error while listing the secondary indexes")
for _, index := range indexes {
defn := index.Definition
// start := time.Now()
e := client.DropIndex(uint64(defn.DefnId))
// elapsed := time.Since(start)
if e != nil {
return e
}
log.Printf("Dropped index %v", defn.Name)
// tc.LogPerfStat("DropIndex", elapsed) // Commenting out this log as it is used only in setup
}
return nil
}
func DropSecondaryIndexByID(indexDefnID uint64, server string) error {
log.Printf("Dropping the secondary index %v", indexDefnID)
client, e := CreateClient(server, "2itest")
if e != nil {
return e
}
defer client.Close()
e = client.DropIndex(indexDefnID)
if e != nil {
return e
}
log.Printf("Index dropped")
return nil
}
func BuildAllSecondaryIndexes(server string, indexActiveTimeoutSeconds int64) error {
log.Printf("In BuildAllSecondaryIndexes()")
client, e := CreateClient(server, "2itest")
if e != nil {
return e
}
defer client.Close()
indexes, _, _, err := client.Refresh()
tc.HandleError(err, "Error while listing the secondary indexes")
for i, index := range indexes {
defn := index.Definition
log.Printf("Building index %v %v", i, defn.Name)
state, _ := client.IndexState(uint64(defn.DefnId))
if state == c.INDEX_STATE_ACTIVE {
continue
}
err = BuildIndex(defn.Name, defn.Bucket, server, indexActiveTimeoutSeconds)
log.Printf("Built index %v %v", i, defn.Name)
}
return err
}