Datastore

class lsst.daf.butler.Datastore(config: Config | ResourcePathExpression, bridgeManager: DatastoreRegistryBridgeManager, butlerRoot: ResourcePathExpression | None = None)

Bases: object

Datastore interface.

Parameters:

configDatastoreConfig or str

Load configuration either from an existing config instance or by referring to a configuration file.

bridgeManagerDatastoreRegistryBridgeManager

Object that manages the interface between Registry and datastores.

butlerRootstr, optional

New datastore root to use to override the configuration value.

Attributes Summary

containerKey	Name of the key containing a list of subconfigurations that also need to be merged with defaults and will likely use different Python datastore classes (but all using DatastoreConfig).
defaultConfigFile	Path to configuration defaults.
isEphemeral	Indicate whether this Datastore is ephemeral or not.
names	Names associated with this datastore returned as a list.
roots	Return the root URIs for each named datastore.

Methods Summary

emptyTrash([ignore_errors])	Remove all datasets from the trash.
exists(datasetRef)	Check if the dataset exists in the datastore.
export(refs, *[, directory, transfer])	Export datasets for transfer to another data repository.
export_records(refs)	Export datastore records and locations to an in-memory data structure.
forget(refs)	Indicate to the Datastore that it should remove all records of the given datasets, without actually deleting them.
fromConfig(config, bridgeManager[, butlerRoot])	Create datastore from type specified in config file.
get(datasetRef[, parameters, storageClass])	Load an InMemoryDataset from the store.
getLookupKeys()	Return all the lookup keys relevant to this datastore.
getManyURIs(refs[, predict, allow_missing])	Return URIs associated with many datasets.
getURI(datasetRef[, predict])	URI to the Dataset.
getURIs(datasetRef[, predict])	Return URIs associated with dataset.
import_records(data)	Import datastore location and record data from an in-memory data structure.
ingest(*datasets[, transfer, ...])	Ingest one or more files into the datastore.
knows(ref)	Check if the dataset is known to the datastore.
knows_these(refs)	Check which of the given datasets are known to this datastore.
mexists(refs[, artifact_existence])	Check the existence of multiple datasets at once.
needs_expanded_data_ids(transfer[, entity])	Test whether this datastore needs expanded data IDs to ingest.
put(inMemoryDataset, datasetRef)	Write a InMemoryDataset with a given DatasetRef to the store.
remove(datasetRef)	Indicate to the Datastore that a Dataset can be removed.
retrieveArtifacts(refs, destination[, ...])	Retrieve the artifacts associated with the supplied refs.
setConfigRoot(root, config, full[, overwrite])	Set filesystem-dependent config options for this datastore.
set_retrieve_dataset_type_method(method)	Specify a method that can be used by datastore to retrieve registry-defined dataset type.
transaction()	Context manager supporting Datastore transactions.
transfer(inputDatastore, datasetRef)	Transfer a dataset from another datastore to this datastore.
transfer_from(source_datastore, refs[, ...])	Transfer dataset artifacts from another datastore to this one.
trash(ref[, ignore_errors])	Indicate to the Datastore that a Dataset can be moved to the trash.
validateConfiguration(entities[, logFailures])	Validate some of the configuration for this datastore.
validateKey(lookupKey, entity)	Validate a specific look up key with supplied entity.

Attributes Documentation

containerKey: ClassVar[str | None] = None

Name of the key containing a list of subconfigurations that also need to be merged with defaults and will likely use different Python datastore classes (but all using DatastoreConfig). Assumed to be a list of configurations that can be represented in a DatastoreConfig and containing a “cls” definition. None indicates that no containers are expected in this Datastore.

defaultConfigFile: ClassVar[str | None] = None

Path to configuration defaults. Accessed within the config resource or relative to a search path. Can be None if no defaults specified.

isEphemeral: bool = False

Indicate whether this Datastore is ephemeral or not. An ephemeral datastore is one where the contents of the datastore will not exist across process restarts. This value can change per-instance.

names

Names associated with this datastore returned as a list.

Can be different to name for a chaining datastore.

roots

Return the root URIs for each named datastore.

