DirectoryIndexer

class of dascore.io.indexer
inherits from: AbstractIndexer
source

DirectoryIndexer(
    path: Path ,
    cache_size = 5,
    index_path = None,
)

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.
index_path The path to the index. By default, the index will be created on the
top level of the data directory. If another index is

Methods

Name Description
clear_cache Removes all cached dataframes.
get_contents Get contents of directory with specific query params.
get_index_metadata Return a dict of metadata about the index.
update Updates the contents of the Indexer.