lsst.dax.apdb.schema_model.Index Class Reference

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

Static Public Attributes
str	name
str	id
list	columns = dataclasses.field(default_factory=list)
list	expressions = dataclasses.field(default_factory=list)
str	description = None
Mapping	annotations = dataclasses.field(default_factory=dict)

Detailed Description

Index representation.

Definition at line 139 of file schema_model.py.

Member Function Documentation

from_felis()

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

Convert Felis index definition into instance of this class.

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

Returns
-------
index : `Index`
    Converted index definition.

Definition at line 165 of file schema_model.py.

    def from_felis(cls, dm_index: felis.datamodel.Index, columns: Mapping[str, Column]) -> Index:
        """Convert Felis index definition into instance of this class.
 
        Parameters
        ----------
        dm_index : `felis.datamodel.Index`
            Felis index definition.
        columns : `~collections.abc.Mapping` [`str`, `Column`]
            Mapping of column ID to `Column` instance.
 
        Returns
        -------
        index : `Index`
            Converted index definition.
        """
        return cls(
            name=dm_index.name,
            id=dm_index.id,
            columns=[columns[c] for c in (dm_index.columns or [])],
            expressions=dm_index.expressions or [],
            description=dm_index.description,
            annotations=_strip_keys(dict(dm_index), ["name", "id", "columns", "expressions", "description"]),
        )
 
 
@dataclasses.dataclass

Member Data Documentation

annotations

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

static

Definition at line 161 of file schema_model.py.

columns

list lsst.dax.apdb.schema_model.Index.columns = dataclasses.field(default_factory=list)

static

Definition at line 148 of file schema_model.py.

description

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

static

Definition at line 158 of file schema_model.py.

expressions

list lsst.dax.apdb.schema_model.Index.expressions = dataclasses.field(default_factory=list)

static

Definition at line 153 of file schema_model.py.

id

str lsst.dax.apdb.schema_model.Index.id

static

Definition at line 145 of file schema_model.py.

name

str lsst.dax.apdb.schema_model.Index.name

static

Definition at line 142 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/g295015adf3+81dd352a9d/python/lsst/dax/apdb/schema_model.py