Merge branch 'refs/heads/wl11205'

Author: silvakid

common/op_impl.h

@@ -2080,6 +2080,10 @@ class Op_collection_modify
       case Impl::ARRAY_DELETE:
         prc.remove(&doc_field);
         break;
+
+      case Impl::MERGE_PATCH:
+        m_update_it->process_if(prc.patch());
+        break;
     }
   }
 

devapi/tests/crud-t.cc

@@ -2335,3 +2335,52 @@ TEST_F(Crud, add_or_replace)
   cout << "Done!" << endl;
 
 }
+
+TEST_F(Crud, merge_patch)
+{
+  SKIP_IF_NO_XPLUGIN;
+  SKIP_IF_SERVER_VERSION_LESS(8, 0, 3)
+
+  cout << "Creating collection..." << endl;
+
+  Schema sch = getSchema("test");
+  Collection coll = sch.createCollection("c1", true);
+
+  coll.remove("true").execute();
+
+  add_data(coll);
+
+  coll.modify("true").patch(R"(
+                        {
+                          "age" : null,
+                          "birth" : { "year": year(CURDATE())-age }
+                        }
+                        )").execute();
+
+  auto res = coll.find().execute();
+  for (auto row : res)
+  {
+    EXPECT_FALSE(row.hasField("age"));
+    std::cout << row["birth"]["year"] << std::endl;
+  }
+
+  coll.modify("true")
+      .patch(R"(
+             {
+             "food":["Falcoaria"],
+             "fullname": concat("Silva", ', ', name)
+             }
+             )")
+      .execute();
+
+  res = coll.find().execute();
+  for (auto doc : res)
+  {
+    EXPECT_EQ(string("Falcoaria"), doc["food"][0].get<string>());
+    EXPECT_THROW(doc["food"][1], std::out_of_range);
+    std::cout << doc["fullname"] << std::endl;
+    string fullname = string("Silva, ") + doc["name"].get<string>();
+    EXPECT_EQ(fullname, doc["fullname"].get<string>());
+  }
+
+}

include/mysqlx/common/op_if.h

@@ -249,7 +249,8 @@ struct Collection_modify_if : public Select_if<Sort_if>
     UNSET,
     ARRAY_INSERT,
     ARRAY_APPEND,
-    ARRAY_DELETE
+    ARRAY_DELETE,
+    MERGE_PATCH
   };
 
   virtual void add_operation(Operation, const string&, const Value&) = 0;

include/mysqlx/devapi/collection_crud.h

@@ -554,6 +554,35 @@ class CollectionModify
     CATCH_AND_WRAP
   }
 
+  /**
+    Apply JSON Patch to a target JSON document.
+
+    The JSON Patch format is defined by
+    <a href=https://tools.ietf.org/html/rfc7386>RFC7386</a>.
+
+    A document patch is similar to a JSON object, with the key difference that
+    document field values can be nested expressions in addition to literal
+    values.
+
+    The patch contains instructions of how the source document is to be modified
+    producing a derived document. By default, all fields from the source
+    document are copied to the resulting document. If patch sets a field to NULL,
+    the field of that name in the source is skipped from the result, identifiers
+    and function calls are evaluated against the original source document.
+
+  */
+
+  CollectionModify& patch(const string &val)
+  {
+    try {
+      get_impl()->add_operation(
+        Impl::MERGE_PATCH, L"$", (const common::Value&)expr(val)
+      );
+      return *this;
+    }
+    CATCH_AND_WRAP
+  }
+
 protected:
 
   using Impl = common::Collection_modify_if;

include/mysqlx/devapi/document.h

@@ -82,6 +82,9 @@ class Field
   Field(const char *s) : m_fld(s)
   {}
 
+  Field()
+  {}
+
   operator const string&() const { return m_fld; }
 
   bool operator <(const Field &other) const
@@ -597,7 +600,15 @@ class Expression
    set_as_expr();
  }
 
+ template <typename V>
+ Expression(const V& val)
+ : Value(val)
+ {
+   set_as_expr();
+ }
+
  friend Expression expr(string&& s);
+ friend Expression expr(const string& s);
 };
 
 
@@ -626,6 +637,12 @@ mysqlx::internal::Expression expr(string&& e)
   return std::forward<string>(e);
 }
 
+inline
+mysqlx::internal::Expression expr(const string& e)
+{
+  return e;
+}
+
 }  // internal
 
 

