Inheritance diagram for lsst.dax.apdb.apdbSchema.ApdbSchema:

Public Member Functions
	__init__ (self, str schema_file, str schema_name="ApdbSchema")

type\|str	column_dtype (self, felis.datamodel.DataType\|ExtraDataTypes felis_type)

VersionTuple	schemaVersion (self)

Public Attributes
	tableSchemas

Protected Member Functions
tuple[Mapping[ApdbTables, Table], VersionTuple\|None]	_buildSchemas (cls, str schema_file, str schema_name="ApdbSchema")

Protected Attributes
	_schemaVersion

Detailed Description

Class for management of APDB schema.

Attributes
----------
tableSchemas : `dict`
    Maps table name to `TableDef` instance.

Parameters
----------
schema_file : `str`
    Name of the YAML schema file.
schema_name : `str`, optional
    Name of the schema in YAML files.

Definition at line 99 of file apdbSchema.py.

Constructor & Destructor Documentation

◆ init()

lsst.dax.apdb.apdbSchema.ApdbSchema.__init__	(		self,
		str	schema_file,
		str	schema_name = "ApdbSchema" )

Reimplemented in lsst.dax.apdb.cassandra.apdbCassandraSchema.ApdbCassandraSchema, and lsst.dax.apdb.sql.apdbSqlSchema.ApdbSqlSchema.

Definition at line 115 of file apdbSchema.py.

    ):
        # build complete table schema
        self.tableSchemas, self._schemaVersion = self._buildSchemas(schema_file, schema_name)
 

Member Function Documentation

◆ _buildSchemas()

tuple[Mapping[ApdbTables, Table], VersionTuple \| None] lsst.dax.apdb.apdbSchema.ApdbSchema._buildSchemas	(		cls,
		str	schema_file,
		str	schema_name = "ApdbSchema" )

protected

Create schema definitions for all tables.

Reads YAML schema and builds a dictionary containing
`.schema_model.Table` instances for each table.

Parameters
----------
schema_file : `str`
    Name of YAML file with ``felis`` schema.
schema_name : `str`, optional
    Name of the schema in YAML files.

Returns
-------
tables : `dict`
    Mapping of table names to `.schema_model.Table` instances.
version : `VersionTuple` or `None`
    Schema version defined in schema file, `None` if version is not
    defined.

Definition at line 161 of file apdbSchema.py.

    ) -> tuple[Mapping[ApdbTables, Table], VersionTuple | None]:
        """Create schema definitions for all tables.
 
        Reads YAML schema and builds a dictionary containing
        `.schema_model.Table` instances for each table.
 
        Parameters
        ----------
        schema_file : `str`
            Name of YAML file with ``felis`` schema.
        schema_name : `str`, optional
            Name of the schema in YAML files.
 
        Returns
        -------
        tables : `dict`
            Mapping of table names to `.schema_model.Table` instances.
        version : `VersionTuple` or `None`
            Schema version defined in schema file, `None` if version is not
            defined.
        """
        schema_file = os.path.expandvars(schema_file)
        with open(schema_file) as yaml_stream:
            schemas_list = list(yaml.load_all(yaml_stream, Loader=yaml.SafeLoader))
            schemas_list = [schema for schema in schemas_list if schema.get("name") == schema_name]
            if not schemas_list:
                raise ValueError(f"Schema file {schema_file!r} does not define schema {schema_name!r}")
            elif len(schemas_list) > 1:
                raise ValueError(f"Schema file {schema_file!r} defines multiple schemas {schema_name!r}")
            felis_schema = felis.datamodel.Schema.model_validate(schemas_list[0])
            schema = Schema.from_felis(felis_schema)
 
        # convert all dicts into classes
        tables: MutableMapping[ApdbTables, Table] = {}
        for table in schema.tables:
            try:
                table_enum = ApdbTables(table.name)
            except ValueError:
                # There may be other tables in the schema that do not belong
                # to APDB.
                continue
            else:
                tables[table_enum] = table
 
        version: VersionTuple | None = None
        if schema.version is not None:
            version = VersionTuple.fromString(schema.version.current)
 
        return tables, version

◆ column_dtype()

type \| str lsst.dax.apdb.apdbSchema.ApdbSchema.column_dtype	(		self,
		felis.datamodel.DataType \| ExtraDataTypes	felis_type )

Return Pandas data type for a given Felis column type.

Parameters
----------
felis_type : `felis.datamodel.DataType`
    Felis type, on of the enums defined in `felis.datamodel` module.

Returns
-------
column_dtype : `type` or `str`
    Type that can be used for columns in Pandas.

Raises
------
TypeError
    Raised if type is cannot be handled.

Definition at line 123 of file apdbSchema.py.

    def column_dtype(self, felis_type: felis.datamodel.DataType | ExtraDataTypes) -> type | str:
        """Return Pandas data type for a given Felis column type.
 
        Parameters
        ----------
        felis_type : `felis.datamodel.DataType`
            Felis type, on of the enums defined in `felis.datamodel` module.
 
        Returns
        -------
        column_dtype : `type` or `str`
            Type that can be used for columns in Pandas.
 
        Raises
        ------
        TypeError
            Raised if type is cannot be handled.
        """
        try:
            return _dtype_map[felis_type]
        except KeyError:
            raise TypeError(f"Unexpected Felis type: {felis_type}")
 

◆ schemaVersion()

VersionTuple lsst.dax.apdb.apdbSchema.ApdbSchema.schemaVersion ( self )

Return schema version as defined in YAML schema file.

Returns
-------
version : `VersionTuple`
    Version number read from YAML file, if YAML file does not define
    schema version then "0.1.0" is returned.

Definition at line 146 of file apdbSchema.py.

    def schemaVersion(self) -> VersionTuple:
        """Return schema version as defined in YAML schema file.
 
        Returns
        -------
        version : `VersionTuple`
            Version number read from YAML file, if YAML file does not define
            schema version then "0.1.0" is returned.
        """
        if self._schemaVersion is None:
            return VersionTuple(0, 1, 0)
        else:
            return self._schemaVersion
 

Member Data Documentation

◆ _schemaVersion

lsst.dax.apdb.apdbSchema.ApdbSchema._schemaVersion

protected

Definition at line 121 of file apdbSchema.py.

◆ tableSchemas

lsst.dax.apdb.apdbSchema.ApdbSchema.tableSchemas

Definition at line 121 of file apdbSchema.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/apdbSchema.py

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes