Add optional 'persist' query to PUT/PATCH array

Author: padraic-shafer

tiled/catalog/adapter.py

@@ -1194,10 +1194,12 @@ def make_ws_schema(self):
             "data_type": dataclasses.asdict(self.structure().data_type),
         }
 
-    async def write(self, media_type, deserializer, entry, body):
+    async def write(self, media_type, deserializer, entry, body, persist=True):
         shape = entry.structure().shape
         if self.context.streaming_cache:
             await self._stream(media_type, entry, body, shape)
+        if not persist:
+            return None
         if entry.structure_family == "array":
             dtype = entry.structure().data_type.to_numpy_dtype()
             data = await ensure_awaitable(deserializer, body, dtype, shape)
@@ -1207,14 +1209,16 @@ async def write(self, media_type, deserializer, entry, body):
             raise NotImplementedError(entry.structure_family)
         return await ensure_awaitable((await self.get_adapter()).write, data)
 
-    async def write_block(self, block, media_type, deserializer, entry, body):
+    async def write_block(self, block, media_type, deserializer, entry, body, persist=True):
         from tiled.adapters.array import slice_and_shape_from_block_and_chunks
 
         _, shape = slice_and_shape_from_block_and_chunks(
             block, entry.structure().chunks
         )
         if self.context.streaming_cache:
             await self._stream(media_type, entry, body, shape, block=block)
+        if not persist:
+            return None
         if entry.structure_family == "array":
             dtype = entry.structure().data_type.to_numpy_dtype()
             data = await ensure_awaitable(deserializer, body, dtype, shape)
@@ -1226,9 +1230,11 @@ async def write_block(self, block, media_type, deserializer, entry, body):
             (await self.get_adapter()).write_block, data, block
         )
 
-    async def patch(self, shape, offset, extend, media_type, deserializer, entry, body):
+    async def patch(self, shape, offset, extend, media_type, deserializer, entry, body, persist=True):
         if self.context.streaming_cache:
             await self._stream(media_type, entry, body, shape, offset=offset)
+        if not persist:
+            return entry.structure()
         dtype = entry.structure().data_type.to_numpy_dtype()
         data = await ensure_awaitable(deserializer, body, dtype, shape)
         # assumes a single DataSource (currently only supporting zarr)

tiled/server/router.py

@@ -1719,6 +1719,7 @@ async def delete(
     async def put_array_full(
         request: Request,
         path: str,
+        persist: bool = Query(True, description="Persist data to storage"),
         principal: Optional[Principal] = Depends(get_current_principal),
         root_tree=Depends(get_root_tree),
         session_state: dict = Depends(get_session_state),
@@ -1751,14 +1752,15 @@ async def put_array_full(
             deserializer = deserialization_registry.dispatch("sparse", media_type)
         else:
             raise NotImplementedError(entry.structure_family)
-        await ensure_awaitable(entry.write, media_type, deserializer, entry, body)
+        await ensure_awaitable(entry.write, media_type, deserializer, entry, body, persist)
         return json_or_msgpack(request, None)
 
     @router.put("/array/block/{path:path}")
     async def put_array_block(
         request: Request,
         path: str,
         block=Depends(block),
+        persist: bool = Query(True, description="Persist data to storage"),
         principal: Optional[Principal] = Depends(get_current_principal),
         root_tree=Depends(get_root_tree),
         session_state: dict = Depends(get_session_state),
@@ -1790,7 +1792,7 @@ async def put_array_block(
             entry.structure_family, media_type
         )
         await ensure_awaitable(
-            entry.write_block, block, media_type, deserializer, entry, body
+            entry.write_block, block, media_type, deserializer, entry, body, persist
         )
         return json_or_msgpack(request, None)
 
@@ -1801,6 +1803,7 @@ async def patch_array_full(
         offset=Depends(offset_param),
         shape=Depends(shape_param),
         extend: bool = False,
+        persist: bool = Query(True, description="Persist data to storage"),
         principal: Optional[Principal] = Depends(get_current_principal),
         root_tree=Depends(get_root_tree),
         session_state: dict = Depends(get_session_state),
@@ -1830,7 +1833,7 @@ async def patch_array_full(
         media_type = request.headers["content-type"]
         deserializer = deserialization_registry.dispatch("array", media_type)
         structure = await ensure_awaitable(
-            entry.patch, shape, offset, extend, media_type, deserializer, entry, body
+            entry.patch, shape, offset, extend, media_type, deserializer, entry, body, persist
         )
         return json_or_msgpack(request, structure)