include/mysqlx/xapi.h

@@ -179,6 +179,7 @@ typedef object_id* MYSQLX_GUID;
 #define MYSQLX_ERROR_AUTH_METHOD "Unknown authentication method"
 #define MYSQLX_ERROR_ROW_LOCKING "Row locking is supported only for SELECT and FIND"
 #define MYSQLX_ERROR_WRONG_LOCKING_MODE "Wrong value for the row locking mode"
+#define MYSQLX_ERROR_WRONG_EXPRESSION "Expression could not be parsed"
 #define MYSQLX_ERROR_EMPTY_JSON "Empty JSON document string"
 
 
@@ -1126,6 +1127,46 @@ mysqlx_collection_modify_unset(mysqlx_collection_t *collection,
                                const char *criteria, ...);
 
 
+/**
+  Apply a given patch to documents in a collection.
+
+  @param collection collection handle
+  @param criteria criteria selecting documents to be modified; if this
+         parameter is NULL then all documents are modified
+  @param patch_spec patch specification given as a character string and
+         interpreted like a JSON documents, but values of fields are
+         interpreted as expressions
+
+  @return handle to the statement result.
+          NULL is returned only in case of an error. The error details
+          can be obtained using `mysqlx_error()` function
+
+  @ingroup xapi_coll
+*/
+
+PUBLIC_API mysqlx_result_t *
+mysqlx_collection_modify_patch(mysqlx_collection_t *collection,
+                               const char *criteria,
+                               const char *patch_spec);
+
+
+/**
+  Set a given patch for a modify statement to be applied to
+  documents in a collection after executing the statement.
+
+  @param stmt modify statement
+  @param patch_spec patch specification given as a character string and
+         interpreted like a JSON documents, but values of fields are
+         interpreted as expressions
+
+  @return `RESULT_OK` - on success; `RESULT_ERR` - on error
+  @ingroup xapi_coll
+*/
+
+PUBLIC_API int
+mysqlx_set_modify_patch(mysqlx_stmt_t *stmt,
+                                   const char *patch_spec);
+
 /*
   Deferred statement execution
   ----------------------------

xapi/crud.cc

@@ -309,6 +309,7 @@ int mysqlx_stmt_struct::add_coll_modify_values(va_list &args, mysqlx_modify_op m
   case MODIFY_ARRAY_INSERT: op = MImpl::ARRAY_INSERT; break;
   case MODIFY_ARRAY_APPEND: op = MImpl::ARRAY_APPEND; break;
   case MODIFY_ARRAY_DELETE: op = MImpl::ARRAY_DELETE; break;
+  case MODIFY_MERGE_PATCH: op = MImpl::MERGE_PATCH; break;
   }
 
   int rc = RESULT_ERROR;
@@ -324,6 +325,16 @@ int mysqlx_stmt_struct::add_coll_modify_values(va_list &args, mysqlx_modify_op m
       impl->add_operation(op, path);
       continue;
     }
+    else if (modify_type == MODIFY_MERGE_PATCH)
+    {
+      /*
+        Note: in this case path contains the patch to be applied, which should
+        be trated as an expression, not a literal string.
+      */
+      impl->add_operation(op, L"$", Value::Access::mk_expr(path));
+      // For merge only one item is expected
+      return RESULT_OK;
+    }
 
     impl->add_operation(op, path, get_value(args));
   }

xapi/def_internal.h

@@ -81,7 +81,8 @@ typedef enum mysqlx_modify_op_enum
   MODIFY_UNSET = 2,
   MODIFY_ARRAY_INSERT = 3,
   MODIFY_ARRAY_APPEND = 4,
-  MODIFY_ARRAY_DELETE = 5
+  MODIFY_ARRAY_DELETE = 5,
+  MODIFY_MERGE_PATCH = 6
 } mysqlx_modify_op;
 
 #endif

xapi/mysqlx.cc

@@ -585,7 +585,7 @@ int STDCALL mysqlx_set_modify_set(mysqlx_stmt_struct *stmt, ...)
 }
 
 
-int STDCALL STDCALL mysqlx_set_modify_unset(mysqlx_stmt_struct *stmt, ...)
+int STDCALL mysqlx_set_modify_unset(mysqlx_stmt_struct *stmt, ...)
 {
   SAFE_EXCEPTION_BEGIN(stmt, RESULT_ERROR)
 
@@ -602,7 +602,7 @@ int STDCALL STDCALL mysqlx_set_modify_unset(mysqlx_stmt_struct *stmt, ...)
 }
 
 
