EntityKeyTable (#72)

Co-authored-by: Ryan Ly <[email protected]>

common/namespace.yaml

@@ -23,7 +23,7 @@ namespaces:
   - doc: data types for different types of sparse matrices
     source: sparse.yaml
     title: Sparse data types
-  version: 1.6.0
+  version: 1.7.0
 
 - name: hdmf-experimental
   doc: Experimental data structures provided by HDMF. These are not guaranteed to be available in the future.
@@ -48,4 +48,4 @@ namespaces:
   - doc: data types for storing references to web accessible resources
     source: resources.yaml
     title: Resource reference data types
-  version: 0.3.0
+  version: 0.4.0

common/resources.yaml

@@ -33,9 +33,6 @@ groups:
     name: entities
     doc: A table for mapping user terms (i.e., keys) to resource entities.
     dtype:
-    - name: keys_idx
-      dtype: uint
-      doc: The row index to the key in the `keys` table.
     - name: entity_id
       dtype: text
       doc: "The compact uniform resource identifier (CURIE) of the entity, in the form
@@ -92,3 +89,18 @@ groups:
     - num_rows
     shape:
     - null
+
+  - data_type_inc: Data
+    name: entity_keys
+    doc: A table for identifying which keys use which entity.
+    dtype:
+    - name: entities_idx
+      dtype: uint
+      doc: The row index to the entity in the `entities` table.
+    - name: keys_idx
+      dtype: uint
+      doc: The row index to the key in the `keys` table.
+    dims:
+    - num_rows
+    shape:
+    - null

docs/source/conf.py

@@ -83,9 +83,9 @@ def setup(app):
 # built documents.
 #
 # The short X.Y version.
-version = 'v1.6.0'
+version = 'v1.7.0'
 # The full version, including alpha/beta/rc tags.
-release = 'v1.6.0'
+release = 'v1.7.0'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.

docs/source/hdmf_common_release_notes.rst

@@ -3,6 +3,11 @@
 hdmf-common Release Notes
 =========================
 
+1.7.0 (June 22, 2023)
+-------------------
+- No change in the hdmf-common namespace. See :ref:`here <hdmf_experimental_release_notes>` for changes to the
+  hdmf-experimental namespace.
+
 1.6.0 (May 3, 2023)
 -------------------
 - No change in the hdmf-common namespace. See :ref:`here <hdmf_experimental_release_notes>` for changes to the

docs/source/hdmf_experimental_release_notes.rst

@@ -3,6 +3,10 @@
 hdmf-experimental Release Notes
 ===============================
 
+0.4.0 (June 22, 2023)
+---------------------
+- In the experimental ``ExternalResources``, added a ``entity_keys`` table and removed ``keys_idx`` from the ``entities`` table.
+
 0.3.0 (May 3, 2023)
 -------------------
 - In the experimental ``ExternalResources``, added a ``files`` table, removed the ``resources`` table, and adjusted