Mapping from datastore name to root URI. The URI can be None if a datastore has no concept of a root URI. (dict [str, ResourcePath | None])

Methods Documentation

abstract emptyTrash(ignore_errors: bool = True) → None

Remove all datasets from the trash.

Parameters:

ignore_errorsbool, optional

Determine whether errors should be ignored.

Notes

Some Datastores may implement this method as a silent no-op to disable Dataset deletion through standard interfaces.

abstract exists(datasetRef: DatasetRef) → bool

Check if the dataset exists in the datastore.

Parameters:

datasetRefDatasetRef

Reference to the required dataset.

Returns:

existsbool

True if the entity exists in the Datastore.

export(refs: Iterable[DatasetRef], *, directory: ResourcePathExpression | None = None, transfer: str | None = 'auto') → Iterable[FileDataset]

Export datasets for transfer to another data repository.

Parameters:

refsiterable of DatasetRef

Dataset references to be exported.

directorystr, optional

Path to a directory that should contain files corresponding to output datasets. Ignored if transfer is explicitly None.

transferstr, optional

Mode that should be used to move datasets out of the repository. Valid options are the same as those of the transfer argument to ingest, and datastores may similarly signal that a transfer mode is not supported by raising NotImplementedError. If “auto” is given and no directory is specified, None will be implied.

Returns:

datasetiterable of DatasetTransfer

Structs containing information about the exported datasets, in the same order as refs.

Raises:

NotImplementedError

Raised if the given transfer mode is not supported.

abstract export_records(refs: Iterable[DatasetIdRef]) → Mapping[str, DatastoreRecordData]

Export datastore records and locations to an in-memory data structure.

Parameters:

refsIterable [ DatasetIdRef ]

Datasets to save. This may include datasets not known to this datastore, which should be ignored. May not include component datasets.

Returns:

dataMapping [ str, DatastoreRecordData ]

Exported datastore records indexed by datastore name.

abstract forget(refs: Iterable[DatasetRef]) → None

Indicate to the Datastore that it should remove all records of the given datasets, without actually deleting them.

Parameters:

refsIterable [ DatasetRef ]

References to the datasets being forgotten.

Notes

Asking a datastore to forget a DatasetRef it does not hold should be a silent no-op, not an error.

static fromConfig(config: Config, bridgeManager: DatastoreRegistryBridgeManager, butlerRoot: ResourcePathExpression | None = None) → Datastore

Create datastore from type specified in config file.

Parameters:

configConfig or ResourcePathExpression

Configuration instance.

bridgeManagerDatastoreRegistryBridgeManager

Object that manages the interface between Registry and datastores.

butlerRootstr, optional

Butler root directory.

abstract get(datasetRef: DatasetRef, parameters: Mapping[str, Any] | None = None, storageClass: StorageClass | str | None = None) → Any

Load an InMemoryDataset from the store.

Parameters:

datasetRefDatasetRef

Reference to the required Dataset.

parametersdict

StorageClass-specific parameters that specify a slice of the Dataset to be loaded.

storageClassStorageClass or str, optional

The storage class to be used to override the Python type returned by this method. By default the returned type matches the dataset type definition for this dataset. Specifying a read StorageClass can force a different type to be returned. This type must be compatible with the original type.

Returns:

inMemoryDatasetobject

Requested Dataset or slice thereof as an InMemoryDataset.

abstract getLookupKeys() → set[LookupKey]

Return all the lookup keys relevant to this datastore.

Returns:

keysset of LookupKey

The keys stored internally for looking up information based on DatasetType name or StorageClass.

getManyURIs(refs: Iterable[DatasetRef], predict: bool = False, allow_missing: bool = False) → dict[DatasetRef, DatasetRefURIs]

Return URIs associated with many datasets.

Parameters:

refsiterable of DatasetIdRef

References to the required datasets.

predictbool, optional

If True, allow URIs to be returned of datasets that have not been written.

allow_missingbool

If False, and predict is False, will raise if a DatasetRef does not exist.

Returns:

URIsdict of [DatasetRef, DatasetRefUris]

A dict of primary and component URIs, indexed by the passed-in refs.

