DatabaseDimensionOverlapStorage

class lsst.daf.butler.registry.interfaces.DatabaseDimensionOverlapStorage

Bases: ABC

A base class for objects that manage overlaps between a pair of database-backed dimensions.

Attributes Summary

elements

The pair of elements whose overlaps this object manages.

Methods Summary

digestTables()	Return tables used for schema digest.
initialize(db, elementStorage, governorStorage)	Construct an instance of this class using a standardized interface.

Attributes Documentation

elements

The pair of elements whose overlaps this object manages.

The order of elements is the same as their ordering within the DimensionUniverse.

Methods Documentation

abstract digestTables() → Iterable[Table]

Return tables used for schema digest.

Returns:

tablesIterable [ sqlalchemy.schema.Table ]

Possibly empty set of tables for schema digest calculations.

abstract classmethod initialize(db: Database, elementStorage: tuple[DatabaseDimensionRecordStorage, DatabaseDimensionRecordStorage], governorStorage: tuple[GovernorDimensionRecordStorage, GovernorDimensionRecordStorage], context: StaticTablesContext | None = None) → DatabaseDimensionOverlapStorage

Construct an instance of this class using a standardized interface.

Parameters:

dbDatabase

Interface to the underlying database engine and namespace.

elementStoragetuple [ DatabaseDimensionRecordStorage ]

Storage objects for the elements this object will related.

governorStoragetuple [ GovernorDimensionRecordStorage ]

Storage objects for the governor dimensions of the elements this object will related.

contextStaticTablesContext, optional

If provided, an object to use to create any new tables. If not provided, db.ensureTableExists should be used instead.

Returns:

storageDatabaseDimensionOverlapStorage

A new DatabaseDimensionOverlapStorage subclass instance.