couchbase 4.2.3 → 4.2.5-dev.1

package/deps/couchbase-cxx-client/docs/cbc-pillowfight.md

@@ -1,4 +1,4 @@
-# cbc-pillowfight - simple workload generator {#cbc-pillowfight}
+# cbc-pillowfight - Simple Workload Generator {#cbc-pillowfight}
 
 ### NAME
 
@@ -17,9 +17,12 @@ Run simple workload generator that sends GET/UPSERT requests with optional N1QL
 
 <dl>
 <dt>`-h|--help`</dt><dd>Show this screen.</dd>
+<dt>`--verbose`</dt><dd>Include more context and information where it is applicable.</dd>
 <dt>`--bucket-name=STRING`</dt><dd>Name of the bucket. [default: `default`]</dd>
 <dt>`--scope-name=STRING`</dt><dd>Name of the scope. [default: `_default`]</dd>
 <dt>`--collection-name=STRING`</dt><dd>Name of the collection. [default: `_default`]</dd>
+<dt>`--batch-size=INTEGER`</dt><dd>Number of the operations in single batch. [default: `100`]</dd>
+<dt>`--batch-wait=DURATION`</dt><dd>Time to wait after the batch. [default: `0ms`]</dd>
 <dt>`--number-of-io-threads=INTEGER`</dt><dd>Number of the IO threads. [default: `1`]</dd>
 <dt>`--number-of-worker-threads=INTEGER`</dt><dd>Number of the IO threads. [default: `1`]</dd>
 <dt>`--chance-of-get=FLOAT`</dt><dd>The probability of get operation (where 1 means only get, and 0 - only upsert). [default: `0.6`]</dd>