Raises:

FileNotFoundError

A URI has been requested for a dataset that does not exist and guessing is not allowed.

Notes

In file-based datastores, getManyURIs does not check that the file is really there, it’s assuming it is if datastore is aware of the file then it actually exists.

abstract getURI(datasetRef: DatasetRef, predict: bool = False) → ResourcePath

URI to the Dataset.

Parameters:

datasetRefDatasetRef

Reference to the required Dataset.

predictbool

If True attempt to predict the URI for a dataset if it does not exist in datastore.

Returns:

uristr

URI string pointing to the Dataset within the datastore. If the Dataset does not exist in the datastore, the URI may be a guess. If the datastore does not have entities that relate well to the concept of a URI the returned URI string will be descriptive. The returned URI is not guaranteed to be obtainable.

Raises:

FileNotFoundError

A URI has been requested for a dataset that does not exist and guessing is not allowed.

abstract getURIs(datasetRef: DatasetRef, predict: bool = False) → DatasetRefURIs

Return URIs associated with dataset.

Parameters:

refDatasetRef

Reference to the required dataset.

predictbool, optional

If the datastore does not know about the dataset, should it return a predicted URI or not?

Returns:

urisDatasetRefURIs

The URI to the primary artifact associated with this dataset (if the dataset was disassembled within the datastore this may be None), and the URIs to any components associated with the dataset artifact. (can be empty if there are no components).

abstract import_records(data: Mapping[str, DatastoreRecordData]) → None

Import datastore location and record data from an in-memory data structure.

Parameters:

dataMapping [ str, DatastoreRecordData ]

Datastore records indexed by datastore name. May contain data for other Datastore instances (generally because they are chained to this one), which should be ignored.

Notes

Implementations should generally not check that any external resources (e.g. files) referred to by these records actually exist, for performance reasons; we expect higher-level code to guarantee that they do.

Implementations are responsible for calling DatastoreRegistryBridge.insert on all datasets in data.locations where the key is in names, as well as loading any opaque table data.

Implementations may assume that datasets are either fully present or not at all (single-component exports are not permitted).

ingest(*datasets: FileDataset, transfer: str | None = None, record_validation_info: bool = True) → None

Ingest one or more files into the datastore.

Parameters:

datasetsFileDataset

Each positional argument is a struct containing information about a file to be ingested, including its path (either absolute or relative to the datastore root, if applicable), a complete DatasetRef (with dataset_id not None), and optionally a formatter class or its fully-qualified string name. If a formatter is not provided, the one the datastore would use for put on that dataset is assumed.

transferstr, optional

How (and whether) the dataset should be added to the datastore. If None (default), the file must already be in a location appropriate for the datastore (e.g. within its root directory), and will not be modified. Other choices include “move”, “copy”, “link”, “symlink”, “relsymlink”, and “hardlink”. “link” is a special transfer mode that will first try to make a hardlink and if that fails a symlink will be used instead. “relsymlink” creates a relative symlink rather than use an absolute path. Most datastores do not support all transfer modes. “auto” is a special option that will let the data store choose the most natural option for itself.

record_validation_infobool, optional

If True, the default, the datastore can record validation information associated with the file. If False the datastore will not attempt to track any information such as checksums or file sizes. This can be useful if such information is tracked in an external system or if the file is to be compressed in place. It is up to the datastore whether this parameter is relevant.

Raises:

NotImplementedError

Raised if the datastore does not support the given transfer mode (including the case where ingest is not supported at all).

DatasetTypeNotSupportedError

Raised if one or more files to be ingested have a dataset type that is not supported by the datastore.

FileNotFoundError

Raised if one of the given files does not exist.

FileExistsError

Raised if transfer is not None but the (internal) location the file would be moved to is already occupied.

Notes

Subclasses should implement _prepIngest and _finishIngest instead of implementing ingest directly. Datastores that hold and delegate to child datastores may want to call those methods as well.

Subclasses are encouraged to document their supported transfer modes in their class documentation.

abstract knows(ref: DatasetRef) → bool

Check if the dataset is known to the datastore.

Does not check for existence of any artifact.

