lsst.dax.apdb.schema_model.Schema Class Reference

Public Member Functions
Schema	from_felis (cls, felis.datamodel.Schema dm_schema)

Static Public Attributes
str	name
str	id
list	tables [Table]
felis	version = None
str	description = None
Mapping	annotations = dataclasses.field(default_factory=dict)

Detailed Description

Complete schema description, collection of tables.

Definition at line 408 of file schema_model.py.

Member Function Documentation

from_felis()

Schema lsst.dax.apdb.schema_model.Schema.from_felis	(		cls,
		felis.datamodel.Schema	dm_schema )

Convert felis schema definition to instance of this class.

Parameters
----------
dm_schema : `felis.datamodel.Schema`
    Felis schema definition.

Returns
-------
schema : `Schema`
    Converted schema definition.

Definition at line 430 of file schema_model.py.

    def from_felis(cls, dm_schema: felis.datamodel.Schema) -> Schema:
        """Convert felis schema definition to instance of this class.
 
        Parameters
        ----------
        dm_schema : `felis.datamodel.Schema`
            Felis schema definition.
 
        Returns
        -------
        schema : `Schema`
            Converted schema definition.
        """
        # Convert all columns first.
        columns: MutableMapping[str, Column] = {}
        for dm_table in dm_schema.tables:
            for dm_column in dm_table.columns:
                column = Column.from_felis(dm_column)
                columns[column.id] = column
 
        tables = [Table.from_felis(dm_table, columns) for dm_table in dm_schema.tables]
 
        version: felis.datamodel.SchemaVersion | None
        if isinstance(dm_schema.version, str):
            version = felis.datamodel.SchemaVersion(current=dm_schema.version)
        else:
            version = dm_schema.version
 
        schema = cls(
            name=dm_schema.name,
            id=dm_schema.id,
            tables=tables,
            version=version,
            description=dm_schema.description,
            annotations=_strip_keys(dict(dm_schema), ["name", "id", "tables", "description"]),
        )
        return schema

Member Data Documentation

annotations

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

static

Definition at line 426 of file schema_model.py.

description

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

static

Definition at line 423 of file schema_model.py.

id

str lsst.dax.apdb.schema_model.Schema.id

static

Definition at line 414 of file schema_model.py.

name

str lsst.dax.apdb.schema_model.Schema.name

static

Definition at line 411 of file schema_model.py.

tables

list lsst.dax.apdb.schema_model.Schema.tables [Table]

static

Definition at line 417 of file schema_model.py.

version

felis lsst.dax.apdb.schema_model.Schema.version = None

static

Definition at line 420 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/g88963caddf+0cb8e002cc/python/lsst/dax/apdb/schema_model.py