Prerequisites

Apart from MySQL itself, you only need to have the Python package PyMySQL installed. If you install CountRecordRefs following the instructions below, PyMySQL will be installed automatically for you.

Installation

The project is hosted at https://github.com/jmenglund/CountRecordRefs and can be installed using git:

$ git clone https://github.com/jmenglund/CountRecordRefs.git
$ cd CountRecordRefs
$ python setup.py install

You may consider installing CountRecordRefs within a virtual environment in order to avoid cluttering your system’s Python path. See for example the environment management system conda or the package virtualenv.

This project is centered around a self-contained single-module (single-file) executable script that can also be used as such.

Usage

usage: CountRecordRefs.py [-h] [-V] [--user USER] [--password PASSWORD]
                          [--host HOST] [-z]
                          database_name table_name id

Command-line utility for counting related records in a MySQL database. Output
is written to <stdout>.

positional arguments:
  database_name        MySQL database name
  table_name           table name
  id                   primary key value to look up

optional arguments:
  -h, --help           show this help message and exit
  -V, --version        show program's version number and exit
  --user USER          MySQL user (default: "root")
  --password PASSWORD  MySQL password
  --host HOST          database host (default: "localhost")
  -z, --zero-counts    include counts of zero in output

License

CountRecordRefs is distributed under the GNU General Public License, version 3 (GPL-3.0).

Author

Markus Englund, orcid.org/0000-0003-1688-7112