couchbase 4.4.6-dev.1 → 4.5.0

package/deps/couchbase-cxx-client/couchbase/transactions/transaction_get_multi_mode.hxx

@@ -0,0 +1,47 @@
+/*
+ *     Copyright 2021-Present Couchbase, Inc.
+ *
+ *   Licensed under the Apache License, Version 2.0 (the "License");
+ *   you may not use this file except in compliance with the License.
+ *   You may obtain a copy of the License at
+ *
+ *       http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *   Unless required by applicable law or agreed to in writing, software
+ *   distributed under the License is distributed on an "AS IS" BASIS,
+ *   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *   See the License for the specific language governing permissions and
+ *   limitations under the License.
+ */
+#pragma once
+
+#include <cstdint>
+
+namespace couchbase::transactions
+{
+/**
+ * Strategy to deal with potential read skews while reading multiple documents.
+ *
+ * Essentially when a transaction reads document X and then Y, and another
+ * transaction commits a change to Y inbetween those reads - read skew has
+ * occurred.
+ */
+enum class transaction_get_multi_mode : std::uint8_t {
+  /**
+   * Some time-bounded effort will be made to detect and avoid read skew.
+   */
+  prioritise_latency,
+
+  /**
+   * No read skew detection should be attempted. Once the documents are fetched, they will be
+   * returned immediately.
+   */
+  disable_read_skew_detection,
+
+  /**
+   * Great effort will be made to detect and avoid read skew.
+   */
+  prioritise_read_skew_detection,
+};
+
+} // namespace couchbase::transactions

package/deps/couchbase-cxx-client/couchbase/transactions/transaction_get_multi_options.hxx

@@ -0,0 +1,44 @@
+/*
+ *     Copyright 2021-Present Couchbase, Inc.
+ *
+ *   Licensed under the Apache License, Version 2.0 (the "License");
+ *   you may not use this file except in compliance with the License.
+ *   You may obtain a copy of the License at
+ *
+ *       http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *   Unless required by applicable law or agreed to in writing, software
+ *   distributed under the License is distributed on an "AS IS" BASIS,
+ *   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *   See the License for the specific language governing permissions and
+ *   limitations under the License.
+ */
+#pragma once
+
+#include <couchbase/transactions/transaction_get_multi_mode.hxx>
+
+namespace couchbase
+{
+namespace core::transactions
+{
+class attempt_context_impl;
+} // namespace core::transactions
+
+namespace transactions
+{
+class transaction_get_multi_options
+{
+public:
+  auto mode(transaction_get_multi_mode mode) -> transaction_get_multi_options&
+  {
+    mode_ = mode;
+    return *this;
+  }
+
+private:
+  friend class core::transactions::attempt_context_impl;
+
+  transaction_get_multi_mode mode_{ transaction_get_multi_mode::prioritise_latency };
+};
+} // namespace transactions
+} // namespace couchbase

package/deps/couchbase-cxx-client/couchbase/transactions/transaction_get_multi_replicas_from_preferred_server_group_mode.hxx

@@ -0,0 +1,46 @@
+/*
+ *     Copyright 2021-Present Couchbase, Inc.
+ *
+ *   Licensed under the Apache License, Version 2.0 (the "License");
+ *   you may not use this file except in compliance with the License.
+ *   You may obtain a copy of the License at
+ *
+ *       http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *   Unless required by applicable law or agreed to in writing, software
+ *   distributed under the License is distributed on an "AS IS" BASIS,
+ *   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *   See the License for the specific language governing permissions and
+ *   limitations under the License.
+ */
+#pragma once
+
+#include <cstdint>
+
+namespace couchbase::transactions
+{
+/**
+ * Strategy to deal with potential read skews while reading multiple documents.
+ *
+ * Essentially when a transaction reads document X and then Y, and another
+ * transaction commits a change to Y inbetween those reads - read skew has
+ * occurred.
+ */
+enum class transaction_get_multi_replicas_from_preferred_server_group_mode : std::uint8_t {
+  /**
+   * Some time-bounded effort will be made to detect and avoid read skew.
+   */
+  prioritise_latency,
+
+  /**
+   * No read skew detection should be attempted. Once the documents are fetched, they will be
+   * returned immediately.
+   */
+  disable_read_skew_detection,
+
+  /**
+   * Great effort will be made to detect and avoid read skew.
+   */
+  prioritise_read_skew_detection,
+};
+} // namespace couchbase::transactions

