Inheritance diagram for lsst.dax.apdb.apdbSqlSchema.ApdbSqlSchema:

Public Member Functions
def	__init__ (self, sqlalchemy.engine.Engine engine, str dia_object_index, str htm_index_column, str schema_file, Optional[str] extra_schema_file=None, str prefix="")

None	makeSchema (self, bool drop=False, str mysql_engine='InnoDB')

Public Attributes
	objects

	objects_last

	sources

	forcedSources

	tableSchemas

Detailed Description

Class for management of APDB schema.

Attributes
----------
objects : `sqlalchemy.Table`
    DiaObject table instance
objects_last : `sqlalchemy.Table`
    DiaObjectLast table instance, may be None
sources : `sqlalchemy.Table`
    DiaSource table instance
forcedSources : `sqlalchemy.Table`
    DiaForcedSource table instance

Parameters
----------
engine : `sqlalchemy.engine.Engine`
    SQLAlchemy engine instance
dia_object_index : `str`
    Indexing mode for DiaObject table, see `ApdbSqlConfig.dia_object_index`
    for details.
htm_index_column : `str`
    Name of a HTM index column for DiaObject and DiaSource tables.
schema_file : `str`
    Name of the YAML schema file.
extra_schema_file : `str`, optional
    Name of the YAML schema file with extra column definitions.
prefix : `str`, optional
    Prefix to add to all scheam elements.

Definition at line 42 of file apdbSqlSchema.py.

Constructor & Destructor Documentation

◆ init()

def lsst.dax.apdb.apdbSqlSchema.ApdbSqlSchema.__init__	(		self,
		sqlalchemy.engine.Engine	engine,
		str	dia_object_index,
		str	htm_index_column,
		str	schema_file,
		Optional[str]	extra_schema_file = `None`,
		str	prefix = `""`
	)

Definition at line 72 of file apdbSqlSchema.py.

                  schema_file: str, extra_schema_file: Optional[str] = None, prefix: str = ""):
  
         super().__init__(schema_file, extra_schema_file)
  
         self._engine = engine
         self._dia_object_index = dia_object_index
         self._prefix = prefix
  
         self._metadata = MetaData(self._engine)
  
         # map YAML column types to SQLAlchemy
         self._type_map = dict(DOUBLE=self._getDoubleType(engine),
                               FLOAT=sqlalchemy.types.Float,
                               DATETIME=sqlalchemy.types.TIMESTAMP,
                               BIGINT=sqlalchemy.types.BigInteger,
                               INTEGER=sqlalchemy.types.Integer,
                               INT=sqlalchemy.types.Integer,
                               TINYINT=sqlalchemy.types.Integer,
                               BLOB=sqlalchemy.types.LargeBinary,
                               CHAR=sqlalchemy.types.CHAR,
                               BOOL=sqlalchemy.types.Boolean)
  
         # Adjust index if needed
         if self._dia_object_index == 'pix_id_iov':
             objects = self.tableSchemas[ApdbTables.DiaObject]
             objects.primary_key.columns.insert(0, htm_index_column)
  
         # Add pixelId column and index to tables that need it
         for table in (ApdbTables.DiaObject, ApdbTables.DiaObjectLast, ApdbTables.DiaSource):
             tableDef = self.tableSchemas.get(table)
             if not tableDef:
                 continue
             column = ColumnDef(name="pixelId",
                                type="BIGINT",
                                nullable=False,
                                default=None,
                                description="",
                                unit="",
                                ucd="")
             tableDef.columns.append(column)
  
             if table is ApdbTables.DiaObjectLast:
                 # use it as a leading PK column
                 tableDef.primary_key.columns.insert(0, "pixelId")
             else:
                 # make a regular index
                 index = IndexDef(name=f"IDX_{tableDef.name}_pixelId",
                                  type=IndexType.INDEX, columns=["pixelId"])
                 tableDef.indices.append(index)
  
         # generate schema for all tables, must be called last
         self._tables = self._makeTables()
  
         self.objects = self._tables[ApdbTables.DiaObject]
         self.objects_last = self._tables.get(ApdbTables.DiaObjectLast)
         self.sources = self._tables[ApdbTables.DiaSource]
         self.forcedSources = self._tables[ApdbTables.DiaForcedSource]
  

Member Function Documentation

◆ makeSchema()

None lsst.dax.apdb.apdbSqlSchema.ApdbSqlSchema.makeSchema	(		self,
		bool	drop = `False`,
		str	mysql_engine = `'InnoDB'`
	)

Create or re-create all tables.

Parameters
----------
drop : `bool`, optional
    If True then drop tables before creating new ones.
mysql_engine : `str`, optional
    MySQL engine type to use for new tables.

Definition at line 160 of file apdbSqlSchema.py.

     def makeSchema(self, drop: bool = False, mysql_engine: str = 'InnoDB') -> None:
         """Create or re-create all tables.
  
         Parameters
         ----------
         drop : `bool`, optional
             If True then drop tables before creating new ones.
         mysql_engine : `str`, optional
             MySQL engine type to use for new tables.
         """
  
         # re-make table schema for all needed tables with possibly different options
         _LOG.debug("clear metadata")
         self._metadata.clear()
         _LOG.debug("re-do schema mysql_engine=%r", mysql_engine)
         self._makeTables(mysql_engine=mysql_engine)
  
         # create all tables (optionally drop first)
         if drop:
             _LOG.info('dropping all tables')
             self._metadata.drop_all()
         _LOG.info('creating all tables')
         self._metadata.create_all()
  

Member Data Documentation

◆ forcedSources

lsst.dax.apdb.apdbSqlSchema.ApdbSqlSchema.forcedSources

Definition at line 129 of file apdbSqlSchema.py.

◆ objects

lsst.dax.apdb.apdbSqlSchema.ApdbSqlSchema.objects

Definition at line 126 of file apdbSqlSchema.py.

◆ objects_last

lsst.dax.apdb.apdbSqlSchema.ApdbSqlSchema.objects_last

Definition at line 127 of file apdbSqlSchema.py.

◆ sources

lsst.dax.apdb.apdbSqlSchema.ApdbSqlSchema.sources

Definition at line 128 of file apdbSqlSchema.py.

◆ tableSchemas

lsst.dax.apdb.apdbSchema.ApdbSchema.tableSchemas

inherited

Definition at line 178 of file apdbSchema.py.

The documentation for this class was generated from the following file:

/j/snowflake/release/lsstsw/stack/lsst-scipipe-0.7.0/Linux64/dax_apdb/22.0.1-5-g75bb458+99c117b92f/python/lsst/dax/apdb/apdbSqlSchema.py

Public Member Functions

Public Attributes