DatasetColumnTag

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

Bases: _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

generate(dataset_type, columns)

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

Attributes Documentation

column: str

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: str

Name of the dataset type (str).

is_key
qualified_name

Methods Documentation

classmethod generate(dataset_type: str, columns: Iterable[str]) list[lsst.daf.butler._column_tags.DatasetColumnTag]

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

Parameters:
dataset_typestr

Name of the dataset type.

columnsIterable [ str ]

Column names.

Returns:
tagslist [ DatasetColumnTag ]

List of column tags.