package/deps/couchbase-cxx-client/couchbase/transactions/transaction_get_multi_replicas_from_preferred_server_group_options.hxx

@@ -0,0 +1,48 @@
+/*
+ *     Copyright 2021-Present Couchbase, Inc.
+ *
+ *   Licensed under the Apache License, Version 2.0 (the "License");
+ *   you may not use this file except in compliance with the License.
+ *   You may obtain a copy of the License at
+ *
+ *       http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *   Unless required by applicable law or agreed to in writing, software
+ *   distributed under the License is distributed on an "AS IS" BASIS,
+ *   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *   See the License for the specific language governing permissions and
+ *   limitations under the License.
+ */
+#pragma once
+
+#include <couchbase/transactions/transaction_get_multi_replicas_from_preferred_server_group_mode.hxx>
+
+namespace couchbase
+{
+namespace core::transactions
+{
+class attempt_context_impl;
+} // namespace core::transactions
+
+namespace transactions
+{
+class transaction_get_multi_replicas_from_preferred_server_group_options
+{
+public:
+  auto mode(transaction_get_multi_replicas_from_preferred_server_group_mode mode)
+    -> transaction_get_multi_replicas_from_preferred_server_group_options&
+  {
+    mode_ = mode;
+    return *this;
+  }
+
+private:
+  friend class core::transactions::attempt_context_impl;
+
+  transaction_get_multi_replicas_from_preferred_server_group_mode mode_{
+    transaction_get_multi_replicas_from_preferred_server_group_mode::prioritise_latency
+  };
+};
+
+} // namespace transactions
+} // namespace couchbase

package/deps/couchbase-cxx-client/couchbase/transactions/transaction_get_multi_replicas_from_preferred_server_group_result.hxx

@@ -0,0 +1,109 @@
+/*
+ *     Copyright 2021-Present Couchbase, Inc.
+ *
+ *   Licensed under the Apache License, Version 2.0 (the "License");
+ *   you may not use this file except in compliance with the License.
+ *   You may obtain a copy of the License at
+ *
+ *       http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *   Unless required by applicable law or agreed to in writing, software
+ *   distributed under the License is distributed on an "AS IS" BASIS,
+ *   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *   See the License for the specific language governing permissions and
+ *   limitations under the License.
+ */
+#pragma once
+
+#include "couchbase/error_codes.hxx"
+#include <couchbase/codec/default_json_transcoder.hxx>
+
+#include <optional>
+#include <stdexcept>
+#include <system_error>
+#include <vector>
+
+namespace couchbase
+{
+namespace core::transactions
+{
+class attempt_context_impl;
+} // namespace core::transactions
+
+namespace transactions
+{
+class transaction_get_multi_replicas_from_preferred_server_group_result
+{
+public:
+  transaction_get_multi_replicas_from_preferred_server_group_result(
+    const transaction_get_multi_replicas_from_preferred_server_group_result&) = default;
+  ~transaction_get_multi_replicas_from_preferred_server_group_result() = default;
+  transaction_get_multi_replicas_from_preferred_server_group_result(
+    transaction_get_multi_replicas_from_preferred_server_group_result&&) = default;
+  auto operator=(const transaction_get_multi_replicas_from_preferred_server_group_result&)
+    -> transaction_get_multi_replicas_from_preferred_server_group_result& = default;
+  auto operator=(transaction_get_multi_replicas_from_preferred_server_group_result&&)
+    -> transaction_get_multi_replicas_from_preferred_server_group_result& = default;
+
+  /**
+   * Content of the document.
+   *
+   * @return content of the document.
+   */
+  template<typename Document,
+           typename Transcoder = codec::default_json_transcoder,
+           std::enable_if_t<!codec::is_transcoder_v<Document>, bool> = true,
+           std::enable_if_t<codec::is_transcoder_v<Transcoder>, bool> = true>
+  [[nodiscard]] auto content_as(std::size_t spec_index) const -> Document
+  {
+    if (spec_index >= content_.size()) {
+      throw std::invalid_argument("spec index " + std::to_string(spec_index) + " is not valid");
+    }
+    if (const auto& content = content_[spec_index]; content.has_value()) {
+      return Transcoder::template decode<Document>(content.value());
+    }
+    throw std::system_error(errc::key_value::document_not_found,
+                            "document was not found for index " + std::to_string(spec_index));
+  }
+
+  /**
+   * Content of the document.
+   *
+   * @return content of the document.
+   */
+  template<typename Transcoder, std::enable_if_t<codec::is_transcoder_v<Transcoder>, bool> = true>
+  [[nodiscard]] auto content_as(std::size_t spec_index) const -> typename Transcoder::document_type
+  {
+    if (spec_index >= content_.size()) {
+      throw std::invalid_argument("spec index " + std::to_string(spec_index) + " is not valid");
+    }
+    if (const auto& content = content_[spec_index]; content.has_value()) {
+      return Transcoder::decode(content.value());
+    }
+    throw std::system_error(errc::key_value::document_not_found,
+                            "document was not found for index " + std::to_string(spec_index));
+  }
+
+  /**
+   * Check if spec returned any content
+   *
+   * @return the id of this document.
+   */
+  [[nodiscard]] auto exists(std::size_t spec_index) const -> bool
+  {
+    return spec_index >= content_.size() && content_[spec_index].has_value();
+  }
+
+private:
+  friend core::transactions::attempt_context_impl;
+
+  explicit transaction_get_multi_replicas_from_preferred_server_group_result(
+    std::vector<std::optional<codec::encoded_value>> content)
+    : content_{ std::move(content) }
+  {
+  }
+
+  std::vector<std::optional<codec::encoded_value>> content_;
+};
+} // namespace transactions
+} // namespace couchbase

