528 lines
12 KiB
Groff
528 lines
12 KiB
Groff
'\" t
|
|
.\" Title: \fBmysqlshow\fR
|
|
.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author]
|
|
.\" Generator: DocBook XSL Stylesheets v1.77.1 <http://docbook.sf.net/>
|
|
.\" Date: 11/04/2013
|
|
.\" Manual: MySQL Database System
|
|
.\" Source: MySQL 5.1
|
|
.\" Language: English
|
|
.\"
|
|
.TH "\FBMYSQLSHOW\FR" "1" "11/04/2013" "MySQL 5\&.1" "MySQL Database System"
|
|
.\" -----------------------------------------------------------------
|
|
.\" * Define some portability stuff
|
|
.\" -----------------------------------------------------------------
|
|
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
.\" http://bugs.debian.org/507673
|
|
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
|
|
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
.ie \n(.g .ds Aq \(aq
|
|
.el .ds Aq '
|
|
.\" -----------------------------------------------------------------
|
|
.\" * set default formatting
|
|
.\" -----------------------------------------------------------------
|
|
.\" disable hyphenation
|
|
.nh
|
|
.\" disable justification (adjust text to left margin only)
|
|
.ad l
|
|
.\" -----------------------------------------------------------------
|
|
.\" * MAIN CONTENT STARTS HERE *
|
|
.\" -----------------------------------------------------------------
|
|
.\" mysqlshow
|
|
.\" databases: displaying
|
|
.\" displaying: database information
|
|
.\" tables: displaying
|
|
.\" columns: displaying
|
|
.\" showing: database information
|
|
.SH "NAME"
|
|
mysqlshow \- display database, table, and column information
|
|
.SH "SYNOPSIS"
|
|
.HP \w'\fBmysqlshow\ [\fR\fB\fIoptions\fR\fR\fB]\ [\fR\fB\fIdb_name\fR\fR\fB\ [\fR\fB\fItbl_name\fR\fR\fB\ [\fR\fB\fIcol_name\fR\fR\fB]]]\fR\ 'u
|
|
\fBmysqlshow [\fR\fB\fIoptions\fR\fR\fB] [\fR\fB\fIdb_name\fR\fR\fB [\fR\fB\fItbl_name\fR\fR\fB [\fR\fB\fIcol_name\fR\fR\fB]]]\fR
|
|
.SH "DESCRIPTION"
|
|
.PP
|
|
The
|
|
\fBmysqlshow\fR
|
|
client can be used to quickly see which databases exist, their tables, or a table\*(Aqs columns or indexes\&.
|
|
.PP
|
|
\fBmysqlshow\fR
|
|
provides a command\-line interface to several SQL
|
|
SHOW
|
|
statements\&. See
|
|
Section\ \&13.7.5, \(lqSHOW Syntax\(rq\&. The same information can be obtained by using those statements directly\&. For example, you can issue them from the
|
|
\fBmysql\fR
|
|
client program\&.
|
|
.PP
|
|
Invoke
|
|
\fBmysqlshow\fR
|
|
like this:
|
|
.sp
|
|
.if n \{\
|
|
.RS 4
|
|
.\}
|
|
.nf
|
|
shell> \fBmysqlshow [\fR\fB\fIoptions\fR\fR\fB] [\fR\fB\fIdb_name\fR\fR\fB [\fR\fB\fItbl_name\fR\fR\fB [\fR\fB\fIcol_name\fR\fR\fB]]]\fR
|
|
.fi
|
|
.if n \{\
|
|
.RE
|
|
.\}
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP \(bu 2.3
|
|
.\}
|
|
If no database is given, a list of database names is shown\&.
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP \(bu 2.3
|
|
.\}
|
|
If no table is given, all matching tables in the database are shown\&.
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP \(bu 2.3
|
|
.\}
|
|
If no column is given, all matching columns and column types in the table are shown\&.
|
|
.RE
|
|
.PP
|
|
The output displays only the names of those databases, tables, or columns for which you have some privileges\&.
|
|
.PP
|
|
If the last argument contains shell or SQL wildcard characters (\(lq*\(rq,
|
|
\(lq?\(rq,
|
|
\(lq%\(rq, or
|
|
\(lq_\(rq), only those names that are matched by the wildcard are shown\&. If a database name contains any underscores, those should be escaped with a backslash (some Unix shells require two) to get a list of the proper tables or columns\&.
|
|
\(lq*\(rq
|
|
and
|
|
\(lq?\(rq
|
|
characters are converted into SQL
|
|
\(lq%\(rq
|
|
and
|
|
\(lq_\(rq
|
|
wildcard characters\&. This might cause some confusion when you try to display the columns for a table with a
|
|
\(lq_\(rq
|
|
in the name, because in this case,
|
|
\fBmysqlshow\fR
|
|
shows you only the table names that match the pattern\&. This is easily fixed by adding an extra
|
|
\(lq%\(rq
|
|
last on the command line as a separate argument\&.
|
|
.PP
|
|
\fBmysqlshow\fR
|
|
supports the following options, which can be specified on the command line or in the
|
|
[mysqlshow]
|
|
and
|
|
[client]
|
|
groups of an option file\&.
|
|
\fBmysqlshow\fR
|
|
also supports the options for processing option files described at
|
|
Section\ \&4.2.3.4, \(lqCommand-Line Options that Affect Option-File Handling\(rq\&.
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP \(bu 2.3
|
|
.\}
|
|
.\" mysqlshow: help option
|
|
.\" help option: mysqlshow
|
|
\fB\-\-help\fR,
|
|
\fB\-?\fR
|
|
.sp
|
|
Display a help message and exit\&.
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP \(bu 2.3
|
|
.\}
|
|
.\" mysqlshow: bind-address option
|
|
.\" bind-address option: mysqlshow
|
|
\fB\-\-bind\-address=\fR\fB\fIip_address\fR\fR
|
|
.sp
|
|
On a computer having multiple network interfaces, this option can be used to select which interface is employed when connecting to the MySQL server\&.
|
|
.sp
|
|
This option is supported only in the version of
|
|
\fBmysqlshow\fR
|
|
that is supplied with MySQL Cluster, beginning with MySQL Cluster NDB 6\&.3\&.4\&. It is not available in standard MySQL 5\&.1 releases\&.
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP \(bu 2.3
|
|
.\}
|
|
.\" mysqlshow: character-sets-dir option
|
|
.\" character-sets-dir option: mysqlshow
|
|
\fB\-\-character\-sets\-dir=\fR\fB\fIpath\fR\fR
|
|
.sp
|
|
The directory where character sets are installed\&. See
|
|
Section\ \&10.5, \(lqCharacter Set Configuration\(rq\&.
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP \(bu 2.3
|
|
.\}
|
|
.\" mysqlshow: compress option
|
|
.\" compress option: mysqlshow
|
|
\fB\-\-compress\fR,
|
|
\fB\-C\fR
|
|
.sp
|
|
Compress all information sent between the client and the server if both support compression\&.
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP \(bu 2.3
|
|
.\}
|
|
.\" mysqlshow: count option
|
|
.\" count option: mysqlshow
|
|
\fB\-\-count\fR
|
|
.sp
|
|
Show the number of rows per table\&. This can be slow for non\-MyISAM
|
|
tables\&.
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP \(bu 2.3
|
|
.\}
|
|
.\" mysqlshow: debug option
|
|
.\" debug option: mysqlshow
|
|
\fB\-\-debug[=\fR\fB\fIdebug_options\fR\fR\fB]\fR,
|
|
\fB\-# [\fR\fB\fIdebug_options\fR\fR\fB]\fR
|
|
.sp
|
|
Write a debugging log\&. A typical
|
|
\fIdebug_options\fR
|
|
string is
|
|
\*(Aqd:t:o,\fIfile_name\fR\*(Aq\&. The default is
|
|
\*(Aqd:t:o\*(Aq\&.
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP \(bu 2.3
|
|
.\}
|
|
.\" mysqlshow: debug-check option
|
|
.\" debug-check option: mysqlshow
|
|
\fB\-\-debug\-check\fR
|
|
.sp
|
|
Print some debugging information when the program exits\&. This option was added in MySQL 5\&.1\&.21\&.
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP \(bu 2.3
|
|
.\}
|
|
.\" mysqlshow: debug-info option
|
|
.\" debug-info option: mysqlshow
|
|
\fB\-\-debug\-info\fR
|
|
.sp
|
|
Print debugging information and memory and CPU usage statistics when the program exits\&. This option was added in MySQL 5\&.1\&.14\&.
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP \(bu 2.3
|
|
.\}
|
|
.\" mysqlshow: default-character-set option
|
|
.\" default-character-set option: mysqlshow
|
|
\fB\-\-default\-character\-set=\fR\fB\fIcharset_name\fR\fR
|
|
.sp
|
|
Use
|
|
\fIcharset_name\fR
|
|
as the default character set\&. See
|
|
Section\ \&10.5, \(lqCharacter Set Configuration\(rq\&.
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP \(bu 2.3
|
|
.\}
|
|
.\" mysqlshow: host option
|
|
.\" host option: mysqlshow
|
|
\fB\-\-host=\fR\fB\fIhost_name\fR\fR,
|
|
\fB\-h \fR\fB\fIhost_name\fR\fR
|
|
.sp
|
|
Connect to the MySQL server on the given host\&.
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP \(bu 2.3
|
|
.\}
|
|
.\" mysqlshow: keys option
|
|
.\" keys option: mysqlshow
|
|
\fB\-\-keys\fR,
|
|
\fB\-k\fR
|
|
.sp
|
|
Show table indexes\&.
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP \(bu 2.3
|
|
.\}
|
|
.\" mysqlshow: password option
|
|
.\" password option: mysqlshow
|
|
\fB\-\-password[=\fR\fB\fIpassword\fR\fR\fB]\fR,
|
|
\fB\-p[\fR\fB\fIpassword\fR\fR\fB]\fR
|
|
.sp
|
|
The password to use when connecting to the server\&. If you use the short option form (\fB\-p\fR), you
|
|
\fIcannot\fR
|
|
have a space between the option and the password\&. If you omit the
|
|
\fIpassword\fR
|
|
value following the
|
|
\fB\-\-password\fR
|
|
or
|
|
\fB\-p\fR
|
|
option on the command line,
|
|
\fBmysqlshow\fR
|
|
prompts for one\&.
|
|
.sp
|
|
Specifying a password on the command line should be considered insecure\&. See
|
|
Section\ \&6.1.2.1, \(lqEnd-User Guidelines for Password Security\(rq\&. You can use an option file to avoid giving the password on the command line\&.
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP \(bu 2.3
|
|
.\}
|
|
.\" mysqlshow: pipe option
|
|
.\" pipe option: mysqlshow
|
|
\fB\-\-pipe\fR,
|
|
\fB\-W\fR
|
|
.sp
|
|
On Windows, connect to the server using a named pipe\&. This option applies only if the server supports named\-pipe connections\&.
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP \(bu 2.3
|
|
.\}
|
|
.\" mysqlshow: port option
|
|
.\" port option: mysqlshow
|
|
\fB\-\-port=\fR\fB\fIport_num\fR\fR,
|
|
\fB\-P \fR\fB\fIport_num\fR\fR
|
|
.sp
|
|
The TCP/IP port number to use for the connection\&.
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP \(bu 2.3
|
|
.\}
|
|
.\" mysqlshow: protocol option
|
|
.\" protocol option: mysqlshow
|
|
\fB\-\-protocol={TCP|SOCKET|PIPE|MEMORY}\fR
|
|
.sp
|
|
The connection protocol to use for connecting to the server\&. It is useful when the other connection parameters normally would cause a protocol to be used other than the one you want\&. For details on the permissible values, see
|
|
Section\ \&4.2.2, \(lqConnecting to the MySQL Server\(rq\&.
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP \(bu 2.3
|
|
.\}
|
|
.\" mysqlshow: show-table-type option
|
|
.\" show-table-type option: mysqlshow
|
|
\fB\-\-show\-table\-type\fR,
|
|
\fB\-t\fR
|
|
.sp
|
|
Show a column indicating the table type, as in
|
|
SHOW FULL TABLES\&. The type is
|
|
BASE TABLE
|
|
or
|
|
VIEW\&.
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP \(bu 2.3
|
|
.\}
|
|
.\" mysqlshow: socket option
|
|
.\" socket option: mysqlshow
|
|
\fB\-\-socket=\fR\fB\fIpath\fR\fR,
|
|
\fB\-S \fR\fB\fIpath\fR\fR
|
|
.sp
|
|
For connections to
|
|
localhost, the Unix socket file to use, or, on Windows, the name of the named pipe to use\&.
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP \(bu 2.3
|
|
.\}
|
|
.\" mysqlshow: SSL options
|
|
.\" SSL options: mysqlshow
|
|
\fB\-\-ssl*\fR
|
|
.sp
|
|
Options that begin with
|
|
\fB\-\-ssl\fR
|
|
specify whether to connect to the server using SSL and indicate where to find SSL keys and certificates\&. See
|
|
Section\ \&6.3.6.4, \(lqSSL Command Options\(rq\&.
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP \(bu 2.3
|
|
.\}
|
|
.\" mysqlshow: status option
|
|
.\" status option: mysqlshow
|
|
\fB\-\-status\fR,
|
|
\fB\-i\fR
|
|
.sp
|
|
Display extra information about each table\&.
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP \(bu 2.3
|
|
.\}
|
|
.\" mysqlshow: user option
|
|
.\" user option: mysqlshow
|
|
\fB\-\-user=\fR\fB\fIuser_name\fR\fR,
|
|
\fB\-u \fR\fB\fIuser_name\fR\fR
|
|
.sp
|
|
The MySQL user name to use when connecting to the server\&.
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP \(bu 2.3
|
|
.\}
|
|
.\" mysqlshow: verbose option
|
|
.\" verbose option: mysqlshow
|
|
\fB\-\-verbose\fR,
|
|
\fB\-v\fR
|
|
.sp
|
|
Verbose mode\&. Print more information about what the program does\&. This option can be used multiple times to increase the amount of information\&.
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP \(bu 2.3
|
|
.\}
|
|
.\" mysqlshow: version option
|
|
.\" version option: mysqlshow
|
|
\fB\-\-version\fR,
|
|
\fB\-V\fR
|
|
.sp
|
|
Display version information and exit\&.
|
|
.RE
|
|
.SH "COPYRIGHT"
|
|
.br
|
|
.PP
|
|
Copyright \(co 1997, 2013, Oracle and/or its affiliates. All rights reserved.
|
|
.PP
|
|
This documentation is free software; you can redistribute it and/or modify it only under the terms of the GNU General Public License as published by the Free Software Foundation; version 2 of the License.
|
|
.PP
|
|
This documentation 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.
|
|
.PP
|
|
You should have received a copy of the GNU General Public License along with the program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA or see http://www.gnu.org/licenses/.
|
|
.sp
|
|
.SH "SEE ALSO"
|
|
For more information, please refer to the MySQL Reference Manual,
|
|
which may already be installed locally and which is also available
|
|
online at http://dev.mysql.com/doc/.
|
|
.SH AUTHOR
|
|
Oracle Corporation (http://dev.mysql.com/).
|