Parameters:

refDatasetRef

Reference to the required dataset.

Returns:

existsbool

True if the dataset is known to the datastore.

knows_these(refs: Iterable[DatasetRef]) → dict[DatasetRef, bool]

Check which of the given datasets are known to this datastore.

This is like mexist() but does not check that the file exists.

Parameters:

refsiterable DatasetRef

The datasets to check.

Returns:

existsdict`[`DatasetRef, bool]

Mapping of dataset to boolean indicating whether the dataset is known to the datastore.

mexists(refs: Iterable[DatasetRef], artifact_existence: dict[ResourcePath, bool] | None = None) → dict[DatasetRef, bool]

Check the existence of multiple datasets at once.

Parameters:

refsiterable of DatasetRef

The datasets to be checked.

artifact_existencedict [lsst.resources.ResourcePath, bool]

Optional mapping of datastore artifact to existence. Updated by this method with details of all artifacts tested. Can be None if the caller is not interested.

Returns:

existencedict of [DatasetRef, bool]

Mapping from dataset to boolean indicating existence.

needs_expanded_data_ids(transfer: str | None, entity: DatasetRef | DatasetType | StorageClass | None = None) → bool

Test whether this datastore needs expanded data IDs to ingest.

Parameters:

transferstr or None

Transfer mode for ingest.

entity, optional

Object representing what will be ingested. If not provided (or not specific enough), True may be returned even if expanded data IDs aren’t necessary.

Returns:

neededbool

If True, expanded data IDs may be needed. False only if expansion definitely isn’t necessary.

abstract put(inMemoryDataset: Any, datasetRef: DatasetRef) → None

Write a InMemoryDataset with a given DatasetRef to the store.

Parameters:

inMemoryDatasetobject

The Dataset to store.

datasetRefDatasetRef

Reference to the associated Dataset.

abstract remove(datasetRef: DatasetRef) → None

Indicate to the Datastore that a Dataset can be removed.

Parameters:

datasetRefDatasetRef

Reference to the required Dataset.

Raises:

FileNotFoundError

When Dataset does not exist.

Notes

Some Datastores may implement this method as a silent no-op to disable Dataset deletion through standard interfaces.

abstract retrieveArtifacts(refs: Iterable[DatasetRef], destination: ResourcePath, transfer: str = 'auto', preserve_path: bool = True, overwrite: bool = False) → list[ResourcePath]

Retrieve the artifacts associated with the supplied refs.

Parameters:

refsiterable of DatasetRef

The datasets for which artifacts are to be retrieved. A single ref can result in multiple artifacts. The refs must be resolved.

destinationlsst.resources.ResourcePath

Location to write the artifacts.

transferstr, optional

Method to use to transfer the artifacts. Must be one of the options supported by lsst.resources.ResourcePath.transfer_from(). “move” is not allowed.

preserve_pathbool, optional

If True the full path of the artifact within the datastore is preserved. If False the final file component of the path is used.

overwritebool, optional

If True allow transfers to overwrite existing files at the destination.

Returns:

targetslist of lsst.resources.ResourcePath

URIs of file artifacts in destination location. Order is not preserved.

Notes

For non-file datastores the artifacts written to the destination may not match the representation inside the datastore. For example a hierarchichal data structure in a NoSQL database may well be stored as a JSON file.

abstract classmethod setConfigRoot(root: str, config: Config, full: Config, overwrite: bool = True) → None

Set filesystem-dependent config options for this datastore.

The options will be appropriate for a new empty repository with the given root.

Parameters:

rootstr

Filesystem path to the root of the data repository.

configConfig

A Config to update. Only the subset understood by this component will be updated. Will not expand defaults.

fullConfig

A complete config with all defaults expanded that can be converted to a DatastoreConfig. Read-only and will not be modified by this method. Repository-specific options that should not be obtained from defaults when Butler instances are constructed should be copied from full to config.

overwritebool, optional

If False, do not modify a value in config if the value already exists. Default is always to overwrite with the provided root.

Notes

If a keyword is explicitly defined in the supplied config it will not be overridden by this method if overwrite is False. This allows explicit values set in external configs to be retained.

