Add note to checkforChanges call to explain what happens with existin…

…g transactions (#7407)
iTwin · Nov 20, 2024 · f9f96ba · f9f96ba
1 parent 80a4290
commit f9f96ba
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 1 deletion.
diff --git a/...changes/@itwin/core-backend/nick-updatecheckForChangesDocumentation_2024-11-20-15-43.json b/...changes/@itwin/core-backend/nick-updatecheckForChangesDocumentation_2024-11-20-15-43.json
@@ -0,0 +1,10 @@
+{
+  "changes": [
+    {
+      "packageName": "@itwin/core-backend",
+      "comment": "",
+      "type": "none"
+    }
+  ],
+  "packageName": "@itwin/core-backend"
+}
diff --git a/core/backend/src/CloudSqlite.ts b/core/backend/src/CloudSqlite.ts
@@ -501,7 +501,8 @@ export namespace CloudSqlite {
      *
      * Notes:
      * - no changes made by other processes are visible to this CloudContainer unless/until this method is called.
-     * - note this is automatically called whenever the write lock is obtained to ensure all changes are against the latest version.
+     * - this is automatically called whenever the write lock is obtained to ensure all changes are against the latest version.
+     * - any existing transactions on databases within the container will continue to use the old version of the manifest and therefore see no new changes pulled in.
      */
     checkForChanges(): void;