forked from couchbase/couchnode
-
Notifications
You must be signed in to change notification settings - Fork 1
/
types.d.ts
1851 lines (1593 loc) · 55 KB
/
types.d.ts
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
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/**
* <p>AnalyticsIndexManager provides an interface for performing management
* operations against the analytics indexes for the cluster.</p>
*/
declare class AnalyticsIndexManager {
createDataverse(dataverseName: string, options?: {
ignoreIfExists?: boolean;
timeout?: number;
}, callback?: CreateDataverseCallback): Promise<boolean>;
dropDataverse(dataverseName: string, options?: {
ignoreIfNotExists?: boolean;
timeout?: number;
}, callback?: DropDataverseCallback): Promise<boolean>;
createDataset(datasetName: string, options?: {
ignoreIfExists?: boolean;
dataverseName?: string;
condition?: string;
timeout?: number;
}, callback?: CreateDatasetCallback): Promise<boolean>;
dropDataset(datasetName: string, options?: {
ignoreIfNotExists?: boolean;
dataverseName?: string;
timeout?: number;
}, callback?: DropDatasetCallback): Promise<boolean>;
getAllDatasets(options?: {
timeout?: number;
}, callback?: GetAllDatasetsCallback): Promise<AnalyticsDataset[]>;
createIndex(datasetName: string, indexName: string, fields: string[], options?: {
dataverseName?: string;
ignoreIfExists?: boolean;
timeout?: number;
}, callback?: CreateAnalyticsIndexCallback): Promise<boolean>;
dropIndex(datasetName: string, indexName: string, options?: {
dataverseName?: string;
ignoreIfNotExists?: boolean;
timeout?: number;
}, callback?: DropAnalyticsIndexCallback): Promise<boolean>;
getAllIndexes(options?: {
timeout?: number;
}, callback?: GetAllAnalyticsIndexesCallback): Promise<AnalyticsIndex[]>;
connectLink(linkName: string, options?: {
timeout?: number;
}, callback?: ConnectLinkCallback): Promise<boolean>;
disconnectLink(linkName: string, options?: {
timeout?: number;
}, callback?: DisconnectLinkCallback): Promise<boolean>;
getPendingMutations(options?: {
timeout?: number;
}, callback?: GetPendingMutationsCallback): Promise<{
[key: string]: number;
}>;
}
declare type CreateDataverseCallback = (err: Error, success: boolean) => void;
declare type DropDataverseCallback = (err: Error, success: boolean) => void;
declare type CreateDatasetCallback = (err: Error, success: boolean) => void;
declare type DropDatasetCallback = (err: Error, success: boolean) => void;
declare type AnalyticsDataset = {
name: string;
dataverseName: string;
linkName: string;
bucketName: string;
};
declare type GetAllDatasetsCallback = (err: Error, datasets: AnalyticsDataset[]) => void;
declare type CreateAnalyticsIndexCallback = (err: Error, success: boolean) => void;
declare type DropAnalyticsIndexCallback = (err: Error, success: boolean) => void;
declare type AnalyticsIndex = {
name: string;
datasetName: string;
dataverseName: string;
isPrimary: boolean;
};
declare type GetAllAnalyticsIndexesCallback = (err: Error, indexes: AnalyticsIndex[]) => void;
declare type ConnectLinkCallback = (err: Error, success: boolean) => void;
declare type DisconnectLinkCallback = (err: Error, success: boolean) => void;
declare type GetPendingMutationsCallback = (err: Error, pendingMutations: {
[key: string]: number;
}) => void;
/**
* <p>BinaryCollection provides various binary operations which
* are available to be performed against a collection.</p>
*/
declare class BinaryCollection {
increment(key: string, value: number, options?: {
timeout?: number;
}, callback?: IncrementCallback): Promise<IncrementResult>;
decrement(key: string, value: number, options?: {
timeout?: number;
}, callback?: DecrementCallback): Promise<DecrementResult>;
append(key: string, value: Buffer, options?: {
timeout?: number;
}, callback?: AppendCallback): Promise<AppendResult>;
prepend(key: string, value: Buffer, options?: {
timeout?: number;
}, callback?: PrependCallback): Promise<PrependResult>;
}
declare type IncrementResult = {
value: number;
cas: Cas;
mutationToken?: MutationToken;
};
declare type IncrementCallback = (err: Error, res: IncrementResult) => void;
declare type DecrementResult = {
value: number;
cas: Cas;
mutationToken?: MutationToken;
};
declare type DecrementCallback = (err: Error, res: DecrementResult) => void;
declare type AppendResult = {
cas: Cas;
mutationToken?: MutationToken;
};
declare type AppendCallback = (err: Error, res: AppendResult) => void;
declare type PrependResult = {
cas: Cas;
mutationToken?: MutationToken;
};
declare type PrependCallback = (err: Error, res: PrependResult) => void;
declare type Cas = any;
declare type MutationToken = any;
/**
* <p>Bucket represents a storage grouping of data within a Couchbase Server cluster.</p>
*/
declare class Bucket {
/**
* <p>Ping returns information from pinging the connections for this bucket.</p>
*/
ping(options?: {
reportId?: string;
serviceTypes?: ServiceType[];
timeout?: number;
}, callback?: PingCallback): Promise<PingResult>;
/**
* @param designDoc - <p>The design document containing the view to query</p>
* @param viewName - <p>The name of the view to query</p>
*/
viewQuery(designDoc: string, viewName: string, options?: {
scanConsistency?: ViewScanConsistency;
skip?: number;
limit?: number;
order?: ViewOrdering;
reduce?: string;
group?: boolean;
groupLevel?: number;
key?: string;
keys?: string[];
range?: {
start?: string | string[];
end?: string | string[];
inclusiveEnd?: boolean;
};
idRange?: {
start?: string;
end?: string;
};
fullSet?: boolean;
onError?: ViewErrorMode;
timeout?: number;
}, callback?: ViewQueryCallback): Promise<ViewQueryResult>;
/**
* <p>Gets a reference to a specific scope.</p>
*/
scope(scopeName: string): Scope;
/**
* <p>Gets a reference to the default scope.</p>
*/
defaultScope(): Scope;
/**
* <p>Gets a reference to a specific collection.</p>
*/
collection(collectionName: string): Collection;
/**
* <p>Gets a reference to the default collection.</p>
*/
defaultCollection(): Collection;
/**
* <p>Gets a view index manager for this bucket</p>
*/
viewIndexes(): ViewIndexManager;
/**
* <p>Gets a collection manager for this bucket</p>
*/
collections(): CollectionManager;
/**
* <p>Returns the name of this bucket.</p>
*/
name: string;
}
declare type ViewQueryResult = {
rows: object[];
meta: any;
};
declare type ViewQueryCallback = (err: Error, res: ViewQueryResult) => void;
/**
* <p>BucketManager provides an interface for adding/removing/updating
* buckets within the cluster.</p>
*/
declare class BucketManager {
createBucket(settings: CreateBucketSettings, options?: {
timeout?: number;
}, callback?: CreateBucketCallback): Promise<boolean>;
updateBucket(settings: BucketSettings, options?: {
timeout?: number;
}, callback?: UpdateBucketCallback): Promise<boolean>;
dropBucket(bucketName: string, options?: {
timeout?: number;
}, callback?: DropBucketCallback): Promise<boolean>;
getBucket(bucketName: string, options?: {
timeout?: number;
}, callback?: GetBucketCallback): Promise<BucketSettings>;
getAllBuckets(bucketName: string, options?: {
timeout?: number;
}, callback?: GetAllBucketsCallback): Promise<BucketSettings[]>;
flushBucket(bucketName: string, options?: {
timeout?: number;
}, callback?: FlushBucketCallback): Promise<boolean>;
}
/**
* <p>BucketSettings provides information about a specific bucket.</p>
*/
declare type BucketSettings = {
name: string;
flushEnabled: boolean;
ramQuotaMB: number;
numReplicas: number;
replicaIndexes: boolean;
bucketType: BucketType;
ejectionMethod: EvictionPolicy;
maxTTL: number;
compressionMode: CompressionMode;
minimumDurabilityLevel: DurabilityLevel;
};
/**
* <p>CreateBucketSettings provides information for creating a bucket.</p>
*/
declare type CreateBucketSettings = {
conflictResolutionType: ConflictResolutionType;
};
declare type CreateBucketCallback = (err: Error, res: boolean) => void;
declare type UpdateBucketCallback = (err: Error, res: boolean) => void;
declare type DropBucketCallback = (err: Error, res: boolean) => void;
declare type GetBucketCallback = (err: Error, res: BucketSettings) => void;
declare type GetAllBucketsCallback = (err: Error, res: BucketSettings[]) => void;
declare type FlushBucketCallback = (err: Error, res: boolean) => void;
/**
* <p>CertificateAuthenticator provides an authenticator implementation
* which uses TLS Certificate Authentication.</p>
*/
declare class CertificateAuthenticator {
constructor(certificatePath: string, keyPath: string);
}
/**
* <p>Cluster represents an entire Couchbase Server cluster.</p>
*/
declare class Cluster {
/**
* <p>Connect establishes a connection to the cluster and is the entry
* point for all SDK operations.</p>
*/
static connect(connStr: string, options?: {
username?: string;
password?: string;
authenticator?: string;
trustStorePath?: string;
kvTimeout?: number;
kvDurableTimeout?: number;
viewTimeout?: number;
queryTimeout?: number;
analyticsTimeout?: number;
searchTimeout?: number;
managementTimeout?: number;
transcoder?: Transcoder;
logFunc?: LoggingCallback;
}, callback?: ConnectCallback): Promise<Cluster>;
/**
* <p>Diagnostics returns stateful data about the current SDK connections.</p>
*/
diagnostics(options?: {
reportId?: string;
}, callback?: DiagnosticsCallback): Promise<DiagnosticsResult>;
/**
* <p>Ping returns information from pinging the connections for this cluster.</p>
*/
ping(options?: {
reportId?: string;
serviceTypes?: ServiceType[];
timeout?: number;
}, callback?: PingCallback): Promise<PingResult>;
/**
* @param query - <p>The query string to execute.</p>
* @param [options.parameters] - <p>parameters specifies a list of values to substitute within the query
* statement during execution.</p>
* @param [options.scanConsistency] - <p>scanConsistency specifies the level of consistency that is required for
* the results of the query.</p>
* @param [options.consistentWith] - <p>consistentWith specifies a MutationState object to use when determining
* the level of consistency needed for the results of the query.</p>
* @param [options.adhoc] - <p>adhoc specifies that the query is an adhoc query and should not be
* prepared and cached within the SDK.</p>
* @param [options.flexIndex] - <p>flexIndex specifies to enable the use of FTS indexes when selecting
* indexes to use for the query.</p>
* @param [options.clientContextId] - <p>clientContextId specifies a unique identifier for the execution of this
* query to enable various tools to correlate the query.</p>
* @param [options.readOnly] - <p>readOnly specifies that query should not be permitted to mutate any data.
* This option also enables a few minor performance improvements and the
* ability to automatically retry the query on failure.</p>
* @param [options.profile] - <p>profile enables the return of profiling data from the server.</p>
* @param [options.metrics] - <p>metrics enables the return of metrics data from the server</p>
* @param [options.raw] - <p>raw specifies an object represent raw key value pairs that should be
* included with the query.</p>
* @param [options.timeout] - <p>timeout specifies the number of ms to wait for completion before
* cancelling the operation and returning control to the application.</p>
*/
query(query: string, options?: {
parameters?: any | any[];
scanConsistency?: QueryScanConsistency;
consistentWith?: MutationState;
adhoc?: boolean;
flexIndex?: boolean;
clientContextId?: string;
maxParallelism?: number;
pipelineBatch?: number;
pipelineCap?: number;
scanWait?: number;
scanCap?: number;
readOnly?: boolean;
profile?: QueryProfileMode;
metrics?: boolean;
raw?: any;
timeout?: number;
}, callback?: QueryCallback): Promise<QueryResult>;
/**
* @param query - <p>The query string to execute.</p>
* @param [options.parameters] - <p>parameters specifies a list of values to substitute within the query
* statement during execution.</p>
* @param [options.scanConsistency] - <p>scanConsistency specifies the level of consistency that is required for
* the results of the query.</p>
* @param [options.clientContextId] - <p>clientContextId specifies a unique identifier for the execution of this
* query to enable various tools to correlate the query.</p>
* @param [options.priority] - <p>priority specifies that this query should be executed with a higher
* priority than others, causing it to receive extra resources.</p>
* @param [options.readOnly] - <p>readOnly specifies that query should not be permitted to mutate any data.
* This option also enables a few minor performance improvements and the
* ability to automatically retry the query on failure.</p>
* @param [options.raw] - <p>raw specifies an object represent raw key value pairs that should be
* included with the query.</p>
* @param [options.timeout] - <p>timeout specifies the number of ms to wait for completion before
* cancelling the operation and returning control to the application.</p>
*/
analyticsQuery(query: string, options?: {
parameters?: any | any[];
scanConsistency?: AnalyticsScanConsistency;
clientContextId?: string;
priority?: boolean;
readOnly?: boolean;
raw?: any;
timeout?: number;
}, callback?: AnalyticsQueryCallback): Promise<AnalyticsResult>;
/**
* @param indexName - <p>The name of the index to execute the query against.</p>
* @param query - <p>The search query object describing the requested search.</p>
*/
searchQuery(indexName: string, query: SearchQuery, options?: {
skip?: number;
limit?: number;
explain?: boolean;
highlight?: {
style?: HighlightStyle;
fields?: string[];
};
fields?: string[];
facets?: SearchFacet[];
sort?: SearchSort;
disableScoring?: boolean;
consistency?: SearchScanConsistency;
consistentWith?: MutationState;
timeout?: number;
}, callback?: SearchQueryCallback): Promise<SearchQueryResult>;
/**
* <p>Gets a reference to a bucket.</p>
*/
bucket(bucketName: string): Bucket;
/**
* <p>Closes all connections associated with this cluster. Any
* running operations will be cancelled. Further operations
* will cause new connections to be established.</p>
*/
close(): void;
/**
* <p>Gets a user manager for this cluster</p>
*/
users(): UserManager;
/**
* <p>Gets a bucket manager for this cluster</p>
*/
buckets(): BucketManager;
/**
* <p>Gets a query index manager for this cluster</p>
*/
queryIndexes(): QueryIndexManager;
/**
* <p>Gets an analytics index manager for this cluster</p>
*/
analyticsIndexes(): AnalyticsIndexManager;
/**
* <p>Gets a search index manager for this cluster</p>
*/
searchIndexes(): SearchIndexManager;
}
declare type ConnectCallback = (err: Error, cluster: Cluster) => void;
/**
* <p>Contains the results from a previously executed Diagnostics operation.</p>
*/
declare type DiagnosticsResult = {
id: string;
version: number;
sdk: string;
services: any;
};
declare type DiagnosticsCallback = (err: Error, res: DiagnosticsResult) => void;
/**
* <p>Contains the results from a previously executed Diagnostics operation.</p>
*/
declare type PingResult = {
id: string;
version: number;
sdk: string;
services: any;
};
declare type PingCallback = (err: Error, res: PingResult) => void;
declare type QueryResult = {
rows: object[];
meta: any;
};
declare type QueryCallback = (err: Error, res: QueryResult) => void;
declare type AnalyticsResult = {
rows: object[];
meta: any;
};
declare type AnalyticsQueryCallback = (err: Error, res: AnalyticsResult) => void;
declare type SearchQueryResult = {
rows: object[];
meta: any;
};
declare type SearchQueryCallback = (err: Error, res: SearchQueryResult) => void;
/**
* <p>Collection provides an interface for performing operations against
* a collection within the cluster.</p>
*/
declare class Collection {
get(key: string, options?: {
project?: string[];
withExpiry?: boolean;
transcoder?: Transcoder;
timeout?: number;
}, callback?: GetCallback): Promise<GetResult>;
exists(key: string, options?: {
timeout?: number;
}, callback?: ExistsCallback): Promise<ExistsResult>;
getAnyReplica(key: string, options?: {
transcoder?: Transcoder;
timeout?: number;
}, callback?: GetAnyReplicaCallback): Promise<GetReplicaResult>;
getAllReplicas(key: string, options?: {
transcoder?: Transcoder;
timeout?: number;
}, callback?: GetAllReplicasCallback): Promise<GetReplicaResult[]>;
insert(key: string, value: any, options?: {
transcoder?: Transcoder;
timeout?: number;
}, callback?: MutateCallback): Promise<MutationResult>;
upsert(key: string, value: any, options?: {
transcoder?: Transcoder;
timeout?: number;
}, callback?: MutateCallback): Promise<MutationResult>;
replace(key: string, value: any, options?: {
transcoder?: Transcoder;
timeout?: number;
cas?: Cas;
}, callback?: MutateCallback): Promise<MutationResult>;
remove(key: string, options?: {
timeout?: number;
}, callback?: RemoveCallback): Promise<RemoveResult>;
getAndTouch(key: string, expiry: number, options?: {
transcoder?: Transcoder;
timeout?: number;
}, callback?: GetAndTouchCallback): Promise<GetAndTouchResult>;
touch(key: string, expiry: number, options?: {
timeout?: number;
}, callback?: TouchCallback): Promise<TouchResult>;
getAndLock(key: string, lockTime: number, options?: {
transcoder?: Transcoder;
timeout?: number;
}, callback?: GetAndLockCallback): Promise<GetAndLockCallback>;
unlock(key: string, cas: Cas, options?: {
timeout?: number;
}, callback?: UnlockCallback): Promise<UnlockResult>;
lookupIn(key: string, spec: LookupInSpec[], options?: {
timeout?: number;
}, callback?: LookupInCallback): Promise<LookupInResult>;
mutateIn(key: string, spec: MutateInSpec, options?: {
cas?: Cas;
timeout?: number;
}, callback?: MutateInCallback): Promise<MutateInResult>;
list(key: string): CouchbaseList;
queue(key: string): CouchbaseQueue;
map(key: string): CouchbaseMap;
set(key: string): CouchbaseSet;
binary(): BinaryCollection;
}
/**
* <p>Contains the results from a previously execute Get operation.</p>
*/
declare type GetResult = {
content: any;
cas: Cas;
expiry?: number;
};
declare type GetCallback = (err: Error, res: GetResult) => void;
/**
* <p>Contains the results from a previously execute Get operation.</p>
*/
declare type ExistsResult = {
exists: boolean;
cas: Cas;
};
declare type ExistsCallback = (err: Error, res: ExistsResult) => void;
/**
* <p>Contains the results from a previously executed replica get operation.</p>
*/
declare type GetReplicaResult = {
value: any;
cas: Cas;
isReplica: boolean;
};
declare type GetAnyReplicaCallback = (err: Error, res: GetReplicaResult) => void;
declare type GetAllReplicasCallback = (err: Error, res: GetReplicaResult[]) => void;
/**
* <p>Contains the results from a previously executed mutation operation.</p>
*/
declare type MutationResult = {
cas: Cas;
mutationToken?: MutationToken;
};
declare type MutateCallback = (err: Error, res: MutationResult) => void;
declare type RemoveResult = {
cas: Cas;
mutationToken?: MutationToken;
};
declare type RemoveCallback = (err: Error, res: RemoveResult) => void;
declare type GetAndTouchResult = {
content: any;
cas: Cas;
mutationToken?: MutationToken;
};
declare type GetAndTouchCallback = (err: Error, res: GetAndTouchResult) => void;
declare type TouchResult = {
cas: Cas;
mutationToken?: MutationToken;
};
declare type TouchCallback = (err: Error, res: TouchResult) => void;
declare type GetAndLockResult = {
content: any;
cas: Cas;
mutationToken?: MutationToken;
};
declare type GetAndLockCallback = (err: Error, res: GetAndLockResult[]) => void;
declare type UnlockResult = {
content: any;
cas: Cas;
mutationToken?: MutationToken;
};
declare type UnlockCallback = (err: Error, res: UnlockResult) => void;
declare type LookupInResult = {
content: any;
cas: Cas;
};
declare type LookupInCallback = (err: Error, res: LookupInResult) => void;
declare type MutateInResult = {
content: any;
};
declare type MutateInCallback = (err: Error, res: MutateInResult) => void;
/**
* <p>CollectionManager allows the management of collections within a Bucket.</p>
*/
declare class CollectionManager {
/**
* <p>createCollection creates a collection within a scope in a bucket.</p>
* @param collectionSpec - <p>The details of the collection to create.</p>
* @param [options.timeout] - <p>Timeout for the operation in milliseconds.</p>
*/
createCollection(collectionSpec: CollectionSpec, options?: {
timeout?: number;
}, callback?: CreateCollectionCallback): Promise<boolean>;
/**
* <p>dropCollection drops a collection from a scope in a bucket.</p>
* @param collectionName - <p>The name of the collection to drop.</p>
* @param scopeName - <p>The name of the scope containing the collection to drop.</p>
* @param [options.timeout] - <p>Timeout for the operation in milliseconds.</p>
*/
dropCollection(collectionName: string, scopeName: string, options?: {
timeout?: number;
}, callback?: DropCollectionCallback): Promise<boolean>;
/**
* <p>createScope creates a scope within a bucket.</p>
* @param scopeName - <p>The name of the scope to create.</p>
* @param [options.timeout] - <p>Timeout for the operation in milliseconds.</p>
*/
createScope(scopeName: string, options?: {
timeout?: number;
}, callback?: CreateScopeCallback): Promise<boolean>;
/**
* <p>dropScope drops a scope from a bucket.</p>
* @param scopeName - <p>The name of the scope to drop.</p>
* @param [options.timeout] - <p>Timeout for the operation in milliseconds.</p>
*/
dropScope(scopeName: string, options?: {
timeout?: number;
}, callback?: DropScopeCallback): Promise<boolean>;
}
/**
* @property name - <p>The name of the collection to create.</p>
* @property scopeName - <p>The name of the scope to create the collection in.</p>
* @property maxExpiry - <p>The maximum expiry for documents in this bucket.</p>
*/
declare type CollectionSpec = {
name: string;
scopeName: string;
maxExpiry: number;
};
declare type CreateCollectionCallback = (err: Error, res: boolean) => void;
declare type DropCollectionCallback = (err: Error, res: boolean) => void;
declare type CreateScopeCallback = (err: Error, res: boolean) => void;
declare type DropScopeCallback = (err: Error, res: boolean) => void;
declare type LoggingEntry = {
severity: number;
srcFile: string;
srcLine: number;
subsys: string;
message: string;
};
declare type LoggingCallback = (entry: LoggingEntry) => void;
declare module "couchbase" {
/**
* <p>Creates a new Cluster object for interacting with a Couchbase
* cluster and performing operations.</p>
* @param connStr - <p>The connection string of your cluster</p>
* @param [options.username] - <p>The RBAC username to use when connecting to the cluster.</p>
* @param [options.password] - <p>The RBAC password to use when connecting to the cluster</p>
* @param [options.clientCertificate] - <p>A client certificate to use for authentication with the server. Specifying
* this certificate along with any other authentication method (such as username
* and password) is an error.</p>
* @param [options.certificateChain] - <p>A certificate chain to use for validating the clusters certificates.</p>
*/
function connect(connStr: string, options?: {
username?: string;
password?: string;
clientCertificate?: string;
certificateChain?: string;
}, callback?: ConnectCallback): Promise<Cluster>;
/**
* <p>Expose the LCB version that is in use.</p>
*/
var lcbVersion: string;
}
/**
* <p>CouchbaseList provides a simplified interface
* for storing lists within a Couchbase document.</p>
*/
declare class CouchbaseList {
getAll(callback: (...params: any[]) => any): void;
getAt(index: any, callback: (...params: any[]) => any): void;
removeAt(index: any, callback: (...params: any[]) => any): void;
indexOf(value: any, callback: (...params: any[]) => any): void;
size(callback: (...params: any[]) => any): void;
push(value: any, callback: (...params: any[]) => any): void;
unshift(value: any, callback: (...params: any[]) => any): void;
}
/**
* <p>CouchbaseMap provides a simplified interface
* for storing a map within a Couchbase document.</p>
*/
declare class CouchbaseMap {
getAll(callback: (...params: any[]) => any): void;
forEach(rowCallback: (...params: any[]) => any, callback: (...params: any[]) => any): void;
set(item: any, value: any, callback: (...params: any[]) => any): void;
get(item: any, callback: (...params: any[]) => any): void;
remove(item: any, callback: (...params: any[]) => any): void;
exists(item: any, callback: (...params: any[]) => any): void;
keys(callback: (...params: any[]) => any): void;
values(callback: (...params: any[]) => any): void;
size(callback: (...params: any[]) => any): void;
}
/**
* <p>CouchbaseQueue provides a simplified interface
* for storing a queue within a Couchbase document.</p>
*/
declare class CouchbaseQueue {
size(callback: (...params: any[]) => any): void;
push(value: any, callback: (...params: any[]) => any): void;
pop(callback: (...params: any[]) => any): void;
}
/**
* <p>CouchbaseSet provides a simplified interface
* for storing a set within a Couchbase document.</p>
*/
declare class CouchbaseSet {
add(item: any, callback: (...params: any[]) => any): void;
contains(item: any, callback: (...params: any[]) => any): void;
remove(item: any, callback: (...params: any[]) => any): void;
values(callback: (...params: any[]) => any): void;
size(callback: (...params: any[]) => any): void;
}
/**
* <p>Transcoder provides an interface for performing custom transcoding
* of document contents being retrieved and stored to the cluster.</p>
*/
declare interface Transcoder {
/**
* <p>Encodes a value. Must return an array of two values, containing
* a {@link Buffer} and {@link number}.</p>
*/
encode(value: any): any[];
decode(bytes: Buffer, flags: number): any;
}
declare class DesignDocumentView {
map: string;
reduce: string;
}
declare class DesignDocument {
constructor(name: string, views: {
[key: string]: DesignDocumentView;
});
/**
* <p>Returns the View class ({@link DesignDocumentView}).</p>
*/
static View: (...params: any[]) => any;
name: string;
views: {
[key: string]: DesignDocumentView;
};
}
declare const enum DurabilityLevel {
None = 0,
Majority = 1,
MajorityAndPersistOnMaster = 2,
PersistToMajority = 3
}
declare const enum BucketType {
Couchbase = "membase",
Memcached = "memcached",
Ephemeral = "ephemeral"
}
declare const enum EvictionPolicy {
FullEviction = "fullEviction",
ValueOnly = "valueOnly",
NotRecentlyUsed = "nruEviction",
NoEviction = "noEviction"
}
declare const enum CompressionMode {
Off = "off",
Passive = "passive",
Active = "active"
}
declare const enum ConflictResolutionType {
Timestamp = "lww",
SequenceNumber = "seqno"
}
declare const enum QueryProfileMode {
Off = "off",
Phases = "phases",
Timings = "timings"
}
declare const enum QueryScanConsistency {
NotBounded = "not_bounded",
RequestPlus = "request_plus"
}
declare const enum QueryStatus {
Running = "running",
Success = "success",
Errors = "errors",
Completed = "completed",
Stopped = "stopped",
Timeout = "timeout",
Closed = "closed",
Fatal = "fatal",
Aborted = "aborted",
Unknown = "unknown"
}
declare const enum AnalyticsScanConsistency {
NotBounded = "not_bounded",
RequestPlus = "request_plus"
}
declare const enum AnalyticsStatus {
Running = "running",
Success = "success",
Errors = "errors",
Completed = "completed",
Stopped = "stopped",
Timeout = "timeout",
Closed = "closed",
Fatal = "fatal",
Aborted = "aborted",
Unknown = "unknown"
}
declare const enum IndexType {
Gsi = "gsi",
View = "view",
Unknown = ""
}
declare const enum HighlightStyle {
HTML = "html",
ANSI = "ansi"
}
declare const enum ViewScanConsistency {
RequestPlus = "false",
UpdateAfter = "update_after",
NotBounded = "ok"
}
declare const enum ViewOrdering {
Ascending = "false",
Descending = "true"
}
declare const enum ViewErrorMode {
Continue = "continue",
Stop = "stop"
}
declare const enum SearchScanConsistency {
NotBounded = ""
}
declare const enum LookupInMacro {
Document = "{}",
Expiry = "{}",
Cas = "{}",
SeqNo = "{}",
LastModified = "{}",
IsDeleted = "{}",
ValueSizeBytes = "{}",
RevId = "{}"
}
declare const enum MutateInMacro {
Cas = "{}",
SeqNo = "{}",
ValueCrc32c = "{}"
}
declare const enum ServiceType {
KeyValue = "kv",
Management = "mgmt",
Views = "views",
Query = "query",
Search = "search",
Analytics = "analytics"
}
declare class CouchbaseError {
}
declare class TimeoutError {
}
declare class RequestCanceledError {
}
declare class InvalidArgumentError {
}
declare class ServiceNotAvailableError {
}
declare class InternalServerFailureError {
}
declare class AuthenticationFailureError {
}
declare class TemporaryFailureError {
}
declare class ParsingFailureError {
}
declare class CasMismatchError {
}
declare class BucketNotFoundError {
}
declare class CollectionNotFoundError {
}
declare class EncodingFailureError {
}
declare class DecodingFailureError {