ApdbSqlSchema

class lsst.dax.apdb.ApdbSqlSchema(engine: Engine, dia_object_index: str, htm_index_column: str, schema_file: str, schema_name: str = 'ApdbSchema', prefix: str = '', namespace: str | None = None, use_insert_id: bool = False)

Bases: ApdbSchema

Class for management of APDB schema.

Parameters:

enginesqlalchemy.engine.Engine

SQLAlchemy engine instance

dia_object_indexstr

Indexing mode for DiaObject table, see ApdbSqlConfig.dia_object_index for details.

htm_index_columnstr

Name of a HTM index column for DiaObject and DiaSource tables.

schema_filestr

Name of the YAML schema file.

schema_namestr, optional

Name of the schema in YAML files.

prefixstr, optional

Prefix to add to all schema elements.

namespacestr, optional

Namespace (or schema name) to use for all APDB tables.

use_insert_idbool, optional

Attributes:

objectssqlalchemy.Table

DiaObject table instance

objects_lastsqlalchemy.Table

DiaObjectLast table instance, may be None

sourcessqlalchemy.Table

DiaSource table instance

forcedSourcessqlalchemy.Table

DiaForcedSource table instance

has_insert_idbool

Whether insert ID tables are to be used (bool).

Attributes Summary

has_insert_id	Whether insert ID tables are to be used (bool).
pixel_id_tables	Tables that need pixelId column for spatial indexing.

Methods Summary

column_dtype(felis_type)	Return Pandas data type for a given Felis column type.
empty()	Return True if database schema is empty.
get_apdb_columns(table_enum)	Return list of columns defined for a table in APDB schema.
get_table(table_enum)	Return SQLAlchemy table instance for a specified table type/enum.
makeSchema([drop])	Create or re-create all tables.
schemaVersion()	Return schema version as defined in YAML schema file.

Attributes Documentation

has_insert_id

Whether insert ID tables are to be used (bool).

pixel_id_tables = (<ApdbTables.DiaObject: 'DiaObject'>, <ApdbTables.DiaObjectLast: 'DiaObjectLast'>, <ApdbTables.DiaSource: 'DiaSource'>)

Tables that need pixelId column for spatial indexing.

Methods Documentation

column_dtype(felis_type: type[felis.types.FelisType]) → type | str

Return Pandas data type for a given Felis column type.

Parameters:

felis_typetype

Felis type, on of the classes defined in felis.types module.

Returns:

column_dtypetype or str

Type that can be used for columns in Pandas.

Raises:

TypeError

Raised if type is cannot be handled.

empty() → bool

Return True if database schema is empty.

Returns:

emptybool

True if none of the required APDB tables exist in the database, False if all required tables exist.

Raises:

InconsistentSchemaError

Raised when some of the required tables exist but not all.

get_apdb_columns(table_enum: ApdbTables | ExtraTables) → list[sqlalchemy.sql.schema.Column]

Return list of columns defined for a table in APDB schema.

Returned list excludes columns that are implementation-specific, e.g. pixelId column is not include in the returned list.

Parameters:

table_enumApdbTables or ExtraTables

Type of table.

Returns:

tablelist [sqlalchemy.schema.Column]

Table instance.

Raises:

ValueError

Raised if table_enum is not valid for this database.

get_table(table_enum: ApdbTables | ExtraTables) → Table

Return SQLAlchemy table instance for a specified table type/enum.

Parameters:

table_enumApdbTables or ExtraTables

Type of table to return.

Returns:

tablesqlalchemy.schema.Table

Table instance.

Raises:

ValueError

Raised if table_enum is not valid for this database.

makeSchema(drop: bool = False) → None

Create or re-create all tables.

Parameters:

dropbool, optional

If True then drop tables before creating new ones.

schemaVersion() → VersionTuple

Return schema version as defined in YAML schema file.

Returns:

versionVersionTuple

Version number read from YAML file, if YAML file does not define schema version then “0.1.0” is returned.