DatasetRecordStorageManager¶
-
class
lsst.daf.butler.registry.interfaces.
DatasetRecordStorageManager
¶ Bases:
lsst.daf.butler.registry.interfaces.VersionedExtension
An interface that manages the tables that describe datasets.
DatasetRecordStorageManager
primarily serves as a container and factory forDatasetRecordStorage
instances, which each provide access to the records for a differentDatasetType
.Methods Summary
addDatasetForeignKey
(tableSpec, *, name, …)Add a foreign key (field and constraint) referencing the dataset table. currentVersion
()Return extension version as defined by current implementation. extensionName
()Return full name of the extension. find
(name)Return an object that provides access to the records associated with the given DatasetType
name, if one exists.getCollectionSummary
(collection)Return a summary for the given collection. getDatasetRef
(id)Return a DatasetRef
for the given dataset primary key value.initialize
(db, context, *, collections, …)Construct an instance of the manager. refresh
()Ensure all other operations on this manager are aware of any dataset types that may have been registered by other clients since it was initialized or last refreshed. register
(datasetType)Ensure that this Registry
can hold records for the givenDatasetType
, creating new tables as necessary.remove
(name)Remove the dataset type. schemaDigest
()Return digest for schema piece managed by this extension. Methods Documentation
-
classmethod
addDatasetForeignKey
(tableSpec: lsst.daf.butler.core.ddl.TableSpec, *, name: str = 'dataset', constraint: bool = True, onDelete: Optional[str] = None, **kwargs) → lsst.daf.butler.core.ddl.FieldSpec¶ Add a foreign key (field and constraint) referencing the dataset table.
Parameters: - tableSpec :
ddl.TableSpec
Specification for the table that should reference the dataset table. Will be modified in place.
- name: `str`, optional
A name to use for the prefix of the new field; the full name is
{name}_id
.- onDelete: `str`, optional
One of “CASCADE” or “SET NULL”, indicating what should happen to the referencing row if the collection row is deleted.
None
indicates that this should be an integrity error.- constraint: `bool`, optional
If
False
(True
is default), add a field that can be joined to the dataset primary key, but do not add a foreign key constraint.- **kwargs
Additional keyword arguments are forwarded to the
ddl.FieldSpec
constructor (only thename
anddtype
arguments are otherwise provided).
Returns: - idSpec :
ddl.FieldSpec
Specification for the ID field.
- tableSpec :
-
classmethod
currentVersion
() → Optional[lsst.daf.butler.registry.interfaces._versioning.VersionTuple]¶ Return extension version as defined by current implementation.
This method can return
None
if an extension does not require its version to be saved or checked.Returns: - version :
VersionTuple
Current extension version or
None
.
- version :
-
classmethod
extensionName
() → str¶ Return full name of the extension.
This name should match the name defined in registry configuration. It is also stored in registry attributes. Default implementation returns full class name.
Returns: - name :
str
Full extension name.
- name :
-
find
(name: str) → Optional[lsst.daf.butler.registry.interfaces._datasets.DatasetRecordStorage]¶ Return an object that provides access to the records associated with the given
DatasetType
name, if one exists.Parameters: - name :
str
Name of the dataset type.
Returns: - records :
DatasetRecordStorage
orNone
The object representing the records for the given dataset type, or
None
if there are no records for that dataset type.
Notes
Dataset types registered by another client of the same repository since the last call to
initialize
orrefresh
may not be found.- name :
-
getCollectionSummary
(collection: CollectionRecord) → CollectionSummary¶ Return a summary for the given collection.
Parameters: - collection :
CollectionRecord
Record describing the collection for which a summary is to be retrieved.
Returns: - summary :
CollectionSummary
Summary of the dataset types and governor dimension values in this collection.
- collection :
-
getDatasetRef
(id: int) → Optional[lsst.daf.butler.core.datasets.ref.DatasetRef]¶ Return a
DatasetRef
for the given dataset primary key value.Parameters: - id :
int
Autoincrement primary key value for the dataset.
Returns: - id :
-
classmethod
initialize
(db: Database, context: StaticTablesContext, *, collections: CollectionManager, dimensions: DimensionRecordStorageManager) → DatasetRecordStorageManager¶ Construct an instance of the manager.
Parameters: - db :
Database
Interface to the underlying database engine and namespace.
- context :
StaticTablesContext
Context object obtained from
Database.declareStaticTables
; used to declare any tables that should always be present.- collections: `CollectionManager`
Manager object for the collections in this
Registry
.- dimensions :
DimensionRecordStorageManager
Manager object for the dimensions in this
Registry
.
Returns: - manager :
DatasetRecordStorageManager
An instance of a concrete
DatasetRecordStorageManager
subclass.
- db :
-
refresh
() → None¶ Ensure all other operations on this manager are aware of any dataset types that may have been registered by other clients since it was initialized or last refreshed.
-
register
(datasetType: lsst.daf.butler.core.datasets.type.DatasetType) → Tuple[lsst.daf.butler.registry.interfaces._datasets.DatasetRecordStorage, bool]¶ Ensure that this
Registry
can hold records for the givenDatasetType
, creating new tables as necessary.Parameters: - datasetType :
DatasetType
Dataset type for which a table should created (as necessary) and an associated
DatasetRecordStorage
returned.
Returns: - records :
DatasetRecordStorage
The object representing the records for the given dataset type.
- inserted :
bool
True
if the dataset type did not exist in the registry before.
Notes
This operation may not be invoked within a
Database.transaction
context.- datasetType :
-
schemaDigest
() → Optional[str]¶ Return digest for schema piece managed by this extension.
Returns: Notes
There is no exact definition of digest format, any string should work. The only requirement for string contents is that it has to remain stable over time if schema does not change but it should produce different string for any change in the schema. In many cases default implementation in
_defaultSchemaDigest
can be used as a reasonable choice.
-
classmethod