lsst.dax.apdb.schema_model.Column Class Reference

Public Member Functions
Column	from_felis (cls, felis.datamodel.Column dm_column)
Column	clone (self)

Static Public Attributes
str	name
str	id
DataTypes	datatype
int	length = None
bool	nullable = True
Any	value = None
bool	autoincrement = None
str	description = None
Mapping	annotations = dataclasses.field(default_factory=dict)
Table	table = None

Detailed Description

Column representation in schema.

Definition at line 70 of file schema_model.py.

Member Function Documentation

clone()

Column lsst.dax.apdb.schema_model.Column.clone

(

self

)

Make a clone of self.

Definition at line 133 of file schema_model.py.

    def clone(self) -> Column:
        """Make a clone of self."""
        return dataclasses.replace(self, table=None)
 
 
@dataclasses.dataclass

from_felis()

Column lsst.dax.apdb.schema_model.Column.from_felis	(		cls,
		felis.datamodel.Column	dm_column )

Convert Felis column definition into instance of this class.

Parameters
----------
dm_column : `felis.datamodel.Column`
    Felis column definition.

Returns
-------
column : `Column`
    Converted column definition.

Definition at line 104 of file schema_model.py.

    def from_felis(cls, dm_column: felis.datamodel.Column) -> Column:
        """Convert Felis column definition into instance of this class.
 
        Parameters
        ----------
        dm_column : `felis.datamodel.Column`
            Felis column definition.
 
        Returns
        -------
        column : `Column`
            Converted column definition.
        """
        column = cls(
            name=dm_column.name,
            id=dm_column.id,
            datatype=dm_column.datatype,
            length=dm_column.length,
            value=dm_column.value,
            description=dm_column.description,
            nullable=dm_column.nullable if dm_column.nullable is not None else True,
            autoincrement=dm_column.autoincrement,
            annotations=_strip_keys(
                dict(dm_column),
                ["name", "id", "datatype", "length", "nullable", "value", "autoincrement", "description"],
            ),
        )
        return column
 

Member Data Documentation

annotations

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

static

Definition at line 97 of file schema_model.py.

autoincrement

bool lsst.dax.apdb.schema_model.Column.autoincrement = None

static

Definition at line 91 of file schema_model.py.

datatype

DataTypes lsst.dax.apdb.schema_model.Column.datatype

static

Definition at line 79 of file schema_model.py.

description

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

static

Definition at line 94 of file schema_model.py.

id

str lsst.dax.apdb.schema_model.Column.id

static

Definition at line 76 of file schema_model.py.

length

int lsst.dax.apdb.schema_model.Column.length = None

static

Definition at line 82 of file schema_model.py.

name

str lsst.dax.apdb.schema_model.Column.name

static

Definition at line 73 of file schema_model.py.

nullable

bool lsst.dax.apdb.schema_model.Column.nullable = True

static

Definition at line 85 of file schema_model.py.

table

Table lsst.dax.apdb.schema_model.Column.table = None

static

Definition at line 100 of file schema_model.py.

value

Any lsst.dax.apdb.schema_model.Column.value = None

static

Definition at line 88 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/g1afd7665f7+eb25d4c773/python/lsst/dax/apdb/schema_model.py