Skip to content

sift_py.data_import.hdf5

CLASS DESCRIPTION
Hdf5UploadService

Service to upload HDF5 files.

Hdf5UploadService

Hdf5UploadService(rest_conf: SiftRestConfig)

Service to upload HDF5 files.

METHOD DESCRIPTION
get_previous_upload_run_id

Return the run_id used in the previous upload

upload

Uploads the HDF5 file pointed to by path using a custom HDF5 config.

get_previous_upload_run_id

get_previous_upload_run_id() -> str

Return the run_id used in the previous upload

upload

upload(
    path: Union[str, Path],
    hdf5_config: Hdf5Config,
    show_progress: bool = True,
) -> DataImportService

Uploads the HDF5 file pointed to by path using a custom HDF5 config.

PARAMETER DESCRIPTION
path

The path to the HDF5 file.

TYPE: Union[str, Path]

hdf5_config

The HDF5 config.

TYPE: Hdf5Config

show_progress

Whether to show the status bar or not.

TYPE: bool DEFAULT: True

RETURNS DESCRIPTION
DataImportService

DataImportService used to get the status of the import