update_transient_summaries (class)

class update_transient_summaries(log, dbConn, settings=False, transientBucketId=False)[source]

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()

Methods

update()

Update the transient summaries table in the marshall database

update()[source]

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()