lsst.dax.apdb.apdbSqlSchema.ApdbSqlSchema Class Reference

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, str schema_name="ApdbSchema", str prefix="")
None	makeSchema (self, bool drop=False, str mysql_engine='InnoDB')
def	__init__ (self, str schema_file, str schema_name="ApdbSchema")

Public Attributes
	objects
	objects_last
	sources
	forcedSources
	ssObjects
Public Attributes inherited from lsst.dax.apdb.apdbSchema.ApdbSchema
	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.
schema_name : `str`, optional
    Name of the schema in YAML files.
prefix : `str`, optional
    Prefix to add to all scheam elements.

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,
		str	schema_name = "ApdbSchema",
		str	prefix = ""
	)

Reimplemented from lsst.dax.apdb.apdbSchema.ApdbSchema.

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.

---

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

• python/lsst/dax/apdb/apdbSqlSchema.py