Skip to content

Commit

Permalink
Add description of links as sub-objects
Browse files Browse the repository at this point in the history
  • Loading branch information
mattjala authored Apr 24, 2024
1 parent be0e8bb commit a7099f6
Showing 1 changed file with 19 additions and 0 deletions.
19 changes: 19 additions & 0 deletions docs/design/obj_store_schema/obj_store_schema_v2.md
Original file line number Diff line number Diff line change
Expand Up @@ -644,6 +644,7 @@ The specification for these borrows heavily from the HDF5/JSON specification, so
- dataspace
- attribute
- creationProperties
- link

### Type

Expand Down Expand Up @@ -757,6 +758,24 @@ The following example shows properties for "allocTime", "fillValue", and "layout
}
```

### Links

Links are stored on group objects, and represent pointers to other HDF5 data model objects. Links may be hard, soft, or external.

An example of JSON describing links within a group is given here: <https://hdf5-json.readthedocs.io/en/latest/examples/tgroup.html?highlight=links#a-few-hdf5-groups>.

#### Link example

The following example describes a hard link named "g1" which uses a UUID to point to a group.
```json
{
"collection": "groups",
"title": "g1",
"class": "H5L_TYPE_HARD",
"id": "a6c3f58c-7bf7-11e4-a370-3c15c2da029e"
}
```

## Related documents

The following documents provided related material that may be of use:
Expand Down

0 comments on commit a7099f6

Please sign in to comment.