dqrdb 0.2.0

Maintain a database of IGWN Data Quality Reports

dqrdb

dqrdb maintains a MariaDB/MySQL database that tracks every Data Quality Report (DQR) produced by the IGWN DQR pipeline — which events have been processed, where the report files live, and what site and revision produced them.

Overview

When the DQR task manager completes a report, dqrdb records it:

GraceDB alert → dqralert → DQR task manager → dqr-process-upload → dqrdb

The database can also be populated in bulk from an existing directory tree using dqr-scandir.

Installation

pip install dqrdb

Quick Start

1. Configure the database connection

Create a dqrdb.ini file:

[DATABASE]
host     = localhost
user     = dqr-dev
password = <your-password>
database = dqr

2. Populate the database from an existing directory tree

dqr-scandir -v \
    --base-url https://ldas-jobs.ligo.caltech.edu/~dqr \
    --project online \
    /home/dqr/public_html/o4dqr/online/events/

3. Query the database from Python

from dqrdb.utils import get_events

results = get_events('S230529ad', project='online')
for r in results:
    print(r['site'], r['version'], r['url'])

4. Add a result programmatically

from pathlib import Path
from dqrdb.utils import add_result

added = add_result(
    path=Path('/home/dqr/public_html/o4dqr/online/events/202305/S230529ad_LHO_01'),
    url='https://ldas-jobs.ligo.caltech.edu/~dqr/online/events/202305/S230529ad_LHO_01/',
    gid='S230529ad',
    project='online',
    site='LHO',
    rev=1,
)
print('New record inserted:', added)

Command-Line Reference

Command	Description
dqr-scandir	Walk a directory tree and record all DQR results
dqr-process-upload	Accept a remote DQR upload and register it in the database

Documentation

Full documentation — including configuration reference, CLI options, and API docs — is available at:

https://dqr-builder.docs.ligo.org/dqrdb/

License

dqrdb is distributed under the GNU General Public License v3 or later.