RDoc-4008 Documents > Patching (Reorganization) + JsonPatch behavior by Danielle9897 · Pull Request #2583 · ravendb/docs

Danielle9897 · 2026-07-28T15:38:55Z

Issue links

https://issues.hibernatingrhinos.com/issue/RDoc-4008/Per-feature-reorganization-Patching
https://issues.hibernatingrhinos.com/issue/RDoc-3986/Document-JsonPatch-behavior-for-session-Patch-methods
https://issues.hibernatingrhinos.com/issue/RDoc-2719/Client-API-Operations-Patching-Single-document-Fix-article
https://issues.hibernatingrhinos.com/issue/RDoc-2721/Client-API-Operations-Patching-Set-based-Fix-article
https://issues.hibernatingrhinos.com/issue/RDoc-3908/Dictionary-patching-with-the-strongly-typed-Session-API
https://issues.hibernatingrhinos.com/issue/RDoc-4037/Patching-a-modified-document-tracked-by-the-same-session-other-fixes

Additional description

Organized patching under Documents > Patching
As described in:
https://issues.hibernatingrhinos.com/issue/RDoc-4008/Per-feature-reorganization-Patching
Fixed info about "Patching a single document"
As described in:
https://issues.hibernatingrhinos.com/issue/RDoc-2719/Client-API-Operations-Patching-Single-document-Fix-article
Fixed info about "Patching multiple documents"
As described in:
https://issues.hibernatingrhinos.com/issue/RDoc-2721/Client-API-Operations-Patching-Set-based-Fix-article
Documented the JsonPatch behavior for session patch methods
Created C#, Node.js, Python, & Java versions

Type of change

Changes in docs URLs

No changes in docs URLs
[s] Articles are restructured, URLs will change, mapping is required (update /scripts/redirects.json file, set Documents Moved PR label)

Changes in UX/UI

No changes in UX/UI
Changes in UX/UI (include screenshots and description)

Danielle9897 · 2026-07-28T17:58:40Z

