lsst.dax.apdb.schema_model.Constraint Class Reference

Inheritance diagram for lsst.dax.apdb.schema_model.Constraint:

Public Member Functions
Constraint	from_felis (cls, felis.datamodel.Constraint dm_constr, Mapping[str, Column] columns)

Static Public Attributes
str	name | None
str	id
bool	deferrable = False
str	initially = None
str	description = None
Mapping	annotations = dataclasses.field(default_factory=dict)

Detailed Description

Constraint description, this is a base class, actual constraints will be
instances of one of the subclasses.

Definition at line 191 of file schema_model.py.

Member Function Documentation

from_felis()

Constraint lsst.dax.apdb.schema_model.Constraint.from_felis	(		cls,
		felis.datamodel.Constraint	dm_constr,
		Mapping[str, Column]	columns )

Convert Felis constraint definition into instance of this class.

Parameters
----------
dm_const : `felis.datamodel.Constraint`
    Felis constraint definition.
columns : `~collections.abc.Mapping` [`str`, `Column`]
    Mapping of column ID to `Column` instance.

Returns
-------
constraint : `Constraint`
    Converted constraint definition.

Definition at line 215 of file schema_model.py.

    def from_felis(cls, dm_constr: felis.datamodel.Constraint, columns: Mapping[str, Column]) -> Constraint:
        """Convert Felis constraint definition into instance of this class.
 
        Parameters
        ----------
        dm_const : `felis.datamodel.Constraint`
            Felis constraint definition.
        columns : `~collections.abc.Mapping` [`str`, `Column`]
            Mapping of column ID to `Column` instance.
 
        Returns
        -------
        constraint : `Constraint`
            Converted constraint definition.
        """
        if isinstance(dm_constr, felis.datamodel.UniqueConstraint):
            return UniqueConstraint(
                name=dm_constr.name,
                id=dm_constr.id,
                columns=[columns[c] for c in dm_constr.columns],
                deferrable=dm_constr.deferrable,
                initially=dm_constr.initially,
                description=dm_constr.description,
                annotations=_strip_keys(
                    dict(dm_constr),
                    ["name", "type", "id", "columns", "deferrable", "initially", "description"],
                ),
            )
        elif isinstance(dm_constr, felis.datamodel.ForeignKeyConstraint):
            return ForeignKeyConstraint(
                name=dm_constr.name,
                id=dm_constr.id,
                columns=[columns[c] for c in dm_constr.columns],
                referenced_columns=[columns[c] for c in dm_constr.referenced_columns],
                deferrable=dm_constr.deferrable,
                initially=dm_constr.initially,
                description=dm_constr.description,
                annotations=_strip_keys(
                    dict(dm_constr),
                    [
                        "name",
                        "id",
                        "type",
                        "columns",
                        "deferrable",
                        "initially",
                        "referenced_columns",
                        "description",
                    ],
                ),
            )
        elif isinstance(dm_constr, felis.datamodel.CheckConstraint):
            return CheckConstraint(
                name=dm_constr.name,
                id=dm_constr.id,
                expression=dm_constr.expression,
                deferrable=dm_constr.deferrable,
                initially=dm_constr.initially,
                description=dm_constr.description,
                annotations=_strip_keys(
                    dict(dm_constr),
                    ["name", "id", "type", "expression", "deferrable", "initially", "description"],
                ),
            )
        else:
            raise TypeError(f"Unexpected constraint type: {dm_constr.type}")
 
 
@dataclasses.dataclass

Member Data Documentation

annotations

Mapping lsst.dax.apdb.schema_model.Constraint.annotations = dataclasses.field(default_factory=dict)

static

Definition at line 211 of file schema_model.py.

deferrable

bool lsst.dax.apdb.schema_model.Constraint.deferrable = False

static

Definition at line 202 of file schema_model.py.

description

str lsst.dax.apdb.schema_model.Constraint.description = None

static

Definition at line 208 of file schema_model.py.

id

str lsst.dax.apdb.schema_model.Constraint.id

static

Definition at line 199 of file schema_model.py.

initially

str lsst.dax.apdb.schema_model.Constraint.initially = None

static

Definition at line 205 of file schema_model.py.

name

str lsst.dax.apdb.schema_model.Constraint.name | None

static

Definition at line 196 of file schema_model.py.

---

The documentation for this class was generated from the following file:

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-8.0.0/Linux64/dax_apdb/g0e03ccb3e3+1224bbe97e/python/lsst/dax/apdb/schema_model.py