| blob | 61da5bfe269cc2345885f2eecbcfdbe4a25b6e31 |
1 '\" t
2 .\" Title: \fBmysqlshow\fR
3 .\" Author: [FIXME: author] [see http://docbook.sf.net/el/author]
4 .\" Generator: DocBook XSL Stylesheets v1.77.1 <http://docbook.sf.net/>
5 .\" Date: 11/04/2013
6 .\" Manual: MySQL Database System
7 .\" Source: MySQL 5.1
8 .\" Language: English
9 .\"
10 .TH "\FBMYSQLSHOW\FR" "1" "11/04/2013" "MySQL 5\&.1" "MySQL Database System"
11 .\" -----------------------------------------------------------------
12 .\" * Define some portability stuff
13 .\" -----------------------------------------------------------------
14 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
15 .\" http://bugs.debian.org/507673
16 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
17 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
18 .ie \n(.g .ds Aq \(aq
19 .el .ds Aq '
20 .\" -----------------------------------------------------------------
21 .\" * set default formatting
22 .\" -----------------------------------------------------------------
23 .\" disable hyphenation
24 .nh
25 .\" disable justification (adjust text to left margin only)
26 .ad l
27 .\" -----------------------------------------------------------------
28 .\" * MAIN CONTENT STARTS HERE *
29 .\" -----------------------------------------------------------------
30 .\" mysqlshow
31 .\" databases: displaying
32 .\" displaying: database information
33 .\" tables: displaying
34 .\" columns: displaying
35 .\" showing: database information
36 .SH "NAME"
37 mysqlshow \- display database, table, and column information
38 .SH "SYNOPSIS"
39 .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
40 \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
41 .SH "DESCRIPTION"
42 .PP
43 The
44 \fBmysqlshow\fR
45 client can be used to quickly see which databases exist, their tables, or a table\*(Aqs columns or indexes\&.
46 .PP
47 \fBmysqlshow\fR
48 provides a command\-line interface to several SQL
49 SHOW
50 statements\&. See
51 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
52 \fBmysql\fR
53 client program\&.
54 .PP
55 Invoke
56 \fBmysqlshow\fR
57 like this:
58 .sp
59 .if n \{\
60 .RS 4
61 .\}
62 .nf
63 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
64 .fi
65 .if n \{\
66 .RE
67 .\}
68 .sp
69 .RS 4
70 .ie n \{\
71 \h'-04'\(bu\h'+03'\c
72 .\}
73 .el \{\
74 .sp -1
75 .IP \(bu 2.3
76 .\}
77 If no database is given, a list of database names is shown\&.
78 .RE
79 .sp
80 .RS 4
81 .ie n \{\
82 \h'-04'\(bu\h'+03'\c
83 .\}
84 .el \{\
85 .sp -1
86 .IP \(bu 2.3
87 .\}
88 If no table is given, all matching tables in the database are shown\&.
89 .RE
90 .sp
91 .RS 4
92 .ie n \{\
93 \h'-04'\(bu\h'+03'\c
94 .\}
95 .el \{\
96 .sp -1
97 .IP \(bu 2.3
98 .\}
99 If no column is given, all matching columns and column types in the table are shown\&.
100 .RE
101 .PP
102 The output displays only the names of those databases, tables, or columns for which you have some privileges\&.
103 .PP
104 If the last argument contains shell or SQL wildcard characters (\(lq*\(rq,
105 \(lq?\(rq,
106 \(lq%\(rq, or
107 \(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\&.
108 \(lq*\(rq
109 and
110 \(lq?\(rq
111 characters are converted into SQL
112 \(lq%\(rq
113 and
114 \(lq_\(rq
115 wildcard characters\&. This might cause some confusion when you try to display the columns for a table with a
116 \(lq_\(rq
117 in the name, because in this case,
118 \fBmysqlshow\fR
119 shows you only the table names that match the pattern\&. This is easily fixed by adding an extra
120 \(lq%\(rq
121 last on the command line as a separate argument\&.
122 .PP
123 \fBmysqlshow\fR
124 supports the following options, which can be specified on the command line or in the
125 [mysqlshow]
126 and
127 [client]
128 groups of an option file\&.
129 \fBmysqlshow\fR
130 also supports the options for processing option files described at
131 Section\ \&4.2.3.4, \(lqCommand-Line Options that Affect Option-File Handling\(rq\&.
132 .sp
133 .RS 4
134 .ie n \{\
135 \h'-04'\(bu\h'+03'\c
136 .\}
137 .el \{\
138 .sp -1
139 .IP \(bu 2.3
140 .\}
141 .\" mysqlshow: help option
142 .\" help option: mysqlshow
143 \fB\-\-help\fR,
144 \fB\-?\fR
145 .sp
146 Display a help message and exit\&.
147 .RE
148 .sp
149 .RS 4
150 .ie n \{\
151 \h'-04'\(bu\h'+03'\c
152 .\}
153 .el \{\
154 .sp -1
155 .IP \(bu 2.3
156 .\}
157 .\" mysqlshow: bind-address option
158 .\" bind-address option: mysqlshow
159 \fB\-\-bind\-address=\fR\fB\fIip_address\fR\fR
160 .sp
161 On a computer having multiple network interfaces, this option can be used to select which interface is employed when connecting to the MySQL server\&.
162 .sp
163 This option is supported only in the version of
164 \fBmysqlshow\fR
165 that is supplied with MySQL Cluster, beginning with MySQL Cluster NDB 6\&.3\&.4\&. It is not available in standard MySQL 5\&.1 releases\&.
166 .RE
167 .sp
168 .RS 4
169 .ie n \{\
170 \h'-04'\(bu\h'+03'\c
171 .\}
172 .el \{\
173 .sp -1
174 .IP \(bu 2.3
175 .\}
176 .\" mysqlshow: character-sets-dir option
177 .\" character-sets-dir option: mysqlshow
178 \fB\-\-character\-sets\-dir=\fR\fB\fIpath\fR\fR
179 .sp
180 The directory where character sets are installed\&. See
181 Section\ \&10.5, \(lqCharacter Set Configuration\(rq\&.
182 .RE
183 .sp
184 .RS 4
185 .ie n \{\
186 \h'-04'\(bu\h'+03'\c
187 .\}
188 .el \{\
189 .sp -1
190 .IP \(bu 2.3
191 .\}
192 .\" mysqlshow: compress option
193 .\" compress option: mysqlshow
194 \fB\-\-compress\fR,
195 \fB\-C\fR
196 .sp
197 Compress all information sent between the client and the server if both support compression\&.
198 .RE
199 .sp
200 .RS 4
201 .ie n \{\
202 \h'-04'\(bu\h'+03'\c
203 .\}
204 .el \{\
205 .sp -1
206 .IP \(bu 2.3
207 .\}
208 .\" mysqlshow: count option
209 .\" count option: mysqlshow
210 \fB\-\-count\fR
211 .sp
212 Show the number of rows per table\&. This can be slow for non\-MyISAM
213 tables\&.
214 .RE
215 .sp
216 .RS 4
217 .ie n \{\
218 \h'-04'\(bu\h'+03'\c
219 .\}
220 .el \{\
221 .sp -1
222 .IP \(bu 2.3
223 .\}
224 .\" mysqlshow: debug option
225 .\" debug option: mysqlshow
226 \fB\-\-debug[=\fR\fB\fIdebug_options\fR\fR\fB]\fR,
227 \fB\-# [\fR\fB\fIdebug_options\fR\fR\fB]\fR
228 .sp
229 Write a debugging log\&. A typical
230 \fIdebug_options\fR
231 string is
232 \*(Aqd:t:o,\fIfile_name\fR\*(Aq\&. The default is
233 \*(Aqd:t:o\*(Aq\&.
234 .RE
235 .sp
236 .RS 4
237 .ie n \{\
238 \h'-04'\(bu\h'+03'\c
239 .\}
240 .el \{\
241 .sp -1
242 .IP \(bu 2.3
243 .\}
244 .\" mysqlshow: debug-check option
245 .\" debug-check option: mysqlshow
246 \fB\-\-debug\-check\fR
247 .sp
248 Print some debugging information when the program exits\&. This option was added in MySQL 5\&.1\&.21\&.
249 .RE
250 .sp
251 .RS 4
252 .ie n \{\
253 \h'-04'\(bu\h'+03'\c
254 .\}
255 .el \{\
256 .sp -1
257 .IP \(bu 2.3
258 .\}
259 .\" mysqlshow: debug-info option
260 .\" debug-info option: mysqlshow
261 \fB\-\-debug\-info\fR
262 .sp
263 Print debugging information and memory and CPU usage statistics when the program exits\&. This option was added in MySQL 5\&.1\&.14\&.
264 .RE
265 .sp
266 .RS 4
267 .ie n \{\
268 \h'-04'\(bu\h'+03'\c
269 .\}
270 .el \{\
271 .sp -1
272 .IP \(bu 2.3
273 .\}
274 .\" mysqlshow: default-character-set option
275 .\" default-character-set option: mysqlshow
276 \fB\-\-default\-character\-set=\fR\fB\fIcharset_name\fR\fR
277 .sp
278 Use
279 \fIcharset_name\fR
280 as the default character set\&. See
281 Section\ \&10.5, \(lqCharacter Set Configuration\(rq\&.
282 .RE
283 .sp
284 .RS 4
285 .ie n \{\
286 \h'-04'\(bu\h'+03'\c
287 .\}
288 .el \{\
289 .sp -1
290 .IP \(bu 2.3
291 .\}
292 .\" mysqlshow: host option
293 .\" host option: mysqlshow
294 \fB\-\-host=\fR\fB\fIhost_name\fR\fR,
295 \fB\-h \fR\fB\fIhost_name\fR\fR
296 .sp
297 Connect to the MySQL server on the given host\&.
298 .RE
299 .sp
300 .RS 4
301 .ie n \{\
302 \h'-04'\(bu\h'+03'\c
303 .\}
304 .el \{\
305 .sp -1
306 .IP \(bu 2.3
307 .\}
308 .\" mysqlshow: keys option
309 .\" keys option: mysqlshow
310 \fB\-\-keys\fR,
311 \fB\-k\fR
312 .sp
313 Show table indexes\&.
314 .RE
315 .sp
316 .RS 4
317 .ie n \{\
318 \h'-04'\(bu\h'+03'\c
319 .\}
320 .el \{\
321 .sp -1
322 .IP \(bu 2.3
323 .\}
324 .\" mysqlshow: password option
325 .\" password option: mysqlshow
326 \fB\-\-password[=\fR\fB\fIpassword\fR\fR\fB]\fR,
327 \fB\-p[\fR\fB\fIpassword\fR\fR\fB]\fR
328 .sp
329 The password to use when connecting to the server\&. If you use the short option form (\fB\-p\fR), you
330 \fIcannot\fR
331 have a space between the option and the password\&. If you omit the
332 \fIpassword\fR
333 value following the
334 \fB\-\-password\fR
335 or
336 \fB\-p\fR
337 option on the command line,
338 \fBmysqlshow\fR
339 prompts for one\&.
340 .sp
341 Specifying a password on the command line should be considered insecure\&. See
342 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\&.
343 .RE
344 .sp
345 .RS 4
346 .ie n \{\
347 \h'-04'\(bu\h'+03'\c
348 .\}
349 .el \{\
350 .sp -1
351 .IP \(bu 2.3
352 .\}
353 .\" mysqlshow: pipe option
354 .\" pipe option: mysqlshow
355 \fB\-\-pipe\fR,
356 \fB\-W\fR
357 .sp
358 On Windows, connect to the server using a named pipe\&. This option applies only if the server supports named\-pipe connections\&.
359 .RE
360 .sp
361 .RS 4
362 .ie n \{\
363 \h'-04'\(bu\h'+03'\c
364 .\}
365 .el \{\
366 .sp -1
367 .IP \(bu 2.3
368 .\}
369 .\" mysqlshow: port option
370 .\" port option: mysqlshow
371 \fB\-\-port=\fR\fB\fIport_num\fR\fR,
372 \fB\-P \fR\fB\fIport_num\fR\fR
373 .sp
374 The TCP/IP port number to use for the connection\&.
375 .RE
376 .sp
377 .RS 4
378 .ie n \{\
379 \h'-04'\(bu\h'+03'\c
380 .\}
381 .el \{\
382 .sp -1
383 .IP \(bu 2.3
384 .\}
385 .\" mysqlshow: protocol option
386 .\" protocol option: mysqlshow
387 \fB\-\-protocol={TCP|SOCKET|PIPE|MEMORY}\fR
388 .sp
389 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
390 Section\ \&4.2.2, \(lqConnecting to the MySQL Server\(rq\&.
391 .RE
392 .sp
393 .RS 4
394 .ie n \{\
395 \h'-04'\(bu\h'+03'\c
396 .\}
397 .el \{\
398 .sp -1
399 .IP \(bu 2.3
400 .\}
401 .\" mysqlshow: show-table-type option
402 .\" show-table-type option: mysqlshow
403 \fB\-\-show\-table\-type\fR,
404 \fB\-t\fR
405 .sp
406 Show a column indicating the table type, as in
407 SHOW FULL TABLES\&. The type is
408 BASE TABLE
409 or
410 VIEW\&.
411 .RE
412 .sp
413 .RS 4
414 .ie n \{\
415 \h'-04'\(bu\h'+03'\c
416 .\}
417 .el \{\
418 .sp -1
419 .IP \(bu 2.3
420 .\}
421 .\" mysqlshow: socket option
422 .\" socket option: mysqlshow
423 \fB\-\-socket=\fR\fB\fIpath\fR\fR,
424 \fB\-S \fR\fB\fIpath\fR\fR
425 .sp
426 For connections to
427 localhost, the Unix socket file to use, or, on Windows, the name of the named pipe to use\&.
428 .RE
429 .sp
430 .RS 4
431 .ie n \{\
432 \h'-04'\(bu\h'+03'\c
433 .\}
434 .el \{\
435 .sp -1
436 .IP \(bu 2.3
437 .\}
438 .\" mysqlshow: SSL options
439 .\" SSL options: mysqlshow
440 \fB\-\-ssl*\fR
441 .sp
442 Options that begin with
443 \fB\-\-ssl\fR
444 specify whether to connect to the server using SSL and indicate where to find SSL keys and certificates\&. See
445 Section\ \&6.3.6.4, \(lqSSL Command Options\(rq\&.
446 .RE
447 .sp
448 .RS 4
449 .ie n \{\
450 \h'-04'\(bu\h'+03'\c
451 .\}
452 .el \{\
453 .sp -1
454 .IP \(bu 2.3
455 .\}
456 .\" mysqlshow: status option
457 .\" status option: mysqlshow
458 \fB\-\-status\fR,
459 \fB\-i\fR
460 .sp
461 Display extra information about each table\&.
462 .RE
463 .sp
464 .RS 4
465 .ie n \{\
466 \h'-04'\(bu\h'+03'\c
467 .\}
468 .el \{\
469 .sp -1
470 .IP \(bu 2.3
471 .\}
472 .\" mysqlshow: user option
473 .\" user option: mysqlshow
474 \fB\-\-user=\fR\fB\fIuser_name\fR\fR,
475 \fB\-u \fR\fB\fIuser_name\fR\fR
476 .sp
477 The MySQL user name to use when connecting to the server\&.
478 .RE
479 .sp
480 .RS 4
481 .ie n \{\
482 \h'-04'\(bu\h'+03'\c
483 .\}
484 .el \{\
485 .sp -1
486 .IP \(bu 2.3
487 .\}
488 .\" mysqlshow: verbose option
489 .\" verbose option: mysqlshow
490 \fB\-\-verbose\fR,
491 \fB\-v\fR
492 .sp
493 Verbose mode\&. Print more information about what the program does\&. This option can be used multiple times to increase the amount of information\&.
494 .RE
495 .sp
496 .RS 4
497 .ie n \{\
498 \h'-04'\(bu\h'+03'\c
499 .\}
500 .el \{\
501 .sp -1
502 .IP \(bu 2.3
503 .\}
504 .\" mysqlshow: version option
505 .\" version option: mysqlshow
506 \fB\-\-version\fR,
507 \fB\-V\fR
508 .sp
509 Display version information and exit\&.
510 .RE
511 .SH "COPYRIGHT"
512 .br
513 .PP
514 Copyright \(co 1997, 2013, Oracle and/or its affiliates. All rights reserved.
515 .PP
516 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.
517 .PP
518 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.
519 .PP
520 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/.
521 .sp
522 .SH "SEE ALSO"
523 For more information, please refer to the MySQL Reference Manual,
524 which may already be installed locally and which is also available
525 online at http://dev.mysql.com/doc/.
526 .SH AUTHOR
527 Oracle Corporation (http://dev.mysql.com/).