Skip to content

Latest commit

 

History

History
60 lines (42 loc) · 1.99 KB

README.md

File metadata and controls

60 lines (42 loc) · 1.99 KB
Raw

db-jobs

This is a Python project for running database queries/statements and generating reports.

Features

  • Reads config files
  • Can read command-line arguments
  • Runs SQL statements/queries and can get a result set
  • Can writes the result set to a spreadsheet file (.xlsx or .csv)
  • Can email the spreadsheet as an attachment, or just a path name, if recipient email addresses are defined in the config file.

Installing dependencies

pip install --user XlsxWriter
pip install --user python-tds
pip install --user mysql-connector
pip install --user psycopg2

python-tds is a connector for Microsoft SQL Server, mysql-connector is a connector that works with MySQL and MariaDB, and psycopg2 is a connector for PostgreSQL.

You only need the database connector(s) for the database system type(s) that you intend to use.

Configuration

Copy the files conf/*.example.cfg files to just conf/*.cfg:

  • config.example.cfg to config.cfg
  • jobs.example.cfg to jobs.cfg
  • datasources.example.cfg to datasources.cfg

Then customise them to use your own database credentials, database queries and email settings.

Example usage

# Report on plates and imagings from a RockMaker database
python runreport.py RockMakerPlateReport -m 10 -y 2018
# Report on plates and imagings from an ISPyB database
python runreport.py ISPyBPlatesReport - m 9 -y 2018

Developing new reports

You will need to add this to the 'jobs.cfg' file:

  • An SQL template string for your database query
  • A list with the column headers you want to use in the report

You also need to add database credentials to the datasources.cfg file and email settings to the config.cfg file.

If your database system is not yet supported, then you need to amend the create_report in the DBReport class.

See also the *.example.cfg files for examples.

To install the source code in editable mode for development:

git clone [email protected]:DiamondLightSource/db-jobs.git
pip install --user -e db-jobs