Store SOMA encoding version number as array/group metadata

single-cell-data · Jun 21, 2022 · 019aeb4 · 019aeb4
1 parent c9bb1f7
commit 019aeb4
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 0 deletions.
diff --git a/apis/python/src/tiledbsc/tiledb_array.py b/apis/python/src/tiledbsc/tiledb_array.py
@@ -115,6 +115,9 @@ def _set_soma_object_type_metadata(self) -> None:
             A.meta[
                 tiledbsc.util.SOMA_OBJECT_TYPE_METADATA_KEY
             ] = self.__class__.__name__
+            A.meta[
+                tiledbsc.util.SOMA_ENCODING_VERSION_METADATA_KEY
+            ] tiledbsc.util.SOMA_ENCODING_VERSION
 
     def show_metadata(self, recursively=True, indent=""):
         """

diff --git a/apis/python/src/tiledbsc/tiledb_group.py b/apis/python/src/tiledbsc/tiledb_group.py
@@ -81,6 +81,9 @@ def _set_soma_object_type_metadata(self):
             G.meta[
                 tiledbsc.util.SOMA_OBJECT_TYPE_METADATA_KEY
             ] = self.__class__.__name__
+            G.meta[
+                tiledbsc.util.SOMA_ENCODING_VERSION_METADATA_KEY
+            ] = SOMA_ENCODING_VERSION
 
     def _set_soma_object_type_metadata_recursively(self):
         """

diff --git a/apis/python/src/tiledbsc/util.py b/apis/python/src/tiledbsc/util.py
@@ -13,6 +13,8 @@
 # that start at the SOMACollection level) confidently navigate with a minimum of introspection on
 # group contents.
 SOMA_OBJECT_TYPE_METADATA_KEY = "soma_object_type"
+SOMA_ENCODING_VERSION_METADATA_KEY = "soma_encoding_version"
+SOMA_ENCODING_VERSION = "1"
 
 # ----------------------------------------------------------------
 def is_soma(uri: str, ctx: Optional[tiledb.Ctx] = None) -> bool: