DatabaseDimensionCombination¶

class lsst.daf.butler.DatabaseDimensionCombination(name: str, storage: dict, *, required: NamedValueAbstractSet[Dimension], implied: NamedValueAbstractSet[Dimension], metadata_columns: NamedValueAbstractSet[IntColumnSpec | StringColumnSpec | FloatColumnSpec | HashColumnSpec | BoolColumnSpec], alwaysJoin: bool, populated_by: Dimension | None, doc: str)¶

Bases: DimensionCombination, DatabaseDimensionElement

A combination class that maps directly to a database table or query.

Parameters:

namestr: Name of the dimension.
storagedict: Fully qualified name of the DatabaseDimensionRecordStorage subclass that will back this element in the registry (in a “cls” key) along with any other construction keyword arguments (in other keys).
requiredNamedValueAbstractSet [ Dimension ]: Dimensions whose keys define the compound primary key for this combinations’s (logical) table, as well as references to their own tables.
impliedNamedValueAbstractSet [ Dimension ]: Dimensions whose keys are included in this combinations’s (logical) table as foreign keys.
metadata_columnsNamedValueAbstractSet [ MetadataColumnSpec ]: Field specifications for all non-key fields in this combination’s table.
alwaysJoinbool, optional: If True, always include this element in any query or data ID in which its required dimensions appear, because it defines a relationship between those dimensions that must always be satisfied.
populated_byDimension or None: The dimension that this element’s records are always inserted, exported, and imported alongside.
docstr: Extended description of this element.

Notes

DatabaseDimensionCombination objects may belong to a TopologicalFamily, but it is the responsibility of DatabaseTopologicalFamilyConstructionVisitor to update the topology attribute of their members.

This class has a lot in common with DatabaseDimension, but they are expected to diverge in future changes, and the only way to make them share method implementations would be via multiple inheritance. Given the trivial nature of all of those implementations, this does not seem worth the drawbacks (particularly the constraints it imposes on constructor signatures).

Attributes Summary

`RecordClass`	Return the record subclass for this element.
`alternate_keys`	Additional unique key fields for this dimension element that are not the primary key (`NamedValueAbstractSet` of `KeyColumnSpec`).
`alwaysJoin`	Indicate if the element should always be included.
`defines_relationships`	Whether this element's records define one or more relationships that must be satisfied in rows over dimensions that include it.
`dimensions`	Return all dimensions.
`documentation`	Extended description of this dimension element.
`governor`	Return the governor dimension.
`graph`	Return minimal graph that includes this element (`DimensionGraph`).
`has_own_table`	Whether this element should have its own table in the database.
`implied`	Return the implied dimensions.
`implied_union_target`	If not `None`, the name of an element whose implied values for this element form the set of allowable values.
`is_cached`	Whether this element's records should be aggressively cached, because they are small in number and rarely inserted.
`metadata`	Additional metadata fields included in this element's table.
`metadata_columns`	Additional metadata fields included in this element's table.
`minimal_group`	Return minimal dimension group that includes this element.
`name`	Return unique string identifier for this endpoint (`str`).
`populated_by`	The dimension that this element's records are always inserted, exported, and imported alongside.
`required`	Return the required dimensions.
`schema`	A description of the columns in this element's records and (at least conceptual) table.
`spatial`	Return this endpoint's `SPATIAL` family.
`temporal`	Return this endpoint's `TEMPORAL` family.
`topology`	Return the relationship families to which this endpoint belongs.
`viewOf`	Name of another table this element's records are drawn from.

Methods Summary

`from_json`(json_str[, universe, registry])	Return new class from JSON string.
`from_simple`(simple[, universe, registry])	Construct a new object from the simplified form.
`hasTable`()	Indicate if this element is associated with a table.
`to_json`([minimal])	Convert this class to JSON form.
`to_simple`([minimal])	Convert this class to a simple python type.

Attributes Documentation

RecordClass¶

Return the record subclass for this element.