package/deps/couchbase-cxx-client/couchbase/transactions/transaction_get_multi_replicas_from_preferred_server_group_spec.hxx

@@ -0,0 +1,47 @@
+/*
+ *     Copyright 2021-Present Couchbase, Inc.
+ *
+ *   Licensed under the Apache License, Version 2.0 (the "License");
+ *   you may not use this file except in compliance with the License.
+ *   You may obtain a copy of the License at
+ *
+ *       http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *   Unless required by applicable law or agreed to in writing, software
+ *   distributed under the License is distributed on an "AS IS" BASIS,
+ *   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *   See the License for the specific language governing permissions and
+ *   limitations under the License.
+ */
+#pragma once
+
+#include <string>
+
+namespace couchbase
+{
+class collection;
+namespace core::transactions
+{
+class attempt_context_impl;
+} // namespace core::transactions
+
+namespace transactions
+{
+class transaction_get_multi_replicas_from_preferred_server_group_spec
+{
+public:
+  transaction_get_multi_replicas_from_preferred_server_group_spec(
+    const couchbase::collection& collection,
+    std::string id);
+
+private:
+  friend class core::transactions::attempt_context_impl;
+
+  std::string bucket_;
+  std::string scope_;
+  std::string collection_;
+  std::string id_;
+};
+
+} // namespace transactions
+} // namespace couchbase

package/deps/couchbase-cxx-client/couchbase/transactions/transaction_get_multi_result.hxx

