DatabaseDimensionElement

class lsst.daf.butler.DatabaseDimensionElement(name: str, *, implied: NamedValueAbstractSet[Dimension], metadata_columns: NamedValueAbstractSet[IntColumnSpec | StringColumnSpec | FloatColumnSpec | HashColumnSpec | BoolColumnSpec], is_cached: bool, doc: str)

Bases: DimensionElement

An intermediate base class for DimensionElement database classes.

Instances of these element classes map directly to a database table or query.

Parameters:
namestr

Name of the dimension.

impliedNamedValueAbstractSet [ Dimension ]

Other dimensions whose keys are included in this dimension’s (logical) table as foreign keys.

metadata_columnsNamedValueAbstractSet [ MetadataColumnSpec ]

Field specifications for all non-key fields in this dimension’s table.

is_cachedbool

Whether this element’s records should be persistently cached in the client.

docstr

Extended description of this element.

Attributes Summary

documentation

Extended description of this dimension element.

implied

Return the implied dimensions.

is_cached

Whether this element's records should be aggressively cached, because they are small in number and rarely inserted.

metadata_columns

Additional metadata fields included in this element's table.

name

Return unique string identifier for this endpoint (str).

spatial

Return this endpoint's SPATIAL family.

temporal

Return this endpoint's TEMPORAL family.

topology

Return the relationship families to which this endpoint belongs.

Attributes Documentation

documentation
implied
is_cached
metadata_columns
name
spatial
temporal
topology