update

update(
    self ,
    progress: Literal[‘standard’, ‘basic’, None, False] = standard,
    client: dascore.constants.ExecutorType | None[ExecutorType, None] = None,
)-> ‘Self’

Updates the contents of the spool, return the updated spool.

Only root spools can update. Directory roots re-index, single-file roots rescan, and in-memory roots are already current. Derived spools raise; update their root and reapply the operations.

Parameters

Parameter	Description
progress	Controls the progress bar. “standard” produces the standard progress bar. “basic” is a simplified version with lower refresh rates, best for high-latency environments, and None (or False) disables the progress bar.
client	Optional executor with an ordered `map` method. Directory updates scan batches of changed sources in its workers; index writes stay in the calling thread. None keeps scanning serial. The caller owns the executor and may reuse it across updates. Single-file and in-memory spools do not use it.

Note

Process pools can parallelize HDF5 scans, whose h5py calls are serialized within one process. Reusing a pool avoids paying its startup cost on every update. Each worker opens its own sources and uses the configuration active when update was called. Warnings are emitted where the scan runs. Parent-process warning capture and filters do not automatically apply to process workers; configure their warning handling in the worker initializer or environment. Missing optional dependencies are handled per batch, so an unreadable batch can raise even if other batches contain readable files. The caller is responsible for executor support and initialization. Use one writer and no concurrent readers while updating a directory spool.