UNPKG

103 kBTypeScriptView Raw
1/// <reference types="node" />
2export type CppMilliseconds = number;
3export type CppSeconds = number;
4export type CppBytes = string | Buffer;
5export type CppDocFlags = number;
6export type CppExpiry = number;
7export type CppJsonString = string | Buffer;
8export interface CppClusterCredentials {
9 username?: string;
10 password?: string;
11 certificate_path?: string;
12 key_path?: string;
13 allowed_sasl_mechanisms?: string[];
14}
15export interface CppDnsConfig {
16 nameserver?: string;
17 port?: number;
18 dnsSrvTimeout?: number;
19}
20export interface CppDocumentId {
21 bucket: string;
22 scope: string;
23 collection: string;
24 key: string;
25}
26export interface CppCas {
27 toString(): string;
28 toJSON(): any;
29}
30export declare const zeroCas: CppCas;
31export type CppCasInput = CppCas | string | Buffer;
32export interface CppMutationToken {
33 toString(): string;
34 toJSON(): any;
35}
36export interface CppQueryContext {
37 bucket_name: string;
38 scope_name: string;
39}
40export interface CppScanIterator {
41 cancelled: boolean;
42 next(callback: (err: CppError | null, result: CppRangeScanItem | undefined) => void): void;
43 cancel(): boolean;
44}
45export interface CppEncodedValue {
46 data: Buffer;
47 flags: number;
48}
49export declare enum CppManagementAnalyticsCouchbaseLinkEncryptionLevel {
50}
51export declare enum CppManagementClusterBucketType {
52}
53export declare enum CppManagementClusterBucketCompression {
54}
55export declare enum CppManagementClusterBucketEvictionPolicy {
56}
57export declare enum CppManagementClusterBucketConflictResolution {
58}
59export declare enum CppManagementClusterBucketStorageBackend {
60}
61export declare enum CppManagementEventingFunctionDcpBoundary {
62}
63export declare enum CppManagementEventingFunctionLanguageCompatibility {
64}
65export declare enum CppManagementEventingFunctionLogLevel {
66}
67export declare enum CppManagementEventingFunctionBucketAccess {
68}
69export declare enum CppManagementEventingFunctionStatus {
70}
71export declare enum CppManagementEventingFunctionDeploymentStatus {
72}
73export declare enum CppManagementEventingFunctionProcessingStatus {
74}
75export declare enum CppManagementRbacAuthDomain {
76}
77export declare enum CppRetryReason {
78}
79export declare enum CppProtocolSubdocOpcode {
80}
81export declare enum CppAnalyticsScanConsistency {
82}
83export declare enum CppDesignDocumentNamespace {
84}
85export declare enum CppDiagClusterState {
86}
87export declare enum CppDiagEndpointState {
88}
89export declare enum CppDiagPingState {
90}
91export declare enum CppQueryProfile {
92}
93export declare enum CppQueryScanConsistency {
94}
95export declare enum CppSearchHighlightStyle {
96}
97export declare enum CppSearchScanConsistency {
98}
99export declare enum CppServiceType {
100}
101export declare enum CppViewOnError {
102}
103export declare enum CppViewScanConsistency {
104}
105export declare enum CppViewSortOrder {
106}
107export declare enum CppAnalyticsResponseAnalyticsStatus {
108}
109export declare enum CppDurabilityLevel {
110}
111export declare enum CppErrcCommon {
112}
113export declare enum CppErrcKeyValue {
114}
115export declare enum CppErrcQuery {
116}
117export declare enum CppErrcAnalytics {
118}
119export declare enum CppErrcSearch {
120}
121export declare enum CppErrcView {
122}
123export declare enum CppErrcManagement {
124}
125export declare enum CppErrcFieldLevelEncryption {
126}
127export declare enum CppErrcNetwork {
128}
129export declare enum CppKeyValueStatusCode {
130}
131export declare enum CppImplSubdocOpcode {
132}
133export declare enum CppStoreSemantics {
134}
135export declare enum CppPersistTo {
136}
137export declare enum CppReplicateTo {
138}
139export declare enum CppReadPreference {
140}
141export declare enum CppVectorQueryCombination {
142}
143export interface CppManagementAnalyticsDataset {
144 name: string;
145 dataverse_name: string;
146 link_name: string;
147 bucket_name: string;
148}
149export interface CppManagementAnalyticsIndex {
150 name: string;
151 dataverse_name: string;
152 dataset_name: string;
153 is_primary: boolean;
154}
155export interface CppManagementAnalyticsAzureBlobExternalLink {
156 link_name: string;
157 dataverse: string;
158 connection_string?: string;
159 account_name?: string;
160 account_key?: string;
161 shared_access_signature?: string;
162 blob_endpoint?: string;
163 endpoint_suffix?: string;
164}
165export interface CppManagementAnalyticsCouchbaseLinkEncryptionSettings {
166 level: CppManagementAnalyticsCouchbaseLinkEncryptionLevel;
167 certificate?: string;
168 client_certificate?: string;
169 client_key?: string;
170}
171export interface CppManagementAnalyticsCouchbaseRemoteLink {
172 link_name: string;
173 dataverse: string;
174 hostname: string;
175 username?: string;
176 password?: string;
177 encryption: CppManagementAnalyticsCouchbaseLinkEncryptionSettings;
178}
179export interface CppManagementAnalyticsS3ExternalLink {
180 link_name: string;
181 dataverse: string;
182 access_key_id: string;
183 secret_access_key: string;
184 session_token?: string;
185 region: string;
186 service_endpoint?: string;
187}
188export interface CppManagementClusterBucketSettings {
189 name: string;
190 uuid: string;
191 ram_quota_mb: number;
192 bucket_type: CppManagementClusterBucketType;
193 max_expiry?: number;
194 compression_mode: CppManagementClusterBucketCompression;
195 minimum_durability_level?: CppDurabilityLevel;
196 num_replicas?: number;
197 replica_indexes?: boolean;
198 flush_enabled?: boolean;
199 eviction_policy: CppManagementClusterBucketEvictionPolicy;
200 conflict_resolution_type: CppManagementClusterBucketConflictResolution;
201 history_retention_collection_default?: boolean;
202 history_retention_bytes?: number;
203 history_retention_duration?: number;
204 storage_backend: CppManagementClusterBucketStorageBackend;
205 capabilities: string[];
206 nodes: CppManagementClusterBucketSettingsNode[];
207}
208export interface CppManagementClusterBucketSettingsNode {
209 hostname: string;
210 status: string;
211 version: string;
212 services: string[];
213 ports: {
214 [key: string]: number;
215 };
216}
217export interface CppManagementViewsDesignDocument {
218 rev?: string;
219 name: string;
220 ns: CppDesignDocumentNamespace;
221 views: {
222 [key: string]: CppManagementViewsDesignDocumentView;
223 };
224}
225export interface CppManagementViewsDesignDocumentView {
226 name: string;
227 map?: string;
228 reduce?: string;
229}
230export interface CppManagementEventingFunctionKeyspace {
231 bucket: string;
232 scope?: string;
233 collection?: string;
234}
235export interface CppManagementEventingFunctionSettings {
236 cpp_worker_count?: number;
237 dcp_stream_boundary?: CppManagementEventingFunctionDcpBoundary;
238 description?: string;
239 deployment_status?: CppManagementEventingFunctionDeploymentStatus;
240 processing_status?: CppManagementEventingFunctionProcessingStatus;
241 log_level?: CppManagementEventingFunctionLogLevel;
242 language_compatibility?: CppManagementEventingFunctionLanguageCompatibility;
243 execution_timeout?: CppMilliseconds;
244 lcb_inst_capacity?: number;
245 lcb_retry_count?: number;
246 lcb_timeout?: CppMilliseconds;
247 query_consistency?: CppQueryScanConsistency;
248 num_timer_partitions?: number;
249 sock_batch_size?: number;
250 tick_duration?: CppMilliseconds;
251 timer_context_size?: number;
252 user_prefix?: string;
253 bucket_cache_size?: number;
254 bucket_cache_age?: CppMilliseconds;
255 curl_max_allowed_resp_size?: number;
256 query_prepare_all?: boolean;
257 worker_count?: number;
258 handler_headers: string[];
259 handler_footers: string[];
260 enable_app_log_rotation?: boolean;
261 app_log_dir?: string;
262 app_log_max_size?: number;
263 app_log_max_files?: number;
264 checkpoint_interval?: CppMilliseconds;
265}
266export interface CppManagementEventingFunctionBucketBinding {
267 alias: string;
268 name: CppManagementEventingFunctionKeyspace;
269 access: CppManagementEventingFunctionBucketAccess;
270}
271export interface CppManagementEventingFunctionUrlNoAuth {
272}
273export interface CppManagementEventingFunctionUrlAuthBasic {
274 username: string;
275 password: string;
276}
277export interface CppManagementEventingFunctionUrlAuthDigest {
278 username: string;
279 password: string;
280}
281export interface CppManagementEventingFunctionUrlAuthBearer {
282 key: string;
283}
284export interface CppManagementEventingFunctionUrlBinding {
285 alias: string;
286 hostname: string;
287 allow_cookies: boolean;
288 validate_ssl_certificate: boolean;
289 auth_name: string;
290 auth_value: CppManagementEventingFunctionUrlNoAuth | CppManagementEventingFunctionUrlAuthBasic | CppManagementEventingFunctionUrlAuthDigest | CppManagementEventingFunctionUrlAuthBearer;
291}
292export interface CppManagementEventingFunctionConstantBinding {
293 alias: string;
294 literal: string;
295}
296export interface CppManagementEventingFunction {
297 name: string;
298 code: string;
299 metadata_keyspace: CppManagementEventingFunctionKeyspace;
300 source_keyspace: CppManagementEventingFunctionKeyspace;
301 version?: string;
302 enforce_schema?: boolean;
303 handler_uuid?: number;
304 function_instance_id?: string;
305 bucket_bindings: CppManagementEventingFunctionBucketBinding[];
306 url_bindings: CppManagementEventingFunctionUrlBinding[];
307 constant_bindings: CppManagementEventingFunctionConstantBinding[];
308 settings: CppManagementEventingFunctionSettings;
309}
310export interface CppManagementEventingFunctionState {
311 name: string;
312 status: CppManagementEventingFunctionStatus;
313 num_bootstrapping_nodes: number;
314 num_deployed_nodes: number;
315 deployment_status: CppManagementEventingFunctionDeploymentStatus;
316 processing_status: CppManagementEventingFunctionProcessingStatus;
317 redeploy_required?: boolean;
318}
319export interface CppManagementEventingStatus {
320 num_eventing_nodes: number;
321 functions: CppManagementEventingFunctionState[];
322}
323export interface CppManagementRbacRole {
324 name: string;
325 bucket?: string;
326 scope?: string;
327 collection?: string;
328}
329export interface CppManagementRbacRoleAndDescription {
330 display_name: string;
331 description: string;
332}
333export interface CppManagementRbacOrigin {
334 type: string;
335 name?: string;
336}
337export interface CppManagementRbacRoleAndOrigins {
338 origins: CppManagementRbacOrigin[];
339}
340export interface CppManagementRbacUser {
341 username: string;
342 display_name?: string;
343 groups: string[];
344 roles: CppManagementRbacRole[];
345 password?: string;
346}
347export interface CppManagementRbacUserAndMetadata {
348 domain: CppManagementRbacAuthDomain;
349 effective_roles: CppManagementRbacRoleAndOrigins[];
350 password_changed?: string;
351 external_groups: string[];
352}
353export interface CppManagementRbacGroup {
354 name: string;
355 description?: string;
356 roles: CppManagementRbacRole[];
357 ldap_group_reference?: string;
358}
359export interface CppManagementSearchIndex {
360 uuid: string;
361 name: string;
362 type: string;
363 params_json: string;
364 source_uuid: string;
365 source_name: string;
366 source_type: string;
367 source_params_json: string;
368 plan_params_json: string;
369}
370export interface CppManagementQueryIndex {
371 is_primary: boolean;
372 name: string;
373 state: string;
374 type: string;
375 index_key: string[];
376 partition?: string;
377 condition?: string;
378 bucket_name: string;
379 scope_name?: string;
380 collection_name?: string;
381}
382export interface CppTopologyCollectionsManifest {
383 id: number[];
384 uid: number;
385 scopes: CppTopologyCollectionsManifestScope[];
386}
387export interface CppTopologyCollectionsManifestCollection {
388 uid: number;
389 name: string;
390 max_expiry: number;
391 history?: boolean;
392}
393export interface CppTopologyCollectionsManifestScope {
394 uid: number;
395 name: string;
396 collections: CppTopologyCollectionsManifestCollection[];
397}
398export interface CppDiagEndpointDiagInfo {
399 type: CppServiceType;
400 id: string;
401 last_activity?: CppMilliseconds;
402 remote: string;
403 local: string;
404 state: CppDiagEndpointState;
405 bucket?: string;
406 details?: string;
407}
408export interface CppDiagDiagnosticsResult {
409 id: string;
410 sdk: string;
411 services: {
412 [key: string]: CppDiagEndpointDiagInfo[];
413 };
414 version: number;
415}
416export interface CppDiagEndpointPingInfo {
417 type: CppServiceType;
418 id: string;
419 latency: CppMilliseconds;
420 remote: string;
421 local: string;
422 state: CppDiagPingState;
423 bucket?: string;
424 error?: string;
425}
426export interface CppDiagPingResult {
427 id: string;
428 sdk: string;
429 services: {
430 [key: string]: CppDiagEndpointPingInfo[];
431 };
432 version: number;
433}
434export interface CppPrependResponse {
435 cas: CppCas;
436 token: CppMutationToken;
437}
438export interface CppPrependRequest {
439 id: CppDocumentId;
440 value: Buffer;
441 partition: number;
442 opaque: number;
443 durability_level: CppDurabilityLevel;
444 timeout?: CppMilliseconds;
445}
446export interface CppPrependWithLegacyDurabilityRequest {
447 id: CppDocumentId;
448 value: Buffer;
449 partition: number;
450 opaque: number;
451 timeout?: CppMilliseconds;
452 persist_to: CppPersistTo;
453 replicate_to: CppReplicateTo;
454}
455export interface CppExistsResponse {
456 deleted: boolean;
457 cas: CppCas;
458 flags: number;
459 expiry: number;
460 sequence_number: number;
461 datatype: number;
462 document_exists: boolean;
463}
464export interface CppExistsRequest {
465 id: CppDocumentId;
466 partition: number;
467 opaque: number;
468 timeout?: CppMilliseconds;
469}
470export interface CppHttpNoopResponse {
471}
472export interface CppHttpNoopRequest {
473 type: CppServiceType;
474 client_context_id?: string;
475 timeout?: CppMilliseconds;
476}
477export interface CppUnlockResponse {
478 cas: CppCas;
479}
480export interface CppUnlockRequest {
481 id: CppDocumentId;
482 partition: number;
483 opaque: number;
484 cas: CppCasInput;
485 timeout?: CppMilliseconds;
486}
487export interface CppGetAllReplicasResponse {
488 entries: CppGetAllReplicasResponseEntry[];
489}
490export interface CppGetAllReplicasResponseEntry {
491 value: Buffer;
492 cas: CppCas;
493 flags: number;
494 replica: boolean;
495}
496export interface CppGetAllReplicasRequest {
497 id: CppDocumentId;
498 timeout?: CppMilliseconds;
499}
500export interface CppUpsertResponse {
501 cas: CppCas;
502 token: CppMutationToken;
503}
504export interface CppUpsertRequest {
505 id: CppDocumentId;
506 value: Buffer;
507 partition: number;
508 opaque: number;
509 flags: number;
510 expiry: number;
511 durability_level: CppDurabilityLevel;
512 timeout?: CppMilliseconds;
513 preserve_expiry: boolean;
514}
515export interface CppUpsertWithLegacyDurabilityRequest {
516 id: CppDocumentId;
517 value: Buffer;
518 partition: number;
519 opaque: number;
520 flags: number;
521 expiry: number;
522 timeout?: CppMilliseconds;
523 preserve_expiry: boolean;
524 persist_to: CppPersistTo;
525 replicate_to: CppReplicateTo;
526}
527export interface CppGetAnyReplicaResponse {
528 value: Buffer;
529 cas: CppCas;
530 flags: number;
531 replica: boolean;
532}
533export interface CppGetAnyReplicaRequest {
534 id: CppDocumentId;
535 timeout?: CppMilliseconds;
536}
537export interface CppAppendResponse {
538 cas: CppCas;
539 token: CppMutationToken;
540}
541export interface CppAppendRequest {
542 id: CppDocumentId;
543 value: Buffer;
544 partition: number;
545 opaque: number;
546 durability_level: CppDurabilityLevel;
547 timeout?: CppMilliseconds;
548}
549export interface CppAppendWithLegacyDurabilityRequest {
550 id: CppDocumentId;
551 value: Buffer;
552 partition: number;
553 opaque: number;
554 timeout?: CppMilliseconds;
555 persist_to: CppPersistTo;
556 replicate_to: CppReplicateTo;
557}
558export interface CppQueryResponse {
559 meta: CppQueryResponseQueryMetaData;
560 prepared?: string;
561 rows: string[];
562 served_by_node: string;
563}
564export interface CppQueryResponseQueryMetrics {
565 elapsed_time: CppMilliseconds;
566 execution_time: CppMilliseconds;
567 result_count: number;
568 result_size: number;
569 sort_count: number;
570 mutation_count: number;
571 error_count: number;
572 warning_count: number;
573}
574export interface CppQueryResponseQueryProblem {
575 code: number;
576 message: string;
577 reason?: number;
578 retry?: boolean;
579}
580export interface CppQueryResponseQueryMetaData {
581 request_id: string;
582 client_context_id: string;
583 status: string;
584 metrics?: CppQueryResponseQueryMetrics;
585 signature?: string;
586 profile?: string;
587 warnings?: CppQueryResponseQueryProblem[];
588 errors?: CppQueryResponseQueryProblem[];
589}
590export interface CppQueryRequest {
591 statement: string;
592 adhoc: boolean;
593 metrics: boolean;
594 readonly: boolean;
595 flex_index: boolean;
596 preserve_expiry: boolean;
597 use_replica?: boolean;
598 max_parallelism?: number;
599 scan_cap?: number;
600 scan_wait?: CppMilliseconds;
601 pipeline_batch?: number;
602 pipeline_cap?: number;
603 scan_consistency?: CppQueryScanConsistency;
604 mutation_state: CppMutationToken[];
605 query_context?: string;
606 client_context_id?: string;
607 timeout?: CppMilliseconds;
608 profile?: CppQueryProfile;
609 raw: {
610 [key: string]: CppJsonString;
611 };
612 positional_parameters: CppJsonString[];
613 named_parameters: {
614 [key: string]: CppJsonString;
615 };
616 send_to_node?: string;
617 body_str: string;
618}
619export interface CppReplaceResponse {
620 cas: CppCas;
621 token: CppMutationToken;
622}
623export interface CppReplaceRequest {
624 id: CppDocumentId;
625 value: Buffer;
626 partition: number;
627 opaque: number;
628 flags: number;
629 expiry: number;
630 cas: CppCasInput;
631 durability_level: CppDurabilityLevel;
632 timeout?: CppMilliseconds;
633 preserve_expiry: boolean;
634}
635export interface CppReplaceWithLegacyDurabilityRequest {
636 id: CppDocumentId;
637 value: Buffer;
638 partition: number;
639 opaque: number;
640 flags: number;
641 expiry: number;
642 cas: CppCasInput;
643 timeout?: CppMilliseconds;
644 preserve_expiry: boolean;
645 persist_to: CppPersistTo;
646 replicate_to: CppReplicateTo;
647}
648export interface CppGetAndTouchResponse {
649 value: Buffer;
650 cas: CppCas;
651 flags: number;
652}
653export interface CppGetAndTouchRequest {
654 id: CppDocumentId;
655 partition: number;
656 opaque: number;
657 expiry: number;
658 timeout?: CppMilliseconds;
659}
660export interface CppRemoveResponse {
661 cas: CppCas;
662 token: CppMutationToken;
663}
664export interface CppRemoveRequest {
665 id: CppDocumentId;
666 partition: number;
667 opaque: number;
668 cas: CppCasInput;
669 durability_level: CppDurabilityLevel;
670 timeout?: CppMilliseconds;
671}
672export interface CppRemoveWithLegacyDurabilityRequest {
673 id: CppDocumentId;
674 partition: number;
675 opaque: number;
676 cas: CppCasInput;
677 timeout?: CppMilliseconds;
678 persist_to: CppPersistTo;
679 replicate_to: CppReplicateTo;
680}
681export interface CppGetResponse {
682 value: Buffer;
683 cas: CppCas;
684 flags: number;
685}
686export interface CppGetRequest {
687 id: CppDocumentId;
688 partition: number;
689 opaque: number;
690 timeout?: CppMilliseconds;
691}
692export interface CppLookupInAllReplicasResponse {
693 entries: CppLookupInAllReplicasResponseEntry[];
694}
695export interface CppLookupInAllReplicasResponseEntry {
696 fields: CppLookupInAllReplicasResponseEntryLookupInEntry[];
697 cas: CppCas;
698 deleted: boolean;
699 is_replica: boolean;
700}
701export interface CppLookupInAllReplicasResponseEntryLookupInEntry {
702 path: string;
703 value: Buffer;
704 original_index: number;
705 exists: boolean;
706 opcode: CppProtocolSubdocOpcode;
707 status: CppKeyValueStatusCode;
708 ec: CppError;
709}
710export interface CppLookupInAllReplicasRequest {
711 id: CppDocumentId;
712 specs: CppImplSubdocCommand[];
713 timeout?: CppMilliseconds;
714}
715export interface CppAnalyticsResponse {
716 meta: CppAnalyticsResponseAnalyticsMetaData;
717 rows: string[];
718}
719export interface CppAnalyticsResponseAnalyticsMetrics {
720 elapsed_time: CppMilliseconds;
721 execution_time: CppMilliseconds;
722 result_count: number;
723 result_size: number;
724 error_count: number;
725 processed_objects: number;
726 warning_count: number;
727}
728export interface CppAnalyticsResponseAnalyticsProblem {
729 code: number;
730 message: string;
731}
732export interface CppAnalyticsResponseAnalyticsMetaData {
733 request_id: string;
734 client_context_id: string;
735 status: CppAnalyticsResponseAnalyticsStatus;
736 metrics: CppAnalyticsResponseAnalyticsMetrics;
737 signature?: string;
738 errors: CppAnalyticsResponseAnalyticsProblem[];
739 warnings: CppAnalyticsResponseAnalyticsProblem[];
740}
741export interface CppAnalyticsRequest {
742 statement: string;
743 readonly: boolean;
744 priority: boolean;
745 bucket_name?: string;
746 scope_name?: string;
747 scope_qualifier?: string;
748 scan_consistency?: CppAnalyticsScanConsistency;
749 raw: {
750 [key: string]: CppJsonString;
751 };
752 positional_parameters: CppJsonString[];
753 named_parameters: {
754 [key: string]: CppJsonString;
755 };
756 client_context_id?: string;
757 timeout?: CppMilliseconds;
758 body_str: string;
759}
760export interface CppGetProjectedResponse {
761 value: Buffer;
762 cas: CppCas;
763 flags: number;
764 expiry?: number;
765}
766export interface CppGetProjectedRequest {
767 id: CppDocumentId;
768 partition: number;
769 opaque: number;
770 projections: string[];
771 with_expiry: boolean;
772 effective_projections: string[];
773 preserve_array_indexes: boolean;
774 timeout?: CppMilliseconds;
775}
776export interface CppDecrementResponse {
777 content: number;
778 cas: CppCas;
779 token: CppMutationToken;
780}
781export interface CppDecrementRequest {
782 id: CppDocumentId;
783 partition: number;
784 opaque: number;
785 expiry: number;
786 delta: number;
787 initial_value?: number;
788 durability_level: CppDurabilityLevel;
789 timeout?: CppMilliseconds;
790}
791export interface CppDecrementWithLegacyDurabilityRequest {
792 id: CppDocumentId;
793 partition: number;
794 opaque: number;
795 expiry: number;
796 delta: number;
797 initial_value?: number;
798 timeout?: CppMilliseconds;
799 persist_to: CppPersistTo;
800 replicate_to: CppReplicateTo;
801}
802export interface CppSearchResponse {
803 status: string;
804 meta: CppSearchResponseSearchMetaData;
805 error: string;
806 rows: CppSearchResponseSearchRow[];
807 facets: CppSearchResponseSearchFacet[];
808}
809export interface CppSearchResponseSearchMetrics {
810 took: CppMilliseconds;
811 total_rows: number;
812 max_score: number;
813 success_partition_count: number;
814 error_partition_count: number;
815}
816export interface CppSearchResponseSearchMetaData {
817 client_context_id: string;
818 metrics: CppSearchResponseSearchMetrics;
819 errors: {
820 [key: string]: string;
821 };
822}
823export interface CppSearchResponseSearchLocation {
824 field: string;
825 term: string;
826 position: number;
827 start_offset: number;
828 end_offset: number;
829 array_positions?: number[];
830}
831export interface CppSearchResponseSearchRow {
832 index: string;
833 id: string;
834 score: number;
835 locations: CppSearchResponseSearchLocation[];
836 fragments: {
837 [key: string]: string[];
838 };
839 fields: string;
840 explanation: string;
841}
842export interface CppSearchResponseSearchFacet {
843 name: string;
844 field: string;
845 total: number;
846 missing: number;
847 other: number;
848 terms: CppSearchResponseSearchFacetTermFacet[];
849 date_ranges: CppSearchResponseSearchFacetDateRangeFacet[];
850 numeric_ranges: CppSearchResponseSearchFacetNumericRangeFacet[];
851}
852export interface CppSearchResponseSearchFacetTermFacet {
853 term: string;
854 count: number;
855}
856export interface CppSearchResponseSearchFacetDateRangeFacet {
857 name: string;
858 count: number;
859 start?: string;
860 end?: string;
861}
862export interface CppSearchResponseSearchFacetNumericRangeFacet {
863 name: string;
864 count: number;
865 min: undefined | number | number;
866 max: undefined | number | number;
867}
868export interface CppSearchRequest {
869 index_name: string;
870 query: CppJsonString;
871 bucket_name?: string;
872 scope_name?: string;
873 show_request?: boolean;
874 vector_search?: CppJsonString;
875 vector_query_combination?: CppVectorQueryCombination;
876 limit?: number;
877 skip?: number;
878 explain?: boolean;
879 disable_scoring: boolean;
880 include_locations: boolean;
881 highlight_style?: CppSearchHighlightStyle;
882 highlight_fields: string[];
883 fields: string[];
884 collections: string[];
885 scan_consistency?: CppSearchScanConsistency;
886 mutation_state: CppMutationToken[];
887 sort_specs: string[];
888 facets: {
889 [key: string]: string;
890 };
891 raw: {
892 [key: string]: CppJsonString;
893 };
894 client_context_id?: string;
895 timeout?: CppMilliseconds;
896 log_request?: boolean;
897 log_response?: boolean;
898 body_str: string;
899}
900export interface CppTouchResponse {
901 cas: CppCas;
902}
903export interface CppTouchRequest {
904 id: CppDocumentId;
905 partition: number;
906 opaque: number;
907 expiry: number;
908 timeout?: CppMilliseconds;
909}
910export interface CppLookupInResponse {
911 cas: CppCas;
912 fields: CppLookupInResponseEntry[];
913 deleted: boolean;
914}
915export interface CppLookupInResponseEntry {
916 path: string;
917 value: Buffer;
918 original_index: number;
919 exists: boolean;
920 opcode: CppProtocolSubdocOpcode;
921 status: CppKeyValueStatusCode;
922 ec: CppError;
923}
924export interface CppLookupInRequest {
925 id: CppDocumentId;
926 partition: number;
927 opaque: number;
928 access_deleted: boolean;
929 specs: CppImplSubdocCommand[];
930 timeout?: CppMilliseconds;
931}
932export interface CppDocumentViewResponse {
933 meta: CppDocumentViewResponseMetaData;
934 rows: CppDocumentViewResponseRow[];
935 error?: CppDocumentViewResponseProblem;
936}
937export interface CppDocumentViewResponseMetaData {
938 total_rows?: number;
939 debug_info?: string;
940}
941export interface CppDocumentViewResponseRow {
942 id?: string;
943 key: string;
944 value: string;
945}
946export interface CppDocumentViewResponseProblem {
947 code: string;
948 message: string;
949}
950export interface CppDocumentViewRequest {
951 bucket_name: string;
952 document_name: string;
953 view_name: string;
954 ns: CppDesignDocumentNamespace;
955 limit?: number;
956 skip?: number;
957 consistency?: CppViewScanConsistency;
958 keys: string[];
959 key?: string;
960 start_key?: string;
961 end_key?: string;
962 start_key_doc_id?: string;
963 end_key_doc_id?: string;
964 inclusive_end?: boolean;
965 reduce?: boolean;
966 group?: boolean;
967 group_level?: number;
968 debug: boolean;
969 raw: {
970 [key: string]: string;
971 };
972 full_set?: boolean;
973 order?: CppViewSortOrder;
974 on_error?: CppViewOnError;
975 query_string: string[];
976 client_context_id?: string;
977 timeout?: CppMilliseconds;
978}
979export interface CppGetAndLockResponse {
980 value: Buffer;
981 cas: CppCas;
982 flags: number;
983}
984export interface CppGetAndLockRequest {
985 id: CppDocumentId;
986 partition: number;
987 opaque: number;
988 lock_time: number;
989 timeout?: CppMilliseconds;
990}
991export interface CppInsertResponse {
992 cas: CppCas;
993 token: CppMutationToken;
994}
995export interface CppInsertRequest {
996 id: CppDocumentId;
997 value: Buffer;
998 partition: number;
999 opaque: number;
1000 flags: number;
1001 expiry: number;
1002 durability_level: CppDurabilityLevel;
1003 timeout?: CppMilliseconds;
1004}
1005export interface CppInsertWithLegacyDurabilityRequest {
1006 id: CppDocumentId;
1007 value: Buffer;
1008 partition: number;
1009 opaque: number;
1010 flags: number;
1011 expiry: number;
1012 timeout?: CppMilliseconds;
1013 persist_to: CppPersistTo;
1014 replicate_to: CppReplicateTo;
1015}
1016export interface CppLookupInAnyReplicaResponse {
1017 cas: CppCas;
1018 fields: CppLookupInAnyReplicaResponseEntry[];
1019 deleted: boolean;
1020 is_replica: boolean;
1021}
1022export interface CppLookupInAnyReplicaResponseEntry {
1023 path: string;
1024 value: Buffer;
1025 original_index: number;
1026 exists: boolean;
1027 opcode: CppProtocolSubdocOpcode;
1028 status: CppKeyValueStatusCode;
1029 ec: CppError;
1030}
1031export interface CppLookupInAnyReplicaRequest {
1032 id: CppDocumentId;
1033 specs: CppImplSubdocCommand[];
1034 timeout?: CppMilliseconds;
1035}
1036export interface CppMutateInResponse {
1037 cas: CppCas;
1038 token: CppMutationToken;
1039 fields: CppMutateInResponseEntry[];
1040 deleted: boolean;
1041}
1042export interface CppMutateInResponseEntry {
1043 path: string;
1044 value: Buffer;
1045 original_index: number;
1046 opcode: CppProtocolSubdocOpcode;
1047 status: CppKeyValueStatusCode;
1048 ec: CppError;
1049}
1050export interface CppMutateInRequest {
1051 id: CppDocumentId;
1052 partition: number;
1053 opaque: number;
1054 cas: CppCasInput;
1055 access_deleted: boolean;
1056 create_as_deleted: boolean;
1057 expiry?: number;
1058 store_semantics: CppStoreSemantics;
1059 specs: CppImplSubdocCommand[];
1060 durability_level: CppDurabilityLevel;
1061 timeout?: CppMilliseconds;
1062 preserve_expiry: boolean;
1063 flags?: number;
1064}
1065export interface CppMutateInWithLegacyDurabilityRequest {
1066 id: CppDocumentId;
1067 partition: number;
1068 opaque: number;
1069 cas: CppCasInput;
1070 access_deleted: boolean;
1071 create_as_deleted: boolean;
1072 expiry?: number;
1073 store_semantics: CppStoreSemantics;
1074 specs: CppImplSubdocCommand[];
1075 timeout?: CppMilliseconds;
1076 preserve_expiry: boolean;
1077 flags?: number;
1078 persist_to: CppPersistTo;
1079 replicate_to: CppReplicateTo;
1080}
1081export interface CppIncrementResponse {
1082 content: number;
1083 cas: CppCas;
1084 token: CppMutationToken;
1085}
1086export interface CppIncrementRequest {
1087 id: CppDocumentId;
1088 partition: number;
1089 opaque: number;
1090 expiry: number;
1091 delta: number;
1092 initial_value?: number;
1093 durability_level: CppDurabilityLevel;
1094 timeout?: CppMilliseconds;
1095}
1096export interface CppIncrementWithLegacyDurabilityRequest {
1097 id: CppDocumentId;
1098 partition: number;
1099 opaque: number;
1100 expiry: number;
1101 delta: number;
1102 initial_value?: number;
1103 timeout?: CppMilliseconds;
1104 persist_to: CppPersistTo;
1105 replicate_to: CppReplicateTo;
1106}
1107export interface CppManagementGroupUpsertResponse {
1108 errors: string[];
1109}
1110export interface CppManagementGroupUpsertRequest {
1111 group: CppManagementRbacGroup;
1112 client_context_id?: string;
1113 timeout?: CppMilliseconds;
1114}
1115export interface CppManagementEventingPauseFunctionResponse {
1116 error?: CppManagementEventingProblem;
1117}
1118export interface CppManagementEventingPauseFunctionRequest {
1119 name: string;
1120 bucket_name?: string;
1121 scope_name?: string;
1122 client_context_id?: string;
1123 timeout?: CppMilliseconds;
1124}
1125export interface CppManagementQueryIndexGetAllResponse {
1126 status: string;
1127 indexes: CppManagementQueryIndex[];
1128}
1129export interface CppManagementQueryIndexGetAllRequest {
1130 bucket_name: string;
1131 scope_name: string;
1132 collection_name: string;
1133 query_ctx: CppQueryContext;
1134 client_context_id?: string;
1135 timeout?: CppMilliseconds;
1136}
1137export interface CppManagementCollectionCreateResponse {
1138 uid: number;
1139}
1140export interface CppManagementCollectionCreateRequest {
1141 bucket_name: string;
1142 scope_name: string;
1143 collection_name: string;
1144 max_expiry?: number;
1145 history?: boolean;
1146 client_context_id?: string;
1147 timeout?: CppMilliseconds;
1148}
1149export interface CppManagementEventingResumeFunctionResponse {
1150 error?: CppManagementEventingProblem;
1151}
1152export interface CppManagementEventingResumeFunctionRequest {
1153 name: string;
1154 bucket_name?: string;
1155 scope_name?: string;
1156 client_context_id?: string;
1157 timeout?: CppMilliseconds;
1158}
1159export interface CppManagementSearchIndexGetStatsResponse {
1160 status: string;
1161 error: string;
1162 stats: string;
1163}
1164export interface CppManagementSearchIndexGetStatsRequest {
1165 index_name: string;
1166 client_context_id?: string;
1167 timeout?: CppMilliseconds;
1168}
1169export interface CppManagementBucketGetAllResponse {
1170 buckets: CppManagementClusterBucketSettings[];
1171}
1172export interface CppManagementBucketGetAllRequest {
1173 client_context_id?: string;
1174 timeout?: CppMilliseconds;
1175}
1176export interface CppManagementQueryIndexBuildDeferredResponse {
1177 status: string;
1178 errors: CppManagementQueryIndexBuildDeferredResponseQueryProblem[];
1179}
1180export interface CppManagementQueryIndexBuildDeferredResponseQueryProblem {
1181 code: number;
1182 message: string;
1183}
1184export interface CppManagementQueryIndexBuildDeferredRequest {
1185 bucket_name: string;
1186 scope_name?: string;
1187 collection_name?: string;
1188 query_ctx: CppQueryContext;
1189 client_context_id?: string;
1190 timeout?: CppMilliseconds;
1191}
1192export interface CppManagementClusterDescribeResponse {
1193 info: CppManagementClusterDescribeResponseClusterInfo;
1194}
1195export interface CppManagementClusterDescribeResponseClusterInfo {
1196 nodes: CppManagementClusterDescribeResponseClusterInfoNode[];
1197 buckets: CppManagementClusterDescribeResponseClusterInfoBucket[];
1198 services: CppServiceType[];
1199}
1200export interface CppManagementClusterDescribeResponseClusterInfoNode {
1201 uuid: string;
1202 otp_node: string;
1203 status: string;
1204 hostname: string;
1205 os: string;
1206 version: string;
1207 services: string[];
1208}
1209export interface CppManagementClusterDescribeResponseClusterInfoBucket {
1210 uuid: string;
1211 name: string;
1212}
1213export interface CppManagementClusterDescribeRequest {
1214 client_context_id?: string;
1215 timeout?: CppMilliseconds;
1216}
1217export interface CppManagementSearchIndexGetAllResponse {
1218 status: string;
1219 impl_version: string;
1220 indexes: CppManagementSearchIndex[];
1221}
1222export interface CppManagementSearchIndexGetAllRequest {
1223 bucket_name?: string;
1224 scope_name?: string;
1225 client_context_id?: string;
1226 timeout?: CppMilliseconds;
1227}
1228export interface CppManagementSearchIndexAnalyzeDocumentResponse {
1229 status: string;
1230 error: string;
1231 analysis: string;
1232}
1233export interface CppManagementSearchIndexAnalyzeDocumentRequest {
1234 index_name: string;
1235 encoded_document: string;
1236 bucket_name?: string;
1237 scope_name?: string;
1238 client_context_id?: string;
1239 timeout?: CppMilliseconds;
1240}
1241export interface CppManagementQueryIndexDropResponse {
1242 status: string;
1243 errors: CppManagementQueryIndexDropResponseQueryProblem[];
1244}
1245export interface CppManagementQueryIndexDropResponseQueryProblem {
1246 code: number;
1247 message: string;
1248}
1249export interface CppManagementQueryIndexDropRequest {
1250 bucket_name: string;
1251 scope_name: string;
1252 collection_name: string;
1253 index_name: string;
1254 query_ctx: CppQueryContext;
1255 is_primary: boolean;
1256 ignore_if_does_not_exist: boolean;
1257 client_context_id?: string;
1258 timeout?: CppMilliseconds;
1259}
1260export interface CppManagementAnalyticsDatasetCreateResponse {
1261 status: string;
1262 errors: CppManagementAnalyticsProblem[];
1263}
1264export interface CppManagementAnalyticsDatasetCreateRequest {
1265 dataverse_name: string;
1266 dataset_name: string;
1267 bucket_name: string;
1268 condition?: string;
1269 client_context_id?: string;
1270 timeout?: CppMilliseconds;
1271 ignore_if_exists: boolean;
1272}
1273export interface CppManagementBucketFlushResponse {
1274}
1275export interface CppManagementBucketFlushRequest {
1276 name: string;
1277 client_context_id?: string;
1278 timeout?: CppMilliseconds;
1279}
1280export interface CppManagementAnalyticsIndexDropResponse {
1281 status: string;
1282 errors: CppManagementAnalyticsProblem[];
1283}
1284export interface CppManagementAnalyticsIndexDropRequest {
1285 dataverse_name: string;
1286 dataset_name: string;
1287 index_name: string;
1288 ignore_if_does_not_exist: boolean;
1289 client_context_id?: string;
1290 timeout?: CppMilliseconds;
1291}
1292export interface CppManagementQueryIndexCreateResponse {
1293 status: string;
1294 errors: CppManagementQueryIndexCreateResponseQueryProblem[];
1295}
1296export interface CppManagementQueryIndexCreateResponseQueryProblem {
1297 code: number;
1298 message: string;
1299}
1300export interface CppManagementQueryIndexCreateRequest {
1301 bucket_name: string;
1302 scope_name: string;
1303 collection_name: string;
1304 index_name: string;
1305 keys: string[];
1306 query_ctx: CppQueryContext;
1307 is_primary: boolean;
1308 ignore_if_exists: boolean;
1309 condition?: string;
1310 deferred?: boolean;
1311 num_replicas?: number;
1312 client_context_id?: string;
1313 timeout?: CppMilliseconds;
1314}
1315export interface CppManagementSearchIndexUpsertResponse {
1316 status: string;
1317 name: string;
1318 uuid: string;
1319 error: string;
1320}
1321export interface CppManagementSearchIndexUpsertRequest {
1322 index: CppManagementSearchIndex;
1323 bucket_name?: string;
1324 scope_name?: string;
1325 client_context_id?: string;
1326 timeout?: CppMilliseconds;
1327}
1328export interface CppManagementAnalyticsDatasetGetAllResponse {
1329 status: string;
1330 datasets: CppManagementAnalyticsDataset[];
1331 errors: CppManagementAnalyticsProblem[];
1332}
1333export interface CppManagementAnalyticsDatasetGetAllRequest {
1334 client_context_id?: string;
1335 timeout?: CppMilliseconds;
1336}
1337export interface CppManagementAnalyticsIndexGetAllResponse {
1338 status: string;
1339 indexes: CppManagementAnalyticsIndex[];
1340 errors: CppManagementAnalyticsProblem[];
1341}
1342export interface CppManagementAnalyticsIndexGetAllRequest {
1343 client_context_id?: string;
1344 timeout?: CppMilliseconds;
1345}
1346export interface CppManagementAnalyticsGetPendingMutationsResponse {
1347 status: string;
1348 errors: CppManagementAnalyticsProblem[];
1349 stats: {
1350 [key: string]: number;
1351 };
1352}
1353export interface CppManagementAnalyticsGetPendingMutationsRequest {
1354 client_context_id?: string;
1355 timeout?: CppMilliseconds;
1356}
1357export interface CppManagementAnalyticsDataverseDropResponse {
1358 status: string;
1359 errors: CppManagementAnalyticsProblem[];
1360}
1361export interface CppManagementAnalyticsDataverseDropRequest {
1362 dataverse_name: string;
1363 ignore_if_does_not_exist: boolean;
1364 client_context_id?: string;
1365 timeout?: CppMilliseconds;
1366}
1367export interface CppManagementEventingProblem {
1368 code: number;
1369 name: string;
1370 description: string;
1371}
1372export interface CppManagementAnalyticsLinkConnectResponse {
1373 status: string;
1374 errors: CppManagementAnalyticsLinkConnectResponseProblem[];
1375}
1376export interface CppManagementAnalyticsLinkConnectResponseProblem {
1377 code: number;
1378 message: string;
1379}
1380export interface CppManagementAnalyticsLinkConnectRequest {
1381 dataverse_name: string;
1382 link_name: string;
1383 force: boolean;
1384 client_context_id?: string;
1385 timeout?: CppMilliseconds;
1386}
1387export interface CppManagementCollectionsManifestGetResponse {
1388 manifest: CppTopologyCollectionsManifest;
1389}
1390export interface CppManagementCollectionsManifestGetRequest {
1391 id: CppDocumentId;
1392 partition: number;
1393 opaque: number;
1394 timeout?: CppMilliseconds;
1395}
1396export interface CppManagementChangePasswordResponse {
1397}
1398export interface CppManagementChangePasswordRequest {
1399 newPassword: string;
1400 client_context_id?: string;
1401 timeout?: CppMilliseconds;
1402}
1403export interface CppManagementClusterDeveloperPreviewEnableResponse {
1404}
1405export interface CppManagementClusterDeveloperPreviewEnableRequest {
1406 client_context_id?: string;
1407 timeout?: CppMilliseconds;
1408}
1409export interface CppManagementAnalyticsLinkDropResponse {
1410 status: string;
1411 errors: CppManagementAnalyticsLinkDropResponseProblem[];
1412}
1413export interface CppManagementAnalyticsLinkDropResponseProblem {
1414 code: number;
1415 message: string;
1416}
1417export interface CppManagementAnalyticsLinkDropRequest {
1418 link_name: string;
1419 dataverse_name: string;
1420 client_context_id?: string;
1421 timeout?: CppMilliseconds;
1422}
1423export interface CppManagementCollectionUpdateResponse {
1424 uid: number;
1425}
1426export interface CppManagementCollectionUpdateRequest {
1427 bucket_name: string;
1428 scope_name: string;
1429 collection_name: string;
1430 max_expiry?: number;
1431 history?: boolean;
1432 client_context_id?: string;
1433 timeout?: CppMilliseconds;
1434}
1435export interface CppManagementServerNodeAddress {
1436 hostname: string;
1437 kv_plain: number;
1438 kv_tls: number;
1439}
1440export interface CppManagementServerNode {
1441 server_group_name: string;
1442 server_index: number;
1443 default_network: CppManagementServerNodeAddress;
1444 external_network: CppManagementServerNodeAddress;
1445 active_vbuckets: number[];
1446 replica_vbuckets: number[];
1447}
1448export interface CppManagementServerGroup {
1449 name: string;
1450 nodes: CppManagementServerNode[];
1451}
1452export interface CppManagementBucketDescribeResponse {
1453 info: CppManagementBucketDescribeResponseBucketInfo;
1454}
1455export interface CppManagementBucketDescribeResponseBucketInfo {
1456 name: string;
1457 uuid: string;
1458 number_of_nodes: number;
1459 number_of_replicas: number;
1460 bucket_capabilities: string[];
1461 server_groups: {
1462 [key: string]: CppManagementServerGroup;
1463 };
1464 storage_backend: CppManagementClusterBucketStorageBackend;
1465 config_json: string;
1466}
1467export interface CppManagementBucketDescribeRequest {
1468 name: string;
1469 client_context_id?: string;
1470 timeout?: CppMilliseconds;
1471}
1472export interface CppManagementEventingUpsertFunctionResponse {
1473 error?: CppManagementEventingProblem;
1474}
1475export interface CppManagementEventingUpsertFunctionRequest {
1476 function: CppManagementEventingFunction;
1477 bucket_name?: string;
1478 scope_name?: string;
1479 client_context_id?: string;
1480 timeout?: CppMilliseconds;
1481}
1482export interface CppManagementViewIndexGetAllResponse {
1483 design_documents: CppManagementViewsDesignDocument[];
1484}
1485export interface CppManagementViewIndexGetAllRequest {
1486 bucket_name: string;
1487 ns: CppDesignDocumentNamespace;
1488 client_context_id?: string;
1489 timeout?: CppMilliseconds;
1490}
1491export interface CppManagementBucketGetResponse {
1492 bucket: CppManagementClusterBucketSettings;
1493}
1494export interface CppManagementBucketGetRequest {
1495 name: string;
1496 client_context_id?: string;
1497 timeout?: CppMilliseconds;
1498}
1499export interface CppManagementBucketUpdateResponse {
1500 bucket: CppManagementClusterBucketSettings;
1501 error_message: string;
1502}
1503export interface CppManagementBucketUpdateRequest {
1504 bucket: CppManagementClusterBucketSettings;
1505 client_context_id?: string;
1506 timeout?: CppMilliseconds;
1507}
1508export interface CppManagementBucketDropResponse {
1509}
1510export interface CppManagementBucketDropRequest {
1511 name: string;
1512 client_context_id?: string;
1513 timeout?: CppMilliseconds;
1514}
1515export interface CppManagementFreeformResponse {
1516 status: number;
1517 headers: {
1518 [key: string]: string;
1519 };
1520 body: string;
1521}
1522export interface CppManagementFreeformRequest {
1523 type: CppServiceType;
1524 method: string;
1525 path: string;
1526 headers: {
1527 [key: string]: string;
1528 };
1529 body: string;
1530 client_context_id?: string;
1531 timeout?: CppMilliseconds;
1532}
1533export interface CppManagementScopeDropResponse {
1534 uid: number;
1535}
1536export interface CppManagementScopeDropRequest {
1537 bucket_name: string;
1538 scope_name: string;
1539 client_context_id?: string;
1540 timeout?: CppMilliseconds;
1541}
1542export interface CppManagementViewIndexUpsertResponse {
1543}
1544export interface CppManagementViewIndexUpsertRequest {
1545 bucket_name: string;
1546 document: CppManagementViewsDesignDocument;
1547 client_context_id?: string;
1548 timeout?: CppMilliseconds;
1549}
1550export interface CppManagementUserGetAllResponse {
1551 users: CppManagementRbacUserAndMetadata[];
1552}
1553export interface CppManagementUserGetAllRequest {
1554 domain: CppManagementRbacAuthDomain;
1555 client_context_id?: string;
1556 timeout?: CppMilliseconds;
1557}
1558export interface CppManagementScopeCreateResponse {
1559 uid: number;
1560}
1561export interface CppManagementScopeCreateRequest {
1562 bucket_name: string;
1563 scope_name: string;
1564 client_context_id?: string;
1565 timeout?: CppMilliseconds;
1566}
1567export interface CppManagementEventingGetFunctionResponse {
1568 function: CppManagementEventingFunction;
1569 error?: CppManagementEventingProblem;
1570}
1571export interface CppManagementEventingGetFunctionRequest {
1572 name: string;
1573 bucket_name?: string;
1574 scope_name?: string;
1575 client_context_id?: string;
1576 timeout?: CppMilliseconds;
1577}
1578export interface CppManagementViewIndexDropResponse {
1579}
1580export interface CppManagementViewIndexDropRequest {
1581 bucket_name: string;
1582 document_name: string;
1583 ns: CppDesignDocumentNamespace;
1584 client_context_id?: string;
1585 timeout?: CppMilliseconds;
1586}
1587export interface CppManagementAnalyticsLinkReplaceResponse {
1588 status: string;
1589 errors: CppManagementAnalyticsLinkReplaceResponseProblem[];
1590}
1591export interface CppManagementAnalyticsLinkReplaceResponseProblem {
1592 code: number;
1593 message: string;
1594}
1595export interface CppManagementAnalyticsLinkDisconnectResponse {
1596 status: string;
1597 errors: CppManagementAnalyticsLinkDisconnectResponseProblem[];
1598}
1599export interface CppManagementAnalyticsLinkDisconnectResponseProblem {
1600 code: number;
1601 message: string;
1602}
1603export interface CppManagementAnalyticsLinkDisconnectRequest {
1604 dataverse_name: string;
1605 link_name: string;
1606 client_context_id?: string;
1607 timeout?: CppMilliseconds;
1608}
1609export interface CppManagementUserUpsertResponse {
1610 errors: string[];
1611}
1612export interface CppManagementUserUpsertRequest {
1613 domain: CppManagementRbacAuthDomain;
1614 user: CppManagementRbacUser;
1615 client_context_id?: string;
1616 timeout?: CppMilliseconds;
1617}
1618export interface CppManagementEventingGetStatusResponse {
1619 status: CppManagementEventingStatus;
1620 error?: CppManagementEventingProblem;
1621}
1622export interface CppManagementEventingGetStatusRequest {
1623 bucket_name?: string;
1624 scope_name?: string;
1625 client_context_id?: string;
1626 timeout?: CppMilliseconds;
1627}
1628export interface CppManagementEventingGetAllFunctionsResponse {
1629 functions: CppManagementEventingFunction[];
1630 error?: CppManagementEventingProblem;
1631}
1632export interface CppManagementEventingGetAllFunctionsRequest {
1633 bucket_name?: string;
1634 scope_name?: string;
1635 client_context_id?: string;
1636 timeout?: CppMilliseconds;
1637}
1638export interface CppManagementAnalyticsIndexCreateResponse {
1639 status: string;
1640 errors: CppManagementAnalyticsProblem[];
1641}
1642export interface CppManagementAnalyticsIndexCreateRequest {
1643 dataverse_name: string;
1644 dataset_name: string;
1645 index_name: string;
1646 fields: {
1647 [key: string]: string;
1648 };
1649 ignore_if_exists: boolean;
1650 client_context_id?: string;
1651 timeout?: CppMilliseconds;
1652}
1653export interface CppManagementScopeGetAllResponse {
1654 manifest: CppTopologyCollectionsManifest;
1655}
1656export interface CppManagementScopeGetAllRequest {
1657 bucket_name: string;
1658 client_context_id?: string;
1659 timeout?: CppMilliseconds;
1660}
1661export interface CppManagementUserGetResponse {
1662 user: CppManagementRbacUserAndMetadata;
1663}
1664export interface CppManagementUserGetRequest {
1665 username: string;
1666 domain: CppManagementRbacAuthDomain;
1667 client_context_id?: string;
1668 timeout?: CppMilliseconds;
1669}
1670export interface CppManagementSearchIndexDropResponse {
1671 status: string;
1672 error: string;
1673}
1674export interface CppManagementSearchIndexDropRequest {
1675 index_name: string;
1676 bucket_name?: string;
1677 scope_name?: string;
1678 client_context_id?: string;
1679 timeout?: CppMilliseconds;
1680}
1681export interface CppManagementSearchIndexControlPlanFreezeResponse {
1682 status: string;
1683 error: string;
1684}
1685export interface CppManagementSearchIndexControlPlanFreezeRequest {
1686 index_name: string;
1687 freeze: boolean;
1688 bucket_name?: string;
1689 scope_name?: string;
1690 client_context_id?: string;
1691 timeout?: CppMilliseconds;
1692}
1693export interface CppManagementSearchGetStatsResponse {
1694 stats: string;
1695}
1696export interface CppManagementSearchGetStatsRequest {
1697 client_context_id?: string;
1698 timeout?: CppMilliseconds;
1699}
1700export interface CppManagementUserDropResponse {
1701}
1702export interface CppManagementUserDropRequest {
1703 username: string;
1704 domain: CppManagementRbacAuthDomain;
1705 client_context_id?: string;
1706 timeout?: CppMilliseconds;
1707}
1708export interface CppManagementAnalyticsDataverseCreateResponse {
1709 status: string;
1710 errors: CppManagementAnalyticsProblem[];
1711}
1712export interface CppManagementAnalyticsDataverseCreateRequest {
1713 dataverse_name: string;
1714 ignore_if_exists: boolean;
1715 client_context_id?: string;
1716 timeout?: CppMilliseconds;
1717}
1718export interface CppManagementSearchIndexControlQueryResponse {
1719 status: string;
1720 error: string;
1721}
1722export interface CppManagementSearchIndexControlQueryRequest {
1723 index_name: string;
1724 allow: boolean;
1725 bucket_name?: string;
1726 scope_name?: string;
1727 client_context_id?: string;
1728 timeout?: CppMilliseconds;
1729}
1730export interface CppManagementRoleGetAllResponse {
1731 roles: CppManagementRbacRoleAndDescription[];
1732}
1733export interface CppManagementRoleGetAllRequest {
1734 client_context_id?: string;
1735 timeout?: CppMilliseconds;
1736}
1737export interface CppManagementGroupGetAllResponse {
1738 groups: CppManagementRbacGroup[];
1739}
1740export interface CppManagementGroupGetAllRequest {
1741 client_context_id?: string;
1742 timeout?: CppMilliseconds;
1743}
1744export interface CppManagementAnalyticsLinkCreateResponse {
1745 status: string;
1746 errors: CppManagementAnalyticsLinkCreateResponseProblem[];
1747}
1748export interface CppManagementAnalyticsLinkCreateResponseProblem {
1749 code: number;
1750 message: string;
1751}
1752export interface CppManagementEventingDropFunctionResponse {
1753 error?: CppManagementEventingProblem;
1754}
1755export interface CppManagementEventingDropFunctionRequest {
1756 name: string;
1757 bucket_name?: string;
1758 scope_name?: string;
1759 client_context_id?: string;
1760 timeout?: CppMilliseconds;
1761}
1762export interface CppManagementCollectionDropResponse {
1763 uid: number;
1764}
1765export interface CppManagementCollectionDropRequest {
1766 bucket_name: string;
1767 scope_name: string;
1768 collection_name: string;
1769 client_context_id?: string;
1770 timeout?: CppMilliseconds;
1771}
1772export interface CppManagementAnalyticsProblem {
1773 code: number;
1774 message: string;
1775}
1776export interface CppManagementSearchIndexControlIngestResponse {
1777 status: string;
1778 error: string;
1779}
1780export interface CppManagementSearchIndexControlIngestRequest {
1781 index_name: string;
1782 pause: boolean;
1783 bucket_name?: string;
1784 scope_name?: string;
1785 client_context_id?: string;
1786 timeout?: CppMilliseconds;
1787}
1788export interface CppManagementEventingDeployFunctionResponse {
1789 error?: CppManagementEventingProblem;
1790}
1791export interface CppManagementEventingDeployFunctionRequest {
1792 name: string;
1793 bucket_name?: string;
1794 scope_name?: string;
1795 client_context_id?: string;
1796 timeout?: CppMilliseconds;
1797}
1798export interface CppManagementGroupGetResponse {
1799 group: CppManagementRbacGroup;
1800}
1801export interface CppManagementGroupGetRequest {
1802 name: string;
1803 client_context_id?: string;
1804 timeout?: CppMilliseconds;
1805}
1806export interface CppManagementViewIndexGetResponse {
1807 document: CppManagementViewsDesignDocument;
1808}
1809export interface CppManagementViewIndexGetRequest {
1810 bucket_name: string;
1811 document_name: string;
1812 ns: CppDesignDocumentNamespace;
1813 client_context_id?: string;
1814 timeout?: CppMilliseconds;
1815}
1816export interface CppManagementBucketCreateResponse {
1817 error_message: string;
1818}
1819export interface CppManagementBucketCreateRequest {
1820 bucket: CppManagementClusterBucketSettings;
1821 client_context_id?: string;
1822 timeout?: CppMilliseconds;
1823}
1824export interface CppManagementAnalyticsDatasetDropResponse {
1825 status: string;
1826 errors: CppManagementAnalyticsProblem[];
1827}
1828export interface CppManagementAnalyticsDatasetDropRequest {
1829 dataverse_name: string;
1830 dataset_name: string;
1831 ignore_if_does_not_exist: boolean;
1832 client_context_id?: string;
1833 timeout?: CppMilliseconds;
1834}
1835export interface CppManagementGroupDropResponse {
1836}
1837export interface CppManagementGroupDropRequest {
1838 name: string;
1839 client_context_id?: string;
1840 timeout?: CppMilliseconds;
1841}
1842export interface CppManagementSearchIndexGetResponse {
1843 status: string;
1844 index: CppManagementSearchIndex;
1845 error: string;
1846}
1847export interface CppManagementSearchIndexGetRequest {
1848 index_name: string;
1849 bucket_name?: string;
1850 scope_name?: string;
1851 client_context_id?: string;
1852 timeout?: CppMilliseconds;
1853}
1854export interface CppManagementQueryIndexGetAllDeferredResponse {
1855 status: string;
1856 index_names: string[];
1857}
1858export interface CppManagementQueryIndexGetAllDeferredRequest {
1859 bucket_name: string;
1860 scope_name: string;
1861 collection_name: string;
1862 query_ctx: CppQueryContext;
1863 client_context_id?: string;
1864 timeout?: CppMilliseconds;
1865}
1866export interface CppManagementQueryIndexBuildResponse {
1867 status: string;
1868 errors: CppManagementQueryIndexBuildResponseQueryProblem[];
1869}
1870export interface CppManagementQueryIndexBuildResponseQueryProblem {
1871 code: number;
1872 message: string;
1873}
1874export interface CppManagementQueryIndexBuildRequest {
1875 bucket_name: string;
1876 scope_name: string;
1877 collection_name: string;
1878 query_ctx: CppQueryContext;
1879 index_names: string[];
1880 client_context_id?: string;
1881 timeout?: CppMilliseconds;
1882}
1883export interface CppManagementEventingUndeployFunctionResponse {
1884 error?: CppManagementEventingProblem;
1885}
1886export interface CppManagementEventingUndeployFunctionRequest {
1887 name: string;
1888 bucket_name?: string;
1889 scope_name?: string;
1890 client_context_id?: string;
1891 timeout?: CppMilliseconds;
1892}
1893export interface CppManagementSearchIndexGetDocumentsCountResponse {
1894 status: string;
1895 count: number;
1896 error: string;
1897}
1898export interface CppManagementSearchIndexGetDocumentsCountRequest {
1899 index_name: string;
1900 bucket_name?: string;
1901 scope_name?: string;
1902 client_context_id?: string;
1903 timeout?: CppMilliseconds;
1904}
1905export interface CppManagementAnalyticsLinkGetAllResponse {
1906 status: string;
1907 errors: CppManagementAnalyticsLinkGetAllResponseProblem[];
1908 couchbase: CppManagementAnalyticsCouchbaseRemoteLink[];
1909 s3: CppManagementAnalyticsS3ExternalLink[];
1910 azure_blob: CppManagementAnalyticsAzureBlobExternalLink[];
1911}
1912export interface CppManagementAnalyticsLinkGetAllResponseProblem {
1913 code: number;
1914 message: string;
1915}
1916export interface CppManagementAnalyticsLinkGetAllRequest {
1917 link_type: string;
1918 link_name: string;
1919 dataverse_name: string;
1920 client_context_id?: string;
1921 timeout?: CppMilliseconds;
1922}
1923export interface CppImplSubdocCommand {
1924 opcode_: number;
1925 path_: string;
1926 value_?: Buffer;
1927 flags_: number;
1928 original_index_: number;
1929}
1930export interface CppScanTerm {
1931 term: string;
1932 exclusive: boolean;
1933}
1934export interface CppRangeScan {
1935 from?: CppScanTerm;
1936 to?: CppScanTerm;
1937}
1938export interface CppPrefixScan {
1939 prefix: string;
1940}
1941export interface CppSamplingScan {
1942 limit: number;
1943 seed?: number;
1944}
1945export interface CppRangeSnapshotRequirements {
1946 vbucket_uuid: number;
1947 sequence_number: number;
1948 sequence_number_exists: boolean;
1949}
1950export interface CppRangeScanCreateOptions {
1951 scope_name: string;
1952 collection_name: string;
1953 scan_type_name: string;
1954 scan_type_value: undefined | CppRangeScan | CppPrefixScan | CppSamplingScan;
1955 timeout: CppMilliseconds;
1956 collection_id: number;
1957 snapshot_requirements?: CppRangeSnapshotRequirements;
1958 ids_only: boolean;
1959}
1960export interface CppRangeScanCreateResult {
1961 scan_uuid: Buffer;
1962 ids_only: boolean;
1963}
1964export interface CppRangeScanContinueOptions {
1965 batch_item_limit: number;
1966 batch_byte_limit: number;
1967 timeout: CppMilliseconds;
1968 batch_time_limit: CppMilliseconds;
1969}
1970export interface CppRangeScanContinueResult {
1971 more: boolean;
1972 complete: boolean;
1973 ids_only: boolean;
1974}
1975export interface CppRangeScanCancelOptions {
1976 timeout: CppMilliseconds;
1977}
1978export interface CppRangeScanItemBody {
1979 flags: number;
1980 expiry: number;
1981 cas: CppCas;
1982 sequence_number: number;
1983 datatype: number;
1984 value: Buffer;
1985}
1986export interface CppRangeScanItem {
1987 key: string;
1988 body?: CppRangeScanItemBody;
1989}
1990export interface CppRangeScanCancelResult {
1991}
1992export interface CppMutationState {
1993 tokens: CppMutationToken[];
1994}
1995export interface CppRangeScanOrchestratorOptions {
1996 ids_only: boolean;
1997 consistent_with?: CppMutationState;
1998 batch_item_limit: number;
1999 batch_byte_limit: number;
2000 concurrency: number;
2001 timeout: CppMilliseconds;
2002}
2003export interface CppConnectionAutogen {
2004 prepend(options: CppPrependRequest, callback: (err: CppError | null, result: CppPrependResponse) => void): void;
2005 prependWithLegacyDurability(options: CppPrependWithLegacyDurabilityRequest, callback: (err: CppError | null, result: CppPrependResponse) => void): void;
2006 exists(options: CppExistsRequest, callback: (err: CppError | null, result: CppExistsResponse) => void): void;
2007 httpNoop(options: CppHttpNoopRequest, callback: (err: CppError | null, result: CppHttpNoopResponse) => void): void;
2008 unlock(options: CppUnlockRequest, callback: (err: CppError | null, result: CppUnlockResponse) => void): void;
2009 getAllReplicas(options: CppGetAllReplicasRequest, callback: (err: CppError | null, result: CppGetAllReplicasResponse) => void): void;
2010 upsert(options: CppUpsertRequest, callback: (err: CppError | null, result: CppUpsertResponse) => void): void;
2011 upsertWithLegacyDurability(options: CppUpsertWithLegacyDurabilityRequest, callback: (err: CppError | null, result: CppUpsertResponse) => void): void;
2012 getAnyReplica(options: CppGetAnyReplicaRequest, callback: (err: CppError | null, result: CppGetAnyReplicaResponse) => void): void;
2013 append(options: CppAppendRequest, callback: (err: CppError | null, result: CppAppendResponse) => void): void;
2014 appendWithLegacyDurability(options: CppAppendWithLegacyDurabilityRequest, callback: (err: CppError | null, result: CppAppendResponse) => void): void;
2015 query(options: CppQueryRequest, callback: (err: CppError | null, result: CppQueryResponse) => void): void;
2016 replace(options: CppReplaceRequest, callback: (err: CppError | null, result: CppReplaceResponse) => void): void;
2017 replaceWithLegacyDurability(options: CppReplaceWithLegacyDurabilityRequest, callback: (err: CppError | null, result: CppReplaceResponse) => void): void;
2018 getAndTouch(options: CppGetAndTouchRequest, callback: (err: CppError | null, result: CppGetAndTouchResponse) => void): void;
2019 remove(options: CppRemoveRequest, callback: (err: CppError | null, result: CppRemoveResponse) => void): void;
2020 removeWithLegacyDurability(options: CppRemoveWithLegacyDurabilityRequest, callback: (err: CppError | null, result: CppRemoveResponse) => void): void;
2021 get(options: CppGetRequest, callback: (err: CppError | null, result: CppGetResponse) => void): void;
2022 lookupInAllReplicas(options: CppLookupInAllReplicasRequest, callback: (err: CppError | null, result: CppLookupInAllReplicasResponse) => void): void;
2023 analytics(options: CppAnalyticsRequest, callback: (err: CppError | null, result: CppAnalyticsResponse) => void): void;
2024 getProjected(options: CppGetProjectedRequest, callback: (err: CppError | null, result: CppGetProjectedResponse) => void): void;
2025 decrement(options: CppDecrementRequest, callback: (err: CppError | null, result: CppDecrementResponse) => void): void;
2026 decrementWithLegacyDurability(options: CppDecrementWithLegacyDurabilityRequest, callback: (err: CppError | null, result: CppDecrementResponse) => void): void;
2027 search(options: CppSearchRequest, callback: (err: CppError | null, result: CppSearchResponse) => void): void;
2028 touch(options: CppTouchRequest, callback: (err: CppError | null, result: CppTouchResponse) => void): void;
2029 lookupIn(options: CppLookupInRequest, callback: (err: CppError | null, result: CppLookupInResponse) => void): void;
2030 documentView(options: CppDocumentViewRequest, callback: (err: CppError | null, result: CppDocumentViewResponse) => void): void;
2031 getAndLock(options: CppGetAndLockRequest, callback: (err: CppError | null, result: CppGetAndLockResponse) => void): void;
2032 insert(options: CppInsertRequest, callback: (err: CppError | null, result: CppInsertResponse) => void): void;
2033 insertWithLegacyDurability(options: CppInsertWithLegacyDurabilityRequest, callback: (err: CppError | null, result: CppInsertResponse) => void): void;
2034 lookupInAnyReplica(options: CppLookupInAnyReplicaRequest, callback: (err: CppError | null, result: CppLookupInAnyReplicaResponse) => void): void;
2035 mutateIn(options: CppMutateInRequest, callback: (err: CppError | null, result: CppMutateInResponse) => void): void;
2036 mutateInWithLegacyDurability(options: CppMutateInWithLegacyDurabilityRequest, callback: (err: CppError | null, result: CppMutateInResponse) => void): void;
2037 increment(options: CppIncrementRequest, callback: (err: CppError | null, result: CppIncrementResponse) => void): void;
2038 incrementWithLegacyDurability(options: CppIncrementWithLegacyDurabilityRequest, callback: (err: CppError | null, result: CppIncrementResponse) => void): void;
2039 managementGroupUpsert(options: CppManagementGroupUpsertRequest, callback: (err: CppError | null, result: CppManagementGroupUpsertResponse) => void): void;
2040 managementEventingPauseFunction(options: CppManagementEventingPauseFunctionRequest, callback: (err: CppError | null, result: CppManagementEventingPauseFunctionResponse) => void): void;
2041 managementQueryIndexGetAll(options: CppManagementQueryIndexGetAllRequest, callback: (err: CppError | null, result: CppManagementQueryIndexGetAllResponse) => void): void;
2042 managementCollectionCreate(options: CppManagementCollectionCreateRequest, callback: (err: CppError | null, result: CppManagementCollectionCreateResponse) => void): void;
2043 managementEventingResumeFunction(options: CppManagementEventingResumeFunctionRequest, callback: (err: CppError | null, result: CppManagementEventingResumeFunctionResponse) => void): void;
2044 managementSearchIndexGetStats(options: CppManagementSearchIndexGetStatsRequest, callback: (err: CppError | null, result: CppManagementSearchIndexGetStatsResponse) => void): void;
2045 managementBucketGetAll(options: CppManagementBucketGetAllRequest, callback: (err: CppError | null, result: CppManagementBucketGetAllResponse) => void): void;
2046 managementQueryIndexBuildDeferred(options: CppManagementQueryIndexBuildDeferredRequest, callback: (err: CppError | null, result: CppManagementQueryIndexBuildDeferredResponse) => void): void;
2047 managementClusterDescribe(options: CppManagementClusterDescribeRequest, callback: (err: CppError | null, result: CppManagementClusterDescribeResponse) => void): void;
2048 managementSearchIndexGetAll(options: CppManagementSearchIndexGetAllRequest, callback: (err: CppError | null, result: CppManagementSearchIndexGetAllResponse) => void): void;
2049 managementSearchIndexAnalyzeDocument(options: CppManagementSearchIndexAnalyzeDocumentRequest, callback: (err: CppError | null, result: CppManagementSearchIndexAnalyzeDocumentResponse) => void): void;
2050 managementQueryIndexDrop(options: CppManagementQueryIndexDropRequest, callback: (err: CppError | null, result: CppManagementQueryIndexDropResponse) => void): void;
2051 managementAnalyticsDatasetCreate(options: CppManagementAnalyticsDatasetCreateRequest, callback: (err: CppError | null, result: CppManagementAnalyticsDatasetCreateResponse) => void): void;
2052 managementBucketFlush(options: CppManagementBucketFlushRequest, callback: (err: CppError | null, result: CppManagementBucketFlushResponse) => void): void;
2053 managementAnalyticsIndexDrop(options: CppManagementAnalyticsIndexDropRequest, callback: (err: CppError | null, result: CppManagementAnalyticsIndexDropResponse) => void): void;
2054 managementQueryIndexCreate(options: CppManagementQueryIndexCreateRequest, callback: (err: CppError | null, result: CppManagementQueryIndexCreateResponse) => void): void;
2055 managementSearchIndexUpsert(options: CppManagementSearchIndexUpsertRequest, callback: (err: CppError | null, result: CppManagementSearchIndexUpsertResponse) => void): void;
2056 managementAnalyticsDatasetGetAll(options: CppManagementAnalyticsDatasetGetAllRequest, callback: (err: CppError | null, result: CppManagementAnalyticsDatasetGetAllResponse) => void): void;
2057 managementAnalyticsIndexGetAll(options: CppManagementAnalyticsIndexGetAllRequest, callback: (err: CppError | null, result: CppManagementAnalyticsIndexGetAllResponse) => void): void;
2058 managementAnalyticsGetPendingMutations(options: CppManagementAnalyticsGetPendingMutationsRequest, callback: (err: CppError | null, result: CppManagementAnalyticsGetPendingMutationsResponse) => void): void;
2059 managementAnalyticsDataverseDrop(options: CppManagementAnalyticsDataverseDropRequest, callback: (err: CppError | null, result: CppManagementAnalyticsDataverseDropResponse) => void): void;
2060 managementAnalyticsLinkConnect(options: CppManagementAnalyticsLinkConnectRequest, callback: (err: CppError | null, result: CppManagementAnalyticsLinkConnectResponse) => void): void;
2061 managementCollectionsManifestGet(options: CppManagementCollectionsManifestGetRequest, callback: (err: CppError | null, result: CppManagementCollectionsManifestGetResponse) => void): void;
2062 managementChangePassword(options: CppManagementChangePasswordRequest, callback: (err: CppError | null, result: CppManagementChangePasswordResponse) => void): void;
2063 managementClusterDeveloperPreviewEnable(options: CppManagementClusterDeveloperPreviewEnableRequest, callback: (err: CppError | null, result: CppManagementClusterDeveloperPreviewEnableResponse) => void): void;
2064 managementAnalyticsLinkDrop(options: CppManagementAnalyticsLinkDropRequest, callback: (err: CppError | null, result: CppManagementAnalyticsLinkDropResponse) => void): void;
2065 managementCollectionUpdate(options: CppManagementCollectionUpdateRequest, callback: (err: CppError | null, result: CppManagementCollectionUpdateResponse) => void): void;
2066 managementBucketDescribe(options: CppManagementBucketDescribeRequest, callback: (err: CppError | null, result: CppManagementBucketDescribeResponse) => void): void;
2067 managementEventingUpsertFunction(options: CppManagementEventingUpsertFunctionRequest, callback: (err: CppError | null, result: CppManagementEventingUpsertFunctionResponse) => void): void;
2068 managementViewIndexGetAll(options: CppManagementViewIndexGetAllRequest, callback: (err: CppError | null, result: CppManagementViewIndexGetAllResponse) => void): void;
2069 managementBucketGet(options: CppManagementBucketGetRequest, callback: (err: CppError | null, result: CppManagementBucketGetResponse) => void): void;
2070 managementBucketUpdate(options: CppManagementBucketUpdateRequest, callback: (err: CppError | null, result: CppManagementBucketUpdateResponse) => void): void;
2071 managementBucketDrop(options: CppManagementBucketDropRequest, callback: (err: CppError | null, result: CppManagementBucketDropResponse) => void): void;
2072 managementFreeform(options: CppManagementFreeformRequest, callback: (err: CppError | null, result: CppManagementFreeformResponse) => void): void;
2073 managementScopeDrop(options: CppManagementScopeDropRequest, callback: (err: CppError | null, result: CppManagementScopeDropResponse) => void): void;
2074 managementViewIndexUpsert(options: CppManagementViewIndexUpsertRequest, callback: (err: CppError | null, result: CppManagementViewIndexUpsertResponse) => void): void;
2075 managementUserGetAll(options: CppManagementUserGetAllRequest, callback: (err: CppError | null, result: CppManagementUserGetAllResponse) => void): void;
2076 managementScopeCreate(options: CppManagementScopeCreateRequest, callback: (err: CppError | null, result: CppManagementScopeCreateResponse) => void): void;
2077 managementEventingGetFunction(options: CppManagementEventingGetFunctionRequest, callback: (err: CppError | null, result: CppManagementEventingGetFunctionResponse) => void): void;
2078 managementViewIndexDrop(options: CppManagementViewIndexDropRequest, callback: (err: CppError | null, result: CppManagementViewIndexDropResponse) => void): void;
2079 managementAnalyticsLinkDisconnect(options: CppManagementAnalyticsLinkDisconnectRequest, callback: (err: CppError | null, result: CppManagementAnalyticsLinkDisconnectResponse) => void): void;
2080 managementUserUpsert(options: CppManagementUserUpsertRequest, callback: (err: CppError | null, result: CppManagementUserUpsertResponse) => void): void;
2081 managementEventingGetStatus(options: CppManagementEventingGetStatusRequest, callback: (err: CppError | null, result: CppManagementEventingGetStatusResponse) => void): void;
2082 managementEventingGetAllFunctions(options: CppManagementEventingGetAllFunctionsRequest, callback: (err: CppError | null, result: CppManagementEventingGetAllFunctionsResponse) => void): void;
2083 managementAnalyticsIndexCreate(options: CppManagementAnalyticsIndexCreateRequest, callback: (err: CppError | null, result: CppManagementAnalyticsIndexCreateResponse) => void): void;
2084 managementScopeGetAll(options: CppManagementScopeGetAllRequest, callback: (err: CppError | null, result: CppManagementScopeGetAllResponse) => void): void;
2085 managementUserGet(options: CppManagementUserGetRequest, callback: (err: CppError | null, result: CppManagementUserGetResponse) => void): void;
2086 managementSearchIndexDrop(options: CppManagementSearchIndexDropRequest, callback: (err: CppError | null, result: CppManagementSearchIndexDropResponse) => void): void;
2087 managementSearchIndexControlPlanFreeze(options: CppManagementSearchIndexControlPlanFreezeRequest, callback: (err: CppError | null, result: CppManagementSearchIndexControlPlanFreezeResponse) => void): void;
2088 managementSearchGetStats(options: CppManagementSearchGetStatsRequest, callback: (err: CppError | null, result: CppManagementSearchGetStatsResponse) => void): void;
2089 managementUserDrop(options: CppManagementUserDropRequest, callback: (err: CppError | null, result: CppManagementUserDropResponse) => void): void;
2090 managementAnalyticsDataverseCreate(options: CppManagementAnalyticsDataverseCreateRequest, callback: (err: CppError | null, result: CppManagementAnalyticsDataverseCreateResponse) => void): void;
2091 managementSearchIndexControlQuery(options: CppManagementSearchIndexControlQueryRequest, callback: (err: CppError | null, result: CppManagementSearchIndexControlQueryResponse) => void): void;
2092 managementRoleGetAll(options: CppManagementRoleGetAllRequest, callback: (err: CppError | null, result: CppManagementRoleGetAllResponse) => void): void;
2093 managementGroupGetAll(options: CppManagementGroupGetAllRequest, callback: (err: CppError | null, result: CppManagementGroupGetAllResponse) => void): void;
2094 managementEventingDropFunction(options: CppManagementEventingDropFunctionRequest, callback: (err: CppError | null, result: CppManagementEventingDropFunctionResponse) => void): void;
2095 managementCollectionDrop(options: CppManagementCollectionDropRequest, callback: (err: CppError | null, result: CppManagementCollectionDropResponse) => void): void;
2096 managementSearchIndexControlIngest(options: CppManagementSearchIndexControlIngestRequest, callback: (err: CppError | null, result: CppManagementSearchIndexControlIngestResponse) => void): void;
2097 managementEventingDeployFunction(options: CppManagementEventingDeployFunctionRequest, callback: (err: CppError | null, result: CppManagementEventingDeployFunctionResponse) => void): void;
2098 managementGroupGet(options: CppManagementGroupGetRequest, callback: (err: CppError | null, result: CppManagementGroupGetResponse) => void): void;
2099 managementViewIndexGet(options: CppManagementViewIndexGetRequest, callback: (err: CppError | null, result: CppManagementViewIndexGetResponse) => void): void;
2100 managementBucketCreate(options: CppManagementBucketCreateRequest, callback: (err: CppError | null, result: CppManagementBucketCreateResponse) => void): void;
2101 managementAnalyticsDatasetDrop(options: CppManagementAnalyticsDatasetDropRequest, callback: (err: CppError | null, result: CppManagementAnalyticsDatasetDropResponse) => void): void;
2102 managementGroupDrop(options: CppManagementGroupDropRequest, callback: (err: CppError | null, result: CppManagementGroupDropResponse) => void): void;
2103 managementSearchIndexGet(options: CppManagementSearchIndexGetRequest, callback: (err: CppError | null, result: CppManagementSearchIndexGetResponse) => void): void;
2104 managementQueryIndexGetAllDeferred(options: CppManagementQueryIndexGetAllDeferredRequest, callback: (err: CppError | null, result: CppManagementQueryIndexGetAllDeferredResponse) => void): void;
2105 managementQueryIndexBuild(options: CppManagementQueryIndexBuildRequest, callback: (err: CppError | null, result: CppManagementQueryIndexBuildResponse) => void): void;
2106 managementEventingUndeployFunction(options: CppManagementEventingUndeployFunctionRequest, callback: (err: CppError | null, result: CppManagementEventingUndeployFunctionResponse) => void): void;
2107 managementSearchIndexGetDocumentsCount(options: CppManagementSearchIndexGetDocumentsCountRequest, callback: (err: CppError | null, result: CppManagementSearchIndexGetDocumentsCountResponse) => void): void;
2108 managementAnalyticsLinkGetAll(options: CppManagementAnalyticsLinkGetAllRequest, callback: (err: CppError | null, result: CppManagementAnalyticsLinkGetAllResponse) => void): void;
2109}
2110export interface CppBindingAutogen {
2111 management_analytics_couchbase_link_encryption_level: {
2112 none: CppManagementAnalyticsCouchbaseLinkEncryptionLevel;
2113 half: CppManagementAnalyticsCouchbaseLinkEncryptionLevel;
2114 full: CppManagementAnalyticsCouchbaseLinkEncryptionLevel;
2115 };
2116 management_cluster_bucket_type: {
2117 unknown: CppManagementClusterBucketType;
2118 couchbase: CppManagementClusterBucketType;
2119 memcached: CppManagementClusterBucketType;
2120 ephemeral: CppManagementClusterBucketType;
2121 };
2122 management_cluster_bucket_compression: {
2123 unknown: CppManagementClusterBucketCompression;
2124 off: CppManagementClusterBucketCompression;
2125 active: CppManagementClusterBucketCompression;
2126 passive: CppManagementClusterBucketCompression;
2127 };
2128 management_cluster_bucket_eviction_policy: {
2129 unknown: CppManagementClusterBucketEvictionPolicy;
2130 full: CppManagementClusterBucketEvictionPolicy;
2131 value_only: CppManagementClusterBucketEvictionPolicy;
2132 no_eviction: CppManagementClusterBucketEvictionPolicy;
2133 not_recently_used: CppManagementClusterBucketEvictionPolicy;
2134 };
2135 management_cluster_bucket_conflict_resolution: {
2136 unknown: CppManagementClusterBucketConflictResolution;
2137 timestamp: CppManagementClusterBucketConflictResolution;
2138 sequence_number: CppManagementClusterBucketConflictResolution;
2139 custom: CppManagementClusterBucketConflictResolution;
2140 };
2141 management_cluster_bucket_storage_backend: {
2142 unknown: CppManagementClusterBucketStorageBackend;
2143 couchstore: CppManagementClusterBucketStorageBackend;
2144 magma: CppManagementClusterBucketStorageBackend;
2145 };
2146 management_eventing_function_dcp_boundary: {
2147 everything: CppManagementEventingFunctionDcpBoundary;
2148 from_now: CppManagementEventingFunctionDcpBoundary;
2149 };
2150 management_eventing_function_language_compatibility: {
2151 version_6_0_0: CppManagementEventingFunctionLanguageCompatibility;
2152 version_6_5_0: CppManagementEventingFunctionLanguageCompatibility;
2153 version_6_6_2: CppManagementEventingFunctionLanguageCompatibility;
2154 version_7_2_0: CppManagementEventingFunctionLanguageCompatibility;
2155 };
2156 management_eventing_function_log_level: {
2157 info: CppManagementEventingFunctionLogLevel;
2158 error: CppManagementEventingFunctionLogLevel;
2159 warning: CppManagementEventingFunctionLogLevel;
2160 debug: CppManagementEventingFunctionLogLevel;
2161 trace: CppManagementEventingFunctionLogLevel;
2162 };
2163 management_eventing_function_bucket_access: {
2164 read_only: CppManagementEventingFunctionBucketAccess;
2165 read_write: CppManagementEventingFunctionBucketAccess;
2166 };
2167 management_eventing_function_status: {
2168 undeployed: CppManagementEventingFunctionStatus;
2169 undeploying: CppManagementEventingFunctionStatus;
2170 deploying: CppManagementEventingFunctionStatus;
2171 deployed: CppManagementEventingFunctionStatus;
2172 paused: CppManagementEventingFunctionStatus;
2173 pausing: CppManagementEventingFunctionStatus;
2174 };
2175 management_eventing_function_deployment_status: {
2176 deployed: CppManagementEventingFunctionDeploymentStatus;
2177 undeployed: CppManagementEventingFunctionDeploymentStatus;
2178 };
2179 management_eventing_function_processing_status: {
2180 running: CppManagementEventingFunctionProcessingStatus;
2181 paused: CppManagementEventingFunctionProcessingStatus;
2182 };
2183 management_rbac_auth_domain: {
2184 unknown: CppManagementRbacAuthDomain;
2185 local: CppManagementRbacAuthDomain;
2186 external: CppManagementRbacAuthDomain;
2187 };
2188 retry_reason: {
2189 do_not_retry: CppRetryReason;
2190 unknown: CppRetryReason;
2191 socket_not_available: CppRetryReason;
2192 service_not_available: CppRetryReason;
2193 node_not_available: CppRetryReason;
2194 key_value_not_my_vbucket: CppRetryReason;
2195 key_value_collection_outdated: CppRetryReason;
2196 key_value_error_map_retry_indicated: CppRetryReason;
2197 key_value_locked: CppRetryReason;
2198 key_value_temporary_failure: CppRetryReason;
2199 key_value_sync_write_in_progress: CppRetryReason;
2200 key_value_sync_write_re_commit_in_progress: CppRetryReason;
2201 service_response_code_indicated: CppRetryReason;
2202 socket_closed_while_in_flight: CppRetryReason;
2203 circuit_breaker_open: CppRetryReason;
2204 query_prepared_statement_failure: CppRetryReason;
2205 query_index_not_found: CppRetryReason;
2206 analytics_temporary_failure: CppRetryReason;
2207 search_too_many_requests: CppRetryReason;
2208 views_temporary_failure: CppRetryReason;
2209 views_no_active_partition: CppRetryReason;
2210 };
2211 protocol_subdoc_opcode: {
2212 get_doc: CppProtocolSubdocOpcode;
2213 set_doc: CppProtocolSubdocOpcode;
2214 remove_doc: CppProtocolSubdocOpcode;
2215 get: CppProtocolSubdocOpcode;
2216 exists: CppProtocolSubdocOpcode;
2217 dict_add: CppProtocolSubdocOpcode;
2218 dict_upsert: CppProtocolSubdocOpcode;
2219 remove: CppProtocolSubdocOpcode;
2220 replace: CppProtocolSubdocOpcode;
2221 array_push_last: CppProtocolSubdocOpcode;
2222 array_push_first: CppProtocolSubdocOpcode;
2223 array_insert: CppProtocolSubdocOpcode;
2224 array_add_unique: CppProtocolSubdocOpcode;
2225 counter: CppProtocolSubdocOpcode;
2226 get_count: CppProtocolSubdocOpcode;
2227 replace_body_with_xattr: CppProtocolSubdocOpcode;
2228 };
2229 analytics_scan_consistency: {
2230 not_bounded: CppAnalyticsScanConsistency;
2231 request_plus: CppAnalyticsScanConsistency;
2232 };
2233 design_document_namespace: {
2234 development: CppDesignDocumentNamespace;
2235 production: CppDesignDocumentNamespace;
2236 };
2237 diag_cluster_state: {
2238 online: CppDiagClusterState;
2239 degraded: CppDiagClusterState;
2240 offline: CppDiagClusterState;
2241 };
2242 diag_endpoint_state: {
2243 disconnected: CppDiagEndpointState;
2244 connecting: CppDiagEndpointState;
2245 connected: CppDiagEndpointState;
2246 disconnecting: CppDiagEndpointState;
2247 };
2248 diag_ping_state: {
2249 ok: CppDiagPingState;
2250 timeout: CppDiagPingState;
2251 error: CppDiagPingState;
2252 };
2253 query_profile: {
2254 off: CppQueryProfile;
2255 phases: CppQueryProfile;
2256 timings: CppQueryProfile;
2257 };
2258 query_scan_consistency: {
2259 not_bounded: CppQueryScanConsistency;
2260 request_plus: CppQueryScanConsistency;
2261 };
2262 search_highlight_style: {
2263 html: CppSearchHighlightStyle;
2264 ansi: CppSearchHighlightStyle;
2265 };
2266 search_scan_consistency: {
2267 not_bounded: CppSearchScanConsistency;
2268 };
2269 service_type: {
2270 key_value: CppServiceType;
2271 query: CppServiceType;
2272 analytics: CppServiceType;
2273 search: CppServiceType;
2274 view: CppServiceType;
2275 management: CppServiceType;
2276 eventing: CppServiceType;
2277 };
2278 view_on_error: {
2279 resume: CppViewOnError;
2280 stop: CppViewOnError;
2281 };
2282 view_scan_consistency: {
2283 not_bounded: CppViewScanConsistency;
2284 update_after: CppViewScanConsistency;
2285 request_plus: CppViewScanConsistency;
2286 };
2287 view_sort_order: {
2288 ascending: CppViewSortOrder;
2289 descending: CppViewSortOrder;
2290 };
2291 analytics_response_analytics_status: {
2292 running: CppAnalyticsResponseAnalyticsStatus;
2293 success: CppAnalyticsResponseAnalyticsStatus;
2294 errors: CppAnalyticsResponseAnalyticsStatus;
2295 completed: CppAnalyticsResponseAnalyticsStatus;
2296 stopped: CppAnalyticsResponseAnalyticsStatus;
2297 timedout: CppAnalyticsResponseAnalyticsStatus;
2298 closed: CppAnalyticsResponseAnalyticsStatus;
2299 fatal: CppAnalyticsResponseAnalyticsStatus;
2300 aborted: CppAnalyticsResponseAnalyticsStatus;
2301 unknown: CppAnalyticsResponseAnalyticsStatus;
2302 };
2303 durability_level: {
2304 none: CppDurabilityLevel;
2305 majority: CppDurabilityLevel;
2306 majority_and_persist_to_active: CppDurabilityLevel;
2307 persist_to_majority: CppDurabilityLevel;
2308 };
2309 errc_common: {
2310 request_canceled: CppErrcCommon;
2311 invalid_argument: CppErrcCommon;
2312 service_not_available: CppErrcCommon;
2313 internal_server_failure: CppErrcCommon;
2314 authentication_failure: CppErrcCommon;
2315 temporary_failure: CppErrcCommon;
2316 parsing_failure: CppErrcCommon;
2317 cas_mismatch: CppErrcCommon;
2318 bucket_not_found: CppErrcCommon;
2319 collection_not_found: CppErrcCommon;
2320 unsupported_operation: CppErrcCommon;
2321 ambiguous_timeout: CppErrcCommon;
2322 unambiguous_timeout: CppErrcCommon;
2323 feature_not_available: CppErrcCommon;
2324 scope_not_found: CppErrcCommon;
2325 index_not_found: CppErrcCommon;
2326 index_exists: CppErrcCommon;
2327 encoding_failure: CppErrcCommon;
2328 decoding_failure: CppErrcCommon;
2329 rate_limited: CppErrcCommon;
2330 quota_limited: CppErrcCommon;
2331 };
2332 errc_key_value: {
2333 document_not_found: CppErrcKeyValue;
2334 document_irretrievable: CppErrcKeyValue;
2335 document_locked: CppErrcKeyValue;
2336 value_too_large: CppErrcKeyValue;
2337 document_exists: CppErrcKeyValue;
2338 durability_level_not_available: CppErrcKeyValue;
2339 durability_impossible: CppErrcKeyValue;
2340 durability_ambiguous: CppErrcKeyValue;
2341 durable_write_in_progress: CppErrcKeyValue;
2342 durable_write_re_commit_in_progress: CppErrcKeyValue;
2343 path_not_found: CppErrcKeyValue;
2344 path_mismatch: CppErrcKeyValue;
2345 path_invalid: CppErrcKeyValue;
2346 path_too_big: CppErrcKeyValue;
2347 path_too_deep: CppErrcKeyValue;
2348 value_too_deep: CppErrcKeyValue;
2349 value_invalid: CppErrcKeyValue;
2350 document_not_json: CppErrcKeyValue;
2351 number_too_big: CppErrcKeyValue;
2352 delta_invalid: CppErrcKeyValue;
2353 path_exists: CppErrcKeyValue;
2354 xattr_unknown_macro: CppErrcKeyValue;
2355 xattr_invalid_key_combo: CppErrcKeyValue;
2356 xattr_unknown_virtual_attribute: CppErrcKeyValue;
2357 xattr_cannot_modify_virtual_attribute: CppErrcKeyValue;
2358 xattr_no_access: CppErrcKeyValue;
2359 document_not_locked: CppErrcKeyValue;
2360 cannot_revive_living_document: CppErrcKeyValue;
2361 mutation_token_outdated: CppErrcKeyValue;
2362 range_scan_completed: CppErrcKeyValue;
2363 };
2364 errc_query: {
2365 planning_failure: CppErrcQuery;
2366 index_failure: CppErrcQuery;
2367 prepared_statement_failure: CppErrcQuery;
2368 dml_failure: CppErrcQuery;
2369 };
2370 errc_analytics: {
2371 compilation_failure: CppErrcAnalytics;
2372 job_queue_full: CppErrcAnalytics;
2373 dataset_not_found: CppErrcAnalytics;
2374 dataverse_not_found: CppErrcAnalytics;
2375 dataset_exists: CppErrcAnalytics;
2376 dataverse_exists: CppErrcAnalytics;
2377 link_not_found: CppErrcAnalytics;
2378 link_exists: CppErrcAnalytics;
2379 };
2380 errc_search: {
2381 index_not_ready: CppErrcSearch;
2382 consistency_mismatch: CppErrcSearch;
2383 };
2384 errc_view: {
2385 view_not_found: CppErrcView;
2386 design_document_not_found: CppErrcView;
2387 };
2388 errc_management: {
2389 collection_exists: CppErrcManagement;
2390 scope_exists: CppErrcManagement;
2391 user_not_found: CppErrcManagement;
2392 group_not_found: CppErrcManagement;
2393 bucket_exists: CppErrcManagement;
2394 user_exists: CppErrcManagement;
2395 bucket_not_flushable: CppErrcManagement;
2396 eventing_function_not_found: CppErrcManagement;
2397 eventing_function_not_deployed: CppErrcManagement;
2398 eventing_function_compilation_failure: CppErrcManagement;
2399 eventing_function_identical_keyspace: CppErrcManagement;
2400 eventing_function_not_bootstrapped: CppErrcManagement;
2401 eventing_function_deployed: CppErrcManagement;
2402 eventing_function_paused: CppErrcManagement;
2403 };
2404 errc_field_level_encryption: {
2405 generic_cryptography_failure: CppErrcFieldLevelEncryption;
2406 encryption_failure: CppErrcFieldLevelEncryption;
2407 decryption_failure: CppErrcFieldLevelEncryption;
2408 crypto_key_not_found: CppErrcFieldLevelEncryption;
2409 invalid_crypto_key: CppErrcFieldLevelEncryption;
2410 decrypter_not_found: CppErrcFieldLevelEncryption;
2411 encrypter_not_found: CppErrcFieldLevelEncryption;
2412 invalid_ciphertext: CppErrcFieldLevelEncryption;
2413 };
2414 errc_network: {
2415 resolve_failure: CppErrcNetwork;
2416 no_endpoints_left: CppErrcNetwork;
2417 handshake_failure: CppErrcNetwork;
2418 protocol_error: CppErrcNetwork;
2419 configuration_not_available: CppErrcNetwork;
2420 cluster_closed: CppErrcNetwork;
2421 end_of_stream: CppErrcNetwork;
2422 need_more_data: CppErrcNetwork;
2423 operation_queue_closed: CppErrcNetwork;
2424 operation_queue_full: CppErrcNetwork;
2425 request_already_queued: CppErrcNetwork;
2426 request_cancelled: CppErrcNetwork;
2427 bucket_closed: CppErrcNetwork;
2428 };
2429 key_value_status_code: {
2430 success: CppKeyValueStatusCode;
2431 not_found: CppKeyValueStatusCode;
2432 exists: CppKeyValueStatusCode;
2433 too_big: CppKeyValueStatusCode;
2434 invalid: CppKeyValueStatusCode;
2435 not_stored: CppKeyValueStatusCode;
2436 delta_bad_value: CppKeyValueStatusCode;
2437 not_my_vbucket: CppKeyValueStatusCode;
2438 no_bucket: CppKeyValueStatusCode;
2439 dcp_stream_not_found: CppKeyValueStatusCode;
2440 opaque_no_match: CppKeyValueStatusCode;
2441 locked: CppKeyValueStatusCode;
2442 not_locked: CppKeyValueStatusCode;
2443 config_only: CppKeyValueStatusCode;
2444 auth_stale: CppKeyValueStatusCode;
2445 auth_error: CppKeyValueStatusCode;
2446 auth_continue: CppKeyValueStatusCode;
2447 range_error: CppKeyValueStatusCode;
2448 rollback: CppKeyValueStatusCode;
2449 no_access: CppKeyValueStatusCode;
2450 not_initialized: CppKeyValueStatusCode;
2451 rate_limited_network_ingress: CppKeyValueStatusCode;
2452 rate_limited_network_egress: CppKeyValueStatusCode;
2453 rate_limited_max_connections: CppKeyValueStatusCode;
2454 rate_limited_max_commands: CppKeyValueStatusCode;
2455 scope_size_limit_exceeded: CppKeyValueStatusCode;
2456 unknown_frame_info: CppKeyValueStatusCode;
2457 unknown_command: CppKeyValueStatusCode;
2458 no_memory: CppKeyValueStatusCode;
2459 not_supported: CppKeyValueStatusCode;
2460 internal: CppKeyValueStatusCode;
2461 busy: CppKeyValueStatusCode;
2462 temporary_failure: CppKeyValueStatusCode;
2463 xattr_invalid: CppKeyValueStatusCode;
2464 unknown_collection: CppKeyValueStatusCode;
2465 no_collections_manifest: CppKeyValueStatusCode;
2466 cannot_apply_collections_manifest: CppKeyValueStatusCode;
2467 collections_manifest_is_ahead: CppKeyValueStatusCode;
2468 unknown_scope: CppKeyValueStatusCode;
2469 dcp_stream_id_invalid: CppKeyValueStatusCode;
2470 durability_invalid_level: CppKeyValueStatusCode;
2471 durability_impossible: CppKeyValueStatusCode;
2472 sync_write_in_progress: CppKeyValueStatusCode;
2473 sync_write_ambiguous: CppKeyValueStatusCode;
2474 sync_write_re_commit_in_progress: CppKeyValueStatusCode;
2475 subdoc_path_not_found: CppKeyValueStatusCode;
2476 subdoc_path_mismatch: CppKeyValueStatusCode;
2477 subdoc_path_invalid: CppKeyValueStatusCode;
2478 subdoc_path_too_big: CppKeyValueStatusCode;
2479 subdoc_doc_too_deep: CppKeyValueStatusCode;
2480 subdoc_value_cannot_insert: CppKeyValueStatusCode;
2481 subdoc_doc_not_json: CppKeyValueStatusCode;
2482 subdoc_num_range_error: CppKeyValueStatusCode;
2483 subdoc_delta_invalid: CppKeyValueStatusCode;
2484 subdoc_path_exists: CppKeyValueStatusCode;
2485 subdoc_value_too_deep: CppKeyValueStatusCode;
2486 subdoc_invalid_combo: CppKeyValueStatusCode;
2487 subdoc_multi_path_failure: CppKeyValueStatusCode;
2488 subdoc_success_deleted: CppKeyValueStatusCode;
2489 subdoc_xattr_invalid_flag_combo: CppKeyValueStatusCode;
2490 subdoc_xattr_invalid_key_combo: CppKeyValueStatusCode;
2491 subdoc_xattr_unknown_macro: CppKeyValueStatusCode;
2492 subdoc_xattr_unknown_vattr: CppKeyValueStatusCode;
2493 subdoc_xattr_cannot_modify_vattr: CppKeyValueStatusCode;
2494 subdoc_multi_path_failure_deleted: CppKeyValueStatusCode;
2495 subdoc_invalid_xattr_order: CppKeyValueStatusCode;
2496 subdoc_xattr_unknown_vattr_macro: CppKeyValueStatusCode;
2497 subdoc_can_only_revive_deleted_documents: CppKeyValueStatusCode;
2498 subdoc_deleted_document_cannot_have_value: CppKeyValueStatusCode;
2499 range_scan_cancelled: CppKeyValueStatusCode;
2500 range_scan_more: CppKeyValueStatusCode;
2501 range_scan_complete: CppKeyValueStatusCode;
2502 range_scan_vb_uuid_not_equal: CppKeyValueStatusCode;
2503 unknown: CppKeyValueStatusCode;
2504 };
2505 impl_subdoc_opcode: {
2506 get_doc: CppImplSubdocOpcode;
2507 set_doc: CppImplSubdocOpcode;
2508 remove_doc: CppImplSubdocOpcode;
2509 get: CppImplSubdocOpcode;
2510 exists: CppImplSubdocOpcode;
2511 dict_add: CppImplSubdocOpcode;
2512 dict_upsert: CppImplSubdocOpcode;
2513 remove: CppImplSubdocOpcode;
2514 replace: CppImplSubdocOpcode;
2515 array_push_last: CppImplSubdocOpcode;
2516 array_push_first: CppImplSubdocOpcode;
2517 array_insert: CppImplSubdocOpcode;
2518 array_add_unique: CppImplSubdocOpcode;
2519 counter: CppImplSubdocOpcode;
2520 get_count: CppImplSubdocOpcode;
2521 replace_body_with_xattr: CppImplSubdocOpcode;
2522 };
2523 store_semantics: {
2524 replace: CppStoreSemantics;
2525 upsert: CppStoreSemantics;
2526 insert: CppStoreSemantics;
2527 revive: CppStoreSemantics;
2528 };
2529 persist_to: {
2530 none: CppPersistTo;
2531 active: CppPersistTo;
2532 one: CppPersistTo;
2533 two: CppPersistTo;
2534 three: CppPersistTo;
2535 four: CppPersistTo;
2536 };
2537 replicate_to: {
2538 none: CppReplicateTo;
2539 one: CppReplicateTo;
2540 two: CppReplicateTo;
2541 three: CppReplicateTo;
2542 };
2543 read_preference: {
2544 no_preference: CppReadPreference;
2545 selected_server_group: CppReadPreference;
2546 selected_server_group_or_all_available: CppReadPreference;
2547 };
2548 vector_query_combination: {
2549 combination_and: CppVectorQueryCombination;
2550 combination_or: CppVectorQueryCombination;
2551 };
2552}
2553export type CppErrc = CppErrcCommon | CppErrcKeyValue | CppErrcQuery | CppErrcAnalytics | CppErrcSearch | CppErrcView | CppErrcManagement | CppErrcFieldLevelEncryption | CppErrcNetwork;
2554export declare enum CppTxnFailureType {
2555}
2556export declare enum CppTxnExternalException {
2557}
2558export interface CppErrorBase {
2559 code: CppErrc;
2560}
2561export interface CppGenericError extends CppErrorBase {
2562 ctxtype: undefined | null;
2563}
2564export interface CppEnhancedErrorInfo {
2565 reference: string;
2566 context: string;
2567}
2568export interface CppKeyValueError extends CppErrorBase {
2569 ctxtype: 'key_value';
2570 id: CppDocumentId;
2571 opaque: number;
2572 cas: CppCas;
2573 status_code: CppKeyValueStatusCode;
2574 enhanced_error_info: CppEnhancedErrorInfo;
2575 last_dispatched_to: string;
2576 last_dispatched_from: string;
2577 retry_attempts: number;
2578 retry_reasons: CppRetryReason[];
2579}
2580export interface CppViewError extends CppErrorBase {
2581 ctxtype: 'view';
2582 client_context_id: string;
2583 design_document_name: string;
2584 view_name: string;
2585 query_string: string;
2586 method: string;
2587 path: string;
2588 http_status: number;
2589 http_body: string;
2590 last_dispatched_to: string;
2591 last_dispatched_from: string;
2592 retry_attempts: number;
2593 retry_reasons: CppRetryReason[];
2594}
2595export interface CppQueryError extends CppErrorBase {
2596 ctxtype: 'query';
2597 first_error_code: number;
2598 first_error_message: string;
2599 client_context_id: string;
2600 statement: string;
2601 parameters: string;
2602 method: string;
2603 path: string;
2604 http_status: number;
2605 http_body: string;
2606 last_dispatched_to: string;
2607 last_dispatched_from: string;
2608 retry_attempts: number;
2609 retry_reasons: CppRetryReason[];
2610}
2611export interface CppSearchError extends CppErrorBase {
2612 ctxtype: 'search';
2613 client_context_id: string;
2614 index_name: string;
2615 query: string;
2616 parameters: string;
2617 method: string;
2618 path: string;
2619 http_status: number;
2620 http_body: string;
2621 last_dispatched_to: string;
2622 last_dispatched_from: string;
2623 retry_attempts: number;
2624 retry_reasons: CppRetryReason[];
2625}
2626export interface CppAnalyticsError extends CppErrorBase {
2627 ctxtype: 'analytics';
2628 first_error_code: number;
2629 first_error_message: string;
2630 client_context_id: string;
2631 statement: string;
2632 parameters: string;
2633 method: string;
2634 path: string;
2635 http_status: number;
2636 http_body: string;
2637 last_dispatched_to: string;
2638 last_dispatched_from: string;
2639 retry_attempts: number;
2640 retry_reasons: CppRetryReason[];
2641}
2642export interface CppHttpError extends CppErrorBase {
2643 ctxtype: 'http';
2644 client_context_id: string;
2645 method: string;
2646 path: string;
2647 http_status: number;
2648 http_body: string;
2649 last_dispatched_to: string;
2650 last_dispatched_from: string;
2651 retry_attempts: number;
2652 retry_reasons: CppRetryReason[];
2653}
2654export interface CppTxnOperationFailed extends CppErrorBase {
2655 ctxtype: 'transaction_operation_failed';
2656 ctx: CppTransactionErrorContext;
2657 should_not_retry: boolean;
2658 should_not_rollback: boolean;
2659 cause: CppTxnExternalException;
2660}
2661export interface CppTxnOpException extends CppErrorBase {
2662 ctxtype: 'transaction_op_exception';
2663 ctx: CppTransactionOpErrorContext | undefined;
2664 cause: CppTxnExternalException;
2665}
2666export interface CppTxnError extends CppErrorBase {
2667 ctxtype: 'transaction_exception';
2668 result: CppTransactionResult;
2669 cause: CppTxnExternalException;
2670 type: CppTxnFailureType;
2671}
2672export interface CppTransactionErrorContext {
2673 code: CppErrc;
2674 cause: CppErrc;
2675}
2676export interface CppTransactionOpErrorContext {
2677 code: CppErrc;
2678 cause: CppKeyValueError | CppQueryError | undefined;
2679}
2680export type CppError = CppGenericError | CppKeyValueError | CppViewError | CppQueryError | CppSearchError | CppAnalyticsError | CppHttpError | CppTxnOperationFailed | CppTxnOpException | CppTxnError;
2681export interface CppConnection extends CppConnectionAutogen {
2682 connect(connStr: string, credentials: CppClusterCredentials, dnsOptions: CppDnsConfig | null, callback: (err: CppError | null) => void): void;
2683 shutdown(callback: (err: CppError | null) => void): void;
2684 openBucket(bucketName: string, callback: (err: CppError | null) => void): void;
2685 diagnostics(options: {
2686 report_id?: string;
2687 }, callback: (err: CppError | null, result: {
2688 version: number;
2689 id: string;
2690 sdk: string;
2691 services: {
2692 [serviceType: number]: {
2693 type: CppServiceType;
2694 id: string;
2695 last_activity: number;
2696 remote: string;
2697 local: string;
2698 state: CppDiagEndpointState;
2699 bucket?: string;
2700 details?: string;
2701 }[];
2702 };
2703 }) => void): void;
2704 ping(options: {
2705 report_id?: string;
2706 bucket_name?: string;
2707 services?: CppServiceType[];
2708 }, callback: (err: CppError | null, result: {
2709 version: number;
2710 id: string;
2711 sdk: string;
2712 services: {
2713 [serviceType: number]: {
2714 type: CppServiceType;
2715 id: string;
2716 latency: number;
2717 remote: string;
2718 local: string;
2719 state: CppDiagPingState;
2720 bucket?: string;
2721 error?: string;
2722 }[];
2723 };
2724 }) => void): void;
2725 scan(bucket_name: string, scope_name: string, collection_name: string, scan_type_name: string, scan_type_value: CppRangeScan | CppSamplingScan | CppPrefixScan, options: CppRangeScanOrchestratorOptions): {
2726 cppErr: CppError | null;
2727 result: CppScanIterator;
2728 };
2729}
2730export interface CppTransactionKeyspace {
2731 bucket_name: string;
2732 scope_name?: string;
2733 collection_name?: string;
2734}
2735export interface CppTransactionsConfig {
2736 durability_level?: CppDurabilityLevel;
2737 timeout?: CppMilliseconds;
2738 query_scan_consistency?: CppQueryScanConsistency;
2739 cleanup_window?: CppMilliseconds;
2740 cleanup_lost_attempts?: boolean;
2741 cleanup_client_attempts?: boolean;
2742 metadata_collection?: CppTransactionKeyspace;
2743}
2744export interface CppTransactionOptions {
2745 durability_level?: CppDurabilityLevel;
2746 timeout?: CppMilliseconds;
2747 query_scan_consistency?: CppQueryScanConsistency;
2748}
2749export interface CppTransactionLinks {
2750 atr_id: string;
2751 atr_bucket_name: string;
2752 atr_scope_name: string;
2753 atr_collection_name: string;
2754 staged_transaction_id: string;
2755 staged_attempt_id: string;
2756 staged_operation_id: string;
2757 staged_content_json: string;
2758 staged_content_binary?: Buffer;
2759 cas_pre_txn: string;
2760 revid_pre_txn: string;
2761 exptime_pre_txn: number;
2762 crc32_of_staging: string;
2763 op: string;
2764 forward_compat: string;
2765 is_deleted: boolean;
2766}
2767export interface CppTransactionGetMetaData {
2768 cas: string;
2769 revid: string;
2770 exptime: number;
2771 crc32: string;
2772}
2773export interface CppTransactionGetResult {
2774 id: CppDocumentId;
2775 cas: CppCas;
2776 content: CppJsonString;
2777 links: CppTransactionLinks;
2778 metadata: CppTransactionGetMetaData;
2779}
2780export interface CppTransactionResult {
2781 transaction_id: string;
2782 unstaging_complete: boolean;
2783}
2784export interface CppTransactions {
2785 new (conn: CppConnection): any;
2786 close(callback: (err: CppError | null) => void): void;
2787}
2788export interface CppTransaction {
2789 newAttempt(callback: (err: CppError | null) => void): void;
2790 get(options: {
2791 id: CppDocumentId;
2792 }, callback: (err: CppError | null, result: CppTransactionGetResult | null) => void): void;
2793 insert(options: {
2794 id: CppDocumentId;
2795 content: CppEncodedValue;
2796 }, callback: (err: CppError | null, result: CppTransactionGetResult | null) => void): void;
2797 replace(options: {
2798 doc: CppTransactionGetResult;
2799 content: CppEncodedValue;
2800 }, callback: (err: CppError | null, result: CppTransactionGetResult | null) => void): void;
2801 remove(options: {
2802 doc: CppTransactionGetResult;
2803 }, callback: (err: CppError | null) => void): void;
2804 query(statement: string, options: {
2805 raw?: {
2806 [key: string]: CppJsonString;
2807 };
2808 ad_hoc?: boolean;
2809 scan_consistency?: CppQueryScanConsistency;
2810 profile?: CppQueryProfile;
2811 metrics?: boolean;
2812 client_context_id?: string;
2813 scan_wait?: CppMilliseconds;
2814 readonly?: boolean;
2815 scan_cap?: number;
2816 pipeline_batch?: number;
2817 pipeline_cap?: number;
2818 max_parallelism?: number;
2819 positional_parameters?: CppJsonString[];
2820 named_parameters?: {
2821 [key: string]: CppJsonString;
2822 };
2823 }, callback: (err: CppError | null, resp: CppQueryResponse | null) => void): void;
2824 commit(callback: (err: CppError | null, resp: CppTransactionResult) => void): void;
2825 rollback(callback: (err: CppError | null) => void): void;
2826}
2827export interface CppBinding extends CppBindingAutogen {
2828 cbppVersion: string;
2829 cbppMetadata: string;
2830 enableProtocolLogger: (filename: string) => void;
2831 shutdownLogger: () => void;
2832 Connection: {
2833 new (): CppConnection;
2834 };
2835 Transactions: {
2836 new (conn: CppConnection, config: CppTransactionsConfig): CppTransactions;
2837 };
2838 Transaction: {
2839 new (txns: CppTransactions, options: CppTransactionOptions): CppTransaction;
2840 };
2841 protocol_lookup_in_request_body_doc_flag: {
2842 access_deleted: number;
2843 };
2844 protocol_lookup_in_request_body_lookup_in_specs_path_flag: {
2845 xattr: number;
2846 };
2847 protocol_mutate_in_request_body_doc_flag: {
2848 mkdoc: number;
2849 add: number;
2850 access_deleted: number;
2851 create_as_deleted: number;
2852 revive_document: number;
2853 };
2854 protocol_mutate_in_request_body_mutate_in_specs_path_flag: {
2855 create_parents: number;
2856 xattr: number;
2857 expand_macros: number;
2858 };
2859 txn_failure_type: {
2860 fail: CppTxnFailureType;
2861 expiry: CppTxnFailureType;
2862 commit_ambiguous: CppTxnFailureType;
2863 };
2864 txn_external_exception: {
2865 unknown: CppTxnExternalException;
2866 active_transaction_record_entry_not_found: CppTxnExternalException;
2867 active_transaction_record_full: CppTxnExternalException;
2868 active_transaction_record_not_found: CppTxnExternalException;
2869 document_already_in_transaction: CppTxnExternalException;
2870 document_exists_exception: CppTxnExternalException;
2871 document_not_found_exception: CppTxnExternalException;
2872 not_set: CppTxnExternalException;
2873 feature_not_available_exception: CppTxnExternalException;
2874 transaction_aborted_externally: CppTxnExternalException;
2875 previous_operation_failed: CppTxnExternalException;
2876 forward_compatibility_failure: CppTxnExternalException;
2877 parsing_failure: CppTxnExternalException;
2878 illegal_state_exception: CppTxnExternalException;
2879 couchbase_exception: CppTxnExternalException;
2880 service_not_available_exception: CppTxnExternalException;
2881 request_canceled_exception: CppTxnExternalException;
2882 concurrent_operations_detected_on_same_document: CppTxnExternalException;
2883 commit_not_permitted: CppTxnExternalException;
2884 rollback_not_permitted: CppTxnExternalException;
2885 transaction_already_aborted: CppTxnExternalException;
2886 transaction_already_committed: CppTxnExternalException;
2887 };
2888}
2889declare const binding: CppBinding;
2890export default binding;