/pquery

pquery is an open-source (GPLv2 licensed) multi-threaded test program created to stress test the MySQL server (in any flavor), either randomly or sequentially, for QA purposes.

Primary LanguageC++GNU General Public License v2.0GPL-2.0

What is pquery?

pquery is an open-source (GPLv2 licensed) multi-threaded test program created to stress test the MySQL server (in any flavor), either randomly or sequentially, for QA purposes. Given it's modern C++ core, it is able to maximise the physical server's queries per second (qps) rate. pquery is an acronym for 'parallel query'. Prebuild pquery binaries (with statically linked client libraries) for Percona Server, MySQL Server, MariaDB, and WebScaleSQL are available as part of the pquery framework.

What is the pquery framework?

When the pquery binary is used in combination with the Bash scripted pquery framework and a medium spec QA server (Intel i7/16GB/SSD), a QA engineer can achieve 80+ mysqld crashes per hour. The pquery framework further offers automatic testcase creation, bug filtering, sporadic issue handling, true multi-threaded testcase reduction, near-100% bug reproducibility and much more. The pquery framework furthermore contains high quality SQL input files, and "already known bug" filter lists for Percona Server and MySQL Server. The pquery framework is also GPLv2 licensed, and available from GitHub here: https://github.com/Percona-QA/percona-qa

What is reducer.sh?

Reducer.sh is a powerful multi-threaded SQL testcase simplification tool. It is included in the pquery Framework (ref link in the previous pquery framework section above), as https://github.com/Percona-QA/percona-qa/blob/master/reducer.sh It is developed and maintained by Roel Van de Paar.

Any pquery success stories?

  • In the first ~2 months of it's life, over 200 bugs were logged with Oracle, Percona and TokuTek, most with high quality short testcases.
  • Early MySQL Server 5.7 versions, including RC1 & RC2, were tested with pquery in preparation for Percona Server 5.7. Many bugs, especially in RC1, were found & logged. Chapeau to the MySQL server team who triaged all bugs & resolved major bugs as can be seen in the 5.7.7 and 5.7.8 MYSQL server team notes.

How to build pquery?

  1. Install cmake >= 2.6 and C++ compiler >= 4.7 (gcc-c++ for RedHat-based, g++ for Debian-based), the development files for your MySQL version/fork, and potentially OpenSSL and AIO development files and/or other deps if needed.
  2. Change dir to pquery
  3. Run cmake with the required options, which are:
  • PERCONASERVER - OFF by default, build pquery with Percona Server support
  • WEBSCALESQL - OFF by default, build pquery with WebScaleSQL support
  • MYSQL - OFF by default, build pquery with Oracle MySQL support
  • MARIADB - OFF by default, build pquery with MariaDB support
  • STATIC_LIB - ON by default, compile pquery with MySQL | Percona Server | WebScaleSQL static client library instead of dynamic
  • DEBUG - OFF by default, compile pquery with debug inforamation for GDB
  • STRICT - ON by default, compile pquery with strict flags
  1. If you have MySQL | Percona Server | WebScaleSQL | MariaDB installed to some custom location you may consider setting the additional flags to cmake: MYSQL_INCLUDE_DIR and MYSQL_LIBRARY. OR, you can set BASEDIR variable if you have binary tarball extracted to some custom place for fully automatic library detection (recommended).
  2. The resulting binary will automatically receive an appropriate flavor suffix:
  • pquery-ms for MySQL
  • pquery-ps for Percona Server
  • pquery-ws for WebScaleSQL
  • pquery-md for MariaDB

Please note that only the MySQL client library will be linked statically if STATIC_LIB is set, all other required libraries (AIO, SSL, etc) will be linked dynamically.

Can you give an easy build example using an extracted Percona Server tarball?

$ cd pquery
$ ./clean-tree.sh  # Important note: this removes any local updates you may have made
$ cmake . -DPERCONASERVER=ON -DBASEDIR=/tmp/Percona-Server-5.6.26-rel73.2-Linux.x86_64
$ make
$ sudo make install # If you want pquery to be installed on the system, otherwise the binary can be found in ./src
$ ./clean-tree.sh  # Ref above
$ ... building other MySQL flavors/forks here ...

What options does pquery accept?

Option Function Example
--database The database to connect --database=test
--address IP address to connect to --address=127.0.0.1
--port The port to connect to --port=3306
--infile The SQL input file --infile=./main-ms-ps-md.sql
--logdir Log directory --logdir=/tmp/123
--socket Socket file to use --socket=/tmp/socket.sock
--user The MySQL userID to be used --user=root
--password The MySQL user's password --password=pazsw0rd
--threads The number of client threads to use --threads=1
--queries-per-thread The number of queries to randomly execute per thread --queries-per-thread=100000
--verbose Duplicates log to console when threads=1 --verbose
--log-all-queries Log all queries yes/no --log-all-queries
--log-failed-queries Log failed queries yes/no --log-failed-queries
--no-shuffle Replay SQL shuffled (randomly) or not (sequentially) --no-shuffle
--log-query-statistics Extended output of query result --log-query-statistics
--log-query-duration Log query duration in milliseconds --log-query-duration
--test-connection Test connection to server and exit --test-connection

Note that logfiles (including SQL log files) are appended to, not overwritten. If SQL logs are appended to, it will reduce issue reproducibility. To avoid this, simply use a new log file for each pquery run. The pquery framework (ref pquery-run.sh) already takes care of this automatically.

Where can I find more information on pquery?

Where can I find more information on the pquery Framework?

Where can I find more information on reducer.sh?

Contributors

  • Alexey Bychko - C++ code, cmake extensions
  • Roel Van de Paar - invention, scripted framework
  • For the full list of contributors, please see CONTRIBUTORS