@@ -29,7 +32,9 @@ Run simple workload generator that sends GET/UPSERT requests with optional N1QL
 <dt>`--query-statement=STRING`</dt><dd>The N1QL query statement to use ({bucket_name}, {scope_name} and {collection_name} will be substituted). [default: <code>SELECT COUNT(*) FROM \`{bucket_name}\` WHERE type = "fake_profile"</code>]</dd>
 <dt>`--incompressible-body`</dt><dd>Use random characters to fill generated document value (by default uses 'x' to fill the body).</dd>
 <dt>`--document-body-size=INTEGER`</dt><dd>Size of the body (if zero, it will use predefined document). [default: `0`]</dd>
+<dt>`--number-of-keys-to-populate=INTEGER`</dt><dd>Preload keys before running workload, so that the worker will not generate new keys afterwards. [default: `1000`]</dd>
 <dt>`--operations-limit=INTEGER`</dt><dd>Stop and exit after the number of the operations reaches this limit. (zero for running indefinitely) [default: `0`]</dd>
+
 </dl>
 
 
@@ -160,4 +165,4 @@ Run simple workload generator that sends GET/UPSERT requests with optional N1QL
 
 ### SEE ALSO
 
-[cbc](#cbc).
+[cbc](md_docs_2cbc).

package/deps/couchbase-cxx-client/docs/cbc-query.md

@@ -1,4 +1,4 @@
-# cbc-query - run N1QL query {#cbc-query}
+# cbc-query - Execute N1QL Query {#cbc-query}
 
 ### NAME
 
@@ -176,4 +176,4 @@ Execute one or more N1QL queries and print results to standard output.
 
 ### SEE ALSO
 
-[cbc](#cbc), [cbc-get](#cbc-get).
+[cbc](md_docs_2cbc), [cbc-get](md_docs_2cbc-get).

package/deps/couchbase-cxx-client/docs/cbc.md

@@ -25,12 +25,12 @@ Display version information.
 
 <dt>get</dt>
 <dd>
-Retrieve document from the server. See [cbc-get](#cbc-get) for more information.
+Retrieve document from the server. See [cbc-get](md_docs_2cbc-get) for more information.
 </dd>
 
 <dt>query</dt>
 <dd>
-Perform N1QL query. See [cbc-query](#cbc-query) for more information.
+Perform N1QL query. See [cbc-query](md_docs_2cbc-query) for more information.
 </dd>
 </dl>
 
@@ -43,4 +43,4 @@ Perform N1QL query. See [cbc-query](#cbc-query) for more information.
 
 ### SEE ALSO
 
-[cbc-get](#cbc-get), [cbc-query](#cbc-query).
+[cbc-get](md_docs_2cbc-get), [cbc-query](md_docs_2cbc-query).

package/deps/couchbase-cxx-client/docs/cli.hxx

@@ -21,13 +21,13 @@
  * @page cli Command Line Tools
  * @brief Indexes of the API grouped by stability.
  *
- * @subpage cbc. CLI tools entry point.
+ * @subpage md_docs_2cbc
  *
- * @subpage cbc-get. Retrieve documents from the server by ID.
+ * @subpage md_docs_2cbc-get
  *
- * @subpage cbc-query. Execute N1QL queries.
+ * @subpage md_docs_2cbc-query
  *
- * @subpage cbc-analytics. Execute Analytics queries.
+ * @subpage md_docs_2cbc-analytics
  *
- * @subpage cbc-pillowfight. Run simple workload generator.
+ * @subpage md_docs_2cbc-pillowfight
  */

package/deps/couchbase-cxx-client/docs/mainpage.hxx

@@ -22,15 +22,52 @@
  *
  * @note You may read about related Couchbase software at https://docs.couchbase.com/
  *
+ * @anchor start-using
  * ### Start Using
  *
  * The following example shows the most basic usage of the library. It performs the following operations:
- * * connect to local cluster (location and credentials given in program arguments),
- * * in lines <a href="#l00071">70-78</a>, persists document to the collection using @ref couchbase::collection#upsert(),
- * * in lines <a href="#l00081">80-89</a>, retrieves document back with @ref couchbase::collection#get(), extracts content as generic JSON
+ * * [1] connect to local cluster (location and credentials given in program arguments),
+ * * [2] persists document to the collection using @ref couchbase::collection#upsert(),
+ * * [3] retrieves document back with @ref couchbase::collection#get(), extracts content as generic JSON
  * value, and prints one of the fields,
- * * in lines <a href="#l00092">91-102</a>, performs N1QL query with @ref couchbase::scope#query() and prints the result.
- * * close the cluster and deallocate resources
+ * * [4] performs N1QL query with @ref couchbase::scope#query() and prints the result.
+ * * [5] closes the cluster and deallocate resources
  *
  * @snippetlineno test_integration_examples.cxx start-using
+ *
+ * @anchor start-transactions
+ * ### Using Transactions
+ *
+ * Next example shows transactions API. Read more details in @ref couchbase::transactions::transactions
+ *
+ * * [1] connect to cluster using the given connection string and the options
+ * * [2] persist three documents to the default collection of bucket "default"
+ * * [3] blocking transaction
+ *   * [3.1] closure argument to @ref couchbase::transactions::transactions::run method encapsulates logic, that has to be run in
+ *     transaction
+ *   * [3.2] get document
+ *   * [3.4] replace document's content
+ *   * [3.5] check the overall status of the transaction
+ * * [4] asynchronous transaction
+ *   * [4.1] create promise to retrieve result from the transaction
+ *   * [4.2] closure argument to @ref couchbase::transactions::transactions::run method encapsulates logic, that has to be run in
+ *     transaction
+ *   * [4.3] get document
+ *   * [4.4] replace document's content
+ *   * [4.5] second closure argument to @ref couchbase::transactions::transactions::run represents transaction completion logic
+ * * [5] close cluster connection
+ *
+ * @snippetlineno test_transaction_examples.cxx blocking-txn
+ *
+ * See also simple class that implements an operation in fictional game backend: @ref game_server.cxx (and its asynchronous version in @ref
+ * async_game_server.cxx)
+ *
+ * @example minimal.cxx - minimal example of SDK, stores single document into the collection.
+ *
+ * @example game_server.cxx - more complicated example of using transactions (synchronous version).
+ *
+ * @example async_game_server.cxx - asynchronous version of the game_server.cxx.
+ *
+ * @example distributed_mutex.cxx - example of distributed mutex object, that backed by a document inside collection.
+ *
  */

package/deps/couchbase-cxx-client/test/CMakeLists.txt

@@ -25,6 +25,7 @@ unit_test(json_streaming_lexer)
 unit_test(jsonsl)
 unit_test(config_profiles)
 unit_test(options)
+unit_test(search)
 target_link_libraries(test_unit_jsonsl jsonsl)
 
 integration_benchmark(get)

package/deps/couchbase-cxx-client/test/test_integration_analytics.cxx

@@ -24,8 +24,12 @@ TEST_CASE("integration: analytics query")
 {
     test::utils::integration_test_guard integration;
 
+    if (integration.ctx.deployment == test::utils::deployment_type::elixir) {
+        SKIP("elixir deployment does not support analytics");
+    }
+
     if (!integration.cluster_version().supports_analytics()) {
-        return;
+        SKIP("cluster does not support analytics");
     }
 
     test::utils::open_bucket(integration.cluster, integration.ctx.bucket);
@@ -180,8 +184,15 @@ TEST_CASE("integration: analytics scope query")
 {
     test::utils::integration_test_guard integration;
 
-    if (!integration.cluster_version().supports_analytics() || !integration.cluster_version().supports_collections()) {
-        return;
+    if (integration.ctx.deployment == test::utils::deployment_type::elixir) {
+        SKIP("elixir deployment does not support analytics");
+    }
+
+    if (!integration.cluster_version().supports_analytics()) {
+        SKIP("cluster does not support analytics");
+    }
+    if (!integration.cluster_version().supports_collections()) {
+        SKIP("cluster does not support collections");
     }
 
     test::utils::open_bucket(integration.cluster, integration.ctx.bucket);
@@ -286,8 +297,12 @@ TEST_CASE("integration: public API analytics query")
 {
     test::utils::integration_test_guard integration;
 
+    if (integration.ctx.deployment == test::utils::deployment_type::elixir) {
+        SKIP("elixir deployment does not support analytics");
+    }
+
     if (!integration.cluster_version().supports_analytics()) {
-        return;
+        SKIP("cluster does not support analytics");
     }
 
     auto cluster = couchbase::cluster(integration.cluster);
@@ -468,8 +483,15 @@ TEST_CASE("integration: public API analytics scope query")
 {
     test::utils::integration_test_guard integration;
 
-    if (!integration.cluster_version().supports_analytics() || !integration.cluster_version().supports_collections()) {
-        return;
+    if (integration.ctx.deployment == test::utils::deployment_type::elixir) {
+        SKIP("elixir deployment does not support analytics");
+    }
+
+    if (!integration.cluster_version().supports_analytics()) {
+        SKIP("cluster does not support analytics");
+    }
+    if (!integration.cluster_version().supports_collections()) {
+        SKIP("cluster does not support collections");
     }
 
     auto cluster = couchbase::cluster(integration.cluster);

package/deps/couchbase-cxx-client/test/test_integration_collections.cxx

@@ -25,7 +25,7 @@ TEST_CASE("integration: missing scope and collection", "[integration]")
     test::utils::open_bucket(integration.cluster, integration.ctx.bucket);
 
     if (!integration.cluster_version().supports_collections()) {
-        return;
+        SKIP("cluster does not support collections");
     }
 
     SECTION("get missing scope")
@@ -77,7 +77,7 @@ TEST_CASE("integration: get and insert non default scope and collection", "[inte
     test::utils::open_bucket(integration.cluster, integration.ctx.bucket);
 
     if (!integration.cluster_version().supports_collections()) {
-        return;
+        SKIP("cluster does not support collections");
     }
 
     auto scope_name = test::utils::uniq_id("scope");
@@ -121,7 +121,7 @@ TEST_CASE("integration: insert into dropped scope", "[integration]")
     test::utils::open_bucket(integration.cluster, integration.ctx.bucket);
 
     if (!integration.cluster_version().supports_collections()) {
-        return;
+        SKIP("cluster does not support collections");
     }
 
     auto scope_name = test::utils::uniq_id("scope");
@@ -166,6 +166,10 @@ TEST_CASE("integration: insert into dropped scope", "[integration]")
         REQUIRE(dropped);
     }
 
+    if (integration.cluster_version().is_mock()) {
+        SKIP("GOCAVES does not generate error when inserting into dropped collection. See "
+             "https://github.com/couchbaselabs/gocaves/issues/108");
+    }
     {
         couchbase::core::operations::upsert_request req{ id, couchbase::core::utils::to_binary(key) };
         auto resp = test::utils::execute(integration.cluster, req);

package/deps/couchbase-cxx-client/test/test_integration_connect.cxx

@@ -42,9 +42,9 @@ TEST_CASE("integration: connecting with unresponsive first node in bootstrap nod
     test::utils::init_logger();
     asio::io_context io{};
     auto ctx = test::utils::test_context::load_from_environment();
-    if (ctx.deployment == test::utils::deployment_type::capella) {
+    if (ctx.deployment == test::utils::deployment_type::capella || ctx.deployment == test::utils::deployment_type::elixir) {
         // This breaks SRV assumptions (only one host in connection string)
-        return;
+        SKIP("capella deployment uses single host in the connection string, which assumed to be reachable");
     }
     auto connstr = couchbase::core::utils::parse_connection_string(ctx.connection_string);
     REQUIRE_FALSE(connstr.bootstrap_nodes.empty());
@@ -125,6 +125,10 @@ TEST_CASE("integration: destroy cluster without waiting for close completion", "
     test::utils::init_logger();
     auto ctx = test::utils::test_context::load_from_environment();
 
+    if (ctx.deployment == test::utils::deployment_type::elixir) {
+        SKIP("elixir deployment is incompatible with parts of this test, but it is probably bug in SDK. FIXME");
+    }
+
     asio::io_context io{};
 
     auto cluster = couchbase::core::cluster::create(io);
@@ -143,7 +147,7 @@ TEST_CASE("integration: destroy cluster without waiting for close completion", "
     }
 
     // hit Query
-    {
+    if (ctx.version.supports_query()) {
         couchbase::core::operations::query_request req{ R"(SELECT 42 AS the_answer)" };
         auto resp = test::utils::execute(cluster, req);
         REQUIRE_SUCCESS(resp.ctx.ec);

package/deps/couchbase-cxx-client/test/test_integration_crud.cxx

@@ -35,6 +35,10 @@ TEST_CASE("integration: switching off mutation token", "[integration]")
     opts.enable_mutation_tokens = false;
     test::utils::integration_test_guard integration(opts);
 
+    if (integration.cluster_version().is_mock()) {
+        SKIP("GOCAVES does not allow to switching off mutation tokens. See https://github.com/couchbaselabs/gocaves/issues/100");
+    }
+
     test::utils::open_bucket(integration.cluster, integration.ctx.bucket);
     couchbase::core::document_id id{ integration.ctx.bucket, "_default", "_default", test::utils::uniq_id("foo") };
 
@@ -228,7 +232,8 @@ TEST_CASE("integration: pessimistic locking", "[integration]")
     {
         couchbase::core::operations::get_and_lock_request req{ id };
         req.lock_time = lock_time;
-        if (integration.ctx.deployment == test::utils::deployment_type::capella) {
+        if (integration.ctx.deployment == test::utils::deployment_type::capella ||
+            integration.ctx.deployment == test::utils::deployment_type::elixir) {
             req.timeout = std::chrono::seconds{ 2 };
         }
         auto resp = test::utils::execute(integration.cluster, req);
@@ -489,7 +494,7 @@ TEST_CASE("integration: upsert preserve expiry", "[integration]")
     test::utils::integration_test_guard integration;
 
     if (!integration.cluster_version().supports_preserve_expiry()) {
-        return;
+        SKIP("cluster does not support preserve expiry");
     }
 
     test::utils::open_bucket(integration.cluster, integration.ctx.bucket);
@@ -670,6 +675,10 @@ TEST_CASE("integration: open bucket that does not exist", "[integration]")
 {
     test::utils::integration_test_guard integration;
 
+    if (integration.cluster_version().is_mock()) {
+        SKIP("GOCAVES returns not_found (0x01) instead of no_access (0x24). See https://github.com/couchbaselabs/gocaves/issues/102");
+    }
+
     auto bucket_name = test::utils::uniq_id("missing_bucket");
 
     auto barrier = std::make_shared<std::promise<std::error_code>>();
@@ -814,7 +823,8 @@ TEST_CASE("integration: pessimistic locking with public API", "[integration]")
     // it is not allowed to lock the same key twice
     {
         couchbase::get_and_lock_options options{};
-        if (integration.ctx.deployment == test::utils::deployment_type::capella) {
+        if (integration.ctx.deployment == test::utils::deployment_type::capella ||
+            integration.ctx.deployment == test::utils::deployment_type::elixir) {
             options.timeout(std::chrono::seconds{ 2 });
         }
         auto [ctx, resp] = collection.get_and_lock(id, lock_time, options).get();

package/deps/couchbase-cxx-client/test/test_integration_diagnostics.cxx

@@ -321,6 +321,10 @@ TEST_CASE("integration: fetch diagnostics after N1QL query", "[integration]")
 {
     test::utils::integration_test_guard integration;
 
+    if (!integration.cluster_version().supports_query() || integration.ctx.deployment == test::utils::deployment_type::elixir) {
+        SKIP("cluster does not support query or cluster level query");
+    }
+
     test::utils::open_bucket(integration.cluster, integration.ctx.bucket);
     {
         couchbase::core::operations::query_request req{ "SELECT 'hello, couchbase' AS greetings" };
@@ -365,8 +369,10 @@ TEST_CASE("integration: ping", "[integration]")
         REQUIRE(res.services.count(couchbase::core::service_type::management) > 0);
         REQUIRE(res.services[couchbase::core::service_type::management].size() > 0);
 
-        REQUIRE(res.services.count(couchbase::core::service_type::view) > 0);
-        REQUIRE(res.services[couchbase::core::service_type::view].size() > 0);
+        if (integration.ctx.deployment != test::utils::deployment_type::elixir) {
+            REQUIRE(res.services.count(couchbase::core::service_type::view) > 0);
+            REQUIRE(res.services[couchbase::core::service_type::view].size() > 0);
+        }
 
         REQUIRE(res.services.count(couchbase::core::service_type::query) > 0);
         REQUIRE(res.services[couchbase::core::service_type::query].size() > 0);

package/deps/couchbase-cxx-client/test/test_integration_durability.cxx

@@ -25,7 +25,7 @@ TEST_CASE("integration: durable operations", "[integration]")
 {
     test::utils::integration_test_guard integration;
     if (!integration.cluster_version().supports_enhanced_durability()) {
-        return;
+        SKIP("cluster does not support enhanced durability");
     }
 
     test::utils::open_bucket(integration.cluster, integration.ctx.bucket);
@@ -68,7 +68,7 @@ TEST_CASE("integration: durable operations", "[integration]")
         auto resp = test::utils::execute(integration.cluster, req);
         REQUIRE_SUCCESS(resp.ctx.ec());
         REQUIRE(!resp.cas.empty());
-        REQUIRE(resp.value == couchbase::core::utils::to_binary(R"({"foo":"bar","baz":42})"));
+        REQUIRE(couchbase::core::utils::json::parse_binary(resp.value) == couchbase::core::utils::json::parse(R"({"foo":"bar","baz":42})"));
     }
     {
         couchbase::core::operations::remove_request req{ id };
@@ -83,8 +83,13 @@ TEST_CASE("integration: durable operations", "[integration]")
 TEST_CASE("integration: legacy durability persist to active and replicate to one", "[integration]")
 {
     test::utils::integration_test_guard integration;
-    if (integration.number_of_replicas() == 0 || integration.number_of_nodes() <= integration.number_of_replicas()) {
-        return;
+    if (integration.number_of_replicas() == 0) {
+        SKIP("bucket has zero replicas");
+    }
+    if (integration.number_of_nodes() <= integration.number_of_replicas()) {
+        SKIP(fmt::format("number of nodes ({}) is less or equal to number of replicas ({})",
+                         integration.number_of_nodes(),
+                         integration.number_of_replicas()));
     }
 
     test::utils::open_bucket(integration.cluster, integration.ctx.bucket);
@@ -124,7 +129,7 @@ TEST_CASE("integration: low level legacy durability impossible if number of node
     test::utils::open_bucket(integration.cluster, integration.ctx.bucket);
 
     if (integration.number_of_replicas() == 3) {
-        return;
+        SKIP("bucket has three replicas configured, so the test will not be applicable");
     }
 
     couchbase::core::document_id id{ integration.ctx.bucket, "_default", "_default", test::utils::uniq_id("foo") };
@@ -159,7 +164,7 @@ TEST_CASE("integration: low level legacy durability persist to active and replic
     test::utils::open_bucket(integration.cluster, integration.ctx.bucket);
 
     if (integration.number_of_replicas() < 1) {
-        return;
+        SKIP("bucket does not have replicas configured");
     }
 
     couchbase::core::document_id id{ integration.ctx.bucket, "_default", "_default", test::utils::uniq_id("foo") };
@@ -211,7 +216,7 @@ TEST_CASE("integration: low level legacy durability persist to active and replic
         auto resp = test::utils::execute(integration.cluster, req);
         REQUIRE_SUCCESS(resp.ctx.ec());
         REQUIRE(!resp.cas.empty());
-        REQUIRE(resp.value == couchbase::core::utils::to_binary(R"({"foo":"bar","baz":42})"));
+        REQUIRE(couchbase::core::utils::json::parse_binary(resp.value) == couchbase::core::utils::json::parse(R"({"foo":"bar","baz":42})"));
     }
     {
         couchbase::core::operations::remove_request_with_legacy_durability req{