|
| 1 | +# NAME |
| 2 | + |
| 3 | + MySQLTuner 2.7.2 - MySQL High Performance Tuning Script |
| 4 | + |
| 5 | +# IMPORTANT USAGE GUIDELINES |
| 6 | + |
| 7 | +To run the script with the default options, run the script without arguments |
| 8 | +Allow MySQL server to run for at least 24-48 hours before trusting suggestions |
| 9 | +Some routines may require root level privileges (script will provide warnings) |
| 10 | +You must provide the remote server's total memory when connecting to other servers |
| 11 | + |
| 12 | +# CONNECTION AND AUTHENTICATION |
| 13 | + |
| 14 | + --host <hostname> Connect to a remote host to perform tests (default: localhost) |
| 15 | + --socket <socket> Use a different socket for a local connection |
| 16 | + --pipe Connect to a local Windows database using named pipes |
| 17 | + --pipe_name <na> Use a different pipe name for a local connection |
| 18 | + --port <port> Port to use for connection (default: 3306) |
| 19 | + --protocol tcp Force TCP connection instead of socket |
| 20 | + --user <username> Username to use for authentication |
| 21 | + --userenv <envvar> Name of env variable which contains username to use for authentication |
| 22 | + --pass <password> Password to use for authentication |
| 23 | + --passenv <envvar> Name of env variable which contains password to use for authentication |
| 24 | + --ssl-ca <path> Path to public key |
| 25 | + --mysqladmin <path> Path to a custom mysqladmin executable |
| 26 | + --mysqlcmd <path> Path to a custom mysql executable |
| 27 | + --defaults-file <path> Path to a custom .my.cnf |
| 28 | + --defaults-extra-file <path> Path to an extra custom config file |
| 29 | + --server-log <path> Path to explicit log file (error_log) |
| 30 | + |
| 31 | +# CLOUD SUPPORT |
| 32 | + |
| 33 | + --cloud Enable cloud mode. This is a generic flag for any cloud provider. |
| 34 | + --azure Enable Azure-specific support. |
| 35 | + --ssh-host <hostname> The SSH host for cloud connections. |
| 36 | + --ssh-user <username> The SSH user for cloud connections. |
| 37 | + --ssh-password <password> The SSH password for cloud connections. |
| 38 | + --ssh-identity-file <path> The path to the SSH identity file for cloud connections. |
| 39 | + |
| 40 | +# PERFORMANCE AND REPORTING OPTIONS |
| 41 | + |
| 42 | + --skipsize Don't enumerate tables and their types/sizes (default: on) |
| 43 | + (Recommended for servers with many tables) |
| 44 | + --json Print result as JSON string |
| 45 | + --prettyjson Print result as JSON formatted string |
| 46 | + --skippassword Don't perform checks on user passwords (default: off) |
| 47 | + --checkversion Check for updates to MySQLTuner (default: don't check) |
| 48 | + --updateversion Check for updates to MySQLTuner and update when newer version is available (default: don't check) |
| 49 | + --forcemem <size> Amount of RAM installed in megabytes |
| 50 | + --forceswap <size> Amount of swap memory configured in megabytes |
| 51 | + --passwordfile <path> Path to a password file list (one password by line) |
| 52 | + --cvefile <path> CVE File for vulnerability checks |
| 53 | + --outputfile <path> Path to a output txt file |
| 54 | + --reportfile <path> Path to a report txt file |
| 55 | + --template <path> Path to a template file |
| 56 | + --dumpdir <path> Path to a directory where to dump information files |
| 57 | + --feature <feature> Run a specific feature (see FEATURES section) |
| 58 | + --dumpdir <path> information_schema tables and sys views are dumped in CSV in this path |
| 59 | + |
| 60 | +# OUTPUT OPTIONS |
| 61 | + |
| 62 | + --silent Don't output anything on screen |
| 63 | + --verbose Print out all options (default: no verbose, dbstat, idxstat, sysstat, tbstat, pfstat) |
| 64 | + --color Print output in color |
| 65 | + --nocolor Don't print output in color |
| 66 | + --noprettyicon Print output with legacy tag [OK], [!!], [--], [CMD], ... |
| 67 | + --nogood Remove OK responses |
| 68 | + --nobad Remove negative/suggestion responses |
| 69 | + --noinfo Remove informational responses |
| 70 | + --debug Print debug information |
| 71 | + --experimental Print experimental analysis (may fail) |
| 72 | + --nondedicated Consider server is not dedicated to Db server usage only |
| 73 | + --noprocess Consider no other process is running |
| 74 | + --dbstat Print database information |
| 75 | + --nodbstat Don't print database information |
| 76 | + --tbstat Print table information |
| 77 | + --notbstat Don't print table information |
| 78 | + --colstat Print column information |
| 79 | + --nocolstat Don't print column information |
| 80 | + --idxstat Print index information |
| 81 | + --noidxstat Don't print index information |
| 82 | + --nomyisamstat Don't print MyIsam information |
| 83 | + --sysstat Print system information |
| 84 | + --nosysstat Don't print system information |
| 85 | + --nostructstat Don't print table structures information |
| 86 | + --pfstat Print Performance schema |
| 87 | + --nopfstat Don't print Performance schema |
| 88 | + --bannedports Ports banned separated by comma (,) |
| 89 | + --server-log Define specific error_log to analyze |
| 90 | + --maxportallowed Number of open ports allowable on this host |
| 91 | + --buffers Print global and per-thread buffer values |
| 92 | + |
| 93 | +# PERLDOC |
| 94 | + |
| 95 | +You can find documentation for this module with the perldoc command. |
| 96 | + |
| 97 | + perldoc mysqltuner |
| 98 | + |
| 99 | +## INTERNALS |
| 100 | + |
| 101 | +[https://github.com/major/MySQLTuner-perl/blob/master/INTERNALS.md](https://github.com/major/MySQLTuner-perl/blob/master/INTERNALS.md) |
| 102 | + |
| 103 | + Internal documentation |
| 104 | + |
| 105 | +# AUTHORS |
| 106 | + |
| 107 | +Major Hayden - major@mhtx.net |
| 108 | +Jean-Marie Renouard - jmrenouard@gmail.com |
| 109 | + |
| 110 | +# CONTRIBUTORS |
| 111 | + |
| 112 | +- Matthew Montgomery |
| 113 | +- Paul Kehrer |
| 114 | +- Dave Burgess |
| 115 | +- Jonathan Hinds |
| 116 | +- Mike Jackson |
| 117 | +- Nils Breunese |
| 118 | +- Shawn Ashlee |
| 119 | +- Luuk Vosslamber |
| 120 | +- Ville Skytta |
| 121 | +- Trent Hornibrook |
| 122 | +- Jason Gill |
| 123 | +- Mark Imbriaco |
| 124 | +- Greg Eden |
| 125 | +- Aubin Galinotti |
| 126 | +- Giovanni Bechis |
| 127 | +- Bill Bradford |
| 128 | +- Ryan Novosielski |
| 129 | +- Michael Scheidell |
| 130 | +- Blair Christensen |
| 131 | +- Hans du Plooy |
| 132 | +- Victor Trac |
| 133 | +- Everett Barnes |
| 134 | +- Tom Krouper |
| 135 | +- Gary Barrueto |
| 136 | +- Simon Greenaway |
| 137 | +- Adam Stein |
| 138 | +- Isart Montane |
| 139 | +- Baptiste M. |
| 140 | +- Cole Turner |
| 141 | +- Major Hayden |
| 142 | +- Joe Ashcraft |
| 143 | +- Jean-Marie Renouard |
| 144 | +- Stephan GroBberndt |
| 145 | +- Christian Loos |
| 146 | +- Long Radix |
| 147 | + |
| 148 | +# SUPPORT |
| 149 | + |
| 150 | +Bug reports, feature requests, and downloads at http://mysqltuner.pl/ |
| 151 | + |
| 152 | +Bug tracker can be found at https://github.com/major/MySQLTuner-perl/issues |
| 153 | + |
| 154 | +Maintained by Jean-Marie Renouard (jmrenouard\\@gmail.com) - Licensed under GPL |
| 155 | + |
| 156 | +# SOURCE CODE |
| 157 | + |
| 158 | +[https://github.com/major/MySQLTuner-perl](https://github.com/major/MySQLTuner-perl) |
| 159 | + |
| 160 | + git clone https://github.com/major/MySQLTuner-perl.git |
| 161 | + |
| 162 | +# COPYRIGHT AND LICENSE |
| 163 | + |
| 164 | +Copyright (C) 2006-2023 Major Hayden - major@mhtx.net |
| 165 | +\# Copyright (C) 2015-2023 Jean-Marie Renouard - jmrenouard@gmail.com |
| 166 | + |
| 167 | +For the latest updates, please visit http://mysqltuner.pl/ |
| 168 | + |
| 169 | +Git repository available at https://github.com/major/MySQLTuner-perl |
| 170 | + |
| 171 | +This program is free software: you can redistribute it and/or modify |
| 172 | +it under the terms of the GNU General Public License as published by |
| 173 | +the Free Software Foundation, either version 3 of the License, or |
| 174 | +(at your option) any later version. |
| 175 | + |
| 176 | +This program is distributed in the hope that it will be useful, |
| 177 | +but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 178 | +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. |
| 179 | + |
| 180 | + See the GNU General Public License for more details. |
| 181 | + |
| 182 | +You should have received a copy of the GNU General Public License |
| 183 | +along with this program. If not, see <https://www.gnu.org/licenses/>. |
0 commit comments