@@ -324,7 +324,35 @@
        "key": "/client-api/operations/patching",
        "value": {
            "targetUrl": "/client-api/operations/patching/single-document",
-            "minimumVersion": "6.2"
+            "minimumVersion": "7.2"


This change (from 6.2 to 7.2) is a workaround to make the build pass until RDoc-4009 is fixed.

Danielle9897 · 2026-07-28T18:18:58Z

=======================================
C#:
@ppekrol / @Lwiel pls review these files:

..\documents\patching-documents\overview.mdx
..\documents\patching-documents\patch-a-single-document\content\_api-overview-csharp.mdx
..\documents\patching-documents\patch-a-single-document\content\_json-patch-csharp.mdx
..\documents\patching-documents\patch-a-single-document\examples\content\_patch-examples-advanced-scripts-csharp.mdx
..\documents\patching-documents\patch-a-single-document\examples\content\_patch-examples-counters-time-series-attachments-csharp.mdx
..\documents\patching-documents\patch-a-single-document\examples\content\_patch-examples-documents-and-metadata-csharp.mdx
..\documents\patching-documents\patch-a-single-document\examples\content\_patch-examples-fields-and-arrays-csharp.mdx
..\documents\patching-documents\patch-multiple-documents\content\_client-api-csharp.mdx
..\documents\patching-documents\patch-multiple-documents\patch-view.mdx
..\docs\client-api\configuration\content\_conventions-csharp.mdx

======================================
Python:
@poissoncorp pls review these files:

..\documents\patching-documents\patch-a-single-document\content\_api-overview-python.mdx
..\documents\patching-documents\patch-a-single-document\examples\content\_patch-examples-advanced-scripts-python.mdx
..\documents\patching-documents\patch-a-single-document\examples\content\_patch-examples-counters-time-series-attachments-python.mdx
..\documents\patching-documents\patch-a-single-document\examples\content\_patch-examples-documents-and-metadata-python.mdx
..\documents\patching-documents\patch-a-single-document\examples\content\_patch-examples-fields-and-arrays-python.mdx
..\documents\patching-documents\patch-multiple-documents\content\_client-api-python.mdx

=======================================
Node.js:
@M4xymm pls review these files:

..\documents\patching-documents\patch-a-single-document\content\_api-overview-nodejs.mdx
..\documents\patching-documents\patch-a-single-document\examples\content\_patch-examples-advanced-scripts-nodejs.mdx
..\documents\patching-documents\patch-a-single-document\examples\content\_patch-examples-counters-time-series-attachments-nodejs.mdx
..\documents\patching-documents\patch-a-single-document\examples\content\_patch-examples-documents-and-metadata-nodejs.mdx
..\documents\patching-documents\patch-a-single-document\examples\content\_patch-examples-fields-and-arrays-nodejs.mdx
..\documents\patching-documents\patch-multiple-documents\content\_client-api-nodejs.mdx

==========================================
Java:
@LielNagar pls review these files:

..\documents\patching-documents\patch-a-single-document\content\_api-overview-java.mdx
..\documents\patching-documents\patch-a-single-document\examples\content\_patch-examples-advanced-scripts-java.mdx
..\documents\patching-documents\patch-a-single-document\examples\content\_patch-examples-counters-time-series-attachments-java.mdx
..\documents\patching-documents\patch-a-single-document\examples\content\_patch-examples-documents-and-metadata-java.mdx
..\documents\patching-documents\patch-a-single-document\examples\content\_patch-examples-fields-and-arrays-java.mdx
..\documents\patching-documents\patch-multiple-documents\content\_client-api-java.mdx

===========================================

…=> /patch-multiple-documents/client-api

LielNagar · 2026-08-03T10:22:11Z

+| **add(U item)**                         | `JavaScriptArray<U>` | Adds one item to the end of the array.                                                              |
+| **add(U... items)**                     | `JavaScriptArray<U>` | Adds multiple items to the end of the array.                                                        |
+| **add(Collection&lt;U&gt; items)**      | `JavaScriptArray<U>` | Adds the items of the given collection to the end of the array.                                     |
+| **removeAt(int index)**                 | `JavaScriptArray<U>` | Removes the item in position `index` in the array. An out-of-range index is applied as a no-op.     |


Maybe it worth mentioning negative index, something like:
A negative index will remove from the end of the array. removeAt(-N) removes the last N element

LielNagar · 2026-08-03T10:36:58Z

@@ -0,0 +1,294 @@
+import Admonition from '@theme/Admonition';


Can you add what happens on operation failure?

done.
added info in this file and also in api-overview.mdx.

LielNagar · 2026-08-03T11:55:10Z

+
+Map<String, Object> values = new HashMap<>();
+values.put("name", "HeartRates");
+values.put("timestamp", NetISO8601Utils.format(new Date(), true));


There is no need to use NetISO8601Utils.format function. Please fix in all relevant examples

LielNagar · 2026-08-03T12:18:26Z

+patchRequest.setScript("this['@metadata']['@expires'] = args.expires;");
+// @expires must contain an ISO 8601 UTC date-time string
+patchRequest.setValues(Collections.singletonMap("expires",
+    NetISO8601Utils.format(DateUtils.addMinutes(new Date(), 1), true)));


Same here, the use of NetISO8601Utils.format is reduant

LielNagar · 2026-08-03T13:47:48Z

+  Compare against `undefined` rather than calling `hasOwnProperty`,  
+  which reports every property name as present on the patched document.


drop hasOwnProperty since it will throw either way.

LielNagar · 2026-08-03T14:10:45Z

+
+Parameters parameters = new Parameters();
+parameters.put("timeSeriesName", "PriceHistory");
+parameters.put("timestamp", NetISO8601Utils.format(new Date(), true));


Same reduant use of NetISO8601Utils

M4xymm · 2026-08-04T09:39:28Z

+patchRequest.script = `
+    if (this.SensitiveData != null) {
+        // Generate a fresh 96-bit IV for this encryption.
+        const iv = crypto.getRandomValuesBase64(12);
+
+        // The key comes from patchRequest.values; do not store it in the document.
+        this.SensitiveDataEncrypted = crypto.encryptAesGcm(
+            iv,
+            args.encryptionKey,
+            this.SensitiveData);
+
+        this.SensitiveDataIv = iv;
+
+        // Remove the plaintext only after encryption succeeds.
+        delete this.SensitiveData;
+    }`;
+
+await documentStore.operations.send(new PatchOperation(
+    "users/1",
+    null,
+    patchRequest));
+```


This example is missing patchRequest.values, so args.encryptionKey in the script is never supplied and the patch will not work as shown.

Suggested change

patchRequest.script = `

if (this.SensitiveData != null) {

// Generate a fresh 96-bit IV for this encryption.

const iv = crypto.getRandomValuesBase64(12);

// The key comes from patchRequest.values; do not store it in the document.

this.SensitiveDataEncrypted = crypto.encryptAesGcm(

iv,

args.encryptionKey,

this.SensitiveData);

this.SensitiveDataIv = iv;

// Remove the plaintext only after encryption succeeds.

delete this.SensitiveData;

}`;

await documentStore.operations.send(new PatchOperation(

"users/1",

null,

patchRequest));

```

patchRequest.script = `

if (this.SensitiveData != null) {

// Generate a fresh 96-bit IV for this encryption.

const iv = crypto.getRandomValuesBase64(12);

// The key comes from patchRequest.values; do not store it in the document.

this.SensitiveDataEncrypted = crypto.encryptAesGcm(

iv,

args.encryptionKey,

this.SensitiveData);

this.SensitiveDataIv = iv;

// Remove the plaintext only after encryption succeeds.

delete this.SensitiveData;

}`;

patchRequest.values = {

encryptionKey

};

await documentStore.operations.send(new PatchOperation(

"users/1",

null,

patchRequest));

…other fixes

Danielle9897 force-pushed the RDoc-3986-jsonPatchBehavior branch 2 times, most recently from 531cc7a to 4a465d5 Compare July 28, 2026 16:17

Danielle9897 added the Documents Moved label Jul 28, 2026

Danielle9897 commented Jul 28, 2026

View reviewed changes

Danielle9897 requested review from LielNagar, M4xymm, poissoncorp and ppekrol July 28, 2026 18:19

Danielle9897 marked this pull request as draft August 3, 2026 08:43

Danielle9897 requested a review from Lwiel August 3, 2026 12:00

Danielle9897 added 6 commits August 3, 2026 15:59

RDoc-4008 Documents > Patching

d384730

RDoc-4008 fix redirects.json

060cce6

RDoc-4008 rename: /patch-multiple-documents/patch-multiple-documents …

189ea01

…=> /patch-multiple-documents/client-api

RDoc-4008 this is a patch fix, until issue RDoc-4009 is fixed

de3679a

RDoc-4008 fix QueryingFeatures.tsx

284de7b

RDoc-3908 Dictionary patching with the strongly-typed Session API

714ed01

Danielle9897 force-pushed the RDoc-3986-jsonPatchBehavior branch from c257ed0 to 714ed01 Compare August 3, 2026 13:05

Danielle9897 marked this pull request as ready for review August 3, 2026 13:09

LielNagar suggested changes Aug 3, 2026

View reviewed changes

RDoc-4008 fix review comments

9f5cedd

Danielle9897 requested a review from LielNagar August 4, 2026 04:47

LielNagar approved these changes Aug 4, 2026

View reviewed changes

M4xymm suggested changes Aug 4, 2026

View reviewed changes

Lwiel approved these changes Aug 4, 2026

View reviewed changes

RDoc-4008 fix comment for node.js

d79aeee

Danielle9897 requested a review from M4xymm August 4, 2026 14:27

RDoc-4008 fix Python time series snippets and inaccurate patching notes

1ba5232

M4xymm approved these changes Aug 4, 2026

View reviewed changes

poissoncorp approved these changes Aug 5, 2026

View reviewed changes

Danielle9897 marked this pull request as draft August 5, 2026 06:31

RDoc-4037 Patching a modified document tracked by the same session + …

da5ae2d

…other fixes

Danielle9897 marked this pull request as ready for review August 5, 2026 11:44

ppekrol merged commit 05951aa into ravendb:main Aug 11, 2026
1 check passed

		@@ -0,0 +1,294 @@
		import Admonition from '@theme/Admonition';

		Compare against `undefined` rather than calling `hasOwnProperty`,
		which reports every property name as present on the patched document.

Uh oh!

Conversation

Danielle9897 commented Jul 28, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Issue links

Additional description

Type of change

Changes in docs URLs

Changes in UX/UI

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Danielle9897 commented Jul 28, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

Danielle9897 commented Jul 28, 2026 •

edited

Loading

Danielle9897 commented Jul 28, 2026 •

edited

Loading