@@ -0,0 +1,102 @@
+/*
+ *     Copyright 2021-Present Couchbase, Inc.
+ *
+ *   Licensed under the Apache License, Version 2.0 (the "License");
+ *   you may not use this file except in compliance with the License.
+ *   You may obtain a copy of the License at
+ *
+ *       http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *   Unless required by applicable law or agreed to in writing, software
+ *   distributed under the License is distributed on an "AS IS" BASIS,
+ *   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *   See the License for the specific language governing permissions and
+ *   limitations under the License.
+ */
+#pragma once
+
+#include <couchbase/codec/default_json_transcoder.hxx>
+
+#include <optional>
+#include <vector>
+
+namespace couchbase
+{
+namespace core::transactions
+{
+class attempt_context_impl;
+} // namespace core::transactions
+
+namespace transactions
+{
+class transaction_get_multi_result
+{
+public:
+  transaction_get_multi_result() = default;
+  ~transaction_get_multi_result() = default;
+  transaction_get_multi_result(const transaction_get_multi_result&) = default;
+  transaction_get_multi_result(transaction_get_multi_result&&) = default;
+  auto operator=(const transaction_get_multi_result&) -> transaction_get_multi_result& = default;
+  auto operator=(transaction_get_multi_result&&) -> transaction_get_multi_result& = default;
+
+  /**
+   * Content of the document.
+   *
+   * @return content of the document.
+   */
+  template<typename Document,
+           typename Transcoder = codec::default_json_transcoder,
+           std::enable_if_t<!codec::is_transcoder_v<Document>, bool> = true,
+           std::enable_if_t<codec::is_transcoder_v<Transcoder>, bool> = true>
+  [[nodiscard]] auto content_as(std::size_t spec_index) const -> Document
+  {
+    if (spec_index >= content_.size()) {
+      throw std::invalid_argument("spec index " + std::to_string(spec_index) + " is not valid");
+    }
+    if (const auto& content = content_[spec_index]; content.has_value()) {
+      return Transcoder::template decode<Document>(content.value());
+    }
+    throw std::system_error(errc::key_value::document_not_found,
+                            "document was not found for index " + std::to_string(spec_index));
+  }
+
+  /**
+   * Content of the document.
+   *
+   * @return content of the document.
+   */
+  template<typename Transcoder, std::enable_if_t<codec::is_transcoder_v<Transcoder>, bool> = true>
+  [[nodiscard]] auto content_as(std::size_t spec_index) const -> typename Transcoder::document_type
+  {
+    if (spec_index >= content_.size()) {
+      throw std::invalid_argument("spec index " + std::to_string(spec_index) + " is not valid");
+    }
+    if (const auto& content = content_[spec_index]; content.has_value()) {
+      return Transcoder::decode(content_[spec_index]);
+    }
+    throw std::system_error(errc::key_value::document_not_found,
+                            "document was not found for index " + std::to_string(spec_index));
+  }
+
+  /**
+   * Check if spec returned any content
+   *
+   * @return the id of this document.
+   */
+  [[nodiscard]] auto exists(std::size_t spec_index) const -> bool
+  {
+    return spec_index >= content_.size() && content_[spec_index].has_value();
+  }
+
+private:
+  friend core::transactions::attempt_context_impl;
+
+  explicit transaction_get_multi_result(std::vector<std::optional<codec::encoded_value>> content)
+    : content_{ std::move(content) }
+  {
+  }
+
+  std::vector<std::optional<codec::encoded_value>> content_;
+};
+} // namespace transactions
+} // namespace couchbase

package/deps/couchbase-cxx-client/couchbase/transactions/transaction_get_multi_spec.hxx

@@ -0,0 +1,45 @@
+/*
+ *     Copyright 2021-Present Couchbase, Inc.
+ *
+ *   Licensed under the Apache License, Version 2.0 (the "License");
+ *   you may not use this file except in compliance with the License.
+ *   You may obtain a copy of the License at
+ *
+ *       http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *   Unless required by applicable law or agreed to in writing, software
+ *   distributed under the License is distributed on an "AS IS" BASIS,
+ *   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *   See the License for the specific language governing permissions and
+ *   limitations under the License.
+ */
+#pragma once
+
+#include <string>
+
+namespace couchbase
+{
+class collection;
+namespace core::transactions
+{
+class attempt_context_impl;
+} // namespace core::transactions
+
+namespace transactions
+{
+class transaction_get_multi_spec
+{
+public:
+  transaction_get_multi_spec(const couchbase::collection& collection, std::string id);
+
+private:
+  friend class core::transactions::attempt_context_impl;
+
+  std::string bucket_;
+  std::string scope_;
+  std::string collection_;
+  std::string id_;
+};
+
+} // namespace transactions
+} // namespace couchbase

package/dist/analyticsindexmanager.d.ts

@@ -1,4 +1,5 @@
 /// <reference types="node" />
+/// <reference types="node" />
 import { Cluster } from './cluster';
 import { CppManagementAnalyticsCouchbaseRemoteLink, CppManagementAnalyticsS3ExternalLink, CppManagementAnalyticsAzureBlobExternalLink } from './binding';
 import { NodeCallback } from './utilities';

package/dist/binarycollection.d.ts

@@ -1,4 +1,5 @@
 /// <reference types="node" />
+/// <reference types="node" />
 import { Collection } from './collection';
 import { CounterResult, MutationResult } from './crudoptypes';
 import { DurabilityLevel } from './generaltypes';