ObsCoreTableManager

class lsst.daf.butler.registry.interfaces.ObsCoreTableManager

Bases: VersionedExtension

An interface for populating ObsCore tables(s).

Methods Summary

add_datasets(refs, context)	Possibly add datasets to the obscore table.
associate(refs, collection, context)	Possibly add datasets to the obscore table.
config_json()	Dump configuration in JSON format.
currentVersion()	Return extension version as defined by current implementation.
disassociate(refs, collection)	Possibly remove datasets from the obscore table.
extensionName()	Return full name of the extension.
initialize(db, context, *, universe, config, ...)	Construct an instance of the manager.
query(**kwargs)	Run a SELECT query against obscore table and return result rows.
schemaDigest()	Return digest for schema piece managed by this extension.
update_exposure_regions(instrument, region_data)	Update existing exposure records with spatial region data.

Methods Documentation

abstract add_datasets(refs: Iterable[DatasetRef], context: SqlQueryContext) → int

Possibly add datasets to the obscore table.

This method should be called when new datasets are added to a RUN collection.

Parameters:

refsiterable [ DatasetRef ]

Dataset refs to add. Dataset refs have to be completely expanded. If a record with the same dataset ID is already in obscore table, the dataset is ignored.

contextSqlQueryContext

Context used to execute queries for additional dimension metadata.

Returns:

countint

Actual number of records inserted into obscore table.

Notes

Dataset data types and collection names are checked against configured list of collections and dataset types, non-matching datasets are ignored and not added to the obscore table.

When configuration parameter collection_type is not “RUN”, this method should return immediately.

Note that there is no matching method to remove datasets from obscore table, we assume that removal happens via foreign key constraint to dataset table with “ON DELETE CASCADE” option.

abstract associate(refs: Iterable[DatasetRef], collection: CollectionRecord, context: SqlQueryContext) → int

Possibly add datasets to the obscore table.

This method should be called when existing datasets are associated with a TAGGED collection.

Parameters:

refsiterable [ DatasetRef ]

Dataset refs to add. Dataset refs have to be completely expanded. If a record with the same dataset ID is already in obscore table, the dataset is ignored.

collectionCollectionRecord

Collection record for a TAGGED collection.

contextSqlQueryContext

Context used to execute queries for additional dimension metadata.

Returns:

countint

Actual number of records inserted into obscore table.

Notes

Dataset data types and collection names are checked against configured list of collections and dataset types, non-matching datasets are ignored and not added to the obscore table.

When configuration parameter collection_type is not “TAGGED”, this method should return immediately.

abstract config_json() → str

Dump configuration in JSON format.

Returns:

jsonstr

Configuration serialized in JSON format.

abstract classmethod currentVersion() → VersionTuple | None

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:

versionVersionTuple

Current extension version or None.

abstract disassociate(refs: Iterable[DatasetRef], collection: CollectionRecord) → int

Possibly remove datasets from the obscore table.

This method should be called when datasets are disassociated from a TAGGED collection.

Parameters:

refsiterable [ DatasetRef ]

Dataset refs to remove. Dataset refs have to be resolved.

collectionCollectionRecord

Collection record for a TAGGED collection.

Returns:

countint

Actual number of records removed from obscore table.

Notes

Dataset data types and collection names are checked against configured list of collections and dataset types, non-matching datasets are ignored and not added to the obscore table.

When configuration parameter collection_type is not “TAGGED”, this method should return immediately.

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:

namestr

Full extension name.

abstract classmethod initialize(db: Database, context: StaticTablesContext, *, universe: DimensionUniverse, config: Mapping, datasets: Type[DatasetRecordStorageManager], dimensions: DimensionRecordStorageManager) → ObsCoreTableManager

Construct an instance of the manager.

Parameters:

dbDatabase

Interface to the underlying database engine and namespace.

contextStaticTablesContext

Context object obtained from Database.declareStaticTables; used to declare any tables that should always be present in a layer implemented with this manager.

universeDimensionUniverse

All dimensions known to the registry.

configdict [ str, Any ]

Configuration of the obscore manager.

datasetstype

Type of dataset manager.

dimensions: `DimensionRecordStorageManager`

Manager for Registry dimensions.

Returns:

managerObsCoreTableManager

An instance of a concrete ObsCoreTableManager subclass.

abstract query(**kwargs: Any) → Iterator[CursorResult]

Run a SELECT query against obscore table and return result rows.

Parameters:

**kwargs

Restriction on values of individual obscore columns. Key is the column name, value is the required value of the column. Multiple restrictions are ANDed together.

Returns:

result_contextsqlalchemy.engine.CursorResult

Context manager that returns the query result object when entered. These results are invalidated when the context is exited.

Notes

This method is intended mostly for tests that need to check the contents of obscore table.

abstract schemaDigest() → str | None

Return digest for schema piece managed by this extension.

Returns:

digeststr or None

String representation of the digest of the schema, None should be returned if schema digest is not to be saved or checked. The length of the returned string cannot exceed the length of the “value” column of butler attributes table, currently 65535 characters.

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.

abstract update_exposure_regions(instrument: str, region_data: Iterable[tuple[int, int, Region]]) → int

Update existing exposure records with spatial region data.

Parameters:

instrumentstr

Instrument name.

region_dataIterable`[`tuple`[`int, int, Region]]

Sequence of tuples, each tuple contains three values - exposure ID, detector ID, and corresponding region.

Returns:

countint

Actual number of records updated.

Notes

This method is needed to update obscore records for raw exposures which are ingested before their corresponding visits are defined. Exposure records added when visit is already defined will get their regions from their matching visits automatically.