.TH "MYSQLPROCGREP" "1" "May 09, 2012" "1.0.3" "MySQL Utilities"
.SH NAME
mysqlprocgrep \- Search MySQL servers for processes matching a pattern
.
.nr rst2man-indent-level 0
.
.de1 rstReportMargin
\\$1 \\n[an-margin]
level \\n[rst2man-indent-level]
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
-
\\n[rst2man-indent0]
\\n[rst2man-indent1]
\\n[rst2man-indent2]
..
.de1 INDENT
.\" .rstReportMargin pre:
. RS \\$1
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
. nr rst2man-indent-level +1
.\" .rstReportMargin post:
..
.de UNINDENT
. RE
.\" indent \\n[an-margin]
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
.nr rst2man-indent-level -1
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.\" Man page generated from reStructeredText.
.
.SH SYNOPSIS
.sp
.nf
.ft C
mysqlprocgrep [options]
.ft P
.fi
.SH DESCRIPTION
.sp
This utility scans the process lists for the servers specified using
instances of the \fI\-\-server\fP option and selects those that match the
conditions specified using the \fI\%--age\fP and \fB\-\-match\-xxx\fP options. For
a process to match, all conditions given must match.  The utility then
either prints the selected processes (the default) or executes certain
actions on them.
.sp
If no \fI\%--age\fP or \fB\-\-match\-xxx\fP options are given, the utility
selects all processes.
.sp
The \fB\-\-match\-xxx\fP options correspond to the columns in the
\fBINFORMATION_SCHEMA.PROCESSLIST\fP table. For example,
\fI\%--match-command\fP specifies a matching condition for
\fBPROCESSLIST.COMMAND\fP column values.  There is no \fB\-\-match\-time\fP option.
To specify a condition based on process time, use \fI\%--age\fP.
.sp
Processes that can be seen and killed are subject to whether the
account used to connect to the server has the \fBPROCESS\fP and
\fBSUPER\fP privileges.  Without \fBPROCESS\fP, the account cannot see
processes belonging to other accounts Without \fBSUPER\fP, the account
cannot kill processes belonging to other accounts
.sp
To specify how to display output, use one of the following values
with the \fI\-\-format\fP option:
.INDENT 0.0
.TP
.B \fBgrid\fP (default)
Display output in grid or table format like that of the
\fBmysql\fP monitor.
.TP
.B \fBcsv\fP
Display output in comma\-separated values format.
.TP
.B \fBtab\fP
Display output in tab\-separated format.
.TP
.B \fBvertical\fP
Display output in single\-column format like that of the \fB\eG\fP command
for the \fBmysql\fP monitor.
.UNINDENT
.SH OPTIONS
.sp
\fBmysqlprocgrep\fP accepts the following command\-line options:
.INDENT 0.0
.TP
.B \-\-help
Display a help message and exit.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-age=<time>
Select only processes that have been in the current state more than
a given time. The time value can be specified in two formats:
either using the \fBhh:mm:ss\fP format, with hours and minutes optional,
or as a sequence of numbers with a suffix giving the period size.
.sp
The permitted suffixes are \fBs\fP (second), \fBm\fP (minute), \fBh\fP (hour),
\fBd\fP (day), and \fBw\fP (week). For example, \fB4h15m\fP mean 4 hours and
15 minutes.
.sp
For both formats, the specification can optionally be preceded by
\fB+\fP or \fB\-\fP, where \fB+\fP means older than the given time, and
\fB\-\fP means younger than the given time.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-format=<format>, \-f<format>
Specify the output display format. Permitted format values are \fBgrid\fP,
\fBcsv\fP, \fBtab\fP, and \fBvertical\fP. The default is \fBgrid\fP.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-kill\-connection
Kill the connection for all matching processes (like the \fBKILL
CONNECTION\fP statement).
.UNINDENT
.INDENT 0.0
.TP
.B \-\-kill\-query
Kill the query for all matching processes (like the \fBKILL QUERY\fP
statement).
.UNINDENT
.INDENT 0.0
.TP
.B \-\-match\-command=<pattern>
Match all processes where the \fBCommand\fP field matches the pattern.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-match\-db=<pattern>
Match all processes where the \fBDb\fP field matches the pattern.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-match\-host=<pattern>
Match all processes where the \fBHost\fP field matches the pattern.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-match\-info=<pattern>
Match all processes where the \fBInfo\fP field matches the pattern.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-match\-state=<pattern>
Match all processes where the \fBState\fP field matches the pattern.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-match\-user=<pattern>
Match all processes where the \fBUser\fP field matches the pattern.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-print
Print information about the matching processes. This is the default
if no \fI\%--kill-connection\fP or \fI\%--kill-query\fP option
is given. If a kill option is given, \fI\%--print\fP prints
information about the processes before killing them.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-regexp, \-\-basic\-regexp, \-G
Perform pattern matches using the \fBREGEXP\fP operator. The default is
to use \fBLIKE\fP for matching.  This affects the \fB\-\-match\-xxx\fP options.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-server=<source>
Connection information for a server to search in
<\fIuser\fP>[:<\fIpasswd\fP>]@<\fIhost\fP>[:<\fIport\fP>][:<\fIsocket\fP>] format.
Use this option multiple times to search multiple servers.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-sql, \-\-print\-sql, \-Q
Instead of displaying the selected processes, emit the \fBSELECT\fP
statement that retrieves information about them. If the
\fI\%--kill-connection\fP or \fI\%--kill-query\fP option is
given, the utility generates a stored procedure named \fBkill_processes()\fP
for killing the queries rather than a \fBSELECT\fP statement.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-sql\-body
Like \fI\%--sql\fP, but produces the output as the body of a stored
procedure without the \fBCREATE PROCEDURE\fP part of the definition.
This could be used, for example, to generate an event for the server
Event Manager.
.sp
When used with a kill option, code for killing the matching queries
is generated. Note that it is not possible to execute the emitted
code unless it is put in a stored routine, event, or trigger. For
example, the following code could be generated to kill all idle
connections for user \fBwww\-data\fP:
.sp
.nf
.ft C
$ mysqlprocgrep \-\-kill\-connection \-\-sql\-body \e
>   \-\-match\-user=www\-data \-\-match\-state=sleep
DECLARE kill_done INT;
DECLARE kill_cursor CURSOR FOR
  SELECT
        Id, User, Host, Db, Command, Time, State, Info
      FROM
        INFORMATION_SCHEMA.PROCESSLIST
      WHERE
          user LIKE \(aqwww\-data\(aq
        AND
          State LIKE \(aqsleep\(aq
OPEN kill_cursor;
BEGIN
   DECLARE id BIGINT;
   DECLARE EXIT HANDLER FOR NOT FOUND SET kill_done = 1;
   kill_loop: LOOP
      FETCH kill_cursor INTO id;
      KILL CONNECTION id;
   END LOOP kill_loop;
END;
CLOSE kill_cursor;
.ft P
.fi
.UNINDENT
.INDENT 0.0
.TP
.B \-\-verbose, \-v
Specify how much information to display. Use this option
multiple times to increase the amount of information.  For example,
\fI\-v\fP = verbose, \fI\-vv\fP = more verbose, \fI\-vvv\fP =
debug.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-version
Display version information and exit.
.UNINDENT
.SH NOTES
.sp
For the \fI\-\-format\fP option, the permitted values are not case
sensitive. In addition, values may be specified as any unambiguous prefix of
a valid value.  For example, \fI\-\-format=g\fP specifies the grid format.
An error occurs if a prefix matches more than one valid value.
.SH EXAMPLES
.sp
For each example, assume that the \fBroot\fP user on \fBlocalhost\fP has
sufficient privileges to kill queries and connections.
.sp
Kill all queries created by user \fBmats\fP that are younger than 1 minute:
.sp
.nf
.ft C
mysqlprocgrep \-\-server=root@localhost \e
  \-\-match\-user=mats \-\-age=\-1m \-\-kill\-query
.ft P
.fi
.sp
Kill all connections that have been idle for more than 1 hour:
.sp
.nf
.ft C
mysqlprocgrep \-\-server=root@localhost \e
  \-\-match\-command=sleep \-\-age=1h \-\-kill\-connection
.ft P
.fi
.SH COPYRIGHT
.sp
Copyright (c) 2010, 2012, Oracle and/or its affiliates. All rights reserved.
.sp
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; version 2 of the License.
.sp
This program is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
General Public License for more details.
.sp
You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110\-1301 USA
.SH AUTHOR
MySQL Utilities Team
.SH COPYRIGHT
2010, Oracle and/or its affiliates. All rights reserved.
.\" Generated by docutils manpage writer.
.\" 
.