couchbase
Version:
The official Couchbase Node.js Client Library.
1,659 lines • 120 kB
TypeScript
/// <reference types="node" />
/// <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[];
jwt_token?: string;
}
export interface CppDnsConfig {
nameserver?: string;
port?: number;
dnsSrvTimeout?: number;
}
export interface CppAppTelemetryConfig {
enabled?: boolean;
endpoint?: string;
backoff?: number;
pingInterval?: number;
pingTimeout?: number;
}
export interface CppOrphanReporterConfig {
emitInterval?: number;
sampleSize?: 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 type HiResTime = [number, number];
export interface CppWrapperSdkSpan {
attributes: {
[key: string]: number | string;
};
children?: CppWrapperSdkChildSpan[];
}
export interface CppWrapperSdkChildSpan {
name: string;
start: HiResTime;
end: HiResTime;
attributes: {
[key: string]: number | string;
};
children?: CppWrapperSdkChildSpan[];
}
export interface CppObservableRequest {
wrapper_span_name?: string;
}
export interface CppObservableResponse {
cpp_core_span?: CppWrapperSdkSpan;
}
export type ObservableBindingFunc<TReq extends CppObservableRequests, TResp extends CppObservableResponse> = (req: TReq, cb: (err: CppError | null, res: TResp) => void) => void;
export interface CppClusterLabelsResponse {
clusterName?: string;
clusterUUID?: string;
}
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 declare enum CppTransactionsFailureType {
}
export declare enum CppTransactionsExternalException {
}
export declare enum CppTransactionsTransactionGetMultiMode {
}
export declare enum CppTransactionsTransactionGetMultiReplicasFromPreferredServerGroupMode {
}
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;
num_vbuckets?: 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 extends CppObservableResponse {
cas: CppCas;
token: CppMutationToken;
}
export interface CppPrependRequest extends CppObservableRequest {
id: CppDocumentId;
value: Buffer;
partition: number;
opaque: number;
cas: CppCasInput;
durability_level: CppDurabilityLevel;
timeout?: CppMilliseconds;
}
export interface CppPrependWithLegacyDurabilityRequest extends CppObservableRequest {
id: CppDocumentId;
value: Buffer;
partition: number;
opaque: number;
cas: CppCasInput;
timeout?: CppMilliseconds;
persist_to: CppPersistTo;
replicate_to: CppReplicateTo;
}
export interface CppExistsResponse extends CppObservableResponse {
deleted: boolean;
cas: CppCas;
flags: number;
expiry: number;
sequence_number: number;
datatype: number;
document_exists: boolean;
}
export interface CppExistsRequest extends CppObservableRequest {
id: CppDocumentId;
partition: number;
opaque: number;
timeout?: CppMilliseconds;
}
export interface CppHttpNoopResponse extends CppObservableResponse {
}
export interface CppHttpNoopRequest extends CppObservableRequest {
type: CppServiceType;
client_context_id?: string;
timeout?: CppMilliseconds;
}
export interface CppUnlockResponse extends CppObservableResponse {
cas: CppCas;
}
export interface CppUnlockRequest extends CppObservableRequest {
id: CppDocumentId;
partition: number;
opaque: number;
cas: CppCasInput;
timeout?: CppMilliseconds;
}
export interface CppGetAllReplicasResponse extends CppObservableResponse {
entries: CppGetAllReplicasResponseEntry[];
}
export interface CppGetAllReplicasResponseEntry {
value: Buffer;
cas: CppCas;
flags: number;
replica: boolean;
}
export interface CppGetAllReplicasRequest extends CppObservableRequest {
id: CppDocumentId;
timeout?: CppMilliseconds;
read_preference: CppReadPreference;
}
export interface CppUpsertResponse extends CppObservableResponse {
cas: CppCas;
token: CppMutationToken;
}
export interface CppUpsertRequest extends CppObservableRequest {
id: CppDocumentId;
value: Buffer;
partition: number;
opaque: number;
flags: number;
expiry: number;
durability_level: CppDurabilityLevel;
timeout?: CppMilliseconds;
preserve_expiry: boolean;
}
export interface CppUpsertWithLegacyDurabilityRequest extends CppObservableRequest {
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 extends CppObservableResponse {
value: Buffer;
cas: CppCas;
flags: number;
replica: boolean;
}
export interface CppGetAnyReplicaRequest extends CppObservableRequest {
id: CppDocumentId;
timeout?: CppMilliseconds;
read_preference: CppReadPreference;
}
export interface CppAppendResponse extends CppObservableResponse {
cas: CppCas;
token: CppMutationToken;
}
export interface CppAppendRequest extends CppObservableRequest {
id: CppDocumentId;
value: Buffer;
partition: number;
opaque: number;
cas: CppCasInput;
durability_level: CppDurabilityLevel;
timeout?: CppMilliseconds;
}
export interface CppAppendWithLegacyDurabilityRequest extends CppObservableRequest {
id: CppDocumentId;
value: Buffer;
partition: number;
opaque: number;
cas: CppCasInput;
timeout?: CppMilliseconds;
persist_to: CppPersistTo;
replicate_to: CppReplicateTo;
}
export interface CppQueryResponse extends CppObservableResponse {
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 extends CppObservableRequest {
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 extends CppObservableResponse {
cas: CppCas;
token: CppMutationToken;
}
export interface CppReplaceRequest extends CppObservableRequest {
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 extends CppObservableRequest {
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 extends CppObservableResponse {
value: Buffer;
cas: CppCas;
flags: number;
}
export interface CppGetAndTouchRequest extends CppObservableRequest {
id: CppDocumentId;
partition: number;
opaque: number;
expiry: number;
timeout?: CppMilliseconds;
}
export interface CppRemoveResponse extends CppObservableResponse {
cas: CppCas;
token: CppMutationToken;
}
export interface CppRemoveRequest extends CppObservableRequest {
id: CppDocumentId;
partition: number;
opaque: number;
cas: CppCasInput;
durability_level: CppDurabilityLevel;
timeout?: CppMilliseconds;
}
export interface CppRemoveWithLegacyDurabilityRequest extends CppObservableRequest {
id: CppDocumentId;
partition: number;
opaque: number;
cas: CppCasInput;
timeout?: CppMilliseconds;
persist_to: CppPersistTo;
replicate_to: CppReplicateTo;
}
export interface CppGetResponse extends CppObservableResponse {
value: Buffer;
cas: CppCas;
flags: number;
}
export interface CppGetRequest extends CppObservableRequest {
id: CppDocumentId;
partition: number;
opaque: number;
timeout?: CppMilliseconds;
}
export interface CppLookupInAllReplicasResponse extends CppObservableResponse {
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 extends CppObservableRequest {
id: CppDocumentId;
specs: CppImplSubdocCommand[];
timeout?: CppMilliseconds;
read_preference: CppReadPreference;
access_deleted: boolean;
}
export interface CppAnalyticsResponse extends CppObservableResponse {
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 extends CppObservableRequest {
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 extends CppObservableResponse {
value: Buffer;
cas: CppCas;
flags: number;
expiry?: number;
}
export interface CppGetProjectedRequest extends CppObservableRequest {
id: CppDocumentId;
partition: number;
opaque: number;
projections: string[];
with_expiry: boolean;
effective_projections: string[];
preserve_array_indexes: boolean;
timeout?: CppMilliseconds;
}
export interface CppDecrementResponse extends CppObservableResponse {
content: number;
cas: CppCas;
token: CppMutationToken;
}
export interface CppDecrementRequest extends CppObservableRequest {
id: CppDocumentId;
partition: number;
opaque: number;
expiry: number;
delta: number;
initial_value?: number;
durability_level: CppDurabilityLevel;
timeout?: CppMilliseconds;
}
export interface CppDecrementWithLegacyDurabilityRequest extends CppObservableRequest {
id: CppDocumentId;
partition: number;
opaque: number;
expiry: number;
delta: number;
initial_value?: number;
timeout?: CppMilliseconds;
persist_to: CppPersistTo;
replicate_to: CppReplicateTo;
}
export interface CppSearchResponse extends CppObservableResponse {
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 extends CppObservableRequest {
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 extends CppObservableResponse {
cas: CppCas;
}
export interface CppTouchRequest extends CppObservableRequest {
id: CppDocumentId;
partition: number;
opaque: number;
expiry: number;
timeout?: CppMilliseconds;
}
export interface CppLookupInResponse extends CppObservableResponse {
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 extends CppObservableRequest {
id: CppDocumentId;
partition: number;
opaque: number;
access_deleted: boolean;
specs: CppImplSubdocCommand[];
timeout?: CppMilliseconds;
}
export interface CppDocumentViewResponse extends CppObservableResponse {
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 extends CppObservableRequest {
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 extends CppObservableResponse {
value: Buffer;
cas: CppCas;
flags: number;
}
export interface CppGetAndLockRequest extends CppObservableRequest {
id: CppDocumentId;
partition: number;
opaque: number;
lock_time: number;
timeout?: CppMilliseconds;
}
export interface CppInsertResponse extends CppObservableResponse {
cas: CppCas;
token: CppMutationToken;
}
export interface CppInsertRequest extends CppObservableRequest {
id: CppDocumentId;
value: Buffer;
partition: number;
opaque: number;
flags: number;
expiry: number;
durability_level: CppDurabilityLevel;
timeout?: CppMilliseconds;
}
export interface CppInsertWithLegacyDurabilityRequest extends CppObservableRequest {
id: CppDocumentId;
value: Buffer;
partition: number;
opaque: number;
flags: number;
expiry: number;
timeout?: CppMilliseconds;
persist_to: CppPersistTo;
replicate_to: CppReplicateTo;
}
export interface CppLookupInAnyReplicaResponse extends CppObservableResponse {
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 extends CppObservableRequest {
id: CppDocumentId;
specs: CppImplSubdocCommand[];
timeout?: CppMilliseconds;
read_preference: CppReadPreference;
access_deleted: boolean;
}
export interface CppMutateInResponse extends CppObservableResponse {
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 extends CppObservableRequest {
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 extends CppObservableRequest {
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 extends CppObservableResponse {
content: number;
cas: CppCas;
token: CppMutationToken;
}
export interface CppIncrementRequest extends CppObservableRequest {
id: CppDocumentId;
partition: number;
opaque: number;
expiry: number;
delta: number;
initial_value?: number;
durability_level: CppDurabilityLevel;
timeout?: CppMilliseconds;
}
export interface CppIncrementWithLegacyDurabilityRequest extends CppObservableRequest {
id: CppDocumentId;
partition: number;
opaque: number;
expiry: number;
delta: number;
initial_value?: number;
timeout?: CppMilliseconds;
persist_to: CppPersistTo;
replicate_to: CppReplicateTo;
}
export interface CppManagementGroupUpsertResponse extends CppObservableResponse {
errors: string[];
}
export interface CppManagementGroupUpsertRequest extends CppObservableRequest {
group: CppManagementRbacGroup;
client_context_id?: string;
timeout?: CppMilliseconds;
}
export interface CppManagementEventingPauseFunctionResponse extends CppObservableResponse {
error?: CppManagementEventingProblem;
}
export interface CppManagementEventingPauseFunctionRequest extends CppObservableRequest {
name: string;
bucket_name?: string;
scope_name?: string;
client_context_id?: string;
timeout?: CppMilliseconds;
}
export interface CppManagementQueryIndexGetAllResponse extends CppObservableResponse {
status: string;
indexes: CppManagementQueryIndex[];
}
export interface CppManagementQueryIndexGetAllRequest extends CppObservableRequest {
bucket_name: string;
scope_name: string;
collection_name: string;
query_ctx: CppQueryContext;
client_context_id?: string;
timeout?: CppMilliseconds;
}
export interface CppManagementCollectionCreateResponse extends CppObservableResponse {
uid: number;
}
export interface CppManagementCollectionCreateRequest extends CppObservableRequest {
bucket_name: string;
scope_name: string;
collection_name: string;
max_expiry?: number;
history?: boolean;
client_context_id?: string;
timeout?: CppMilliseconds;
}
export interface CppManagementEventingResumeFunctionResponse extends CppObservableResponse {
error?: CppManagementEventingProblem;
}
export interface CppManagementEventingResumeFunctionRequest extends CppObservableRequest {
name: string;
bucket_name?: string;
scope_name?: string;
client_context_id?: string;
timeout?: CppMilliseconds;
}
export interface CppManagementSearchIndexGetStatsResponse extends CppObservableResponse {
status: string;
error: string;
stats: string;
}
export interface CppManagementSearchIndexGetStatsRequest extends CppObservableRequest {
index_name: string;
client_context_id?: string;
timeout?: CppMilliseconds;
}
export interface CppManagementBucketGetAllResponse extends CppObservableResponse {
buckets: CppManagementClusterBucketSettings[];
}
export interface CppManagementBucketGetAllRequest extends CppObservableRequest {
client_context_id?: string;
timeout?: CppMilliseconds;
}
export interface CppManagementQueryIndexBuildDeferredResponse extends CppObservableResponse {
status: string;
errors: CppManagementQueryIndexBuildDeferredResponseQueryProblem[];
}
export interface CppManagementQueryIndexBuildDeferredResponseQueryProblem {
code: number;
message: string;
}
export interface CppManagementQueryIndexBuildDeferredRequest extends CppObservableRequest {
bucket_name: string;
scope_name?: string;
collection_name?: string;
query_ctx: CppQueryContext;
client_context_id?: string;
timeout?: CppMilliseconds;
}
export interface CppManagementClusterDescribeResponse extends CppObservableResponse {
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 extends CppObservableRequest {
client_context_id?: string;
timeout?: CppMilliseconds;
}
export interface CppManagementSearchIndexGetAllResponse extends CppObservableResponse {
status: string;
impl_version: string;
indexes: CppManagementSearchIndex[];
}
export interface CppManagementSearchIndexGetAllRequest extends CppObservableRequest {
bucket_name?: string;
scope_name?: string;
client_context_id?: string;
timeout?: CppMilliseconds;
}
export interface CppManagementSearchIndexAnalyzeDocumentResponse extends CppObservableResponse {
status: string;
error: string;
analysis: string;
}
export interface CppManagementSearchIndexAnalyzeDocumentRequest extends CppObservableRequest {
index_name: string;
encoded_document: string;
bucket_name?: string;
scope_name?: string;
client_context_id?: string;
timeout?: CppMilliseconds;
}
export interface CppManagementQueryIndexDropResponse extends CppObservableResponse {
status: string;
errors: CppManagementQueryIndexDropResponseQueryProblem[];
}
export interface CppManagementQueryIndexDropResponseQueryProblem {
code: number;
message: string;
}
export interface CppManagementQueryIndexDropRequest extends CppObservableRequest {
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 extends CppObservableResponse {
status: string;
errors: CppManagementAnalyticsProblem[];
}
export interface CppManagementAnalyticsDatasetCreateRequest extends CppObservableRequest {
dataverse_name: string;
dataset_name: string;
bucket_name: string;
condition?: string;
client_context_id?: string;
timeout?: CppMilliseconds;
ignore_if_exists: boolean;
}
export interface CppManagementBucketFlushResponse extends CppObservableResponse {
}
export interface CppManagementBucketFlushRequest extends CppObservableRequest {
name: string;
client_context_id?: string;
timeout?: CppMilliseconds;
}
export interface CppManagementAnalyticsIndexDropResponse extends CppObservableResponse {
status: string;
errors: CppManagementAnalyticsProblem[];
}
export interface CppManagementAnalyticsIndexDropRequest extends CppObservableRequest {
dataverse_name: string;
dataset_name: string;
index_name: string;
ignore_if_does_not_exist: boolean;
client_context_id?: string;
timeout?: CppMilliseconds;
}
export interface CppManagementQueryIndexCreateResponse extends CppObservableResponse {
status: string;
errors: CppManagementQueryIndexCreateResponseQueryProblem[];
}
export interface CppManagementQueryIndexCreateResponseQueryProblem {
code: number;
message: string;
}
export interface CppManagementQueryIndexCreateRequest extends CppObservableRequest {
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 extends CppObservableResponse {
status: string;
name: string;
uuid: string;
error: string;
}
export interface CppManagementSearchIndexUpsertRequest extends CppObservableRequest {
index: CppManagementSearchIndex;
bucket_name?: string;
scope_name?: string;
client_context_id?: string;
timeout?: CppMilliseconds;
}
export interface CppManagementAnalyticsDatasetGetAllResponse extends CppObservableResponse {
status: string;
datasets: CppManagementAnalyticsDataset[];
errors: CppManagementAnalyticsProblem[];
}
export interface CppManagementAnalyticsDatasetGetAllRequest extends CppObservableRequest {
client_context_id?: string;
timeout?: CppMilliseconds;
}
export interface CppManagementAnalyticsIndexGetAllResponse extends CppObservableResponse {
status: string;
indexes: CppManagementAnalyticsIndex[];
errors: CppManagementAnalyticsProblem[];
}
export interface CppManagementAnalyticsIndexGetAllRequest extends CppObservableRequest {
client_context_id?: string;
timeout?: CppMilliseconds;
}
export interface CppManagementAnalyticsGetPendingMutationsResponse extends CppObservableResponse {
status: string;
errors: CppManagementAnalyticsProblem[];
stats: {
[key: string]: number;
};
}
export interface CppManagementAnalyticsGetPendingMutationsRequest extends CppObservableRequest {
client_context_id?: string;
timeout?: CppMilliseconds;
}
export interface CppManagementAnalyticsDataverseDropResponse extends CppObservableResponse {
status: string;
errors: CppManagementAnalyticsProblem[];
}
export interface CppManagementAnalyticsDataverseDropRequest extends CppObservableRequest {
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 extends CppObservableResponse {
status: string;
errors: CppManagementAnalyticsLinkConnectResponseProblem[];
}
export interface CppManagementAnalyticsLinkConnectResponseProblem {
code: number;
message: string;
}
export interface CppManagementAnalyticsLinkConnectRequest extends CppObservableRequest {
dataverse_name: string;
link_name: string;
force: boolean;
client_context_id?: string;
timeout?: CppMilliseconds;
}
export interface CppManagementCollectionsManifestGetResponse extends CppObservableResponse {
manifest: CppTopologyCollectionsManifest;
}
export interface CppManagementCollectionsManifestGetRequest extends CppObservableRequest {
id: CppDocumentId;
partition: number;
opaque: number;
timeout?: CppMilliseconds;
}
export interface CppManagementChangePasswordResponse extends CppObservableResponse {
}
export interface CppManagementChangePasswordRequest extends CppObservableRequest {
newPassword: string;
client_context_id?: string;
timeout?: CppMilliseconds;
}
export interface CppManagementClusterDeveloperPreviewEnableResponse extends CppObservableResponse {
}
export interface CppManagementClusterDeveloperPreviewEnableRequest extends CppObservableRequest {
client_context_id?: string;
timeout?: CppMilliseconds;
}
export interface CppManagementAnalyticsLinkDropResponse extends CppObservableResponse {
status: string;
errors: CppManagementAnalyticsLinkDropResponseProblem[];
}
export interface CppManagementAnalyticsLinkDropResponseProblem {
code: number;
message: string;
}
export interface CppManagementAnalyticsLinkDropRequest extends CppObservableRequest {
link_name: string;
dataverse_name: string;
client_context_id?: string;
timeout?: CppMilliseconds;
}
export interface CppManagementCollectionUpdateResponse extends CppObservableResponse {
uid: number;
}
export interface CppManagementCollectionUpdateRequest extends CppObservableRequest {
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 extends CppObservableResponse {
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 extends CppObservableRequest {
name: string;
client_context_id?: string;
timeout?: CppMilliseconds;
}
export interface CppManagementEventingUpsertFunctionResponse extends CppObservableResponse {
error?: CppManagementEventingProblem;
}
export interface CppManagementEventingUpsertFunctionRequest extends CppObservableRequest {
function: CppManagementEventingFunction;
bucket_name?: string;
scope_name?: string;
client_context_id?: string;
timeout?: CppMilliseconds;
}
export interface CppManagementViewIndexGetAllResponse extends CppObservableResponse {
design_documents: CppManagementViewsDesignDocument[];
}
export interface CppManagementViewIndexGetAllRequest extends CppObservableRequest {
bucket_name: string;
ns: CppDesignDocumentNamespace;
client_context_id?: string;
timeout?: CppMilliseconds;
}
export interface CppManagementBucketGetResponse extends CppObservableResponse {
bucket: CppManagementClusterBucketSettings;
}
export interface CppManagementBucketGetRequest extends CppObservableRequest {
name: string;
client_context_id?: string;
timeout?: CppMilliseconds;
}
export interface CppManagementBucketUpdateResponse extends CppObservableResponse {
bucket: CppManagementClusterBucketSettings;
error_message: string;
}
export interface CppManagementBucketUpdateRequest extends CppObservableRequest {
bucket: CppManagementClusterBucketSettings;
client_context_id?: string;
timeout?: CppMilliseconds;
}
export interface CppManagementBucketDropResponse extends CppObservableResponse {
}
export interface CppManagementBucketDropRequest extends CppObservableRequest {
name: string;
client_context_id?: string;
timeout?: CppMilliseconds;
}
export interface CppManagementFreeformResponse extends CppObservableResponse {
status: number;
headers: {
[key: string]: string;
};
body: string;
}
export interface CppManagementFreeformRequest extends CppObservableRequest {
type: CppServiceType;
method: string;
path: string;
headers: {
[key: string]: string;
};
body: string;
client_context_id?: string;
timeout?: CppMilliseconds;
}
export interface CppManagementScopeDropResponse extends CppObservableResponse {
uid: number;
}
export interface CppManagementScopeDropRequest extends CppObservableRequest {
bucket_name: string;
scope_name: string;
client_context_id?: string;
timeout?: CppMilliseconds;
}
export interface CppManagementViewIndexUpsertResponse extends CppObservableResponse {
}
export interface CppManagementViewIndexUpsertRequest extends CppObservableRequest {
bucket_name: string;
document: CppManagementViewsDesignDocument;
client_context_id?: string;
timeout?: CppMilliseconds;
}
export interface CppManagementUserGetAllResponse extends CppObservableResponse {
users: CppManagementRbacUserAndMetadata[];
}
export interface CppManagementUserGetAllRequest extends CppObservableRequest {
domain: CppManagementRbacAuthDomain;
client_context_id?: string;
timeout?: CppMilliseconds;
}
export interface CppManagementScopeCreateResponse extends CppObservableResponse {
uid: number;
}
export interface CppManagementScopeCreateRequest extends CppObservableRequest {
bucket_name: string;
scope_name: string;
client_context_id?: string;
timeout?: CppMilliseconds;
}
export interface CppManagementEventingGetFunctionResponse extends CppObservableResponse {
function: CppManagementEventingFunction;
error?: CppManagementEventingProblem;
}
export interface CppManagementEventingGetFunctionRequest extends CppObservableRequest {
name: string;
bucket_name?: string;
scope_name?: string;
client_context_id?: string;
timeout?: CppMilliseconds;
}
export interface CppManagementViewIndexDropResponse extends CppObservableResponse {
}
export interface CppManagementViewIndexDropRequest extends CppObservableRequest {
bucket_name: string;
document_name: string;
ns: CppDesignDocumentNamespace;
client_context_id?: string;
timeout?: CppMilliseconds;
}
export interface CppManagementAnalyticsLinkReplaceResponse extends CppObservableRespons