Skip to main content

A MySQL client to run queries, write execution reports and export results

Project description


A MySQL client to run queries, write execution reports and export results.

It is made with the purpose to support SELECT statements only. Other statements will work but the features offered by this module will provide little help or make no sense.

It uses Python 3.


This can be used as a command line tool:

usage: mst [-h] --host HOST --user USER [--database DATABASE] [-a]
                    [-s] [-t KEY VALUE] [-d DESTINATION | --display]
                    query [query ...]

positional arguments:
  query                 Path to a file containing a single sql statement

optional arguments:
  -h, --help            show this help message and exit
  --host HOST           MySQL server host
  --user USER           MySQL server user
  --database DATABASE   MySQL database name
  -a, --ask-password    Do not try to retrieve password from keyring, always
                        ask password
  -s, --store-password  Store password into keyring after connecting to the
  -t KEY VALUE, --template-var KEY VALUE
                        Define a key value pair to substitute the ${key} by
                        the value within the query
                        Directory where to export results
  --display             Do not export results but display them to stdout

It exposes the class Query. The constructor needs a path to a file containing a single sql statement and instances expose the method export which creates a timestamped copy of the original file, appended with an execution report and an export of the result in the csv format.


You can install dependencies with pip install -r requirements.txt.

You can run tests with pytest.

$ pytest

Or you can setup a test run with your IDE.

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
mysql_tracer-1.3.0-py3-none-any.whl (9.9 kB) Copy SHA256 hash SHA256 Wheel py3
mysql_tracer-1.3.0.tar.gz (7.1 kB) Copy SHA256 hash SHA256 Source None

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page