-int STDCALL STDCALL mysqlx_set_modify_array_insert(mysqlx_stmt_struct *stmt, ...)
+int STDCALL mysqlx_set_modify_array_insert(mysqlx_stmt_struct *stmt, ...)
 {
   SAFE_EXCEPTION_BEGIN(stmt, RESULT_ERROR)
 
@@ -619,7 +619,7 @@ int STDCALL STDCALL mysqlx_set_modify_array_insert(mysqlx_stmt_struct *stmt, ...
 }
 
 
-int STDCALL STDCALL mysqlx_set_modify_array_append(mysqlx_stmt_struct *stmt, ...)
+int STDCALL mysqlx_set_modify_array_append(mysqlx_stmt_struct *stmt, ...)
 {
   SAFE_EXCEPTION_BEGIN(stmt, RESULT_ERROR)
 
@@ -636,7 +636,7 @@ int STDCALL STDCALL mysqlx_set_modify_array_append(mysqlx_stmt_struct *stmt, ...
 }
 
 
-int STDCALL STDCALL mysqlx_set_modify_array_delete(mysqlx_stmt_struct *stmt, ...)
+int STDCALL mysqlx_set_modify_array_delete(mysqlx_stmt_struct *stmt, ...)
 {
   SAFE_EXCEPTION_BEGIN(stmt, RESULT_ERROR)
 
@@ -653,6 +653,29 @@ int STDCALL STDCALL mysqlx_set_modify_array_delete(mysqlx_stmt_struct *stmt, ...
 }
 
 
+static int
+_mysqlx_set_modify_patch(mysqlx_stmt_struct *stmt, ...)
+{
+  int res = RESULT_OK;
+  va_list args;
+  SAFE_EXCEPTION_BEGIN(stmt, RESULT_ERROR)
+
+  va_start(args, stmt);
+  res = stmt->add_coll_modify_values(args, MODIFY_MERGE_PATCH);
+  va_end(args);
+
+  SAFE_EXCEPTION_END(stmt, RESULT_ERROR)
+    return res;
+}
+
+int STDCALL
+mysqlx_set_modify_patch(mysqlx_stmt_struct *stmt,
+                        const char *patch_spec)
+{
+  return _mysqlx_set_modify_patch(stmt, patch_spec);
+}
+
+
 /*
   Fetch one row from the result and advance to the next row
   PARAMETERS:
@@ -1446,10 +1469,12 @@ mysqlx_collection_modify_set(mysqlx_collection_struct *collection,
 {
   mysqlx_result_struct *res;
   va_list args;
+  SAFE_EXCEPTION_BEGIN(collection, NULL)
   va_start(args, criteria);
   res = _mysqlx_collection_modify_exec(collection, criteria, MODIFY_SET, args);
   va_end(args);
   return res;
+  SAFE_EXCEPTION_END(collection, NULL)
 }
 
 
@@ -1459,10 +1484,38 @@ mysqlx_collection_modify_unset(mysqlx_collection_struct *collection,
 {
   mysqlx_result_struct *res;
   va_list args;
+  SAFE_EXCEPTION_BEGIN(collection, NULL)
+
   va_start(args, criteria);
   res = _mysqlx_collection_modify_exec(collection, criteria, MODIFY_UNSET, args);
   va_end(args);
   return res;
+  SAFE_EXCEPTION_END(collection, NULL)
+}
+
+static mysqlx_result_t *
+_mysqlx_collection_modify_patch(mysqlx_collection_t *collection,
+                               const char *criteria, ...)
+{
+  mysqlx_result_t *res;
+  va_list args;
+  SAFE_EXCEPTION_BEGIN(collection, NULL)
+
+  va_start(args, criteria);
+  res = _mysqlx_collection_modify_exec(collection, criteria,
+                                       MODIFY_MERGE_PATCH, args);
+  va_end(args);
+  return res;
+  SAFE_EXCEPTION_END(collection, NULL)
+}
+
+mysqlx_result_t * STDCALL
+mysqlx_collection_modify_patch(mysqlx_collection_t *collection,
+                               const char *criteria,
+                               const char *patch_spec)
+{
+  return _mysqlx_collection_modify_patch(collection, criteria,
+                                         patch_spec);
 }