UNPKG

couchbase

Version:

The official Couchbase Node.js Client Library.

1,791 lines 106 kB
/// <reference types="node" /> export type CppMilliseconds = number; export type CppSeconds = number; export type CppBytes = string | Buffer; export type CppDocFlags = number; export type CppExpiry = number; export type CppJsonString = string | Buffer; export interface CppClusterCredentials { username?: string; password?: string; certificate_path?: string; key_path?: string; allowed_sasl_mechanisms?: string[]; } export interface CppDnsConfig { nameserver?: string; port?: number; dnsSrvTimeout?: number; } export interface CppDocumentId { bucket: string; scope: string; collection: string; key: string; } export interface CppCas { toString(): string; toJSON(): any; } export declare const zeroCas: CppCas; export type CppCasInput = CppCas | string | Buffer; export interface CppMutationToken { toString(): string; toJSON(): any; } export interface CppQueryContext { bucket_name: string; scope_name: string; } export interface CppScanIterator { cancelled: boolean; next(callback: (err: CppError | null, result: CppRangeScanItem | undefined) => void): void; cancel(): boolean; } export interface CppEncodedValue { data: Buffer; flags: number; } export declare enum CppManagementAnalyticsCouchbaseLinkEncryptionLevel { } export declare enum CppManagementClusterBucketType { } export declare enum CppManagementClusterBucketCompression { } export declare enum CppManagementClusterBucketEvictionPolicy { } export declare enum CppManagementClusterBucketConflictResolution { } export declare enum CppManagementClusterBucketStorageBackend { } export declare enum CppManagementEventingFunctionDcpBoundary { } export declare enum CppManagementEventingFunctionLanguageCompatibility { } export declare enum CppManagementEventingFunctionLogLevel { } export declare enum CppManagementEventingFunctionBucketAccess { } export declare enum CppManagementEventingFunctionStatus { } export declare enum CppManagementEventingFunctionDeploymentStatus { } export declare enum CppManagementEventingFunctionProcessingStatus { } export declare enum CppManagementRbacAuthDomain { } export declare enum CppRetryReason { } export declare enum CppProtocolSubdocOpcode { } export declare enum CppAnalyticsScanConsistency { } export declare enum CppDesignDocumentNamespace { } export declare enum CppDiagClusterState { } export declare enum CppDiagEndpointState { } export declare enum CppDiagPingState { } export declare enum CppQueryProfile { } export declare enum CppQueryScanConsistency { } export declare enum CppSearchHighlightStyle { } export declare enum CppSearchScanConsistency { } export declare enum CppServiceType { } export declare enum CppViewOnError { } export declare enum CppViewScanConsistency { } export declare enum CppViewSortOrder { } export declare enum CppAnalyticsResponseAnalyticsStatus { } export declare enum CppDurabilityLevel { } export declare enum CppErrcCommon { } export declare enum CppErrcKeyValue { } export declare enum CppErrcQuery { } export declare enum CppErrcAnalytics { } export declare enum CppErrcSearch { } export declare enum CppErrcView { } export declare enum CppErrcManagement { } export declare enum CppErrcFieldLevelEncryption { } export declare enum CppErrcNetwork { } export declare enum CppKeyValueStatusCode { } export declare enum CppImplSubdocOpcode { } export declare enum CppStoreSemantics { } export declare enum CppPersistTo { } export declare enum CppReplicateTo { } export declare enum CppReadPreference { } export declare enum CppVectorQueryCombination { } export interface CppManagementAnalyticsDataset { name: string; dataverse_name: string; link_name: string; bucket_name: string; } export interface CppManagementAnalyticsIndex { name: string; dataverse_name: string; dataset_name: string; is_primary: boolean; } export interface CppManagementAnalyticsAzureBlobExternalLink { link_name: string; dataverse: string; connection_string?: string; account_name?: string; account_key?: string; shared_access_signature?: string; blob_endpoint?: string; endpoint_suffix?: string; } export interface CppManagementAnalyticsCouchbaseLinkEncryptionSettings { level: CppManagementAnalyticsCouchbaseLinkEncryptionLevel; certificate?: string; client_certificate?: string; client_key?: string; } export interface CppManagementAnalyticsCouchbaseRemoteLink { link_name: string; dataverse: string; hostname: string; username?: string; password?: string; encryption: CppManagementAnalyticsCouchbaseLinkEncryptionSettings; } export interface CppManagementAnalyticsS3ExternalLink { link_name: string; dataverse: string; access_key_id: string; secret_access_key: string; session_token?: string; region: string; service_endpoint?: string; } export interface CppManagementClusterBucketSettings { name: string; uuid: string; ram_quota_mb: number; bucket_type: CppManagementClusterBucketType; max_expiry?: number; compression_mode: CppManagementClusterBucketCompression; minimum_durability_level?: CppDurabilityLevel; num_replicas?: number; replica_indexes?: boolean; flush_enabled?: boolean; eviction_policy: CppManagementClusterBucketEvictionPolicy; conflict_resolution_type: CppManagementClusterBucketConflictResolution; history_retention_collection_default?: boolean; history_retention_bytes?: number; history_retention_duration?: number; storage_backend: CppManagementClusterBucketStorageBackend; capabilities: string[]; nodes: CppManagementClusterBucketSettingsNode[]; } export interface CppManagementClusterBucketSettingsNode { hostname: string; status: string; version: string; services: string[]; ports: { [key: string]: number; }; } export interface CppManagementViewsDesignDocument { rev?: string; name: string; ns: CppDesignDocumentNamespace; views: { [key: string]: CppManagementViewsDesignDocumentView; }; } export interface CppManagementViewsDesignDocumentView { name: string; map?: string; reduce?: string; } export interface CppManagementEventingFunctionKeyspace { bucket: string; scope?: string; collection?: string; } export interface CppManagementEventingFunctionSettings { cpp_worker_count?: number; dcp_stream_boundary?: CppManagementEventingFunctionDcpBoundary; description?: string; deployment_status?: CppManagementEventingFunctionDeploymentStatus; processing_status?: CppManagementEventingFunctionProcessingStatus; log_level?: CppManagementEventingFunctionLogLevel; language_compatibility?: CppManagementEventingFunctionLanguageCompatibility; execution_timeout?: CppMilliseconds; lcb_inst_capacity?: number; lcb_retry_count?: number; lcb_timeout?: CppMilliseconds; query_consistency?: CppQueryScanConsistency; num_timer_partitions?: number; sock_batch_size?: number; tick_duration?: CppMilliseconds; timer_context_size?: number; user_prefix?: string; bucket_cache_size?: number; bucket_cache_age?: CppMilliseconds; curl_max_allowed_resp_size?: number; query_prepare_all?: boolean; worker_count?: number; handler_headers: string[]; handler_footers: string[]; enable_app_log_rotation?: boolean; app_log_dir?: string; app_log_max_size?: number; app_log_max_files?: number; checkpoint_interval?: CppMilliseconds; } export interface CppManagementEventingFunctionBucketBinding { alias: string; name: CppManagementEventingFunctionKeyspace; access: CppManagementEventingFunctionBucketAccess; } export interface CppManagementEventingFunctionUrlNoAuth { } export interface CppManagementEventingFunctionUrlAuthBasic { username: string; password: string; } export interface CppManagementEventingFunctionUrlAuthDigest { username: string; password: string; } export interface CppManagementEventingFunctionUrlAuthBearer { key: string; } export interface CppManagementEventingFunctionUrlBinding { alias: string; hostname: string; allow_cookies: boolean; validate_ssl_certificate: boolean; auth_name: string; auth_value: CppManagementEventingFunctionUrlNoAuth | CppManagementEventingFunctionUrlAuthBasic | CppManagementEventingFunctionUrlAuthDigest | CppManagementEventingFunctionUrlAuthBearer; } export interface CppManagementEventingFunctionConstantBinding { alias: string; literal: string; } export interface CppManagementEventingFunction { name: string; code: string; metadata_keyspace: CppManagementEventingFunctionKeyspace; source_keyspace: CppManagementEventingFunctionKeyspace; version?: string; enforce_schema?: boolean; handler_uuid?: number; function_instance_id?: string; bucket_bindings: CppManagementEventingFunctionBucketBinding[]; url_bindings: CppManagementEventingFunctionUrlBinding[]; constant_bindings: CppManagementEventingFunctionConstantBinding[]; settings: CppManagementEventingFunctionSettings; } export interface CppManagementEventingFunctionState { name: string; status: CppManagementEventingFunctionStatus; num_bootstrapping_nodes: number; num_deployed_nodes: number; deployment_status: CppManagementEventingFunctionDeploymentStatus; processing_status: CppManagementEventingFunctionProcessingStatus; redeploy_required?: boolean; } export interface CppManagementEventingStatus { num_eventing_nodes: number; functions: CppManagementEventingFunctionState[]; } export interface CppManagementRbacRole { name: string; bucket?: string; scope?: string; collection?: string; } export interface CppManagementRbacRoleAndDescription { display_name: string; description: string; name: string; bucket?: string; scope?: string; collection?: string; } export interface CppManagementRbacOrigin { type: string; name?: string; } export interface CppManagementRbacRoleAndOrigins { origins: CppManagementRbacOrigin[]; name: string; bucket?: string; scope?: string; collection?: string; } export interface CppManagementRbacUser { username: string; display_name?: string; groups: string[]; roles: CppManagementRbacRole[]; password?: string; } export interface CppManagementRbacUserAndMetadata { domain: CppManagementRbacAuthDomain; effective_roles: CppManagementRbacRoleAndOrigins[]; password_changed?: string; external_groups: string[]; username: string; display_name?: string; groups: string[]; roles: CppManagementRbacRole[]; password?: string; } export interface CppManagementRbacGroup { name: string; description?: string; roles: CppManagementRbacRole[]; ldap_group_reference?: string; } export interface CppManagementSearchIndex { uuid: string; name: string; type: string; params_json: string; source_uuid: string; source_name: string; source_type: string; source_params_json: string; plan_params_json: string; } export interface CppManagementQueryIndex { is_primary: boolean; name: string; state: string; type: string; index_key: string[]; partition?: string; condition?: string; bucket_name: string; scope_name?: string; collection_name?: string; } export interface CppTopologyCollectionsManifest { id: number[]; uid: number; scopes: CppTopologyCollectionsManifestScope[]; } export interface CppTopologyCollectionsManifestCollection { uid: number; name: string; max_expiry: number; history?: boolean; } export interface CppTopologyCollectionsManifestScope { uid: number; name: string; collections: CppTopologyCollectionsManifestCollection[]; } export interface CppDiagEndpointDiagInfo { type: CppServiceType; id: string; last_activity?: CppMilliseconds; remote: string; local: string; state: CppDiagEndpointState; bucket?: string; details?: string; } export interface CppDiagDiagnosticsResult { id: string; sdk: string; services: { [key: string]: CppDiagEndpointDiagInfo[]; }; version: number; } export interface CppDiagEndpointPingInfo { type: CppServiceType; id: string; latency: CppMilliseconds; remote: string; local: string; state: CppDiagPingState; bucket?: string; error?: string; } export interface CppDiagPingResult { id: string; sdk: string; services: { [key: string]: CppDiagEndpointPingInfo[]; }; version: number; } export interface CppPrependResponse { cas: CppCas; token: CppMutationToken; } export interface CppPrependRequest { id: CppDocumentId; value: Buffer; partition: number; opaque: number; durability_level: CppDurabilityLevel; timeout?: CppMilliseconds; } export interface CppPrependWithLegacyDurabilityRequest { id: CppDocumentId; value: Buffer; partition: number; opaque: number; timeout?: CppMilliseconds; persist_to: CppPersistTo; replicate_to: CppReplicateTo; } export interface CppExistsResponse { deleted: boolean; cas: CppCas; flags: number; expiry: number; sequence_number: number; datatype: number; document_exists: boolean; } export interface CppExistsRequest { id: CppDocumentId; partition: number; opaque: number; timeout?: CppMilliseconds; } export interface CppHttpNoopResponse { } export interface CppHttpNoopRequest { type: CppServiceType; client_context_id?: string; timeout?: CppMilliseconds; } export interface CppUnlockResponse { cas: CppCas; } export interface CppUnlockRequest { id: CppDocumentId; partition: number; opaque: number; cas: CppCasInput; timeout?: CppMilliseconds; } export interface CppGetAllReplicasResponse { entries: CppGetAllReplicasResponseEntry[]; } export interface CppGetAllReplicasResponseEntry { value: Buffer; cas: CppCas; flags: number; replica: boolean; } export interface CppGetAllReplicasRequest { id: CppDocumentId; timeout?: CppMilliseconds; } export interface CppUpsertResponse { cas: CppCas; token: CppMutationToken; } export interface CppUpsertRequest { id: CppDocumentId; value: Buffer; partition: number; opaque: number; flags: number; expiry: number; durability_level: CppDurabilityLevel; timeout?: CppMilliseconds; preserve_expiry: boolean; } export interface CppUpsertWithLegacyDurabilityRequest { id: CppDocumentId; value: Buffer; partition: number; opaque: number; flags: number; expiry: number; timeout?: CppMilliseconds; preserve_expiry: boolean; persist_to: CppPersistTo; replicate_to: CppReplicateTo; } export interface CppGetAnyReplicaResponse { value: Buffer; cas: CppCas; flags: number; replica: boolean; } export interface CppGetAnyReplicaRequest { id: CppDocumentId; timeout?: CppMilliseconds; } export interface CppAppendResponse { cas: CppCas; token: CppMutationToken; } export interface CppAppendRequest { id: CppDocumentId; value: Buffer; partition: number; opaque: number; durability_level: CppDurabilityLevel; timeout?: CppMilliseconds; } export interface CppAppendWithLegacyDurabilityRequest { id: CppDocumentId; value: Buffer; partition: number; opaque: number; timeout?: CppMilliseconds; persist_to: CppPersistTo; replicate_to: CppReplicateTo; } export interface CppQueryResponse { meta: CppQueryResponseQueryMetaData; prepared?: string; rows: string[]; served_by_node: string; } export interface CppQueryResponseQueryMetrics { elapsed_time: CppMilliseconds; execution_time: CppMilliseconds; result_count: number; result_size: number; sort_count: number; mutation_count: number; error_count: number; warning_count: number; } export interface CppQueryResponseQueryProblem { code: number; message: string; reason?: number; retry?: boolean; } export interface CppQueryResponseQueryMetaData { request_id: string; client_context_id: string; status: string; metrics?: CppQueryResponseQueryMetrics; signature?: string; profile?: string; warnings?: CppQueryResponseQueryProblem[]; errors?: CppQueryResponseQueryProblem[]; } export interface CppQueryRequest { statement: string; adhoc: boolean; metrics: boolean; readonly: boolean; flex_index: boolean; preserve_expiry: boolean; use_replica?: boolean; max_parallelism?: number; scan_cap?: number; scan_wait?: CppMilliseconds; pipeline_batch?: number; pipeline_cap?: number; scan_consistency?: CppQueryScanConsistency; mutation_state: CppMutationToken[]; query_context?: string; client_context_id?: string; timeout?: CppMilliseconds; profile?: CppQueryProfile; raw: { [key: string]: CppJsonString; }; positional_parameters: CppJsonString[]; named_parameters: { [key: string]: CppJsonString; }; send_to_node?: string; body_str: string; } export interface CppReplaceResponse { cas: CppCas; token: CppMutationToken; } export interface CppReplaceRequest { id: CppDocumentId; value: Buffer; partition: number; opaque: number; flags: number; expiry: number; cas: CppCasInput; durability_level: CppDurabilityLevel; timeout?: CppMilliseconds; preserve_expiry: boolean; } export interface CppReplaceWithLegacyDurabilityRequest { id: CppDocumentId; value: Buffer; partition: number; opaque: number; flags: number; expiry: number; cas: CppCasInput; timeout?: CppMilliseconds; preserve_expiry: boolean; persist_to: CppPersistTo; replicate_to: CppReplicateTo; } export interface CppGetAndTouchResponse { value: Buffer; cas: CppCas; flags: number; } export interface CppGetAndTouchRequest { id: CppDocumentId; partition: number; opaque: number; expiry: number; timeout?: CppMilliseconds; } export interface CppRemoveResponse { cas: CppCas; token: CppMutationToken; } export interface CppRemoveRequest { id: CppDocumentId; partition: number; opaque: number; cas: CppCasInput; durability_level: CppDurabilityLevel; timeout?: CppMilliseconds; } export interface CppRemoveWithLegacyDurabilityRequest { id: CppDocumentId; partition: number; opaque: number; cas: CppCasInput; timeout?: CppMilliseconds; persist_to: CppPersistTo; replicate_to: CppReplicateTo; } export interface CppGetResponse { value: Buffer; cas: CppCas; flags: number; } export interface CppGetRequest { id: CppDocumentId; partition: number; opaque: number; timeout?: CppMilliseconds; } export interface CppLookupInAllReplicasResponse { entries: CppLookupInAllReplicasResponseEntry[]; } export interface CppLookupInAllReplicasResponseEntry { fields: CppLookupInAllReplicasResponseEntryLookupInEntry[]; cas: CppCas; deleted: boolean; is_replica: boolean; } export interface CppLookupInAllReplicasResponseEntryLookupInEntry { path: string; value: Buffer; original_index: number; exists: boolean; opcode: CppProtocolSubdocOpcode; status: CppKeyValueStatusCode; ec: CppError; } export interface CppLookupInAllReplicasRequest { id: CppDocumentId; specs: CppImplSubdocCommand[]; timeout?: CppMilliseconds; } export interface CppAnalyticsResponse { meta: CppAnalyticsResponseAnalyticsMetaData; rows: string[]; } export interface CppAnalyticsResponseAnalyticsMetrics { elapsed_time: CppMilliseconds; execution_time: CppMilliseconds; result_count: number; result_size: number; error_count: number; processed_objects: number; warning_count: number; } export interface CppAnalyticsResponseAnalyticsProblem { code: number; message: string; } export interface CppAnalyticsResponseAnalyticsMetaData { request_id: string; client_context_id: string; status: CppAnalyticsResponseAnalyticsStatus; metrics: CppAnalyticsResponseAnalyticsMetrics; signature?: string; errors: CppAnalyticsResponseAnalyticsProblem[]; warnings: CppAnalyticsResponseAnalyticsProblem[]; } export interface CppAnalyticsRequest { statement: string; readonly: boolean; priority: boolean; bucket_name?: string; scope_name?: string; scope_qualifier?: string; scan_consistency?: CppAnalyticsScanConsistency; raw: { [key: string]: CppJsonString; }; positional_parameters: CppJsonString[]; named_parameters: { [key: string]: CppJsonString; }; client_context_id?: string; timeout?: CppMilliseconds; body_str: string; } export interface CppGetProjectedResponse { value: Buffer; cas: CppCas; flags: number; expiry?: number; } export interface CppGetProjectedRequest { id: CppDocumentId; partition: number; opaque: number; projections: string[]; with_expiry: boolean; effective_projections: string[]; preserve_array_indexes: boolean; timeout?: CppMilliseconds; } export interface CppDecrementResponse { content: number; cas: CppCas; token: CppMutationToken; } export interface CppDecrementRequest { id: CppDocumentId; partition: number; opaque: number; expiry: number; delta: number; initial_value?: number; durability_level: CppDurabilityLevel; timeout?: CppMilliseconds; } export interface CppDecrementWithLegacyDurabilityRequest { id: CppDocumentId; partition: number; opaque: number; expiry: number; delta: number; initial_value?: number; timeout?: CppMilliseconds; persist_to: CppPersistTo; replicate_to: CppReplicateTo; } export interface CppSearchResponse { status: string; meta: CppSearchResponseSearchMetaData; error: string; rows: CppSearchResponseSearchRow[]; facets: CppSearchResponseSearchFacet[]; } export interface CppSearchResponseSearchMetrics { took: CppMilliseconds; total_rows: number; max_score: number; success_partition_count: number; error_partition_count: number; } export interface CppSearchResponseSearchMetaData { client_context_id: string; metrics: CppSearchResponseSearchMetrics; errors: { [key: string]: string; }; } export interface CppSearchResponseSearchLocation { field: string; term: string; position: number; start_offset: number; end_offset: number; array_positions?: number[]; } export interface CppSearchResponseSearchRow { index: string; id: string; score: number; locations: CppSearchResponseSearchLocation[]; fragments: { [key: string]: string[]; }; fields: string; explanation: string; } export interface CppSearchResponseSearchFacet { name: string; field: string; total: number; missing: number; other: number; terms: CppSearchResponseSearchFacetTermFacet[]; date_ranges: CppSearchResponseSearchFacetDateRangeFacet[]; numeric_ranges: CppSearchResponseSearchFacetNumericRangeFacet[]; } export interface CppSearchResponseSearchFacetTermFacet { term: string; count: number; } export interface CppSearchResponseSearchFacetDateRangeFacet { name: string; count: number; start?: string; end?: string; } export interface CppSearchResponseSearchFacetNumericRangeFacet { name: string; count: number; min: undefined | number | number; max: undefined | number | number; } export interface CppSearchRequest { index_name: string; query: CppJsonString; bucket_name?: string; scope_name?: string; show_request?: boolean; vector_search?: CppJsonString; vector_query_combination?: CppVectorQueryCombination; limit?: number; skip?: number; explain?: boolean; disable_scoring: boolean; include_locations: boolean; highlight_style?: CppSearchHighlightStyle; highlight_fields: string[]; fields: string[]; collections: string[]; scan_consistency?: CppSearchScanConsistency; mutation_state: CppMutationToken[]; sort_specs: string[]; facets: { [key: string]: string; }; raw: { [key: string]: CppJsonString; }; client_context_id?: string; timeout?: CppMilliseconds; log_request?: boolean; log_response?: boolean; body_str: string; } export interface CppTouchResponse { cas: CppCas; } export interface CppTouchRequest { id: CppDocumentId; partition: number; opaque: number; expiry: number; timeout?: CppMilliseconds; } export interface CppLookupInResponse { cas: CppCas; fields: CppLookupInResponseEntry[]; deleted: boolean; } export interface CppLookupInResponseEntry { path: string; value: Buffer; original_index: number; exists: boolean; opcode: CppProtocolSubdocOpcode; status: CppKeyValueStatusCode; ec: CppError; } export interface CppLookupInRequest { id: CppDocumentId; partition: number; opaque: number; access_deleted: boolean; specs: CppImplSubdocCommand[]; timeout?: CppMilliseconds; } export interface CppDocumentViewResponse { meta: CppDocumentViewResponseMetaData; rows: CppDocumentViewResponseRow[]; error?: CppDocumentViewResponseProblem; } export interface CppDocumentViewResponseMetaData { total_rows?: number; debug_info?: string; } export interface CppDocumentViewResponseRow { id?: string; key: string; value: string; } export interface CppDocumentViewResponseProblem { code: string; message: string; } export interface CppDocumentViewRequest { bucket_name: string; document_name: string; view_name: string; ns: CppDesignDocumentNamespace; limit?: number; skip?: number; consistency?: CppViewScanConsistency; keys: string[]; key?: string; start_key?: string; end_key?: string; start_key_doc_id?: string; end_key_doc_id?: string; inclusive_end?: boolean; reduce?: boolean; group?: boolean; group_level?: number; debug: boolean; raw: { [key: string]: string; }; full_set?: boolean; order?: CppViewSortOrder; on_error?: CppViewOnError; query_string: string[]; client_context_id?: string; timeout?: CppMilliseconds; } export interface CppGetAndLockResponse { value: Buffer; cas: CppCas; flags: number; } export interface CppGetAndLockRequest { id: CppDocumentId; partition: number; opaque: number; lock_time: number; timeout?: CppMilliseconds; } export interface CppInsertResponse { cas: CppCas; token: CppMutationToken; } export interface CppInsertRequest { id: CppDocumentId; value: Buffer; partition: number; opaque: number; flags: number; expiry: number; durability_level: CppDurabilityLevel; timeout?: CppMilliseconds; } export interface CppInsertWithLegacyDurabilityRequest { id: CppDocumentId; value: Buffer; partition: number; opaque: number; flags: number; expiry: number; timeout?: CppMilliseconds; persist_to: CppPersistTo; replicate_to: CppReplicateTo; } export interface CppLookupInAnyReplicaResponse { cas: CppCas; fields: CppLookupInAnyReplicaResponseEntry[]; deleted: boolean; is_replica: boolean; } export interface CppLookupInAnyReplicaResponseEntry { path: string; value: Buffer; original_index: number; exists: boolean; opcode: CppProtocolSubdocOpcode; status: CppKeyValueStatusCode; ec: CppError; } export interface CppLookupInAnyReplicaRequest { id: CppDocumentId; specs: CppImplSubdocCommand[]; timeout?: CppMilliseconds; } export interface CppMutateInResponse { cas: CppCas; token: CppMutationToken; fields: CppMutateInResponseEntry[]; deleted: boolean; } export interface CppMutateInResponseEntry { path: string; value: Buffer; original_index: number; opcode: CppProtocolSubdocOpcode; status: CppKeyValueStatusCode; ec: CppError; } export interface CppMutateInRequest { id: CppDocumentId; partition: number; opaque: number; cas: CppCasInput; access_deleted: boolean; create_as_deleted: boolean; expiry?: number; store_semantics: CppStoreSemantics; specs: CppImplSubdocCommand[]; durability_level: CppDurabilityLevel; timeout?: CppMilliseconds; preserve_expiry: boolean; flags?: number; } export interface CppMutateInWithLegacyDurabilityRequest { id: CppDocumentId; partition: number; opaque: number; cas: CppCasInput; access_deleted: boolean; create_as_deleted: boolean; expiry?: number; store_semantics: CppStoreSemantics; specs: CppImplSubdocCommand[]; timeout?: CppMilliseconds; preserve_expiry: boolean; flags?: number; persist_to: CppPersistTo; replicate_to: CppReplicateTo; } export interface CppIncrementResponse { content: number; cas: CppCas; token: CppMutationToken; } export interface CppIncrementRequest { id: CppDocumentId; partition: number; opaque: number; expiry: number; delta: number; initial_value?: number; durability_level: CppDurabilityLevel; timeout?: CppMilliseconds; } export interface CppIncrementWithLegacyDurabilityRequest { id: CppDocumentId; partition: number; opaque: number; expiry: number; delta: number; initial_value?: number; timeout?: CppMilliseconds; persist_to: CppPersistTo; replicate_to: CppReplicateTo; } export interface CppManagementGroupUpsertResponse { errors: string[]; } export interface CppManagementGroupUpsertRequest { group: CppManagementRbacGroup; client_context_id?: string; timeout?: CppMilliseconds; } export interface CppManagementEventingPauseFunctionResponse { error?: CppManagementEventingProblem; } export interface CppManagementEventingPauseFunctionRequest { name: string; bucket_name?: string; scope_name?: string; client_context_id?: string; timeout?: CppMilliseconds; } export interface CppManagementQueryIndexGetAllResponse { status: string; indexes: CppManagementQueryIndex[]; } export interface CppManagementQueryIndexGetAllRequest { bucket_name: string; scope_name: string; collection_name: string; query_ctx: CppQueryContext; client_context_id?: string; timeout?: CppMilliseconds; } export interface CppManagementCollectionCreateResponse { uid: number; } export interface CppManagementCollectionCreateRequest { bucket_name: string; scope_name: string; collection_name: string; max_expiry?: number; history?: boolean; client_context_id?: string; timeout?: CppMilliseconds; } export interface CppManagementEventingResumeFunctionResponse { error?: CppManagementEventingProblem; } export interface CppManagementEventingResumeFunctionRequest { name: string; bucket_name?: string; scope_name?: string; client_context_id?: string; timeout?: CppMilliseconds; } export interface CppManagementSearchIndexGetStatsResponse { status: string; error: string; stats: string; } export interface CppManagementSearchIndexGetStatsRequest { index_name: string; client_context_id?: string; timeout?: CppMilliseconds; } export interface CppManagementBucketGetAllResponse { buckets: CppManagementClusterBucketSettings[]; } export interface CppManagementBucketGetAllRequest { client_context_id?: string; timeout?: CppMilliseconds; } export interface CppManagementQueryIndexBuildDeferredResponse { status: string; errors: CppManagementQueryIndexBuildDeferredResponseQueryProblem[]; } export interface CppManagementQueryIndexBuildDeferredResponseQueryProblem { code: number; message: string; } export interface CppManagementQueryIndexBuildDeferredRequest { bucket_name: string; scope_name?: string; collection_name?: string; query_ctx: CppQueryContext; client_context_id?: string; timeout?: CppMilliseconds; } export interface CppManagementClusterDescribeResponse { info: CppManagementClusterDescribeResponseClusterInfo; } export interface CppManagementClusterDescribeResponseClusterInfo { nodes: CppManagementClusterDescribeResponseClusterInfoNode[]; buckets: CppManagementClusterDescribeResponseClusterInfoBucket[]; services: CppServiceType[]; } export interface CppManagementClusterDescribeResponseClusterInfoNode { uuid: string; otp_node: string; status: string; hostname: string; os: string; version: string; services: string[]; } export interface CppManagementClusterDescribeResponseClusterInfoBucket { uuid: string; name: string; } export interface CppManagementClusterDescribeRequest { client_context_id?: string; timeout?: CppMilliseconds; } export interface CppManagementSearchIndexGetAllResponse { status: string; impl_version: string; indexes: CppManagementSearchIndex[]; } export interface CppManagementSearchIndexGetAllRequest { bucket_name?: string; scope_name?: string; client_context_id?: string; timeout?: CppMilliseconds; } export interface CppManagementSearchIndexAnalyzeDocumentResponse { status: string; error: string; analysis: string; } export interface CppManagementSearchIndexAnalyzeDocumentRequest { index_name: string; encoded_document: string; bucket_name?: string; scope_name?: string; client_context_id?: string; timeout?: CppMilliseconds; } export interface CppManagementQueryIndexDropResponse { status: string; errors: CppManagementQueryIndexDropResponseQueryProblem[]; } export interface CppManagementQueryIndexDropResponseQueryProblem { code: number; message: string; } export interface CppManagementQueryIndexDropRequest { bucket_name: string; scope_name: string; collection_name: string; index_name: string; query_ctx: CppQueryContext; is_primary: boolean; ignore_if_does_not_exist: boolean; client_context_id?: string; timeout?: CppMilliseconds; } export interface CppManagementAnalyticsDatasetCreateResponse { status: string; errors: CppManagementAnalyticsProblem[]; } export interface CppManagementAnalyticsDatasetCreateRequest { dataverse_name: string; dataset_name: string; bucket_name: string; condition?: string; client_context_id?: string; timeout?: CppMilliseconds; ignore_if_exists: boolean; } export interface CppManagementBucketFlushResponse { } export interface CppManagementBucketFlushRequest { name: string; client_context_id?: string; timeout?: CppMilliseconds; } export interface CppManagementAnalyticsIndexDropResponse { status: string; errors: CppManagementAnalyticsProblem[]; } export interface CppManagementAnalyticsIndexDropRequest { dataverse_name: string; dataset_name: string; index_name: string; ignore_if_does_not_exist: boolean; client_context_id?: string; timeout?: CppMilliseconds; } export interface CppManagementQueryIndexCreateResponse { status: string; errors: CppManagementQueryIndexCreateResponseQueryProblem[]; } export interface CppManagementQueryIndexCreateResponseQueryProblem { code: number; message: string; } export interface CppManagementQueryIndexCreateRequest { bucket_name: string; scope_name: string; collection_name: string; index_name: string; keys: string[]; query_ctx: CppQueryContext; is_primary: boolean; ignore_if_exists: boolean; condition?: string; deferred?: boolean; num_replicas?: number; client_context_id?: string; timeout?: CppMilliseconds; } export interface CppManagementSearchIndexUpsertResponse { status: string; name: string; uuid: string; error: string; } export interface CppManagementSearchIndexUpsertRequest { index: CppManagementSearchIndex; bucket_name?: string; scope_name?: string; client_context_id?: string; timeout?: CppMilliseconds; } export interface CppManagementAnalyticsDatasetGetAllResponse { status: string; datasets: CppManagementAnalyticsDataset[]; errors: CppManagementAnalyticsProblem[]; } export interface CppManagementAnalyticsDatasetGetAllRequest { client_context_id?: string; timeout?: CppMilliseconds; } export interface CppManagementAnalyticsIndexGetAllResponse { status: string; indexes: CppManagementAnalyticsIndex[]; errors: CppManagementAnalyticsProblem[]; } export interface CppManagementAnalyticsIndexGetAllRequest { client_context_id?: string; timeout?: CppMilliseconds; } export interface CppManagementAnalyticsGetPendingMutationsResponse { status: string; errors: CppManagementAnalyticsProblem[]; stats: { [key: string]: number; }; } export interface CppManagementAnalyticsGetPendingMutationsRequest { client_context_id?: string; timeout?: CppMilliseconds; } export interface CppManagementAnalyticsDataverseDropResponse { status: string; errors: CppManagementAnalyticsProblem[]; } export interface CppManagementAnalyticsDataverseDropRequest { dataverse_name: string; ignore_if_does_not_exist: boolean; client_context_id?: string; timeout?: CppMilliseconds; } export interface CppManagementEventingProblem { code: number; name: string; description: string; } export interface CppManagementAnalyticsLinkConnectResponse { status: string; errors: CppManagementAnalyticsLinkConnectResponseProblem[]; } export interface CppManagementAnalyticsLinkConnectResponseProblem { code: number; message: string; } export interface CppManagementAnalyticsLinkConnectRequest { dataverse_name: string; link_name: string; force: boolean; client_context_id?: string; timeout?: CppMilliseconds; } export interface CppManagementCollectionsManifestGetResponse { manifest: CppTopologyCollectionsManifest; } export interface CppManagementCollectionsManifestGetRequest { id: CppDocumentId; partition: number; opaque: number; timeout?: CppMilliseconds; } export interface CppManagementChangePasswordResponse { } export interface CppManagementChangePasswordRequest { newPassword: string; client_context_id?: string; timeout?: CppMilliseconds; } export interface CppManagementClusterDeveloperPreviewEnableResponse { } export interface CppManagementClusterDeveloperPreviewEnableRequest { client_context_id?: string; timeout?: CppMilliseconds; } export interface CppManagementAnalyticsLinkDropResponse { status: string; errors: CppManagementAnalyticsLinkDropResponseProblem[]; } export interface CppManagementAnalyticsLinkDropResponseProblem { code: number; message: string; } export interface CppManagementAnalyticsLinkDropRequest { link_name: string; dataverse_name: string; client_context_id?: string; timeout?: CppMilliseconds; } export interface CppManagementCollectionUpdateResponse { uid: number; } export interface CppManagementCollectionUpdateRequest { bucket_name: string; scope_name: string; collection_name: string; max_expiry?: number; history?: boolean; client_context_id?: string; timeout?: CppMilliseconds; } export interface CppManagementServerNodeAddress { hostname: string; kv_plain: number; kv_tls: number; } export interface CppManagementServerNode { server_group_name: string; server_index: number; default_network: CppManagementServerNodeAddress; external_network: CppManagementServerNodeAddress; active_vbuckets: number[]; replica_vbuckets: number[]; } export interface CppManagementServerGroup { name: string; nodes: CppManagementServerNode[]; } export interface CppManagementBucketDescribeResponse { info: CppManagementBucketDescribeResponseBucketInfo; } export interface CppManagementBucketDescribeResponseBucketInfo { name: string; uuid: string; number_of_nodes: number; number_of_replicas: number; bucket_capabilities: string[]; server_groups: { [key: string]: CppManagementServerGroup; }; storage_backend: CppManagementClusterBucketStorageBackend; config_json: string; } export interface CppManagementBucketDescribeRequest { name: string; client_context_id?: string; timeout?: CppMilliseconds; } export interface CppManagementEventingUpsertFunctionResponse { error?: CppManagementEventingProblem; } export interface CppManagementEventingUpsertFunctionRequest { function: CppManagementEventingFunction; bucket_name?: string; scope_name?: string; client_context_id?: string; timeout?: CppMilliseconds; } export interface CppManagementViewIndexGetAllResponse { design_documents: CppManagementViewsDesignDocument[]; } export interface CppManagementViewIndexGetAllRequest { bucket_name: string; ns: CppDesignDocumentNamespace; client_context_id?: string; timeout?: CppMilliseconds; } export interface CppManagementBucketGetResponse { bucket: CppManagementClusterBucketSettings; } export interface CppManagementBucketGetRequest { name: string; client_context_id?: string; timeout?: CppMilliseconds; } export interface CppManagementBucketUpdateResponse { bucket: CppManagementClusterBucketSettings; error_message: string; } export interface CppManagementBucketUpdateRequest { bucket: CppManagementClusterBucketSettings; client_context_id?: string; timeout?: CppMilliseconds; } export interface CppManagementBucketDropResponse { } export interface CppManagementBucketDropRequest { name: string; client_context_id?: string; timeout?: CppMilliseconds; } export interface CppManagementFreeformResponse { status: number; headers: { [key: string]: string; }; body: string; } export interface CppManagementFreeformRequest { type: CppServiceType; method: string; path: string; headers: { [key: string]: string; }; body: string; client_context_id?: string; timeout?: CppMilliseconds; } export interface CppManagementScopeDropResponse { uid: number; } export interface CppManagementScopeDropRequest { bucket_name: string; scope_name: string; client_context_id?: string; timeout?: CppMilliseconds; } export interface CppManagementViewIndexUpsertResponse { } export interface CppManagementViewIndexUpsertRequest { bucket_name: string; document: CppManagementViewsDesignDocument; client_context_id?: string; timeout?: CppMilliseconds; } export interface CppManagementUserGetAllResponse { users: CppManagementRbacUserAndMetadata[]; } export interface CppManagementUserGetAllRequest { domain: CppManagementRbacAuthDomain; client_context_id?: string; timeout?: CppMilliseconds; } export interface CppManagementScopeCreateResponse { uid: number; } export interface CppManagementScopeCreateRequest { bucket_name: string; scope_name: string; client_context_id?: string; timeout?: CppMilliseconds; } export interface CppManagementEventingGetFunctionResponse { function: CppManagementEventingFunction; error?: CppManagementEventingProblem; } export interface CppManagementEventingGetFunctionRequest { name: string; bucket_name?: string; scope_name?: string; client_context_id?: string; timeout?: CppMilliseconds; } export interface CppManagementViewIndexDropResponse { } export interface CppManagementViewIndexDropRequest { bucket_name: string; document_name: string; ns: CppDesignDocumentNamespace; client_context_id?: string; timeout?: CppMilliseconds; } export interface CppManagementAnalyticsLinkReplaceResponse { status: string; errors: CppManagementAnalyticsLinkReplaceResponseProblem[]; } export interface CppManagementAnalyticsLinkReplaceResponseProblem { code: number; message: string; } export interface CppManagementAnalyticsLinkReplaceAzureBlobExternalLinkRequest { link: CppManagementAnalyticsAzureBlobExternalLink; client_context_id?: string; timeout?: CppMilliseconds; } export interface CppManagementAnalyticsLinkReplaceCouchbaseRemoteLinkRequest { link: CppManagementAnalyticsCouchbaseRemoteLink; client_context_id?: string; timeout?: CppMilliseconds; } export interface CppManagementAnalyticsLinkReplaceS3ExternalLinkRequest { link: CppManagementAnalyticsS3ExternalLink; client_context_id?: string; timeout?: CppMilliseconds; } export interface CppManagementAnalyticsLinkDisconnectResponse { status: string; errors: CppManagementAnalyticsLinkDisconnectResponseProblem[]; } export interface CppManagementAnalyticsLinkDisconnectResponseProblem { code: number; message: string; } export interface CppManagementAnalyticsLinkDisconnectRequest { dataverse_name: string; link_name: string; client_context_id?: string; timeout?: CppMilliseconds; } export interface CppManagementUserUpsertResponse { errors: string[]; } export interface CppManagementUserUpsertRequest { domain: CppManagementRbacAuthDomain; user: CppManagementRbacUser; client_context_id?: string; timeout?: CppMilliseconds; } export interface CppManagementEventingGetStatusResponse { status: CppManagementEventingStatus; error?: CppManagementEventingProblem; } export interface CppManagementEventingGetStatusRequest { bucket_name?: string; scope_name?: string; client_context_id?: string; timeout?: CppMilliseconds; } export interface CppManagementEventingGetAllFunctionsResponse { functions: CppManagementEventingFunction[]; error?: CppManagementEventingProblem; } export interface CppManagementEventingGetAllFunctionsRequest { bucket_name?: string; scope_name?: string; client_context_id?: string; timeout?: CppMilliseconds; } export interface CppManagementAnalyticsIndexCreateResponse { status: string; errors: CppManagementAnalyticsProblem[]; } export interface CppManagementAnalyticsIndexCreateRequest { dataverse_name: string; dataset_name: string; index_name: string; fields: { [key: string]: string; }; ignore_if_exists: boolean; client_context_id?: string; timeout?: CppMilliseconds; } export interface CppManagementScopeGetAllResponse { manifest: CppTopologyCollectionsManifest; } export interface CppManagementScopeGetAllRequest { bucket_name: string; client_context_id?: string; timeout?: CppMilliseconds; } export interface CppManagementUserGetResponse { user: CppManagementRbacUserAndMetadata; } export interface CppManagementUserGetRequest { username: string; domain: CppManagementRbacAuthDomain; client_context_id?: string; timeout?: CppMilliseconds; } export interface CppManagementSearchIndexDropResponse { status: string; error: string; } export interface CppManagementSearchIndexDropRequest { index_name: string; bucket_name?: string; scope_name?: string; client_context_id?: string; timeout?: CppMilliseconds; } export interface CppManagementSearchIndexControlPlanFreezeResponse { status: string; error: string; } export interface CppManagementSearchIndexControlPlanFreezeRequest { index_name: string; freeze: boolean; bucket_name?: string; scope_name?: string; client_context_id?: string; timeout?: CppMilliseconds; } export interface CppManagementSearchGetStatsResponse { stats: string; } export interface CppManagementSearchGetStatsRequest { client_context_id?: string; timeout?: CppMilliseconds; } export interface CppManagementUserDropResponse { } export interface CppManagementUserDropRequest { username: string; domain: CppManagementRbacAuthDomain; client_context_id?: string; timeout?: CppMilliseconds; } export interface CppManagementAnalyticsDataverseCreateResponse { status: string; errors: CppManagementAnalyticsProblem[]; } export interface CppManagementAnalyticsDataverseCreateRequest { dataverse_name: string; ignore_if_exists: boolean; client_context_id?: string; timeout?: CppMilliseconds; } export interface CppManagementSearchIndexControlQueryResponse { status: string; error: string; } export interface CppManagementSearchIndexControlQueryRequest { index_name: string; allow: boolean; bucket_name?: string; scope_name?: string; client_context_id?: string; timeout?: CppMilliseconds; } export interface CppManagementRoleGetAllResponse { roles: CppManagementRbacRoleAndDescription[]; } export interface CppManagementRoleGetAllRequest { client_context_id?: string; timeout?: CppMilliseconds; } export interface CppManagementGroupGetAllResponse { groups: CppManagementRbacGroup[]; } export interface CppManagementGroupGetAllRequest { client_context_id?: string; timeout?: CppMilliseconds; } export interface CppManagementAnalyticsLinkCreateResponse { status: string; errors: CppManagementAnalyticsLinkCreateResponseProblem[]; } export interface CppManagementAnalyticsLinkCreateResponseProblem { code: number; message: string; } export interface CppManagementAnalyticsLinkCreateAzureBlobExternalLinkRequest { link: CppManagementAnalyticsAzureBlobExternalLink; client_context_id?: string; timeout?: CppMilliseconds; } export interface CppManagementAnalyticsLinkCreateCouchbaseRemoteLinkRequest { link: CppManagementAnalyticsCouchbaseRemoteLink; client_context_id?: string; timeout?: CppMilliseconds; } export interface CppManagementAnalyticsLinkCreateS3ExternalLinkRequest { link: Cpp