DatasetColumnTag

class lsst.daf.butler.DatasetColumnTag(dataset_type: str, column: str)

Bases: lsst.daf.butler.core._column_tags._BaseColumnTag

An identifier for Relation columns that represent columns from a dataset query or subquery.

Attributes Summary

column Name of the column (str).
dataset_type Name of the dataset type (str).
is_key
qualified_name

Methods Summary

filter_from(tags)
generate(dataset_type, columns) Return a list of column tags from an iterable of column names for a single dataset type.

Attributes Documentation

column

Name of the column (str).

Allowed values are:

  • “dataset_id” (autoincrement or UUID primary key)
  • “run” (collection primary key, not collection name)
  • “ingest_date”
  • “timespan” (validity range, or NULL for non-calibration collections)
  • “rank” (collection position in ordered search)
dataset_type

Name of the dataset type (str).

is_key
qualified_name

Methods Documentation

classmethod filter_from(tags: collections.abc.Iterable[Any]) → set
classmethod generate(dataset_type: str, columns: collections.abc.Iterable[str]) → list

Return a list of column tags from an iterable of column names for a single dataset type.

Parameters:
dataset_type : str

Name of the dataset type.

columns : Iterable [ str ]

Column names.

Returns:
tags : list [ DatasetColumnTag ]

List of column tags.