Search Shortcut cmd + k | ctrl + k
h5db

Read HDF5 datasets and attributes

Maintainer(s): jokasimr

Installing and Loading

INSTALL h5db FROM community;
LOAD h5db;

Example

FROM h5_read('file.h5', '/some/dataset', '/another');

About h5db

This extension provides functions for reading data and metadata from HDF5 files.

Features include:

  • h5_read() table function to read datasets.
  • h5_tree() table function to list groups and datasets in a file, optionally including projected attributes.
  • h5_attributes() table function to read attributes.
  • h5_ls() table and scalar functions to list entries in groups.
  • Multiple datasets: Read multiple datasets into separate columns.
  • Multi-dimensional arrays: Support for 1D to 4D datasets.
  • Projection pushdown: Read only the datasets that are actually needed.
  • Index column: Optionally adds an index column that supports predicate pushdown of constant range filters (>, <=, BETWEEN, etc.) for efficient selective reads.
  • Reads datasets that are larger than memory.
  • Remote reads over HTTPS, S3, etc., via the DuckDB httpfs extension.
  • Remote reads over SFTP via a built-in SFTP client.
  • Globbing: Combine datasets from multiple files vertically (UNION ALL).

For full documentation, see: https://github.com/jokasimr/h5db.

Added Functions

function_name function_type description comment examples
h5_alias scalar NULL NULL  
h5_attr scalar NULL NULL  
h5_attributes table NULL NULL  
h5_index scalar NULL NULL  
h5_ls scalar NULL NULL  
h5_ls table NULL NULL  
h5_ls_swmr scalar NULL NULL  
h5_read table NULL NULL  
h5_rse scalar NULL NULL  
h5_tree table NULL NULL  
h5db_version scalar NULL NULL  

Overloaded Functions

This extension does not add any function overloads.

Added Types

This extension does not add any types.

Added Settings

name description input_type scope aliases
h5db_batch_size Target batch size for h5_read chunk caching (e.g. 1MB, 8MB) VARCHAR GLOBAL []
h5db_swmr_default Default to SWMR read mode for h5db table functions BOOLEAN GLOBAL []