lsst.daf.persistence
13.0-11-gfc17871
|
Public Member Functions | |
def | __init__ |
def | write |
def | read |
def | mappers |
Mapper Access #. More... | |
def | getRegistry |
def | getKeys |
def | map |
def | queryMetadata |
def | backup |
def | getMapperDefaultLevel |
def | exists |
Represents a repository of persisted data and has methods to access that data.
Definition at line 122 of file repository.py.
def lsst.daf.persistence.repository.Repository.__init__ | ( | self, | |
repoData | |||
) |
Initialize a Repository with parameters input via RepoData. Parameters ---------- repoData : RepoData Object that contains the parameters with which to init the Repository.
Definition at line 126 of file repository.py.
def lsst.daf.persistence.repository.Repository.backup | ( | self, | |
args, | |||
kwargs | |||
) |
Perform mapper.backup. See mapper.backup for more information about args and kwargs. :param args: arguments to be passed on to mapper.backup :param kwargs: keyword arguments to be passed on to mapper.backup :return: None
Definition at line 262 of file repository.py.
def lsst.daf.persistence.repository.Repository.exists | ( | self, | |
location | |||
) |
Check if location exists in storage. Parameters ---------- location : ButlerLocation Desrcibes a location in storage to look for. Returns ------- bool True if location exists, False if not.
Definition at line 290 of file repository.py.
def lsst.daf.persistence.repository.Repository.getKeys | ( | self, | |
args, | |||
kwargs | |||
) |
Get the keys available in the repository/repositories. :param args: :param kwargs: :return: A dict of {key:valueType}
Definition at line 218 of file repository.py.
def lsst.daf.persistence.repository.Repository.getMapperDefaultLevel | ( | self | ) |
Get the default level of the mapper. This is typically used if no level is passed into butler methods that call repository.getKeys and/or repository.queryMetadata. There is a bug in that code because it gets the default level from this repository but then uses that value when searching all repositories. If this and other repositories have dissimilar data, the default level value will be nonsensical. A good example of this issue is in Butler.subset; it needs refactoring. :return:
Definition at line 275 of file repository.py.
def lsst.daf.persistence.repository.Repository.getRegistry | ( | self | ) |
Get the registry from the mapper Returns ------- Registry or None The registry from the mapper or None if the mapper does not have one.
Definition at line 206 of file repository.py.
def lsst.daf.persistence.repository.Repository.map | ( | self, | |
args, | |||
kwargs | |||
) |
Find a butler location for the given arguments. See mapper.map for more information about args and kwargs. :param args: arguments to be passed on to mapper.map :param kwargs: keyword arguments to be passed on to mapper.map :return: The type of item is dependent on the mapper being used but is typically a ButlerLocation.
Definition at line 231 of file repository.py.
def lsst.daf.persistence.repository.Repository.mappers | ( | self | ) |
Mapper Access #.
Definition at line 203 of file repository.py.
def lsst.daf.persistence.repository.Repository.queryMetadata | ( | self, | |
args, | |||
kwargs | |||
) |
Gets possible values for keys given a partial data id. See mapper documentation for more explanation about queryMetadata. :param args: arguments to be passed on to mapper.queryMetadata :param kwargs: keyword arguments to be passed on to mapper.queryMetadata :return:The type of item is dependent on the mapper being used but is typically a set that contains available values for the keys in the format input argument.
Definition at line 247 of file repository.py.
def lsst.daf.persistence.repository.Repository.read | ( | self, | |
butlerLocation | |||
) |
Read a dataset from Storage. :param butlerLocation: Contains the details needed to find the desired dataset. :return: An instance of the dataset requested by butlerLocation.
Definition at line 188 of file repository.py.
def lsst.daf.persistence.repository.Repository.write | ( | self, | |
butlerLocation, | |||
obj | |||
) |
Write a dataset to Storage. :param butlerLocation: Contains the details needed to find the desired dataset. :param dataset: The dataset to be written. :return:
Definition at line 175 of file repository.py.