-
Notifications
You must be signed in to change notification settings - Fork 198
/
result_code.go
576 lines (398 loc) · 15.3 KB
/
result_code.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
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
// Copyright 2014-2021 Aerospike, Inc.
//
// 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
//
// 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 types
import "fmt"
// ResultCode signifies the database operation error codes.
// The positive numbers align with the server side file proto.h.
type ResultCode int
const (
// MAX_RETRIES_EXCEEDED defines max retries limit reached.
MAX_RETRIES_EXCEEDED ResultCode = -16
// MAX_ERROR_RATE defines max errors limit reached.
MAX_ERROR_RATE ResultCode = -15
// RACK_NOT_DEFINED defines requested Rack for node/namespace was not defined in the cluster.
RACK_NOT_DEFINED ResultCode = -13
// INVALID_CLUSTER_PARTITION_MAP defines cluster has an invalid partition map, usually due to bad configuration.
INVALID_CLUSTER_PARTITION_MAP ResultCode = -12
// SERVER_NOT_AVAILABLE defines server is not accepting requests.
SERVER_NOT_AVAILABLE ResultCode = -11
// CLUSTER_NAME_MISMATCH_ERROR defines cluster Name does not match the ClientPolicy.ClusterName value.
CLUSTER_NAME_MISMATCH_ERROR ResultCode = -10
// RECORDSET_CLOSED defines recordset has already been closed or cancelled
RECORDSET_CLOSED ResultCode = -9
// NO_AVAILABLE_CONNECTIONS_TO_NODE defines there were no connections available to the node in the pool, and the pool was limited
NO_AVAILABLE_CONNECTIONS_TO_NODE ResultCode = -8
// TYPE_NOT_SUPPORTED defines data type is not supported by aerospike server.
TYPE_NOT_SUPPORTED ResultCode = -7
// COMMAND_REJECTED defines info Command was rejected by the server.
COMMAND_REJECTED ResultCode = -6
// QUERY_TERMINATED defines query was terminated by user.
QUERY_TERMINATED ResultCode = -5
// SCAN_TERMINATED defines scan was terminated by user.
SCAN_TERMINATED ResultCode = -4
// INVALID_NODE_ERROR defines chosen node is not currently active.
INVALID_NODE_ERROR ResultCode = -3
// PARSE_ERROR defines client parse error.
PARSE_ERROR ResultCode = -2
// SERIALIZE_ERROR defines client serialization error.
SERIALIZE_ERROR ResultCode = -1
// OK defines operation was successful.
OK ResultCode = 0
// SERVER_ERROR defines unknown server failure.
SERVER_ERROR ResultCode = 1
// KEY_NOT_FOUND_ERROR defines on retrieving, touching or replacing a record that doesn't exist.
KEY_NOT_FOUND_ERROR ResultCode = 2
// GENERATION_ERROR defines on modifying a record with unexpected generation.
GENERATION_ERROR ResultCode = 3
// PARAMETER_ERROR defines bad parameter(s) were passed in database operation call.
PARAMETER_ERROR ResultCode = 4
// KEY_EXISTS_ERROR defines on create-only (write unique) operations on a record that already
// exists.
KEY_EXISTS_ERROR ResultCode = 5
// BIN_EXISTS_ERROR defines bin already exists on a create-only operation.
BIN_EXISTS_ERROR ResultCode = 6
// CLUSTER_KEY_MISMATCH defines expected cluster ID was not received.
CLUSTER_KEY_MISMATCH ResultCode = 7
// SERVER_MEM_ERROR defines server has run out of memory.
SERVER_MEM_ERROR ResultCode = 8
// TIMEOUT defines client or server has timed out.
TIMEOUT ResultCode = 9
// ALWAYS_FORBIDDEN defines operation not allowed in current configuration.
ALWAYS_FORBIDDEN ResultCode = 10
// PARTITION_UNAVAILABLE defines partition is unavailable.
PARTITION_UNAVAILABLE ResultCode = 11
// BIN_TYPE_ERROR defines operation is not supported with configured bin type (single-bin or
// multi-bin).
BIN_TYPE_ERROR ResultCode = 12
// RECORD_TOO_BIG defines record size exceeds limit.
RECORD_TOO_BIG ResultCode = 13
// KEY_BUSY defines too many concurrent operations on the same record.
KEY_BUSY ResultCode = 14
// SCAN_ABORT defines scan aborted by server.
SCAN_ABORT ResultCode = 15
// UNSUPPORTED_FEATURE defines unsupported Server Feature (e.g. Scan + UDF)
UNSUPPORTED_FEATURE ResultCode = 16
// BIN_NOT_FOUND defines bin not found on update-only operation.
BIN_NOT_FOUND ResultCode = 17
// DEVICE_OVERLOAD defines device not keeping up with writes.
DEVICE_OVERLOAD ResultCode = 18
// KEY_MISMATCH defines key type mismatch.
KEY_MISMATCH ResultCode = 19
// INVALID_NAMESPACE defines invalid namespace.
INVALID_NAMESPACE ResultCode = 20
// BIN_NAME_TOO_LONG defines bin name length greater than 14 characters,
// or maximum number of unique bin names are exceeded.
BIN_NAME_TOO_LONG ResultCode = 21
// FAIL_FORBIDDEN defines operation not allowed at this time.
FAIL_FORBIDDEN ResultCode = 22
// FAIL_ELEMENT_NOT_FOUND defines element Not Found in CDT
FAIL_ELEMENT_NOT_FOUND ResultCode = 23
// FAIL_ELEMENT_EXISTS defines element Already Exists in CDT
FAIL_ELEMENT_EXISTS ResultCode = 24
// ENTERPRISE_ONLY defines attempt to use an Enterprise feature on a Community server or a server
// without the applicable feature key.
ENTERPRISE_ONLY ResultCode = 25
// OP_NOT_APPLICABLE defines the operation cannot be applied to the current bin value on the server.
OP_NOT_APPLICABLE ResultCode = 26
// FILTERED_OUT defines the transaction was not performed because the filter was false.
FILTERED_OUT ResultCode = 27
// LOST_CONFLICT defines write command loses conflict to XDR.
LOST_CONFLICT = 28
// QUERY_END defines there are no more records left for query.
QUERY_END ResultCode = 50
// SECURITY_NOT_SUPPORTED defines security type not supported by connected server.
SECURITY_NOT_SUPPORTED ResultCode = 51
// SECURITY_NOT_ENABLED defines administration command is invalid.
SECURITY_NOT_ENABLED ResultCode = 52
// SECURITY_SCHEME_NOT_SUPPORTED defines administration field is invalid.
SECURITY_SCHEME_NOT_SUPPORTED ResultCode = 53
// INVALID_COMMAND defines administration command is invalid.
INVALID_COMMAND ResultCode = 54
// INVALID_FIELD defines administration field is invalid.
INVALID_FIELD ResultCode = 55
// ILLEGAL_STATE defines security protocol not followed.
ILLEGAL_STATE ResultCode = 56
// INVALID_USER defines user name is invalid.
INVALID_USER ResultCode = 60
// USER_ALREADY_EXISTS defines user was previously created.
USER_ALREADY_EXISTS ResultCode = 61
// INVALID_PASSWORD defines password is invalid.
INVALID_PASSWORD ResultCode = 62
// EXPIRED_PASSWORD defines security credential is invalid.
EXPIRED_PASSWORD ResultCode = 63
// FORBIDDEN_PASSWORD defines forbidden password (e.g. recently used)
FORBIDDEN_PASSWORD ResultCode = 64
// INVALID_CREDENTIAL defines security credential is invalid.
INVALID_CREDENTIAL ResultCode = 65
// EXPIRED_SESSION defines login session expired.
EXPIRED_SESSION ResultCode = 66
// INVALID_ROLE defines role name is invalid.
INVALID_ROLE ResultCode = 70
// ROLE_ALREADY_EXISTS defines role already exists.
ROLE_ALREADY_EXISTS ResultCode = 71
// INVALID_PRIVILEGE defines privilege is invalid.
INVALID_PRIVILEGE ResultCode = 72
// INVALID_WHITELIST defines invalid IP address whiltelist
INVALID_WHITELIST = 73
// NOT_AUTHENTICATED defines user must be authentication before performing database operations.
NOT_AUTHENTICATED ResultCode = 80
// ROLE_VIOLATION defines user does not posses the required role to perform the database operation.
ROLE_VIOLATION ResultCode = 81
// NOT_WHITELISTED defines command not allowed because sender IP address not whitelisted.
NOT_WHITELISTED = 82
// UDF_BAD_RESPONSE defines a user defined function returned an error code.
UDF_BAD_RESPONSE ResultCode = 100
// BATCH_DISABLED defines batch functionality has been disabled.
BATCH_DISABLED ResultCode = 150
// BATCH_MAX_REQUESTS_EXCEEDED defines batch max requests have been exceeded.
BATCH_MAX_REQUESTS_EXCEEDED ResultCode = 151
// BATCH_QUEUES_FULL defines all batch queues are full.
BATCH_QUEUES_FULL ResultCode = 152
// GEO_INVALID_GEOJSON defines invalid GeoJSON on insert/update
GEO_INVALID_GEOJSON ResultCode = 160
// INDEX_FOUND defines secondary index already exists.
INDEX_FOUND ResultCode = 200
// INDEX_NOTFOUND defines requested secondary index does not exist.
INDEX_NOTFOUND ResultCode = 201
// INDEX_OOM defines secondary index memory space exceeded.
INDEX_OOM ResultCode = 202
// INDEX_NOTREADABLE defines secondary index not available.
INDEX_NOTREADABLE ResultCode = 203
// INDEX_GENERIC defines generic secondary index error.
INDEX_GENERIC ResultCode = 204
// INDEX_NAME_MAXLEN defines index name maximum length exceeded.
INDEX_NAME_MAXLEN ResultCode = 205
// INDEX_MAXCOUNT defines maximum number of indexes exceeded.
INDEX_MAXCOUNT ResultCode = 206
// QUERY_ABORTED defines secondary index query aborted.
QUERY_ABORTED ResultCode = 210
// QUERY_QUEUEFULL defines secondary index queue full.
QUERY_QUEUEFULL ResultCode = 211
// QUERY_TIMEOUT defines secondary index query timed out on server.
QUERY_TIMEOUT ResultCode = 212
// QUERY_GENERIC defines generic query error.
QUERY_GENERIC ResultCode = 213
// QUERY_NETIO_ERR defines query NetIO error on server
QUERY_NETIO_ERR ResultCode = 214
// QUERY_DUPLICATE defines duplicate TaskId sent for the statement
QUERY_DUPLICATE ResultCode = 215
// AEROSPIKE_ERR_UDF_NOT_FOUND defines uDF does not exist.
AEROSPIKE_ERR_UDF_NOT_FOUND ResultCode = 1301
// AEROSPIKE_ERR_LUA_FILE_NOT_FOUND defines lUA file does not exist.
AEROSPIKE_ERR_LUA_FILE_NOT_FOUND ResultCode = 1302
)
// KeepConnection decides if a connection should be kept
// based on the error type.
func KeepConnection(err error) bool {
// if error is not an AerospikeError, Throw the connection away conservatively
ae, ok := err.(AerospikeError)
if !ok {
return false
}
switch ae.resultCode {
case 0, // Zero Value
QUERY_TERMINATED,
SCAN_TERMINATED,
PARSE_ERROR,
SERIALIZE_ERROR,
SERVER_NOT_AVAILABLE,
SCAN_ABORT,
QUERY_ABORTED,
INVALID_NODE_ERROR,
SERVER_MEM_ERROR,
TIMEOUT,
INDEX_OOM,
QUERY_TIMEOUT:
return false
default:
return true
}
}
// ResultCodeToString returns a human readable errors message based on the result code.
func ResultCodeToString(resultCode ResultCode) string {
switch ResultCode(resultCode) {
case MAX_RETRIES_EXCEEDED:
return "Max retries exceeded"
case MAX_ERROR_RATE:
return "Max errors limit reached for node"
case RACK_NOT_DEFINED:
return "Requested Rack for node/namespace was not defined in the cluster."
case INVALID_CLUSTER_PARTITION_MAP:
return "Cluster has an invalid partition map, usually due to bad configuration."
case SERVER_NOT_AVAILABLE:
return "Server is not accepting requests."
case CLUSTER_NAME_MISMATCH_ERROR:
return "Cluster Name does not match the ClientPolicy.ClusterName value"
case RECORDSET_CLOSED:
return "Recordset has already been closed or cancelled."
case NO_AVAILABLE_CONNECTIONS_TO_NODE:
return "No available connections to the node. Connection Pool was empty, and limited to certain number of connections."
case TYPE_NOT_SUPPORTED:
return "Type cannot be converted to Value Type."
case COMMAND_REJECTED:
return "command rejected"
case QUERY_TERMINATED:
return "Query terminated"
case SCAN_TERMINATED:
return "Scan terminated"
case INVALID_NODE_ERROR:
return "Invalid node"
case PARSE_ERROR:
return "Parse error"
case SERIALIZE_ERROR:
return "Serialize error"
case OK:
return "ok"
case SERVER_ERROR:
return "Server error"
case KEY_NOT_FOUND_ERROR:
return "Key not found"
case GENERATION_ERROR:
return "Generation error"
case PARAMETER_ERROR:
return "Parameter error"
case KEY_EXISTS_ERROR:
return "Key already exists"
case BIN_EXISTS_ERROR:
return "Bin already exists"
case CLUSTER_KEY_MISMATCH:
return "Cluster key mismatch"
case SERVER_MEM_ERROR:
return "Server memory error"
case TIMEOUT:
return "Timeout"
case ALWAYS_FORBIDDEN:
return "Operation not allowed in current configuration."
case PARTITION_UNAVAILABLE:
return "Partition not available"
case BIN_TYPE_ERROR:
return "Bin type error"
case RECORD_TOO_BIG:
return "Record too big"
case KEY_BUSY:
return "Hot key"
case SCAN_ABORT:
return "Scan aborted"
case UNSUPPORTED_FEATURE:
return "Unsupported Server Feature"
case BIN_NOT_FOUND:
return "Bin not found"
case DEVICE_OVERLOAD:
return "Device overload"
case KEY_MISMATCH:
return "Key mismatch"
case INVALID_NAMESPACE:
return "Namespace not found"
case BIN_NAME_TOO_LONG:
return "Bin name length greater than 15 characters, or maximum number of unique bin names are exceeded"
case FAIL_FORBIDDEN:
return "Operation not allowed at this time"
case FAIL_ELEMENT_NOT_FOUND:
return "Element not found."
case FAIL_ELEMENT_EXISTS:
return "Element exists"
case ENTERPRISE_ONLY:
return "Enterprise only"
case OP_NOT_APPLICABLE:
return "Operation not applicable"
case FILTERED_OUT:
return "Transaction filtered out"
case LOST_CONFLICT:
return "Write command loses conflict to XDR."
case QUERY_END:
return "Query end"
case SECURITY_NOT_SUPPORTED:
return "Security not supported"
case SECURITY_NOT_ENABLED:
return "Security not enabled"
case SECURITY_SCHEME_NOT_SUPPORTED:
return "Security scheme not supported"
case INVALID_COMMAND:
return "Invalid command"
case INVALID_FIELD:
return "Invalid field"
case ILLEGAL_STATE:
return "Illegal state"
case INVALID_USER:
return "Invalid user"
case USER_ALREADY_EXISTS:
return "User already exists"
case INVALID_PASSWORD:
return "Invalid password"
case EXPIRED_PASSWORD:
return "Expired password"
case FORBIDDEN_PASSWORD:
return "Forbidden password"
case INVALID_CREDENTIAL:
return "Invalid credential"
case EXPIRED_SESSION:
return "Login session expired"
case INVALID_ROLE:
return "Invalid role"
case ROLE_ALREADY_EXISTS:
return "Role already exists"
case INVALID_PRIVILEGE:
return "Invalid privilege"
case INVALID_WHITELIST:
return "Invalid whitelist"
case NOT_AUTHENTICATED:
return "Not authenticated"
case ROLE_VIOLATION:
return "Role violation"
case NOT_WHITELISTED:
return "Command not whitelisted"
case UDF_BAD_RESPONSE:
return "UDF returned error"
case BATCH_DISABLED:
return "Batch functionality has been disabled"
case BATCH_MAX_REQUESTS_EXCEEDED:
return "Batch max requests have been exceeded"
case BATCH_QUEUES_FULL:
return "All batch queues are full"
case GEO_INVALID_GEOJSON:
return "Invalid GeoJSON on insert/update"
case INDEX_FOUND:
return "Index already exists"
case INDEX_NOTFOUND:
return "Index not found"
case INDEX_OOM:
return "Index out of memory"
case INDEX_NOTREADABLE:
return "Index not readable"
case INDEX_GENERIC:
return "Index error"
case INDEX_NAME_MAXLEN:
return "Index name max length exceeded"
case INDEX_MAXCOUNT:
return "Index count exceeds max"
case QUERY_ABORTED:
return "Query aborted"
case QUERY_QUEUEFULL:
return "Query queue full"
case QUERY_TIMEOUT:
return "Query timeout"
case QUERY_GENERIC:
return "Query error"
case QUERY_NETIO_ERR:
return "Query NetIO error on server"
case QUERY_DUPLICATE:
return "Duplicate TaskId sent for the statement"
case AEROSPIKE_ERR_UDF_NOT_FOUND:
return "UDF does not exist."
case AEROSPIKE_ERR_LUA_FILE_NOT_FOUND:
return "LUA package/file does not exist."
default:
return fmt.Sprintf("Error code (%v) not available yet - please file an issue on github.", resultCode)
}
}