DirectoryIndexer

class of dascore.clients.dirspool source

DirectoryIndexer(
    path: Path ,
    cache_size ,
)

A class for indexing a directory of dascore-readable files.

This works by crawling the directory, getting a summary about the data it contains, then creating a small HDF index file which can be queried later on.

Parameters

Parameter Description
path The path to a directory containing DAS files.
cache_size The number of queries to store in memory to avoid frequent reads of the index file. It is rare this needs to be modified.

Methods

Name Description
clear_cache Removes all cached dataframes.
ensure_path_exists Ensure the base path exists else raise.
get_contents Get contents of directory with specific query params.
update Updates the contents of the Indexer.