hdf5-external-storage · shipping · also HDF5 external raw storage, HDF5 external file list

HDF5 external storage

HDF5 external storage maps a contiguous dataset's raw bytes onto an ordered list of byte ranges in non-HDF5 files.

Related Observatory article: HDF5 external storage on hesela.com

Mapping: each external-file-list segment specifies a filename, byte offset and reserved size; it is not a VDS mapping or a link to an HDF5 object. h5py exposes the list through Dataset.external. [1] [3]

EOF behavior: the HDF5 1.14.6 reader zeroes the remaining bytes when a referenced file reaches EOF; an open failure takes an error path. This byte-level behavior differs from substituting a dataset fill element. [2]

Measured example: truncating a little-endian int32 fixture inside its second integer changed 287454020 to 13124 without a read error, even with fillvalue=-999. Big-endian storage returned 287440896. Missing files errored; empty files returned zeros. These are controlled synthetic observations on one build. [4]

Preservation: validate the required mapped ranges, offsets and source identity together. In the fixture, a 16-byte raw file equalled Dataset.nbytes but lacked eight mapped bytes because data started at offset eight. Same-length replacement passed the range check but changed values. The full analysis and downloadable harness retain the evidence and limits. [5]

Resolution: external raw files use HDF5_EXTFILE_PREFIX, which overrides the dataset-access prefix. Default relative lookup uses the process working directory; ${ORIGIN} in the prefix supports resolution relative to the containing HDF5 file. Preserve the reader settings as well as the stored filename. [6]

Relations

related
HDF5, HDF5 virtual dataset, HDF5 fill value, Backup verification

Citations

  1. The HDF Group: Dataset guide, External Storage Properties (accessed 2026-10-21)
  2. HDF5 1.14.6: H5D__efl_read EOF and open-error handling (accessed 2026-10-21)
  3. h5py 3.15.0: Dataset.external and Dataset.nbytes (accessed 2026-10-21)
  4. Hesela: external raw-file truncation observations (42 fixtures, HDF5 1.14.6) (accessed 2026-10-21)
  5. Hesela: HDF5 dependencies, truncated external raw files (accessed 2026-10-21)
  6. The HDF Group: H5Pset_efile_prefix and HDF5_EXTFILE_PREFIX (accessed 2026-10-21)

JSON: /data/terms/hdf5-external-storage.json

Published by Hesela team · Updated

Report a correction · Editorial standards · Reuse guidance

Cite this page
Hesela team. HDF5 external storage. Hesela. 2026-10-21. https://hesela.dev/terms/hdf5-external-storage/