database_cleaner (class) ∞

class database_cleaner(log, settings=False)[source] ∞

Bases: object

Clean and maintain the database helper tables used by sherlock

The helper tables list row counts for tables and views and provide the column maps that help sherlock know which catalogue columns relate to which parameters (e.g. RA, DEC etc)

Key Arguments

  • dbConn – mysql database connection

  • log – logger

  • settings – the settings dictionary

Usage

Todo

  • add an entry in the tutorial to clean database tables

```python from sherlock.database_cleaner import database_cleaner db = database_cleaner(

log=log, settings=settings

) db.clean() ```

- update key arguments values and definitions with defaults
- update return values and definitions
- update usage examples and text
- update docstring text
- check sublime snippet exists
- clip any useful text to docs mindmap
- regenerate the docs and check redendering of this docstring

Methods

clean()

clean up and run some maintance tasks on the crossmatch catalogue helper tables
clean()[source] ∞

clean up and run some maintance tasks on the crossmatch catalogue helper tables

- update key arguments values and definitions with defaults
- update return values and definitions
- update usage examples and text
- update docstring text
- check sublime snippet exists
- clip any useful text to docs mindmap
- regenerate the docs and check redendering of this docstring