The DimensionRecord subclass used to hold records for this element (type).

Because DimensionRecord subclasses are generated dynamically, this type cannot be imported directly and hence can only be obtained from this attribute.

alternate_keys¶

Additional unique key fields for this dimension element that are not the primary key (NamedValueAbstractSet of KeyColumnSpec).

This is always empty for elements that are not dimensions.

If this dimension has required dependencies, the keys of those dimensions are also included in the unique constraints defined for these alternate keys.

alwaysJoin¶

defines_relationships¶

dimensions¶

Return all dimensions.

The union of required and implied, with all elements in required before any elements in implied.

This differs from self.graph.dimensions both in order and in content:

as in self.implied, implied dimensions are not expanded recursively here;
implied dimensions appear after required dimensions here, instead of being topologically ordered.

As a result, this set is ordered consistently with self.RecordClass.fields.

documentation¶

governor¶

Return the governor dimension.

This is the GovernorDimension that is a required dependency of this element, or None if there is no such dimension (GovernorDimension or None).

graph¶

Return minimal graph that includes this element (DimensionGraph).

self.graph.required includes all dimensions whose primary key values are sufficient (often necessary) to uniquely identify self (including self if isinstance(self, Dimension). self.graph.implied includes all dimensions also identified (possibly recursively) by this set.

has_own_table¶: Whether this element should have its own table in the database.

implied¶

implied_union_target¶

is_cached¶

metadata¶

Additional metadata fields included in this element’s table.

(NamedValueSet of FieldSpec).

metadata_columns¶

minimal_group¶

Return minimal dimension group that includes this element.

self.minimal_group.required includes all dimensions whose primary key values are sufficient (often necessary) to uniquely identify self (including self if isinstance(self, Dimension). self.minimal_group.implied includes all dimensions also identified (possibly recursively) by this set.

name¶

populated_by¶

required¶

schema¶: A description of the columns in this element’s records and (at least conceptual) table.

spatial¶

temporal¶

topology¶

viewOf¶

Name of another table this element’s records are drawn from.

(str or None).

Methods Documentation

classmethod from_json(json_str: str, universe: DimensionUniverse | None = None, registry: Registry | None = None) → SupportsSimple¶

Return new class from JSON string.

Converts a JSON string created by to_json and return something of the supplied class.

Parameters:

json_strstr: Representation of the dimensions in JSON format as created by to_json().
universeDimensionUniverse, optional: The special graph of all known dimensions. Passed directly to from_simple().
registrylsst.daf.butler.Registry, optional: Registry to use to convert simple name of a DatasetType to a full DatasetType. Passed directly to from_simple().

Returns:

constructedAny: Newly-constructed object.

classmethod from_simple(simple: str, universe: DimensionUniverse | None = None, registry: Registry | None = None) → DimensionElement¶

Construct a new object from the simplified form.

Usually the data is returned from the to_simple method.

Parameters:

simplestr: The value returned by to_simple().
universeDimensionUniverse: The special graph of all known dimensions.
registrylsst.daf.butler.Registry, optional: Registry from which a universe can be extracted. Can be None if universe is provided explicitly.

Returns:

dataIdDimensionElement: Newly-constructed object.

hasTable() → bool¶

Indicate if this element is associated with a table.

Return True if this element is associated with a table (even if that table “belongs” to another element).

to_json(minimal: bool = False) → str¶

Convert this class to JSON form.

The class type is not recorded in the JSON so the JSON decoder must know which class is represented.

Parameters:

minimalbool, optional: Use minimal serialization. Requires Registry to convert back to a full type.

Returns:

jsonstr: The class in JSON string format.

to_simple(minimal: bool = False) → str¶

Convert this class to a simple python type.

This is suitable for serialization.

Parameters:

minimalbool, optional: Use minimal serialization. Has no effect on for this class.

Returns:

simplestr: The object converted to a single string.

Navigation

DatabaseDimensionCombination¶