marshallEngine.housekeeping.update_transient_summaries module

Update the transient summaries table in the marshall database with the top-level metadata

Author

David Young

class update_transient_summaries(log, dbConn, settings=False, transientBucketId=False)

Bases: object

Update the transient summaries table in the marshall database

Key Arguments

• log – logger

• settings – the settings dictionary

• dbConn – the marshall database connection

• transientBucketId – a single transientBucketId to update transientBucketId. Default False (i.e. update all)

Usage

To setup your logger, settings and database connections, please use the fundamentals package (see tutorial here).

To initiate a update_transient_summaries object, use the following:

Todo

• add a tutorial about update_transient_summaries to documentation

from marshallEngine.housekeeping import update_transient_summaries
updater = update_transient_summaries(
    log=log,
    settings=settings,
    dbConn=dbConn,
    transientBucketId=False
).update()

update()

Update the transient summaries table in the marshall database

Return

• update_transient_summaries

Usage

from marshallEngine.housekeeping import update_transient_summaries
updater = update_transient_summaries(
    log=log,
    settings=settings,
    dbConn=dbConn
).update()

_add_galactic_coords()

add galactic coordinates to the summary table

Usage

from marshallEngine.housekeeping import update_transient_summaries
updater = update_transient_summaries(
    log=log,
    settings=settings,
    dbConn=dbConn
)
updater._add_galactic_coords()

_add_distances()

Add a distance measurement from the best redshift if the transient does not already have a distance measurement

Usage

from marshallEngine.housekeeping import update_transient_summaries
updater = update_transient_summaries(
    log=log,
    settings=settings,
    dbConn=dbConn
)
updater._add_distances()

_update_htm_columns()

update the htm columns in the transientSummaries table so we can crossmatch if needed