set_retrieve_dataset_type_method(method: Callable[[str], DatasetType | None] | None) → None

Specify a method that can be used by datastore to retrieve registry-defined dataset type.

Parameters:

methodCallable | None

Method that takes a name of the dataset type and returns a corresponding DatasetType instance as defined in Registry. If dataset type name is not known to registry None is returned.

Notes

This method is only needed for a Datastore supporting a “trusted” mode when it does not have an access to datastore records and needs to guess dataset location based on its stored dataset type.

transaction() → Iterator[DatastoreTransaction]

Context manager supporting Datastore transactions.

Transactions can be nested, and are to be used in combination with Registry.transaction.

abstract transfer(inputDatastore: Datastore, datasetRef: DatasetRef) → None

Transfer a dataset from another datastore to this datastore.

Parameters:

inputDatastoreDatastore

The external Datastore from which to retrieve the Dataset.

datasetRefDatasetRef

Reference to the required Dataset.

transfer_from(source_datastore: Datastore, refs: Iterable[DatasetRef], transfer: str = 'auto', artifact_existence: dict[ResourcePath, bool] | None = None) → tuple[set[DatasetRef], set[DatasetRef]]

Transfer dataset artifacts from another datastore to this one.

Parameters:

source_datastoreDatastore

The datastore from which to transfer artifacts. That datastore must be compatible with this datastore receiving the artifacts.

refsiterable of DatasetRef

The datasets to transfer from the source datastore.

transferstr, optional

How (and whether) the dataset should be added to the datastore. Choices include “move”, “copy”, “link”, “symlink”, “relsymlink”, and “hardlink”. “link” is a special transfer mode that will first try to make a hardlink and if that fails a symlink will be used instead. “relsymlink” creates a relative symlink rather than use an absolute path. Most datastores do not support all transfer modes. “auto” (the default) is a special option that will let the data store choose the most natural option for itself. If the source location and transfer location are identical the transfer mode will be ignored.

artifact_existencedict [lsst.resources.ResourcePath, bool]

Optional mapping of datastore artifact to existence. Updated by this method with details of all artifacts tested. Can be None if the caller is not interested.

Returns:

acceptedset [DatasetRef]

The datasets that were transferred.

rejectedset [DatasetRef]

The datasets that were rejected due to a constraints violation.

Raises:

TypeError

Raised if the two datastores are not compatible.

abstract trash(ref: DatasetRef | Iterable[DatasetRef], ignore_errors: bool = True) → None

Indicate to the Datastore that a Dataset can be moved to the trash.

Parameters:

refDatasetRef or iterable thereof

Reference(s) to the required Dataset.

ignore_errorsbool, optional

Determine whether errors should be ignored. When multiple refs are being trashed there will be no per-ref check.

Raises:

FileNotFoundError

When Dataset does not exist and errors are not ignored. Only checked if a single ref is supplied (and not in a list).

Notes

Some Datastores may implement this method as a silent no-op to disable Dataset deletion through standard interfaces.

abstract validateConfiguration(entities: Iterable[DatasetRef | DatasetType | StorageClass], logFailures: bool = False) → None

Validate some of the configuration for this datastore.

Parameters:

entitiesiterable of DatasetRef, DatasetType, or StorageClass

Entities to test against this configuration. Can be differing types.

logFailuresbool, optional

If True, output a log message for every validation error detected.

Raises:

DatastoreValidationError

Raised if there is a validation problem with a configuration.

Notes

Which parts of the configuration are validated is at the discretion of each Datastore implementation.

abstract validateKey(lookupKey: LookupKey, entity: DatasetRef | DatasetType | StorageClass) → None

Validate a specific look up key with supplied entity.

Parameters:

lookupKeyLookupKey

Key to use to retrieve information from the datastore configuration.

entityDatasetRef, DatasetType, or StorageClass

Entity to compare with configuration retrieved using the specified lookup key.

Raises:

DatastoreValidationError

Raised if there is a problem with the combination of entity and lookup key.

Notes

Bypasses the normal selection priorities by allowing a key that would normally not be selected to be validated.