percona-toolkit  3.1.0
About: Percona Toolkit is a collection of advanced command-line tools to perform a variety of MySQL, MariaDB, MongoDB server and system tasks.
  Fossies Dox: percona-toolkit-3.1.0.tar.gz  ("unofficial" and yet experimental doxygen-generated source code documentation)  

percona-toolkit Documentation

Some Fossies usage hints in advance:

  1. To see the Doxygen generated documentation please click on one of the items in the steelblue colored "quick index" bar above or use the side panel at the left which displays a hierarchical tree-like index structure and is adjustable in width.
  2. If you want to search for something by keyword rather than browse for it you can use the client side search facility (using Javascript and DHTML) that provides live searching, i.e. the search results are presented and adapted as you type in the Search input field at the top right.
  3. Doxygen doesn't incorporate all member files but just a definable subset (basically the main project source code files that are written in a supported language). So to search and browse all member files you may visit the Fossies
  4. percona-toolkit-3.1.0.tar.gz contents page and use the Fossies standard member browsing features (also with source code highlighting and additionally with optional code folding).
README.md

Percona Toolkit

CLA assistant

Percona Toolkit is a collection of advanced command-line tools used by Percona support staff to perform a variety of MySQL and system tasks that are too difficult or complex to perform manually.

These tools are ideal alternatives to private or "one-off" scripts because they are professionally developed, formally tested, and fully documented. They are also fully self-contained, so installation is quick and easy and no libraries are installed.

Percona Toolkit is developed and supported by Percona Inc. For more information and other free, open-source software developed by Percona, visit http://www.percona.com/software/.

Installing

To install all tools, run:

perl Makefile.PL
make
make test
make install

You probably need to be root to make install. On most systems, the tools are installed in /usr/local/bin. See the INSTALL file for more information.

Documentation

Run man percona-toolkit to see a list of installed tools, then man tool to read the embedded documentation for a specific tool. You can also read the documentation online at http://www.percona.com/software/percona-toolkit/.

Version 3

Starting from version 3, there are new tools for MongoDB. These tools are written in Go so in order to compile these program, this repo must me cloned into the GOPATH directory.
Example:

mkdir ${HOME}/go
export GOPATH=${HOME}/go
mkdir -p ${HOME}/go/src/github.com/percona
cd ${HOME}/go/src/github.com/percona
git clone https://github.com/percona/percona-toolkit.git
cd percona-toolkit/src/go
make