CollectionRecord

class lsst.daf.butler.registry.interfaces.CollectionRecord(key: _Key, name: str, type: CollectionType)

Bases: Generic[_Key]

A struct used to represent a collection in internal Registry APIs.

User-facing code should always just use a str to represent collections.

Parameters:

key

Unique collection ID, can be the same as name if name is used for identification. Usually this is an integer or string, but can be other database-specific type.

namestr

Name of the collection.

typeCollectionType

Enumeration value describing the type of the collection.

Notes

The name, key, and type attributes set by the base class should be considered immutable by all users and derived classes (as these are used in the definition of equality and this is a hashable type). Other attributes defined by subclasses may be mutable, as long as they do not participate in some subclass equality definition.