diff options
Diffstat (limited to 'man')
51 files changed, 15501 insertions, 0 deletions
diff --git a/man/comp_err.1 b/man/comp_err.1 new file mode 100644 index 00000000000..6709f2f9eb4 --- /dev/null +++ b/man/comp_err.1 @@ -0,0 +1,137 @@ +.\" Title: \fBcomp_err\fR +.\" Author: +.\" Generator: DocBook XSL Stylesheets v1.70.1 <http://docbook.sf.net/> +.\" Date: 03/31/2009 +.\" Manual: MySQL Database System +.\" Source: MySQL 5.1 +.\" +.TH "\fBCOMP_ERR\fR" "1" "03/31/2009" "MySQL 5.1" "MySQL Database System" +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.SH "NAME" +comp_err \- compile MySQL error message file +.SH "SYNOPSIS" +.HP 19 +\fBcomp_err [\fR\fB\fIoptions\fR\fR\fB]\fR +.SH "DESCRIPTION" +.PP +\fBcomp_err\fR +creates the +\fIerrmsg.sys\fR +file that is used by +\fBmysqld\fR +to determine the error messages to display for different error codes. +\fBcomp_err\fR +normally is run automatically when MySQL is built. It compiles the +\fIerrmsg.sys\fR +file from the plaintext file located at +\fIsql/share/errmsg.txt\fR +in MySQL source distributions. +.PP +\fBcomp_err\fR +also generates +\fImysqld_error.h\fR, +\fImysqld_ername.h\fR, and +\fIsql_state.h\fR +header files. +.PP +For more information about how error messages are defined, see the MySQL Internals Manual. +.PP +Invoke +\fBcomp_err\fR +like this: +.sp +.RS 3n +.nf +shell> \fBcomp_err [\fR\fB\fIoptions\fR\fR\fB]\fR +.fi +.RE +.PP +\fBcomp_err\fR +understands the options described in the following list. +.TP 3n +\(bu +\fB\-\-help\fR, +\fB\-?\fR +.sp +Display a help message and exit. +.TP 3n +\(bu +\fB\-\-charset=\fR\fB\fIpath\fR\fR\fB, \-C \fR\fB\fIpath\fR\fR +.sp +The character set directory. The default is +\fI../sql/share/charsets\fR. +.TP 3n +\(bu +\fB\-\-debug=\fR\fB\fIdebug_options\fR\fR\fB, \-# \fR\fB\fIdebug_options\fR\fR +.sp +Write a debugging log. The +\fIdebug_options\fR +string often is +\'d:t:O,\fIfile_name\fR'. The default is +\'d:t:O,/tmp/comp_err.trace'. +.TP 3n +\(bu +\fB\-\-debug\-info\fR, +\fB\-T\fR +.sp +Print some debugging information when the program exits. +.TP 3n +\(bu +\fB\-\-header_file=\fR\fB\fIfile_name\fR\fR\fB, \-H \fR\fB\fIfile_name\fR\fR +.sp +The name of the error header file. The default is +\fImysqld_error.h\fR. +.TP 3n +\(bu +\fB\-\-in_file=\fR\fB\fIfile_name\fR\fR\fB, \-F \fR\fB\fIfile_name\fR\fR +.sp +The name of the input file. The default is +\fI../sql/share/errmsg.txt\fR. +.TP 3n +\(bu +\fB\-\-name_file=\fR\fB\fIfile_name\fR\fR\fB, \-N \fR\fB\fIfile_name\fR\fR +.sp +The name of the error name file. The default is +\fImysqld_ername.h\fR. +.TP 3n +\(bu +\fB\-\-out_dir=\fR\fB\fIpath\fR\fR\fB, \-D \fR\fB\fIpath\fR\fR +.sp +The name of the output base directory. The default is +\fI../sql/share/\fR. +.TP 3n +\(bu +\fB\-\-out_file=\fR\fB\fIfile_name\fR\fR\fB, \-O \fR\fB\fIfile_name\fR\fR +.sp +The name of the output file. The default is +\fIerrmsg.sys\fR. +.TP 3n +\(bu +\fB\-\-statefile=\fR\fB\fIfile_name\fR\fR\fB, \-S \fR\fB\fIfile_name\fR\fR +.sp +The name for the SQLSTATE header file. The default is +\fIsql_state.h\fR. +.TP 3n +\(bu +\fB\-\-version\fR, +\fB\-V\fR +.sp +Display version information and exit. +.SH "COPYRIGHT" +.PP +Copyright 2007\-2008 MySQL AB, 2009 Sun Microsystems, Inc. +.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/. +.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 +MySQL AB (http://www.mysql.com/). diff --git a/man/innochecksum.1 b/man/innochecksum.1 new file mode 100644 index 00000000000..b20fbee4241 --- /dev/null +++ b/man/innochecksum.1 @@ -0,0 +1,81 @@ +.\" Title: \fBinnochecksum\fR +.\" Author: +.\" Generator: DocBook XSL Stylesheets v1.70.1 <http://docbook.sf.net/> +.\" Date: 03/31/2009 +.\" Manual: MySQL Database System +.\" Source: MySQL 5.1 +.\" +.TH "\fBINNOCHECKSUM\fR" "1" "03/31/2009" "MySQL 5.1" "MySQL Database System" +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.SH "NAME" +innochecksum \- offline InnoDB file checksum utility +.SH "SYNOPSIS" +.HP 33 +\fBinnochecksum [\fR\fB\fIoptions\fR\fR\fB] \fR\fB\fIfile_name\fR\fR +.SH "DESCRIPTION" +.PP +\fBinnochecksum\fR +prints checksums for +InnoDB +files. +.PP +Invoke +\fBinnochecksum\fR +like this: +.sp +.RS 3n +.nf +shell> \fBinnochecksum [\fR\fB\fIoptions\fR\fR\fB] \fR\fB\fIfile_name\fR\fR +.fi +.RE +.PP +\fBinnochecksum\fR +understands the options described in the following list. For options that refer to page numbers, the numbers are zero\-based. +.TP 3n +\(bu +\fB\-c\fR +.sp +Print a count of the number of pages in the file. +.TP 3n +\(bu +\fB\-d\fR +.sp +Debug mode; prints checksums for each page. +.TP 3n +\(bu +\fB\-e \fR\fB\fInum\fR\fR +.sp +End at this page number. +.TP 3n +\(bu +\fB\-p \fR\fB\fInum\fR\fR +.sp +Check only this page number. +.TP 3n +\(bu +\fB\-s \fR\fB\fInum\fR\fR +.sp +Start at this page number. +.TP 3n +\(bu +\fB\-v\fR +.sp +Verbose mode; print a progress indicator every five seconds. +.SH "COPYRIGHT" +.PP +Copyright 2007\-2008 MySQL AB, 2009 Sun Microsystems, Inc. +.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/. +.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 +MySQL AB (http://www.mysql.com/). diff --git a/man/make_win_bin_dist.1 b/man/make_win_bin_dist.1 new file mode 100644 index 00000000000..e1be3dfaad3 --- /dev/null +++ b/man/make_win_bin_dist.1 @@ -0,0 +1,106 @@ +.\" Title: \fBmake_win_bin_dist\fR +.\" Author: +.\" Generator: DocBook XSL Stylesheets v1.70.1 <http://docbook.sf.net/> +.\" Date: 03/31/2009 +.\" Manual: MySQL Database System +.\" Source: MySQL 5.1 +.\" +.TH "\fBMAKE_WIN_BIN_DIST" "1" "03/31/2009" "MySQL 5.1" "MySQL Database System" +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.SH "NAME" +make_win_bin_dist \- package MySQL distribution as ZIP archive +.SH "SYNOPSIS" +.HP 60 +\fBmake_win_bin_dist [\fR\fB\fIoptions\fR\fR\fB] \fR\fB\fIpackage_basename\fR\fR\fB [\fR\fB\fIcopy_def\fR\fR\fB ...]\fR +.SH "DESCRIPTION" +.PP +This script is used on Windows after building a MySQL distribution from source to create executable programs. It packages the binaries and support files into a ZIP archive that can be unpacked at the location where you want to install MySQL. +.PP +\fBmake_win_bin_dist\fR +is a shell script, so you must have Cygwin installed to use it. +.PP +This program's use is subject to change. Currently, you invoke it as follows from the root directory of your source distribution: +.sp +.RS 3n +.nf +shell> \fBmake_win_bin_dist [\fR\fB\fIoptions\fR\fR\fB] \fR\fB\fIpackage_basename\fR\fR\fB [\fR\fB\fIcopy_def\fR\fR\fB ...]\fR +.fi +.RE +.PP +The +\fIpackage_basename\fR +argument provides the basename for the resulting ZIP archive. This name will be the name of the directory that results from unpacking the archive. +.PP +Because you might want to include files of directories from other builds, you can instruct this script do copy them in for you, via +\fIcopy_def\fR +arguments, which of which is of the form +\fIrelative_dest_name\fR=\fIsource_name\fR. +.PP +Example: +.sp +.RS 3n +.nf +bin/mysqld\-max.exe=../my\-max\-build/sql/release/mysqld.exe +.fi +.RE +.PP +If you specify a directory, the entire directory will be copied. +.PP +\fBmake_win_bin_dist\fR +understands the following options: +.TP 3n +\(bu +\fB\-\-debug\fR +.sp +Pack the debug binaries and produce an error if they were not built. +.TP 3n +\(bu +\fB\-\-embedded\fR +.sp +Pack the embedded server and produce an error if it was not built. The default is to pack it if it was built. +.TP 3n +\(bu +\fB\-\-exe\-suffix=\fR\fB\fIsuffix\fR\fR +.sp +Add a suffix to the basename of the +\fBmysql\fR +binary. For example, a suffix of +\-abc +produces a binary named +\fBmysqld\-abc.exe\fR. +.TP 3n +\(bu +\fB\-\-no\-debug\fR +.sp +Don't pack the debug binaries even if they were built. +.TP 3n +\(bu +\fB\-\-no\-embedded\fR +.sp +Don't pack the embedded server even if it was built. +.TP 3n +\(bu +\fB\-\-only\-debug\fR +.sp +Use this option when the target for this build was +Debug, and you just want to replace the normal binaries with debug versions (that is, do not use separate +\fIdebug\fR +directories). +.SH "COPYRIGHT" +.PP +Copyright 2007\-2008 MySQL AB, 2009 Sun Microsystems, Inc. +.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/. +.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 +MySQL AB (http://www.mysql.com/). diff --git a/man/msql2mysql.1 b/man/msql2mysql.1 new file mode 100644 index 00000000000..cead24cf8d2 --- /dev/null +++ b/man/msql2mysql.1 @@ -0,0 +1,61 @@ +.\" Title: \fBmsql2mysql\fR +.\" Author: +.\" Generator: DocBook XSL Stylesheets v1.70.1 <http://docbook.sf.net/> +.\" Date: 03/31/2009 +.\" Manual: MySQL Database System +.\" Source: MySQL 5.1 +.\" +.TH "\fBMSQL2MYSQL\fR" "1" "03/31/2009" "MySQL 5.1" "MySQL Database System" +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.SH "NAME" +msql2mysql \- convert mSQL programs for use with MySQL +.SH "SYNOPSIS" +.HP 28 +\fBmsql2mysql\fR\fB\fIC\-source\-file\fR\fR\fB ...\fR +.SH "DESCRIPTION" +.PP +Initially, the MySQL C API was developed to be very similar to that for the mSQL database system. Because of this, mSQL programs often can be converted relatively easily for use with MySQL by changing the names of the C API functions. +.PP +The +\fBmsql2mysql\fR +utility performs the conversion of mSQL C API function calls to their MySQL equivalents. +\fBmsql2mysql\fR +converts the input file in place, so make a copy of the original before converting it. For example, use +\fBmsql2mysql\fR +like this: +.sp +.RS 3n +.nf +shell> \fBcp client\-prog.c client\-prog.c.orig\fR +shell> \fBmsql2mysql client\-prog.c\fR +client\-prog.c converted +.fi +.RE +.PP +Then examine +\fIclient\-prog.c\fR +and make any post\-conversion revisions that may be necessary. +.PP +\fBmsql2mysql\fR +uses the +\fBreplace\fR +utility to make the function name substitutions. See +\fBreplace\fR(1). +.SH "COPYRIGHT" +.PP +Copyright 2007\-2008 MySQL AB, 2009 Sun Microsystems, Inc. +.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/. +.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 +MySQL AB (http://www.mysql.com/). diff --git a/man/my_print_defaults.1 b/man/my_print_defaults.1 new file mode 100644 index 00000000000..a92b2c2ad85 --- /dev/null +++ b/man/my_print_defaults.1 @@ -0,0 +1,111 @@ +.\" Title: \fBmy_print_defaults\fR +.\" Author: +.\" Generator: DocBook XSL Stylesheets v1.70.1 <http://docbook.sf.net/> +.\" Date: 03/31/2009 +.\" Manual: MySQL Database System +.\" Source: MySQL 5.1 +.\" +.TH "\fBMY_PRINT_DEFAULTS" "1" "03/31/2009" "MySQL 5.1" "MySQL Database System" +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.SH "NAME" +my_print_defaults \- display options from option files +.SH "SYNOPSIS" +.HP 45 +\fBmy_print_defaults [\fR\fB\fIoptions\fR\fR\fB] \fR\fB\fIoption_group\fR\fR\fB ...\fR +.SH "DESCRIPTION" +.PP +\fBmy_print_defaults\fR +displays the options that are present in option groups of option files. The output indicates what options will be used by programs that read the specified option groups. For example, the +\fBmysqlcheck\fR +program reads the +[mysqlcheck] +and +[client] +option groups. To see what options are present in those groups in the standard option files, invoke +\fBmy_print_defaults\fR +like this: +.sp +.RS 3n +.nf +shell> \fBmy_print_defaults mysqlcheck client\fR +\-\-user=myusername +\-\-password=secret +\-\-host=localhost +.fi +.RE +.PP +The output consists of options, one per line, in the form that they would be specified on the command line. +.PP +\fBmy_print_defaults\fR +understands the following options: +.TP 3n +\(bu +\fB\-\-help\fR, +\fB\-?\fR +.sp +Display a help message and exit. +.TP 3n +\(bu +\fB\-\-config\-file=\fR\fB\fIfile_name\fR\fR, +\fB\-\-defaults\-file=\fR\fB\fIfile_name\fR\fR, +\fB\-c \fR\fB\fIfile_name\fR\fR +.sp +Read only the given option file. +.TP 3n +\(bu +\fB\-\-debug=\fR\fB\fIdebug_options\fR\fR\fB, \-# \fR\fB\fIdebug_options\fR\fR +.sp +Write a debugging log. The +\fIdebug_options\fR +string often is +\'d:t:o,\fIfile_name\fR'. The default is +\'d:t:o,/tmp/my_print_defaults.trace'. +.TP 3n +\(bu +\fB\-\-defaults\-extra\-file=\fR\fB\fIfile_name\fR\fR, +\fB\-\-extra\-file=\fR\fB\fIfile_name\fR\fR, +\fB\-e \fR\fB\fIfile_name\fR\fR +.sp +Read this option file after the global option file but (on Unix) before the user option file. +.TP 3n +\(bu +\fB\-\-defaults\-group\-suffix=\fR\fB\fIsuffix\fR\fR, +\fB\-g \fR\fB\fIsuffix\fR\fR +.sp +In addition to the groups named on the command line, read groups that have the given suffix. +.TP 3n +\(bu +\fB\-\-no\-defaults\fR, +\fB\-n\fR +.sp +Return an empty string. +.TP 3n +\(bu +\fB\-\-verbose\fR, +\fB\-v\fR +.sp +Verbose mode. Print more information about what the program does. +.TP 3n +\(bu +\fB\-\-version\fR, +\fB\-V\fR +.sp +Display version information and exit. +.SH "COPYRIGHT" +.PP +Copyright 2007\-2008 MySQL AB, 2009 Sun Microsystems, Inc. +.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/. +.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 +MySQL AB (http://www.mysql.com/). diff --git a/man/myisam_ftdump.1 b/man/myisam_ftdump.1 new file mode 100644 index 00000000000..3fc43e11e0d --- /dev/null +++ b/man/myisam_ftdump.1 @@ -0,0 +1,151 @@ +.\" Title: \fBmyisam_ftdump\fR +.\" Author: +.\" Generator: DocBook XSL Stylesheets v1.70.1 <http://docbook.sf.net/> +.\" Date: 03/31/2009 +.\" Manual: MySQL Database System +.\" Source: MySQL 5.1 +.\" +.TH "\fBMYISAM_FTDUMP\fR" "1" "03/31/2009" "MySQL 5.1" "MySQL Database System" +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.SH "NAME" +myisam_ftdump \- display full\-text index information +.SH "SYNOPSIS" +.HP 43 +\fBmyisam_ftdump [\fR\fB\fIoptions\fR\fR\fB] \fR\fB\fItbl_name\fR\fR\fB \fR\fB\fIindex_num\fR\fR +.SH "DESCRIPTION" +.PP +\fBmyisam_ftdump\fR +displays information about +FULLTEXT +indexes in +MyISAM +tables. It reads the +MyISAM +index file directly, so it must be run on the server host where the table is located +.PP +Invoke +\fBmyisam_ftdump\fR +like this: +.sp +.RS 3n +.nf +shell> \fBmyisam_ftdump [\fR\fB\fIoptions\fR\fR\fB] \fR\fB\fItbl_name\fR\fR\fB \fR\fB\fIindex_num\fR\fR +.fi +.RE +.PP +The +\fItbl_name\fR +argument should be the name of a +MyISAM +table. You can also specify a table by naming its index file (the file with the +\fI.MYI\fR +suffix). If you do not invoke +\fBmyisam_ftdump\fR +in the directory where the table files are located, the table or index file name must be preceded by the path name to the table's database directory. Index numbers begin with 0. +.PP +Example: Suppose that the +test +database contains a table named +mytexttablel +that has the following definition: +.sp +.RS 3n +.nf +CREATE TABLE mytexttable +( + id INT NOT NULL, + txt TEXT NOT NULL, + PRIMARY KEY (id), + FULLTEXT (txt) +); +.fi +.RE +.PP +The index on +id +is index 0 and the +FULLTEXT +index on +txt +is index 1. If your working directory is the +test +database directory, invoke +\fBmyisam_ftdump\fR +as follows: +.sp +.RS 3n +.nf +shell> \fBmyisam_ftdump mytexttable 1\fR +.fi +.RE +.PP +If the path name to the +test +database directory is +\fI/usr/local/mysql/data/test\fR, you can also specify the table name argument using that path name. This is useful if you do not invoke +\fBmyisam_ftdump\fR +in the database directory: +.sp +.RS 3n +.nf +shell> \fBmyisam_ftdump /usr/local/mysql/data/test/mytexttable 1\fR +.fi +.RE +.PP +\fBmyisam_ftdump\fR +understands the following options: +.TP 3n +\(bu +\fB\-\-help\fR, +\fB\-h\fR +\fB\-?\fR +.sp +Display a help message and exit. +.TP 3n +\(bu +\fB\-\-count\fR, +\fB\-c\fR +.sp +Calculate per\-word statistics (counts and global weights). +.TP 3n +\(bu +\fB\-\-dump\fR, +\fB\-d\fR +.sp +Dump the index, including data offsets and word weights. +.TP 3n +\(bu +\fB\-\-length\fR, +\fB\-l\fR +.sp +Report the length distribution. +.TP 3n +\(bu +\fB\-\-stats\fR, +\fB\-s\fR +.sp +Report global index statistics. This is the default operation if no other operation is specified. +.TP 3n +\(bu +\fB\-\-verbose\fR, +\fB\-v\fR +.sp +Verbose mode. Print more output about what the program does. +.SH "COPYRIGHT" +.PP +Copyright 2007\-2008 MySQL AB, 2009 Sun Microsystems, Inc. +.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/. +.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 +MySQL AB (http://www.mysql.com/). diff --git a/man/myisamchk.1 b/man/myisamchk.1 new file mode 100644 index 00000000000..0f9702417f8 --- /dev/null +++ b/man/myisamchk.1 @@ -0,0 +1,841 @@ +.\" Title: \fBmyisamchk\fR +.\" Author: +.\" Generator: DocBook XSL Stylesheets v1.70.1 <http://docbook.sf.net/> +.\" Date: 03/31/2009 +.\" Manual: MySQL Database System +.\" Source: MySQL 5.1 +.\" +.TH "\fBMYISAMCHK\fR" "1" "03/31/2009" "MySQL 5.1" "MySQL Database System" +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.SH "NAME" +myisamchk \- MyISAM table\-maintenance utility +.SH "SYNOPSIS" +.HP 33 +\fBmyisamchk [\fR\fB\fIoptions\fR\fR\fB] \fR\fB\fItbl_name\fR\fR\fB ...\fR +.SH "DESCRIPTION" +.PP +The +\fBmyisamchk\fR +utility gets information about your database tables or checks, repairs, or optimizes them. +\fBmyisamchk\fR +works with +MyISAM +tables (tables that have +\fI.MYD\fR +and +\fI.MYI\fR +files for storing data and indexes). +.PP +The use of +\fBmyisamchk\fR +with partitioned tables is not supported. +.sp +.it 1 an-trap +.nr an-no-space-flag 1 +.nr an-break-flag 1 +.br +\fBCaution\fR +.PP +It is best to make a backup of a table before performing a table repair operation; under some circumstances the operation might cause data loss. Possible causes include but are not limited to file system errors. +.PP +Invoke +\fBmyisamchk\fR +like this: +.sp +.RS 3n +.nf +shell> \fBmyisamchk [\fR\fB\fIoptions\fR\fR\fB] \fR\fB\fItbl_name\fR\fR\fB ...\fR +.fi +.RE +.PP +The +\fIoptions\fR +specify what you want +\fBmyisamchk\fR +to do. They are described in the following sections. You can also get a list of options by invoking +\fBmyisamchk \-\-help\fR. +.PP +With no options, +\fBmyisamchk\fR +simply checks your table as the default operation. To get more information or to tell +\fBmyisamchk\fR +to take corrective action, specify options as described in the following discussion. +.PP +\fItbl_name\fR +is the database table you want to check or repair. If you run +\fBmyisamchk\fR +somewhere other than in the database directory, you must specify the path to the database directory, because +\fBmyisamchk\fR +has no idea where the database is located. In fact, +\fBmyisamchk\fR +does not actually care whether the files you are working on are located in a database directory. You can copy the files that correspond to a database table into some other location and perform recovery operations on them there. +.PP +You can name several tables on the +\fBmyisamchk\fR +command line if you wish. You can also specify a table by naming its index file (the file with the +\fI.MYI\fR +suffix). This allows you to specify all tables in a directory by using the pattern +\fI*.MYI\fR. For example, if you are in a database directory, you can check all the +MyISAM +tables in that directory like this: +.sp +.RS 3n +.nf +shell> \fBmyisamchk *.MYI\fR +.fi +.RE +.PP +If you are not in the database directory, you can check all the tables there by specifying the path to the directory: +.sp +.RS 3n +.nf +shell> \fBmyisamchk \fR\fB\fI/path/to/database_dir/\fR\fR\fB*.MYI\fR +.fi +.RE +.PP +You can even check all tables in all databases by specifying a wildcard with the path to the MySQL data directory: +.sp +.RS 3n +.nf +shell> \fBmyisamchk \fR\fB\fI/path/to/datadir/*/*\fR\fR\fB.MYI\fR +.fi +.RE +.PP +The recommended way to quickly check all +MyISAM +tables is: +.sp +.RS 3n +.nf +shell> \fBmyisamchk \-\-silent \-\-fast \fR\fB\fI/path/to/datadir/*/*\fR\fR\fB.MYI\fR +.fi +.RE +.PP +If you want to check all +MyISAM +tables and repair any that are corrupted, you can use the following command: +.sp +.RS 3n +.nf +shell> \fBmyisamchk \-\-silent \-\-force \-\-fast \-\-update\-state \\\fR + \fB\-\-key_buffer_size=64M \-\-sort_buffer_size=64M \\\fR + \fB\-\-read_buffer_size=1M \-\-write_buffer_size=1M \\\fR + \fB\fI/path/to/datadir/*/*\fR\fR\fB.MYI\fR +.fi +.RE +.PP +This command assumes that you have more than 64MB free. For more information about memory allocation with +\fBmyisamchk\fR, see +the section called \(lq\fBMYISAMCHK\fR MEMORY USAGE\(rq. +.sp +.it 1 an-trap +.nr an-no-space-flag 1 +.nr an-break-flag 1 +.br +\fBImportant\fR +.PP +\fIYou must ensure that no other program is using the tables while you are running \fR\fI\fBmyisamchk\fR\fR. The most effective means of doing so is to shut down the MySQL server while running +\fBmyisamchk\fR, or to lock all tables that +\fBmyisamchk\fR +is being used on. +.PP +Otherwise, when you run +\fBmyisamchk\fR, it may display the following error message: +.sp +.RS 3n +.nf +warning: clients are using or haven't closed the table properly +.fi +.RE +.PP +This means that you are trying to check a table that has been updated by another program (such as the +\fBmysqld\fR +server) that hasn't yet closed the file or that has died without closing the file properly, which can sometimes lead to the corruption of one or more +MyISAM +tables. +.PP +If +\fBmysqld\fR +is running, you must force it to flush any table modifications that are still buffered in memory by using +FLUSH TABLES. You should then ensure that no one is using the tables while you are running +\fBmyisamchk\fR +.PP +However, the easiest way to avoid this problem is to use +CHECK TABLE +instead of +\fBmyisamchk\fR +to check tables. See +Section\ 12.5.2.3, \(lqCHECK TABLE Syntax\(rq. +.PP +A complete listing of all the +\fBmyisamchk\fR +options follows. +.SH "\fBMYISAMCHK\fR GENERAL OPTIONS" +.PP +The options described in this section can be used for any type of table maintenance operation performed by +\fBmyisamchk\fR. The sections following this one describe options that pertain only to specific operations, such as table checking or repairing. +.TP 3n +\(bu +\fB\-\-help\fR, +\fB\-?\fR +.sp +Display a help message and exit. Options are grouped by type of operation. +.TP 3n +\(bu +\fB\-\-HELP\fR, +\fB\-H\fR +.sp +Display a help message and exit. Options are presented in a single list. +.TP 3n +\(bu +\fB\-\-debug=\fR\fB\fIdebug_options\fR\fR\fB, \-# \fR\fB\fIdebug_options\fR\fR +.sp +Write a debugging log. The +\fIdebug_options\fR +string often is +\'d:t:o,\fIfile_name\fR'. +.TP 3n +\(bu +\fB\-\-silent\fR, +\fB\-s\fR +.sp +Silent mode. Write output only when errors occur. You can use +\fB\-s\fR +twice (\fB\-ss\fR) to make +\fBmyisamchk\fR +very silent. +.TP 3n +\(bu +\fB\-\-verbose\fR, +\fB\-v\fR +.sp +Verbose mode. Print more information about what the program does. This can be used with +\fB\-d\fR +and +\fB\-e\fR. Use +\fB\-v\fR +multiple times (\fB\-vv\fR, +\fB\-vvv\fR) for even more output. +.TP 3n +\(bu +\fB\-\-version\fR, +\fB\-V\fR +.sp +Display version information and exit. +.TP 3n +\(bu +\fB\-\-wait\fR, +\fB\-w\fR +.sp +Instead of terminating with an error if the table is locked, wait until the table is unlocked before continuing. If you are running +\fBmysqld\fR +with external locking disabled, the table can be locked only by another +\fBmyisamchk\fR +command. +.sp +.RE +.PP +You can also set the following variables by using +\fB\-\-\fR\fB\fIvar_name\fR\fR\fB=\fR\fB\fIvalue\fR\fR +syntax: +.TS +allbox tab(:); +l l +l l +l l +l l +l l +l l +l l +l l +l l +l l +l l +l l. +T{ +\fBVariable\fR +T}:T{ +\fBDefault Value\fR +T} +T{ +sort_key_blocks +T}:T{ +16 +T} +T{ +stats_method +T}:T{ +nulls_unequal +T} +T{ +write_buffer_size +T}:T{ +262136 +T} +T{ +decode_bits +T}:T{ +9 +T} +T{ +ft_max_word_len +T}:T{ +version\-dependent +T} +T{ +ft_min_word_len +T}:T{ +4 +T} +T{ +ft_stopword_file +T}:T{ +built\-in list +T} +T{ +key_buffer_size +T}:T{ +523264 +T} +T{ +myisam_block_size +T}:T{ +1024 +T} +T{ +read_buffer_size +T}:T{ +262136 +T} +T{ +sort_buffer_size +T}:T{ +2097144 +T} +.TE +.sp +.PP +The possible +\fBmyisamchk\fR +variables and their default values can be examined with +\fBmyisamchk \-\-help\fR: +.PP +sort_buffer_size +is used when the keys are repaired by sorting keys, which is the normal case when you use +\fB\-\-recover\fR. +.PP +key_buffer_size +is used when you are checking the table with +\fB\-\-extend\-check\fR +or when the keys are repaired by inserting keys row by row into the table (like when doing normal inserts). Repairing through the key buffer is used in the following cases: +.TP 3n +\(bu +You use +\fB\-\-safe\-recover\fR. +.TP 3n +\(bu +The temporary files needed to sort the keys would be more than twice as big as when creating the key file directly. This is often the case when you have large key values for +CHAR, +VARCHAR, or +TEXT +columns, because the sort operation needs to store the complete key values as it proceeds. If you have lots of temporary space and you can force +\fBmyisamchk\fR +to repair by sorting, you can use the +\fB\-\-sort\-recover\fR +option. +.sp +.RE +.PP +Repairing through the key buffer takes much less disk space than using sorting, but is also much slower. +.PP +If you want a faster repair, set the +key_buffer_size +and +sort_buffer_size +variables to about 25% of your available memory. You can set both variables to large values, because only one of them is used at a time. +.PP +myisam_block_size +is the size used for index blocks. +.PP +stats_method +influences how +NULL +values are treated for index statistics collection when the +\fB\-\-analyze\fR +option is given. It acts like the +myisam_stats_method +system variable. For more information, see the description of +myisam_stats_method +in +Section\ 5.1.3, \(lqServer System Variables\(rq, and +Section\ 7.4.7, \(lqMyISAM Index Statistics Collection\(rq. For MySQL 5.1, +stats_method +was added in MySQL 5.0.14. For older versions, the statistics collection method is equivalent to +nulls_equal. +.PP +The +ft_min_word_len +and +ft_max_word_len +variables are available as of MySQL 4.0.0. +ft_stopword_file +is available as of MySQL 4.0.19. +.PP +ft_min_word_len +and +ft_max_word_len +indicate the minimum and maximum word length for +FULLTEXT +indexes. +ft_stopword_file +names the stopword file. These need to be set under the following circumstances. +.PP +If you use +\fBmyisamchk\fR +to perform an operation that modifies table indexes (such as repair or analyze), the +FULLTEXT +indexes are rebuilt using the default full\-text parameter values for minimum and maximum word length and the stopword file unless you specify otherwise. This can result in queries failing. +.PP +The problem occurs because these parameters are known only by the server. They are not stored in +MyISAM +index files. To avoid the problem if you have modified the minimum or maximum word length or the stopword file in the server, specify the same +ft_min_word_len, +ft_max_word_len, and +ft_stopword_file +values to +\fBmyisamchk\fR +that you use for +\fBmysqld\fR. For example, if you have set the minimum word length to 3, you can repair a table with +\fBmyisamchk\fR +like this: +.sp +.RS 3n +.nf +shell> \fBmyisamchk \-\-recover \-\-ft_min_word_len=3 \fR\fB\fItbl_name\fR\fR\fB.MYI\fR +.fi +.RE +.PP +To ensure that +\fBmyisamchk\fR +and the server use the same values for full\-text parameters, you can place each one in both the +[mysqld] +and +[myisamchk] +sections of an option file: +.sp +.RS 3n +.nf +[mysqld] +ft_min_word_len=3 +[myisamchk] +ft_min_word_len=3 +.fi +.RE +.PP +An alternative to using +\fBmyisamchk\fR +is to use the +REPAIR TABLE, +ANALYZE TABLE, +OPTIMIZE TABLE, or +ALTER TABLE. These statements are performed by the server, which knows the proper full\-text parameter values to use. +.SH "\fBMYISAMCHK\fR CHECK OPTIONS" +.PP +\fBmyisamchk\fR +supports the following options for table checking operations: +.TP 3n +\(bu +\fB\-\-check\fR, +\fB\-c\fR +.sp +Check the table for errors. This is the default operation if you specify no option that selects an operation type explicitly. +.TP 3n +\(bu +\fB\-\-check\-only\-changed\fR, +\fB\-C\fR +.sp +Check only tables that have changed since the last check. +.TP 3n +\(bu +\fB\-\-extend\-check\fR, +\fB\-e\fR +.sp +Check the table very thoroughly. This is quite slow if the table has many indexes. This option should only be used in extreme cases. Normally, +\fBmyisamchk\fR +or +\fBmyisamchk \-\-medium\-check\fR +should be able to determine whether there are any errors in the table. +.sp +If you are using +\fB\-\-extend\-check\fR +and have plenty of memory, setting the +key_buffer_size +variable to a large value helps the repair operation run faster. +.TP 3n +\(bu +\fB\-\-fast\fR, +\fB\-F\fR +.sp +Check only tables that haven't been closed properly. +.TP 3n +\(bu +\fB\-\-force\fR, +\fB\-f\fR +.sp +Do a repair operation automatically if +\fBmyisamchk\fR +finds any errors in the table. The repair type is the same as that specified with the +\fB\-\-recover\fR +or +\fB\-r\fR +option. +.TP 3n +\(bu +\fB\-\-information\fR, +\fB\-i\fR +.sp +Print informational statistics about the table that is checked. +.TP 3n +\(bu +\fB\-\-medium\-check\fR, +\fB\-m\fR +.sp +Do a check that is faster than an +\fB\-\-extend\-check\fR +operation. This finds only 99.99% of all errors, which should be good enough in most cases. +.TP 3n +\(bu +\fB\-\-read\-only\fR, +\fB\-T\fR +.sp +Do not mark the table as checked. This is useful if you use +\fBmyisamchk\fR +to check a table that is in use by some other application that does not use locking, such as +\fBmysqld\fR +when run with external locking disabled. +.TP 3n +\(bu +\fB\-\-update\-state\fR, +\fB\-U\fR +.sp +Store information in the +\fI.MYI\fR +file to indicate when the table was checked and whether the table crashed. This should be used to get full benefit of the +\fB\-\-check\-only\-changed\fR +option, but you shouldn't use this option if the +\fBmysqld\fR +server is using the table and you are running it with external locking disabled. +.SH "\fBMYISAMCHK\fR REPAIR OPTIONS" +.PP +\fBmyisamchk\fR +supports the following options for table repair operations: +.TP 3n +\(bu +\fB\-\-backup\fR, +\fB\-B\fR +.sp +Make a backup of the +\fI.MYD\fR +file as +\fI\fIfile_name\fR\fR\fI\-\fR\fI\fItime\fR\fR\fI.BAK\fR +.TP 3n +\(bu +\fB\-\-character\-sets\-dir=\fR\fB\fIpath\fR\fR +.sp +The directory where character sets are installed. See +Section\ 9.2, \(lqThe Character Set Used for Data and Sorting\(rq. +.TP 3n +\(bu +\fB\-\-correct\-checksum\fR +.sp +Correct the checksum information for the table. +.TP 3n +\(bu +\fB\-\-data\-file\-length=\fR\fB\fIlen\fR\fR\fB, \-D \fR\fB\fIlen\fR\fR +.sp +Maximum length of the data file (when re\-creating data file when it is +\(lqfull\(rq). +.TP 3n +\(bu +\fB\-\-extend\-check\fR, +\fB\-e\fR +.sp +Do a repair that tries to recover every possible row from the data file. Normally, this also finds a lot of garbage rows. Do not use this option unless you are desperate. +.TP 3n +\(bu +\fB\-\-force\fR, +\fB\-f\fR +.sp +Overwrite old intermediate files (files with names like +\fI\fItbl_name\fR\fR\fI.TMD\fR) instead of aborting. +.TP 3n +\(bu +\fB\-\-keys\-used=\fR\fB\fIval\fR\fR, +\fB\-k \fR\fB\fIval\fR\fR +.sp +For +\fBmyisamchk\fR, the option value is a bit\-value that indicates which indexes to update. Each binary bit of the option value corresponds to a table index, where the first index is bit 0. An option value of 0 disables updates to all indexes, which can be used to get faster inserts. Deactivated indexes can be reactivated by using +\fBmyisamchk \-r\fR. +.TP 3n +\(bu +\fB\-\-no\-symlinks\fR, +\fB\-l\fR +.sp +Do not follow symbolic links. Normally +\fBmyisamchk\fR +repairs the table that a symlink points to. This option does not exist as of MySQL 4.0 because versions from 4.0 on do not remove symlinks during repair operations. +.TP 3n +\(bu +\fB\-\-max\-record\-length=\fR\fB\fIlen\fR\fR +.sp +Skip rows larger than the given length if +\fBmyisamchk\fR +cannot allocate memory to hold them. +.TP 3n +\(bu +\fB\-\-parallel\-recover\fR, +\fB\-p\fR +.sp +Uses the same technique as +\fB\-r\fR +and +\fB\-n\fR, but creates all the keys in parallel, using different threads. +\fIThis is beta\-quality code. Use at your own risk!\fR +.TP 3n +\(bu +\fB\-\-quick\fR, +\fB\-q\fR +.sp +Achieve a faster repair by not modifying the data file. You can specify this option twice to force +\fBmyisamchk\fR +to modify the original data file in case of duplicate keys. +.TP 3n +\(bu +\fB\-\-recover\fR, +\fB\-r\fR +.sp +Do a repair that can fix almost any problem except unique keys that are not unique (which is an extremely unlikely error with +MyISAM +tables). If you want to recover a table, this is the option to try first. You should try +\fB\-\-safe\-recover\fR +only if +\fBmyisamchk\fR +reports that the table cannot be recovered using +\fB\-\-recover\fR. (In the unlikely case that +\fB\-\-recover\fR +fails, the data file remains intact.) +.sp +If you have lots of memory, you should increase the value of +sort_buffer_size. +.TP 3n +\(bu +\fB\-\-safe\-recover\fR, +\fB\-o\fR +.sp +Do a repair using an old recovery method that reads through all rows in order and updates all index trees based on the rows found. This is an order of magnitude slower than +\fB\-\-recover\fR, but can handle a couple of very unlikely cases that +\fB\-\-recover\fR +cannot. This recovery method also uses much less disk space than +\fB\-\-recover\fR. Normally, you should repair first using +\fB\-\-recover\fR, and then with +\fB\-\-safe\-recover\fR +only if +\fB\-\-recover\fR +fails. +.sp +If you have lots of memory, you should increase the value of +key_buffer_size. +.TP 3n +\(bu +\fB\-\-set\-character\-set=\fR\fB\fIname\fR\fR +.sp +Change the character set used by the table indexes. This option was replaced by +\fB\-\-set\-collation\fR +in MySQL 5.0.3. +.TP 3n +\(bu +\fB\-\-set\-collation=\fR\fB\fIname\fR\fR +.sp +Specify the collation to use for sorting table indexes. The character set name is implied by the first part of the collation name. +.TP 3n +\(bu +\fB\-\-sort\-recover\fR, +\fB\-n\fR +.sp +Force +\fBmyisamchk\fR +to use sorting to resolve the keys even if the temporary files would be very large. +.TP 3n +\(bu +\fB\-\-tmpdir=\fR\fB\fIpath\fR\fR, +\fB\-t \fR\fB\fIpath\fR\fR +.sp +Path of the directory to be used for storing temporary files. If this is not set, +\fBmyisamchk\fR +uses the value of the +TMPDIR +environment variable. +tmpdir +can be set to a list of directory paths that are used successively in round\-robin fashion for creating temporary files. The separator character between directory names is the colon (\(lq:\(rq) on Unix and the semicolon (\(lq;\(rq) on Windows, NetWare, and OS/2. +.TP 3n +\(bu +\fB\-\-unpack\fR, +\fB\-u\fR +.sp +Unpack a table that was packed with +\fBmyisampack\fR. +.SH "OTHER MYISAMCHK OPTIONS" +.PP +\fBmyisamchk\fR +supports the following options for actions other than table checks and repairs: +.TP 3n +\(bu +\fB\-\-analyze\fR, +\fB\-a\fR +.sp +Analyze the distribution of key values. This improves join performance by enabling the join optimizer to better choose the order in which to join the tables and which indexes it should use. To obtain information about the key distribution, use a +\fBmyisamchk \-\-description \-\-verbose \fR\fB\fItbl_name\fR\fR +command or the +SHOW INDEX FROM \fItbl_name\fR +statement. +.TP 3n +\(bu +\fB\-\-block\-search=\fR\fB\fIoffset\fR\fR, +\fB\-b \fR\fB\fIoffset\fR\fR +.sp +Find the record that a block at the given offset belongs to. +.TP 3n +\(bu +\fB\-\-description\fR, +\fB\-d\fR +.sp +Print some descriptive information about the table. +.TP 3n +\(bu +\fB\-\-set\-auto\-increment[=\fR\fB\fIvalue\fR\fR\fB]\fR, +\fB\-A[\fR\fB\fIvalue\fR\fR\fB]\fR +.sp +Force +AUTO_INCREMENT +numbering for new records to start at the given value (or higher, if there are existing records with +AUTO_INCREMENT +values this large). If +\fIvalue\fR +is not specified, +AUTO_INCREMENT +numbers for new records begin with the largest value currently in the table, plus one. +.TP 3n +\(bu +\fB\-\-sort\-index\fR, +\fB\-S\fR +.sp +Sort the index tree blocks in high\-low order. This optimizes seeks and makes table scans that use indexes faster. +.TP 3n +\(bu +\fB\-\-sort\-records=\fR\fB\fIN\fR\fR, +\fB\-R \fR\fB\fIN\fR\fR +.sp +Sort records according to a particular index. This makes your data much more localized and may speed up range\-based +SELECT +and +ORDER BY +operations that use this index. (The first time you use this option to sort a table, it may be very slow.) To determine a table's index numbers, use +SHOW INDEX, which displays a table's indexes in the same order that +\fBmyisamchk\fR +sees them. Indexes are numbered beginning with 1. +.sp +If keys are not packed (PACK_KEYS=0), they have the same length, so when +\fBmyisamchk\fR +sorts and moves records, it just overwrites record offsets in the index. If keys are packed (PACK_KEYS=1), +\fBmyisamchk\fR +must unpack key blocks first, then re\-create indexes and pack the key blocks again. (In this case, re\-creating indexes is faster than updating offsets for each index.) +.SH "\fBMYISAMCHK\fR MEMORY USAGE" +.PP +Memory allocation is important when you run +\fBmyisamchk\fR. +\fBmyisamchk\fR +uses no more memory than its memory\-related variables are set to. If you are going to use +\fBmyisamchk\fR +on very large tables, you should first decide how much memory you want it to use. The default is to use only about 3MB to perform repairs. By using larger values, you can get +\fBmyisamchk\fR +to operate faster. For example, if you have more than 32MB RAM, you could use options such as these (in addition to any other options you might specify): +.sp +.RS 3n +.nf +shell> \fBmyisamchk \-\-sort_buffer_size=16M \-\-key_buffer_size=16M \\\fR + \fB\-\-read_buffer_size=1M \-\-write_buffer_size=1M ...\fR +.fi +.RE +.PP +Using +\fB\-\-sort_buffer_size=16M\fR +should probably be enough for most cases. +.PP +Be aware that +\fBmyisamchk\fR +uses temporary files in +TMPDIR. If +TMPDIR +points to a memory file system, you may easily get out of memory errors. If this happens, run +\fBmyisamchk\fR +with the +\fB\-\-tmpdir=\fR\fB\fIpath\fR\fR +option to specify some directory located on a file system that has more space. +.PP +When repairing, +\fBmyisamchk\fR +also needs a lot of disk space: +.TP 3n +\(bu +Double the size of the data file (the original file and a copy). This space is not needed if you do a repair with +\fB\-\-quick\fR; in this case, only the index file is re\-created. +\fIThis space must be available on the same file system as the original data file\fR, as the copy is created in the same directory as the original. +.TP 3n +\(bu +Space for the new index file that replaces the old one. The old index file is truncated at the start of the repair operation, so you usually ignore this space. This space must be available on the same file system as the original data file. +.TP 3n +\(bu +When using +\fB\-\-recover\fR +or +\fB\-\-sort\-recover\fR +(but not when using +\fB\-\-safe\-recover\fR), you need space for a sort buffer. The following formula yields the amount of space required: +.sp +.RS 3n +.nf +(\fIlargest_key\fR + \fIrow_pointer_length\fR) \(mu \fInumber_of_rows\fR \(mu 2 +.fi +.RE +You can check the length of the keys and the +row_pointer_length +with +\fBmyisamchk \-dv \fR\fB\fItbl_name\fR\fR. This space is allocated in the temporary directory (specified by +TMPDIR +or +\fB\-\-tmpdir=\fR\fB\fIpath\fR\fR). +.sp +.RE +.PP +If you have a problem with disk space during repair, you can try +\fB\-\-safe\-recover\fR +instead of +\fB\-\-recover\fR. +.SH "COPYRIGHT" +.PP +Copyright 2007\-2008 MySQL AB, 2009 Sun Microsystems, Inc. +.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/. +.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 +MySQL AB (http://www.mysql.com/). diff --git a/man/myisamlog.1 b/man/myisamlog.1 new file mode 100644 index 00000000000..59aaff256ec --- /dev/null +++ b/man/myisamlog.1 @@ -0,0 +1,129 @@ +.\" Title: \fBmyisamlog\fR +.\" Author: +.\" Generator: DocBook XSL Stylesheets v1.70.1 <http://docbook.sf.net/> +.\" Date: 03/31/2009 +.\" Manual: MySQL Database System +.\" Source: MySQL 5.1 +.\" +.TH "\fBMYISAMLOG\fR" "1" "03/31/2009" "MySQL 5.1" "MySQL Database System" +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.SH "NAME" +myisamlog \- display MyISAM log file contents +.SH "SYNOPSIS" +.HP 46 +\fBmyisamlog [\fR\fB\fIoptions\fR\fR\fB] [\fR\fB\fIlog_file\fR\fR\fB [\fR\fB\fItbl_name\fR\fR\fB] ...]\fR +.SH "DESCRIPTION" +.PP +\fBmyisamlog\fR +processes the contents of a +MyISAM +log file. +.PP +Invoke +\fBmyisamlog\fR +like this: +.sp +.RS 3n +.nf +shell> \fBmyisamlog [\fR\fB\fIoptions\fR\fR\fB] [\fR\fB\fIlog_file\fR\fR\fB [\fR\fB\fItbl_name\fR\fR\fB] ...]\fR +shell> \fBisamlog [\fR\fB\fIoptions\fR\fR\fB] [\fR\fB\fIlog_file\fR\fR\fB [\fR\fB\fItbl_name\fR\fR\fB] ...]\fR +.fi +.RE +.PP +The default operation is update (\fB\-u\fR). If a recovery is done (\fB\-r\fR), all writes and possibly updates and deletes are done and errors are only counted. The default log file name is +\fImyisam.log\fR +for +\fBmyisamlog\fR +and +\fIisam.log\fR +for +\fBisamlog\fR +if no +\fIlog_file\fR +argument is given. If tables are named on the command line, only those tables are updated. +.PP +\fBmyisamlog\fR +understands the following options: +.TP 3n +\(bu +\fB\-?\fR, +\fB\-I\fR +.sp +Display a help message and exit. +.TP 3n +\(bu +\fB\-c \fR\fB\fIN\fR\fR +.sp +Execute only +\fIN\fR +commands. +.TP 3n +\(bu +\fB\-f \fR\fB\fIN\fR\fR +.sp +Specify the maximum number of open files. +.TP 3n +\(bu +\fB\-i\fR +.sp +Display extra information before exiting. +.TP 3n +\(bu +\fB\-o \fR\fB\fIoffset\fR\fR +.sp +Specify the starting offset. +.TP 3n +\(bu +\fB\-p \fR\fB\fIN\fR\fR +.sp +Remove +\fIN\fR +components from path. +.TP 3n +\(bu +\fB\-r\fR +.sp +Perform a recovery operation. +.TP 3n +\(bu +\fB\-R \fR\fB\fIrecord_pos_file record_pos\fR\fR +.sp +Specify record position file and record position. +.TP 3n +\(bu +\fB\-u\fR +.sp +Perform an update operation. +.TP 3n +\(bu +\fB\-v\fR +.sp +Verbose mode. Print more output about what the program does. This option can be given multiple times to produce more and more output. +.TP 3n +\(bu +\fB\-w \fR\fB\fIwrite_file\fR\fR +.sp +Specify the write file. +.TP 3n +\(bu +\fB\-V\fR +.sp +Display version information. +.SH "COPYRIGHT" +.PP +Copyright 2007\-2008 MySQL AB, 2009 Sun Microsystems, Inc. +.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/. +.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 +MySQL AB (http://www.mysql.com/). diff --git a/man/myisampack.1 b/man/myisampack.1 new file mode 100644 index 00000000000..679d846e544 --- /dev/null +++ b/man/myisampack.1 @@ -0,0 +1,523 @@ +.\" Title: \fBmyisampack\fR +.\" Author: +.\" Generator: DocBook XSL Stylesheets v1.70.1 <http://docbook.sf.net/> +.\" Date: 03/31/2009 +.\" Manual: MySQL Database System +.\" Source: MySQL 5.1 +.\" +.TH "\fBMYISAMPACK\fR" "1" "03/31/2009" "MySQL 5.1" "MySQL Database System" +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.SH "NAME" +myisampack \- generate compressed, read\-only MyISAM tables +.SH "SYNOPSIS" +.HP 35 +\fBmyisampack [\fR\fB\fIoptions\fR\fR\fB] \fR\fB\fIfile_name\fR\fR\fB ...\fR +.SH "DESCRIPTION" +.PP +The +\fBmyisampack\fR +utility compresses +MyISAM +tables. +\fBmyisampack\fR +works by compressing each column in the table separately. Usually, +\fBmyisampack\fR +packs the data file 40%\-70%. +.PP +When the table is used later, the server reads into memory the information needed to decompress columns. This results in much better performance when accessing individual rows, because you only have to uncompress exactly one row. +.PP +MySQL uses +mmap() +when possible to perform memory mapping on compressed tables. If +mmap() +does not work, MySQL falls back to normal read/write file operations. +.PP +Please note the following: +.TP 3n +\(bu +If the +\fBmysqld\fR +server was invoked with external locking disabled, it is not a good idea to invoke +\fBmyisampack\fR +if the table might be updated by the server during the packing process. It is safest to compress tables with the server stopped. +.TP 3n +\(bu +After packing a table, it becomes read only. This is generally intended (such as when accessing packed tables on a CD). Allowing writes to a packed table is on our TODO list, but with low priority. +.sp +.RE +.PP +Invoke +\fBmyisampack\fR +like this: +.sp +.RS 3n +.nf +shell> \fBmyisampack [\fR\fB\fIoptions\fR\fR\fB] \fR\fB\fIfile_name\fR\fR\fB ...\fR +.fi +.RE +.PP +Each file name argument should be the name of an index (\fI.MYI\fR) file. If you are not in the database directory, you should specify the path name to the file. It is permissible to omit the +\fI.MYI\fR +extension. +.PP +After you compress a table with +\fBmyisampack\fR, you should use +\fBmyisamchk \-rq\fR +to rebuild its indexes. +\fBmyisamchk\fR(1). +.PP +\fBmyisampack\fR +supports the following options: +.TP 3n +\(bu +\fB\-\-help\fR, +\fB\-?\fR +.sp +Display a help message and exit. +.TP 3n +\(bu +\fB\-\-backup\fR, +\fB\-b\fR +.sp +Make a backup of each table's data file using the name +\fI\fItbl_name\fR\fR\fI.OLD\fR. +.TP 3n +\(bu +\fB\-\-character\-sets\-dir=\fR\fB\fIpath\fR\fR +.sp +The directory where character sets are installed. See +Section\ 9.2, \(lqThe Character Set Used for Data and Sorting\(rq. +.TP 3n +\(bu +\fB\-\-debug[=\fR\fB\fIdebug_options\fR\fR\fB]\fR, +\fB\-# [\fR\fB\fIdebug_options\fR\fR\fB]\fR +.sp +Write a debugging log. The +\fIdebug_options\fR +string often is +\'d:t:o,\fIfile_name\fR'. +.TP 3n +\(bu +\fB\-\-force\fR, +\fB\-f\fR +.sp +Produce a packed table even if it becomes larger than the original or if the intermediate file from an earlier invocation of +\fBmyisampack\fR +exists. (\fBmyisampack\fR +creates an intermediate file named +\fI\fItbl_name\fR\fR\fI.TMD\fR +in the database directory while it compresses the table. If you kill +\fBmyisampack\fR, the +\fI.TMD\fR +file might not be deleted.) Normally, +\fBmyisampack\fR +exits with an error if it finds that +\fI\fItbl_name\fR\fR\fI.TMD\fR +exists. With +\fB\-\-force\fR, +\fBmyisampack\fR +packs the table anyway. +.TP 3n +\(bu +\fB\-\-join=\fR\fB\fIbig_tbl_name\fR\fR, +\fB\-j \fR\fB\fIbig_tbl_name\fR\fR +.sp +Join all tables named on the command line into a single packed table +\fIbig_tbl_name\fR. All tables that are to be combined +\fImust\fR +have identical structure (same column names and types, same indexes, and so forth). +.sp +\fIbig_tbl_name\fR +must not exist prior to the join operation. All source tables named on the command line to be merged into +\fIbig_tbl_name\fR +must exist. The source tables are read for the join operation but not modified. The join operation does not create a +\fI.frm\fR +file for +\fIbig_tbl_name\fR, so after the join operation finishes, copy the +\fI.frm\fR +file from one of the source tables and name it +\fI\fIbig_tbl_name\fR\fR\fI.frm\fR. +.TP 3n +\(bu +\fB\-\-silent\fR, +\fB\-s\fR +.sp +Silent mode. Write output only when errors occur. +.TP 3n +\(bu +\fB\-\-test\fR, +\fB\-t\fR +.sp +Do not actually pack the table, just test packing it. +.TP 3n +\(bu +\fB\-\-tmpdir=\fR\fB\fIpath\fR\fR, +\fB\-T \fR\fB\fIpath\fR\fR +.sp +Use the named directory as the location where +\fBmyisampack\fR +creates temporary files. +.TP 3n +\(bu +\fB\-\-verbose\fR, +\fB\-v\fR +.sp +Verbose mode. Write information about the progress of the packing operation and its result. +.TP 3n +\(bu +\fB\-\-version\fR, +\fB\-V\fR +.sp +Display version information and exit. +.TP 3n +\(bu +\fB\-\-wait\fR, +\fB\-w\fR +.sp +Wait and retry if the table is in use. If the +\fBmysqld\fR +server was invoked with external locking disabled, it is not a good idea to invoke +\fBmyisampack\fR +if the table might be updated by the server during the packing process. +.sp +.RE +.PP +The following sequence of commands illustrates a typical table compression session: +.sp +.RS 3n +.nf +shell> \fBls \-l station.*\fR +\-rw\-rw\-r\-\- 1 monty my 994128 Apr 17 19:00 station.MYD +\-rw\-rw\-r\-\- 1 monty my 53248 Apr 17 19:00 station.MYI +\-rw\-rw\-r\-\- 1 monty my 5767 Apr 17 19:00 station.frm +shell> \fBmyisamchk \-dvv station\fR +MyISAM file: station +Isam\-version: 2 +Creation time: 1996\-03\-13 10:08:58 +Recover time: 1997\-02\-02 3:06:43 +Data records: 1192 Deleted blocks: 0 +Datafile parts: 1192 Deleted data: 0 +Datafile pointer (bytes): 2 Keyfile pointer (bytes): 2 +Max datafile length: 54657023 Max keyfile length: 33554431 +Recordlength: 834 +Record format: Fixed length +table description: +Key Start Len Index Type Root Blocksize Rec/key +1 2 4 unique unsigned long 1024 1024 1 +2 32 30 multip. text 10240 1024 1 +Field Start Length Type +1 1 1 +2 2 4 +3 6 4 +4 10 1 +5 11 20 +6 31 1 +7 32 30 +8 62 35 +9 97 35 +10 132 35 +11 167 4 +12 171 16 +13 187 35 +14 222 4 +15 226 16 +16 242 20 +17 262 20 +18 282 20 +19 302 30 +20 332 4 +21 336 4 +22 340 1 +23 341 8 +24 349 8 +25 357 8 +26 365 2 +27 367 2 +28 369 4 +29 373 4 +30 377 1 +31 378 2 +32 380 8 +33 388 4 +34 392 4 +35 396 4 +36 400 4 +37 404 1 +38 405 4 +39 409 4 +40 413 4 +41 417 4 +42 421 4 +43 425 4 +44 429 20 +45 449 30 +46 479 1 +47 480 1 +48 481 79 +49 560 79 +50 639 79 +51 718 79 +52 797 8 +53 805 1 +54 806 1 +55 807 20 +56 827 4 +57 831 4 +shell> \fBmyisampack station.MYI\fR +Compressing station.MYI: (1192 records) +\- Calculating statistics +normal: 20 empty\-space: 16 empty\-zero: 12 empty\-fill: 11 +pre\-space: 0 end\-space: 12 table\-lookups: 5 zero: 7 +Original trees: 57 After join: 17 +\- Compressing file +87.14% +Remember to run myisamchk \-rq on compressed tables +shell> \fBls \-l station.*\fR +\-rw\-rw\-r\-\- 1 monty my 127874 Apr 17 19:00 station.MYD +\-rw\-rw\-r\-\- 1 monty my 55296 Apr 17 19:04 station.MYI +\-rw\-rw\-r\-\- 1 monty my 5767 Apr 17 19:00 station.frm +shell> \fBmyisamchk \-dvv station\fR +MyISAM file: station +Isam\-version: 2 +Creation time: 1996\-03\-13 10:08:58 +Recover time: 1997\-04\-17 19:04:26 +Data records: 1192 Deleted blocks: 0 +Datafile parts: 1192 Deleted data: 0 +Datafile pointer (bytes): 3 Keyfile pointer (bytes): 1 +Max datafile length: 16777215 Max keyfile length: 131071 +Recordlength: 834 +Record format: Compressed +table description: +Key Start Len Index Type Root Blocksize Rec/key +1 2 4 unique unsigned long 10240 1024 1 +2 32 30 multip. text 54272 1024 1 +Field Start Length Type Huff tree Bits +1 1 1 constant 1 0 +2 2 4 zerofill(1) 2 9 +3 6 4 no zeros, zerofill(1) 2 9 +4 10 1 3 9 +5 11 20 table\-lookup 4 0 +6 31 1 3 9 +7 32 30 no endspace, not_always 5 9 +8 62 35 no endspace, not_always, no empty 6 9 +9 97 35 no empty 7 9 +10 132 35 no endspace, not_always, no empty 6 9 +11 167 4 zerofill(1) 2 9 +12 171 16 no endspace, not_always, no empty 5 9 +13 187 35 no endspace, not_always, no empty 6 9 +14 222 4 zerofill(1) 2 9 +15 226 16 no endspace, not_always, no empty 5 9 +16 242 20 no endspace, not_always 8 9 +17 262 20 no endspace, no empty 8 9 +18 282 20 no endspace, no empty 5 9 +19 302 30 no endspace, no empty 6 9 +20 332 4 always zero 2 9 +21 336 4 always zero 2 9 +22 340 1 3 9 +23 341 8 table\-lookup 9 0 +24 349 8 table\-lookup 10 0 +25 357 8 always zero 2 9 +26 365 2 2 9 +27 367 2 no zeros, zerofill(1) 2 9 +28 369 4 no zeros, zerofill(1) 2 9 +29 373 4 table\-lookup 11 0 +30 377 1 3 9 +31 378 2 no zeros, zerofill(1) 2 9 +32 380 8 no zeros 2 9 +33 388 4 always zero 2 9 +34 392 4 table\-lookup 12 0 +35 396 4 no zeros, zerofill(1) 13 9 +36 400 4 no zeros, zerofill(1) 2 9 +37 404 1 2 9 +38 405 4 no zeros 2 9 +39 409 4 always zero 2 9 +40 413 4 no zeros 2 9 +41 417 4 always zero 2 9 +42 421 4 no zeros 2 9 +43 425 4 always zero 2 9 +44 429 20 no empty 3 9 +45 449 30 no empty 3 9 +46 479 1 14 4 +47 480 1 14 4 +48 481 79 no endspace, no empty 15 9 +49 560 79 no empty 2 9 +50 639 79 no empty 2 9 +51 718 79 no endspace 16 9 +52 797 8 no empty 2 9 +53 805 1 17 1 +54 806 1 3 9 +55 807 20 no empty 3 9 +56 827 4 no zeros, zerofill(2) 2 9 +57 831 4 no zeros, zerofill(1) 2 9 +.fi +.RE +.PP +\fBmyisampack\fR +displays the following kinds of information: +.TP 3n +\(bu +normal +.sp +The number of columns for which no extra packing is used. +.TP 3n +\(bu +empty\-space +.sp +The number of columns containing values that are only spaces. These occupy one bit. +.TP 3n +\(bu +empty\-zero +.sp +The number of columns containing values that are only binary zeros. These occupy one bit. +.TP 3n +\(bu +empty\-fill +.sp +The number of integer columns that do not occupy the full byte range of their type. These are changed to a smaller type. For example, a +BIGINT +column (eight bytes) can be stored as a +TINYINT +column (one byte) if all its values are in the range from +\-128 +to +127. +.TP 3n +\(bu +pre\-space +.sp +The number of decimal columns that are stored with leading spaces. In this case, each value contains a count for the number of leading spaces. +.TP 3n +\(bu +end\-space +.sp +The number of columns that have a lot of trailing spaces. In this case, each value contains a count for the number of trailing spaces. +.TP 3n +\(bu +table\-lookup +.sp +The column had only a small number of different values, which were converted to an +ENUM +before Huffman compression. +.TP 3n +\(bu +zero +.sp +The number of columns for which all values are zero. +.TP 3n +\(bu +Original trees +.sp +The initial number of Huffman trees. +.TP 3n +\(bu +After join +.sp +The number of distinct Huffman trees left after joining trees to save some header space. +.sp +.RE +.PP +After a table has been compressed, +\fBmyisamchk \-dvv\fR +prints additional information about each column: +.TP 3n +\(bu +Type +.sp +The data type. The value may contain any of the following descriptors: +.RS 3n +.TP 3n +\(bu +constant +.sp +All rows have the same value. +.TP 3n +\(bu +no endspace +.sp +Do not store endspace. +.TP 3n +\(bu +no endspace, not_always +.sp +Do not store endspace and do not do endspace compression for all values. +.TP 3n +\(bu +no endspace, no empty +.sp +Do not store endspace. Do not store empty values. +.TP 3n +\(bu +table\-lookup +.sp +The column was converted to an +ENUM. +.TP 3n +\(bu +zerofill(\fIN\fR) +.sp +The most significant +\fIN\fR +bytes in the value are always 0 and are not stored. +.TP 3n +\(bu +no zeros +.sp +Do not store zeros. +.TP 3n +\(bu +always zero +.sp +Zero values are stored using one bit. +.RE +.TP 3n +\(bu +Huff tree +.sp +The number of the Huffman tree associated with the column. +.TP 3n +\(bu +Bits +.sp +The number of bits used in the Huffman tree. +.sp +.RE +.PP +After you run +\fBmyisampack\fR, you must run +\fBmyisamchk\fR +to re\-create any indexes. At this time, you can also sort the index blocks and create statistics needed for the MySQL optimizer to work more efficiently: +.sp +.RS 3n +.nf +shell> \fBmyisamchk \-rq \-\-sort\-index \-\-analyze \fR\fB\fItbl_name\fR\fR\fB.MYI\fR +.fi +.RE +.PP +After you have installed the packed table into the MySQL database directory, you should execute +\fBmysqladmin flush\-tables\fR +to force +\fBmysqld\fR +to start using the new table. +.PP +To unpack a packed table, use the +\fB\-\-unpack\fR +option to +\fBmyisamchk\fR. +.SH "COPYRIGHT" +.PP +Copyright 2007\-2008 MySQL AB, 2009 Sun Microsystems, Inc. +.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/. +.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 +MySQL AB (http://www.mysql.com/). diff --git a/man/mysql-stress-test.pl.1 b/man/mysql-stress-test.pl.1 new file mode 100644 index 00000000000..fab129e508d --- /dev/null +++ b/man/mysql-stress-test.pl.1 @@ -0,0 +1,234 @@ +.\" Title: \fBmysql\-stress\-test.pl\fR +.\" Author: +.\" Generator: DocBook XSL Stylesheets v1.70.1 <http://docbook.sf.net/> +.\" Date: 03/27/2009 +.\" Manual: MySQL Database System +.\" Source: MySQL +.\" +.TH "\fBMYSQL\-STRESS\-TEST" "1" "03/27/2009" "MySQL" "MySQL Database System" +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.SH "NAME" +mysql\-stress\-test.pl \- server stress test program +.SH "SYNOPSIS" +.HP 31 +\fBmysql\-stress\-test.pl [\fR\fB\fIoptions\fR\fR\fB]\fR +.SH "DESCRIPTION" +.PP +The +\fBmysql\-stress\-test.pl\fR +Perl script performs stress\-testing of the MySQL server. (MySQL 5.0 and up only) +.PP +\fBmysql\-stress\-test.pl\fR +requires a version of Perl that has been built with threads support. +.PP +Invoke +\fBmysql\-stress\-test.pl\fR +like this: +.sp +.RS 3n +.nf +shell> \fBmysql\-stress\-test.pl [\fR\fB\fIoptions\fR\fR\fB]\fR +.fi +.RE +.PP +\fBmysql\-stress\-test.pl\fR +supports the following options: +.TP 3n +\(bu +\fB\-\-help\fR +.sp +Display a help message and exit. +.TP 3n +\(bu +\fB\-\-abort\-on\-error\fR +.sp +Unknown. +.TP 3n +\(bu +\fB\-\-check\-tests\-file\fR +.sp +Periodically check the file that lists the tests to be run. If it has been modified, reread the file. This can be useful if you update the list of tests to be run during a stress test. +.TP 3n +\(bu +\fB\-\-cleanup\fR +.sp +Force cleanup of the working directory. +.TP 3n +\(bu +\fB\-\-log\-error\-details\fR +.sp +Log error details in the global error log file. +.TP 3n +\(bu +\fB\-\-loop\-count=\fR\fB\fIN\fR\fR +.sp +In sequential test mode, the number of loops to execute before exiting. +.TP 3n +\(bu +\fB\-\-mysqltest=\fR\fB\fIpath\fR\fR +.sp +The path name to the +\fBmysqltest\fR +program. +.TP 3n +\(bu +\fB\-\-server\-database=\fR\fB\fIdb_name\fR\fR +.sp +The database to use for the tests. +.TP 3n +\(bu +\fB\-\-server\-host=\fR\fB\fIhost_name\fR\fR +.sp +The host name of the local host to use for making a TCP/IP connection to the local server. By default, the connection is made to +localhost +using a Unix socket file. +.TP 3n +\(bu +\fB\-\-server\-logs\-dir=\fR\fB\fIpath\fR\fR +.sp +This option is required. +\fIpath\fR +is the directory where all client session logs will be stored. Usually this is the shared directory that is associated with the server used for testing. +.TP 3n +\(bu +\fB\-\-server\-password=\fR\fB\fIpassword\fR\fR +.sp +The password to use when connecting to the server. +.TP 3n +\(bu +\fB\-\-server\-port=\fR\fB\fIport_num\fR\fR +.sp +The TCP/IP port number to use for connecting to the server. The default is 3306. +.TP 3n +\(bu +\fB\-\-server\-socket=\fR\fB\fIfile_name\fR\fR +.sp +For connections to +localhost, the Unix socket file to use, or, on Windows, the name of the named pipe to use. The default if +\fI/tmp/mysql.sock\fR. +.TP 3n +\(bu +\fB\-\-server\-user=\fR\fB\fIuser_name\fR\fR +.sp +The MySQL user name to use when connecting to the server. The default is +root. +.TP 3n +\(bu +\fB\-\-sleep\-time=\fR\fB\fIN\fR\fR +.sp +The delay in seconds between test executions. +.TP 3n +\(bu +\fB\-\-stress\-basedir=\fR\fB\fIpath\fR\fR +.sp +This option is required. +\fIpath\fR +is the working directory for the test run. It is used as the temporary location for result tracking during testing. +.TP 3n +\(bu +\fB\-\-stress\-datadir=\fR\fB\fIpath\fR\fR +.sp +The directory of data files to be used during testing. The default location is the +\fIdata\fR +directory under the location given by the +\fB\-\-stress\-suite\-basedir\fR +option. +.TP 3n +\(bu +\fB\-\-stress\-init\-file[=\fR\fB\fIpath\fR\fR\fB]\fR +.sp +\fIfile_name\fR +is the location of the file that contains the list of tests. If missing, the default file is +\fIstress_init.txt\fR +in the test suite directory. +.TP 3n +\(bu +\fB\-\-stress\-mode=\fR\fB\fImode\fR\fR +.sp +This option indicates the test order in stress\-test mode. The +\fImode\fR +value is either +random +to select tests in random order or +seq +to run tests in each thread in the order specified in the test list file. The default mode is +random. +.TP 3n +\(bu +\fB\-\-stress\-suite\-basedir=\fR\fB\fIpath\fR\fR +.sp +This option is required. +\fIpath\fR +is the directory that has the +\fIt\fR +and +\fIr\fR +subdirectories containing the test case and result files. This directory is also the default location of the +\fIstress\-test.txt\fR +file that contains the list of tests. (A different location can be specified with the +\fB\-\-stress\-tests\-file\fR +option.) +.TP 3n +\(bu +\fB\-\-stress\-tests\-file[=\fR\fB\fIfile_name\fR\fR\fB]\fR +.sp +Use this option to run the stress tests. +\fIfile_name\fR +is the location of the file that contains the list of tests. If +\fIfile_name\fR +is omitted, the default file is +\fIstress\-test.txt\fR +in the stress suite directory. (See +\fB\-\-stress\-suite\-basedir\fR.) +.TP 3n +\(bu +\fB\-\-suite=\fR\fB\fIsuite_name\fR\fR +.sp +Run the named test suite. The default name is +main +(the regular test suite located in the +\fImysql\-test\fR +directory). +.TP 3n +\(bu +\fB\-\-test\-count=\fR\fB\fIN\fR\fR +.sp +The number of tests to execute before exiting. +.TP 3n +\(bu +\fB\-\-test\-duration=\fR\fB\fIN\fR\fR +.sp +The duration of stress testing in seconds. +.TP 3n +\(bu +\fB\-\-test\-suffix=\fR\fB\fIstr\fR\fR +.sp +Unknown. +.TP 3n +\(bu +\fB\-\-threads=\fR\fB\fIN\fR\fR +.sp +The number of threads. The default is 1. +.TP 3n +\(bu +\fB\-\-verbose\fR +.sp +Verbose mode. Print more information about what the program does. +.SH "COPYRIGHT" +.PP +Copyright 2007\-2008 MySQL AB, 2009 Sun Microsystems, Inc. +.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/. +.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 +MySQL AB (http://www.mysql.com/). diff --git a/man/mysql-test-run.pl.1 b/man/mysql-test-run.pl.1 new file mode 100644 index 00000000000..7919f080cd5 --- /dev/null +++ b/man/mysql-test-run.pl.1 @@ -0,0 +1,1145 @@ +.\" Title: \fBmysql\-test\-run.pl\fR +.\" Author: +.\" Generator: DocBook XSL Stylesheets v1.70.1 <http://docbook.sf.net/> +.\" Date: 03/27/2009 +.\" Manual: MySQL Database System +.\" Source: MySQL +.\" +.TH "\fBMYSQL\-TEST\-RUN.PL" "1" "03/27/2009" "MySQL" "MySQL Database System" +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.SH "NAME" +mysql\-test\-run.pl \- run MySQL test suite +.SH "SYNOPSIS" +.HP 28 +\fBmysql\-test\-run.pl [\fR\fB\fIoptions\fR\fR\fB]\fR +.SH "DESCRIPTION" +.PP +The +\fBmysql\-test\-run.pl\fR +Perl script is the main application used to run the MySQL test suite. It invokes +\fBmysqltest\fR +to run individual test cases. (Prior to MySQL 4.1, a similar shell script, +\fBmysql\-test\-run\fR, can be used instead.) +.PP +Invoke +\fBmysql\-test\-run.pl\fR +in the +\fImysql\-test\fR +directory like this: +.sp +.RS 3n +.nf +shell> \fBmysql\-test\-run.pl [\fR\fB\fIoptions\fR\fR\fB] [\fR\fB\fItest_name\fR\fR\fB] ...\fR +.fi +.RE +.PP +Each +\fItest_name\fR +argument names a test case. The test case file that corresponds to the test name is +\fIt/\fR\fI\fItest_name\fR\fR\fI.test\fR. +.PP +For each +\fItest_name\fR +argument, +\fBmysql\-test\-run.pl\fR +runs the named test case. With no +\fItest_name\fR +arguments, +\fBmysql\-test\-run.pl\fR +runs all +\fI.test\fR +files in the +\fIt\fR +subdirectory. +.PP +If no suffix is given for the test name, a suffix of +\fI.test\fR +is assumed. Any leading path name is ignored. These commands are equivalent: +.sp +.RS 3n +.nf +shell> \fBmysql\-test\-run.pl mytest\fR +shell> \fBmysql\-test\-run.pl mytest.test\fR +shell> \fBmysql\-test\-run.pl t/mytest.test\fR +.fi +.RE +.PP +As of MySQL 5.1.23, a suite name can be given as part of the test name. That is, the syntax for naming a test is: +.sp +.RS 3n +.nf +[\fIsuite_name\fR.]\fItest_name\fR[.\fIsuffix\fR] +.fi +.RE +.PP +If a suite name is given, +\fBmysql\-test\-run.pl\fR +looks in that suite for the test. With no suite name, +\fBmysql\-test\-run.pl\fR +looks in the default list of suites for a match and runs the test in any suites where it finds the test. Suppose that the default suite list is +main, +binlog, +rpl, and that a test +\fImytest.test\fR +exists in the +main +and +rpl +suites. With an argument of +mytest +or +mytest.test, +\fBmysql\-test\-run.pl\fR +will run +\fImytest.test\fR +from the +main +and +rpl +suites. +.PP +To run a family of test cases for which the names share a common prefix, use the +\fB\-\-do\-test=\fR\fB\fIprefix\fR\fR +option. For example, +\fB\-\-do\-test=rpl\fR +runs the replication tests (test cases that have names beginning with +rpl). +\fB\-\-skip\-test\fR +has the opposite effect of skipping test cases for which the names share a common prefix. +.PP +As of MySQL 5.0.54/5.1.23/6.0.5, the argument for the +\fB\-\-do\-test\fR +and +\fB\-\-skip\-test\fR +options allows more flexible specification of which tests to perform or skip. If the argument contains a pattern metacharacter other than a lone period, it is interpreted as a Perl regular expression and applies to test names that match the pattern. If the argument contains a lone period or does not contain any pattern metacharacters, it is interpreted the same way as previously and matches test names that begin with the argument value. For example, +\fB\-\-do\-test=testa\fR +matches tests that begin with +testa, +\fB\-\-do\-test=main.testa\fR +matches tests in the +main +test suite that begin with +testa, and +\fB\-\-do\-test=main.*testa\fR +matches test names that contain +main +followed by +testa +with anything in between. In the latter case, the pattern match is not anchored to the beginning of the test name, so it also matches names such as +xmainytestz. +.PP +To perform setup prior to running tests, +\fBmysql\-test\-run.pl\fR +needs to invoke +\fBmysqld\fR +with the +\fB\-\-bootstrap\fR +and +\fB\-\-skip\-grant\-tables\fR +options (see +[1]\&\fITypical \fBconfigure\fR Options\fR). If MySQL was configured with the +\fB\-\-disable\-grant\-options\fR +option, +\fB\-\-bootstrap\fR, +\fB\-\-skip\-grant\-tables\fR, and +\fB\-\-init\-file\fR +will be disabled. To handle this, set the +MYSQLD_BOOTSTRAP +environment variable to the full path name of a server that has all options enabled. +\fBmysql\-test\-run.pl\fR +will use that server to perform setup; it is not used to run the tests. +.PP +The +init_file +test will fail if +\fB\-\-init\-file\fR +is disabled. This is an expected failure that can be handled as follows: +.sp +.RS 3n +.nf +shell> \fBexport MYSQLD_BOOTSTRAP\fR +shell> \fBMYSQLD_BOOTSTRAP=/full/path/to/mysqld\fR +shell> \fBmake test force="\-\-skip\-test=init_file"\fR +.fi +.RE +.PP +To run +\fBmysql\-test\-run.pl\fR +on Windows, you'll need either Cygwin or ActiveState Perl to run it. You may also need to install the modules required by the script. To run the test script, change location into the +\fImysql\-test\fR +directory, set the +MTR_VS_CONFIG +environment variable to the configuration you selected earlier (or use the +\fB\-\-vs\-config\fR +option), and invoke +\fBmysql\-test\-run.pl\fR. For example (using Cygwin and the +\fBbash\fR +shell): +.sp +.RS 3n +.nf +shell> \fBcd mysql\-test\fR +shell> \fBexport MTS_VS_CONFIG=debug\fR +shell> \fB./mysqltest\-run.pl \-\-force \-\-timer\fR +shell> \fB./mysqltest\-run.pl \-\-force \-\-timer \-\-ps\-protocol\fR +.fi +.RE +.PP +If you have a copy of +\fBmysqld\fR +running on the machine where you want to run the test suite, you do not have to stop it, as long as it is not using ports +9306 +or +9307. If either of those ports is taken, you should set the +MTR_BUILD_THREAD +environment variable to an appropriate value, and the test suite will use a different set of ports for master, slave, NDB, and Instance Manager). For example: +.sp +.RS 3n +.nf +shell> \fBexport MTR_BUILD_THREAD=31\fR +shell> \fB./mysql\-test\-run.pl [\fR\fB\fIoptions\fR\fR\fB] [\fR\fB\fItest_name\fR\fR\fB]\fR +.fi +.RE +.PP +\fBmysql\-test\-run.pl\fR +defines several environment variables. Some of them are listed in the following table. +.TS +allbox tab(:); +l l +l l +l l +l l +l l +l l. +T{ +\fBVariable\fR +T}:T{ +\fBMeaning\fR +T} +T{ +MYSQL_TEST +T}:T{ +Path name to \fBmysqltest\fR binary +T} +T{ +MYSQLTEST_VARDIR +T}:T{ +Path name to the \fIvar\fR directory that is used for + logs, temporary files, and so forth +T} +T{ +MYSQLD_BOOTSTRAP +T}:T{ +Full path name to \fBmysqld\fR that has all options enabled +T} +T{ +MASTER_MYPORT +T}:T{ +??? +T} +T{ +MASTER_MYSOCK +T}:T{ +??? +T} +.TE +.sp +.PP +Tests sometimes rely on certain environment variables being defined. For example, certain tests assume that +MYSQL_TEST +is defined so that +\fBmysqltest\fR +can invoke itself with +exec $MYSQL_TEST. +.PP +\fBmysql\-test\-run.pl\fR +supports the options in the following list. An argument of +\fB\-\-\fR +tells +\fBmysql\-test\-run.pl\fR +not to process any following arguments as options. (A description of differences between the options supported by +\fBmysql\-test\-run.pl\fR +and +\fBmysql\-test\-run\fR +appears following the list.) +.TP 3n +\(bu +\fB\-\-help\fR, +\fB\-h\fR +.sp +Display a help message and exit. +.TP 3n +\(bu +\fB\-\-bench\fR +.sp +Run the benchmark suite. +.TP 3n +\(bu +\fB\-\-benchdir=\fR\fB\fIpath\fR\fR +.sp +The directory where the benchmark suite is located. The default path is +\fI../../mysql\-bench\fR. +.TP 3n +\(bu +\fB\-\-big\-test\fR +.sp +Pass the +\fB\-\-big\-test\fR +option to +\fBmysqltest\fR. +.TP 3n +\(bu +\fB\-\-check\-testcases\fR +.sp +Check test cases for side effects. +.TP 3n +\(bu +\fB\-\-client\-bindir\fR +.sp +The path to the directory where client binaries are located. This option was added in MySQL 5.0.66/5.1.27. +.TP 3n +\(bu +\fB\-\-client\-ddd\fR +.sp +Start +\fBmysqltest\fR +in the +\fBddd\fR +debugger. +.TP 3n +\(bu +\fB\-\-client\-debugger\fR +.sp +Start +\fBmysqltest\fR +in the named debugger. +.TP 3n +\(bu +\fB\-\-client\-gdb\fR +.sp +Start +\fBmysqltest\fR +in the +\fBgdb\fR +debugger. +.TP 3n +\(bu +\fB\-\-client\-libdir\fR +.sp +The path to the directory where client libraries are located. This option was added in MySQL 5.0.66/5.1.27. +.TP 3n +\(bu +\fB\-\-combination=\fR\fB\fIvalue\fR\fR +.sp +Extra options to pass to +\fBmysqld\fR. The value should consist of one or more comma\-separated +\fBmysqld\fR +options. This option is similar to +\fB\-\-mysqld\fR +but should be given two or more times. +\fBmysql\-test\-run.pl\fR +executes multiple test runs, using the options for each instance of +\fB\-\-combination\fR +in successive runs. If +\fB\-\-combination\fR +is given only once, it has no effect. For test runs specific to a given test suite, an alternative to the use of +\fB\-\-combination\fR +is to create a +\fIcombinations\fR +file in the suite directory. The file should contain a section of options for each test run. See +Section\ 4.9, \(lqPassing Options from \fBmysql\-test\-run.pl\fR to \fBmysqld\fR or \fBmysqltest\fR\(rq. +.sp +This option was added in MySQL 5.1.23/6.0.4. +.TP 3n +\(bu +\fB\-\-comment=\fR\fB\fIstr\fR\fR +.sp +Write +\fIstr\fR +to the output. +.TP 3n +\(bu +\fB\-\-compress\fR +.sp +Compress all information sent between the client and the server if both support compression. +.TP 3n +\(bu +\fB\-\-cursor\-protocol\fR +.sp +Pass the +\fB\-\-cursor\-protocol\fR +option to +\fBmysqltest\fR +(implies +\fB\-\-ps\-protocol\fR). +.TP 3n +\(bu +\fB\-\-ddd\fR +.sp +Start +\fBmysqld\fR +in the +\fBddd\fR +debugger. +.TP 3n +\(bu +\fB\-\-debug\fR +.sp +Dump trace output for all clients and servers. +.TP 3n +\(bu +\fB\-\-debugger\fR +.sp +Start +\fBmysqld\fR +using the named debugger. +.TP 3n +\(bu +\fB\-\-debug\-sync\-timeout=\fR\fB\fIN\fR\fR +.sp +Controls whether the Debug Sync facility for testing and debugging is enabled. The option value is a timeout in seconds. The default value is 300. A value of 0 disables Debug Sync. The value of this option also becomes the default timeout for individual synchronization points. +.sp +\fBmysql\-test\-run.pl\fR +passes +\fB\-\-loose\-debug\-sync\-timeout=\fR\fB\fIN\fR\fR +to +\fBmysqld\fR. The +\fB\-\-loose\fR +prefix is used so that +\fBmysqld\fR +does not fail if Debug Sync is not compiled in. +.sp +For information about using the Debug Sync facility for testing, see +Section\ 4.14, \(lqThread Synchronization in Test Cases\(rq. +.sp +This option was added in MySQL 6.0.6. +.TP 3n +\(bu +\fB\-\-do\-test=\fR\fB\fIprefix\fR\fR +.sp +Run all test cases having a name that begins with the given +\fIprefix\fR +value. This option provides a convenient way to run a family of similarly named tests. +.sp +As of MySQL 5.0.54/5.1.23/6.0.5, the argument for the +\fB\-\-do\-test\fR +option allows more flexible specification of which tests to perform. If the argument contains a pattern metacharacter other than a lone period, it is interpreted as a Perl regular expression and applies to test names that match the pattern. If the argument contains a lone period or does not contain any pattern metacharacters, it is interpreted the same way as previously and matches test names that begin with the argument value. For example, +\fB\-\-do\-test=testa\fR +matches tests that begin with +testa, +\fB\-\-do\-test=main.testa\fR +matches tests in the +main +test suite that begin with +testa, and +\fB\-\-do\-test=main.*testa\fR +matches test names that contain +main +followed by +testa +with anything in between. In the latter case, the pattern match is not anchored to the beginning of the test name, so it also matches names such as +xmainytestz. +.TP 3n +\(bu +\fB\-\-embedded\-server\fR +.sp +Use a version of +\fBmysqltest\fR +built with the embedded server. +.TP 3n +\(bu +\fB\-\-experimental=\fR\fB\fIfile_name\fR\fR +.sp +Specify a file that contains a list of test cases that should be displayed with the +[ exp\-fail ] +code rather than +[ fail ] +if they fail. This option was added in MySQL 5.1.33/6.0.11. +.TP 3n +\(bu +\fB\-\-extern\fR +.sp +Use an already running server. +.sp +Note: If a test case has an +\fI.opt\fR +file that requires the server to be restarted with specific options, the file will not be used. The test case likely will fail as a result. +.TP 3n +\(bu +\fB\-\-fast\fR +.sp +Do not clean up from earlier test runs. +.TP 3n +\(bu +\fB\-\-force\fR +.sp +Normally, +\fBmysql\-test\-run.pl\fR +exits if a test case fails. +\fB\-\-force\fR +causes execution to continue regardless of test case failure. +.TP 3n +\(bu +\fB\-\-gcov\fR +.sp +Run tests with the +\fBgcov\fR +test coverage tool. +.TP 3n +\(bu +\fB\-\-gdb\fR +.sp +Start +\fBmysqld\fR +in the +\fBgdb\fR +debugger. +.TP 3n +\(bu +\fB\-\-gprof\fR +.sp +Run tests with the +\fBgprof\fR +profiling tool. +.TP 3n +\(bu +\fB\-\-im\-mysqld1\-port\fR +.sp +TCP/IP port number to use for the first +\fBmysqld\fR, controlled by Instance Manager. +.TP 3n +\(bu +\fB\-\-im\-mysqld2\-port\fR +.sp +TCP/IP port number to use for the second +\fBmysqld\fR, controlled by Instance Manager. +.TP 3n +\(bu +\fB\-\-im\-port\fR +.sp +TCP/IP port number to use for +\fBmysqld\fR, controlled by Instance Manager. +.TP 3n +\(bu +\fB\-\-log\-warnings\fR +.sp +Pass the +\fB\-\-log\-warnings\fR +option to +\fBmysqld\fR. +.TP 3n +\(bu +\fB\-\-manual\-debug\fR +.sp +Use a server that has already been started by the user in a debugger. +.TP 3n +\(bu +\fB\-\-manual\-gdb\fR +.sp +Use a server that has already been started by the user in the +\fBgdb\fR +debugger. +.TP 3n +\(bu +\fB\-\-master\-binary=\fR\fB\fIpath\fR\fR +.sp +Specify the path of the +\fBmysqld\fR +binary to use for master servers. +.TP 3n +\(bu +\fB\-\-master_port=\fR\fB\fIport_num\fR\fR +.sp +Specify the TCP/IP port number for the first master server to use. Observe that the option name has an underscore and not a dash. +.TP 3n +\(bu +\fB\-\-mem\fR +.sp +Run the test suite in memory, using tmpfs or ramdisk. This can decrease test times significantly. +\fBmysql\-test\-run.pl\fR +attempts to find a suitable location using a built\-in list of standard locations for tmpfs and puts the +\fIvar\fR +directory there. This option also affects placement of temporary files, which are created in +\fIvar/tmp\fR. +.sp +The default list includes +\fI/dev/shm\fR. You can also enable this option by setting the environment variable +MTR_MEM[=\fIdir_name\fR]. If +\fIdir_name\fR +is given, it is added to the beginning of the list of locations to search, so it takes precedence over any built\-in locations. +.sp +This option was added in MySQL 4.1.22, 5.0.30, and 5.1.13. +.TP 3n +\(bu +\fB\-\-mysqld=\fR\fB\fIvalue\fR\fR +.sp +Extra options to pass to +\fBmysqld\fR. The value should consist of one or more comma\-separated +\fBmysqld\fR +options. See +Section\ 4.9, \(lqPassing Options from \fBmysql\-test\-run.pl\fR to \fBmysqld\fR or \fBmysqltest\fR\(rq. +.TP 3n +\(bu +\fB\-\-mysqltest=\fR\fB\fIvalue\fR\fR +.sp +Extra options to pass to +\fBmysqltest\fR. The value should consist of one or more comma\-separated +\fBmysqltest\fR +options. See +Section\ 4.9, \(lqPassing Options from \fBmysql\-test\-run.pl\fR to \fBmysqld\fR or \fBmysqltest\fR\(rq. This option was added in MySQL 6.0.6. +.TP 3n +\(bu +\fB\-\-ndb\-connectstring=\fR\fB\fIstr\fR\fR +.sp +Pass +\fB\-\-ndb\-connectstring=\fR\fB\fIstr\fR\fR +to the master MySQL server. This option also prevents +\fBmysql\-test\-run.pl\fR +from starting a cluster. It is assumed that there is already a cluster running to which the server can connect with the given connectstring. +.TP 3n +\(bu +\fB\-\-ndb\-connectstring\-slave=\fR\fB\fIstr\fR\fR +.sp +Pass +\fB\-\-ndb\-connectstring=\fR\fB\fIstr\fR\fR +to slave MySQL servers. This option also prevents +\fBmysql\-test\-run.pl\fR +from starting a cluster. It is assumed that there is already a cluster running to which the server can connect with the given connectstring. +.TP 3n +\(bu +\fB\-\-ndb\-extra\-test\fR +.sp +Unknown. +.TP 3n +\(bu +\fB\-\-ndbcluster\-port=\fR\fB\fIport_num\fR\fR, +\fB\-\-ndbcluster_port=\fR\fB\fIport_num\fR\fR +.sp +Specify the TCP/IP port number that NDB Cluster should use. +.TP 3n +\(bu +\fB\-\-ndbcluster\-port\-slave=\fR\fB\fIport_num\fR\fR +.sp +Specify the TCP/IP port number that the slave NDB Cluster should use. +.TP 3n +\(bu +\fB\-\-netware\fR +.sp +Run +\fBmysqld\fR +with options needed on NetWare. +.TP 3n +\(bu +\fB\-\-notimer\fR +.sp +Cause +\fBmysqltest\fR +not to generate a timing file. +.TP 3n +\(bu +\fB\-\-ps\-protocol\fR +.sp +Pass the +\fB\-\-ps\-protocol\fR +option to +\fBmysqltest\fR. +.TP 3n +\(bu +\fB\-\-record\fR +.sp +Pass the +\fB\-\-record\fR +option to +\fBmysqltest\fR. This option requires a specific test case to be named on the command line. +.TP 3n +\(bu +\fB\-\-reorder\fR +.sp +Reorder tests to minimize the number of server restarts needed. +.TP 3n +\(bu +\fB\-\-report\-features\fR +.sp +Display the output of +SHOW ENGINES +and +SHOW VARIABLES. This can be used to verify that binaries are built with all required features. +.sp +This option was added in MySQL 4.1.23, 5.0.30, and 5.1.14. +.TP 3n +\(bu +\fB\-\-script\-debug\fR +.sp +Enable debug output for +\fBmysql\-test\-run.pl\fR +itself. +.TP 3n +\(bu +\fB\-\-skip\-im\fR +.sp +Do not start Instance Manager; skip Instance Manager test cases. +.TP 3n +\(bu +\fB\-\-skip\-master\-binlog\fR +.sp +Do not enable master server binary logging. +.TP 3n +\(bu +\fB\-\-skip\-ndbcluster\fR, +\fB\-\-skip\-ndb\fR +.sp +Do not start NDB Cluster; skip Cluster test cases. +.TP 3n +\(bu +\fB\-\-skip\-ndbcluster\-slave\fR, +\fB\-\-skip\-ndb\-slave\fR +.sp +Do not start an NDB Cluster slave. +.TP 3n +\(bu +\fB\-\-skip\-rpl\fR +.sp +Skip replication test cases. +.TP 3n +\(bu +\fB\-\-skip\-slave\-binlog\fR +.sp +Do not enable master server binary logging. +.TP 3n +\(bu +\fB\-\-skip\-ssl\fR +.sp +Do not start +\fBmysqld\fR +with support for SSL connections. +.TP 3n +\(bu +\fB\-\-skip\-test=\fR\fB\fIregex\fR\fR +.sp +Specify a regular expression to be applied to test case names. Cases with names that match the expression are skipped. tests to skip. +.sp +As of MySQL 5.0.54/5.1.23/6.0.5, the argument for the +\fB\-\-skip\-test\fR +option allows more flexible specification of which tests to skip. If the argument contains a pattern metacharacter other than a lone period, it is interpreted as a Perl regular expression and applies to test names that match the pattern. See the description of the +\fB\-\-do\-test\fR +option for details. +.TP 3n +\(bu +\fB\-\-skip\-*\fR +.sp +\fB\-\-skip\-*\fR +options not otherwise recognized by +\fBmysql\-test\-run.pl\fR +are passed to the master server. +.TP 3n +\(bu +\fB\-\-slave\-binary=\fR\fB\fIpath\fR\fR +.sp +Specify the path of the +\fBmysqld\fR +binary to use for slave servers. +.TP 3n +\(bu +\fB\-\-slave_port=\fR\fB\fIport_num\fR\fR +.sp +Specify the TCP/IP port number for the first master server to use. Observe that the option name has an underscore and not a dash. +.TP 3n +\(bu +\fB\-\-sleep=\fR\fB\fIN\fR\fR +.sp +Pass +\fB\-\-sleep=\fR\fB\fIN\fR\fR +to +\fBmysqltest\fR. +.TP 3n +\(bu +\fB\-\-small\-bench\fR +.sp +Run the benchmarks with the +\fB\-\-small\-tests\fR +and +\fB\-\-small\-tables\fR +options. +.TP 3n +\(bu +\fB\-\-socket=\fR\fB\fIfile_name\fR\fR +.sp +For connections to +localhost, the Unix socket file to use, or, on Windows, the name of the named pipe to use. +.TP 3n +\(bu +\fB\-\-sp\-protocol\fR +.sp +Pass the +\fB\-\-sp\-protocol\fR +option to +\fBmysqltest\fR. +.TP 3n +\(bu +\fB\-\-ssl\fR +.sp +If +\fBmysql\-test\-run.pl\fR +is started with the +\fB\-\-ssl\fR +option, it sets up a secure conection for all test cases. In this case, if +\fBmysqld\fR +does not support SSL, +\fBmysql\-test\-run.pl\fR +exits with an error message: +Couldn't find support for SSL +.TP 3n +\(bu +\fB\-\-start\fR +.sp +Initialize and start servers with the startup settings for the first specified test case. For example: +.sp +.RS 3n +.nf +shell> \fBcd mysql\-test\fR +shell> \fB./mysql\-test\-run.pl \-\-start alias &\fR +.fi +.RE +This option was added in MySQL 5.1.32/6.0.11. +.TP 3n +\(bu +\fB\-\-start\-and\-exit\fR +.sp +Initialize and start servers with the startup settings for the specified test case or cases, if any, and then exit. You can use this option to start a server to which you can connect later. For example, after building a source distribution you can start a server and connect to it with the +\fBmysql\fR +client like this: +.sp +.RS 3n +.nf +shell> \fBcd mysql\-test\fR +shell> \fB./mysql\-test\-run.pl \-\-start\-and\-exit\fR +shell> \fB../mysql \-S ./var/tmp/master.sock \-h localhost \-u root\fR +.fi +.RE +.TP 3n +\(bu +\fB\-\-start\-dirty\fR +.sp +Start servers (without initialization) for the specified test case or cases, if any, and then exit. You can then manually run the test cases. +.TP 3n +\(bu +\fB\-\-start\-from=\fR\fB\fItest_name\fR\fR +.sp +\fBmysql\-test\-run.pl\fR +sorts the list of names of the test cases to be run, and then begins with +\fItest_name\fR. +.TP 3n +\(bu +\fB\-\-strace\-client\fR +.sp +Create +\fBstrace\fR +output for +\fBmysqltest\fR. +.TP 3n +\(bu +\fB\-\-stress\fR +.sp +Run the stress test. The other +\fB\-\-stress\-\fR\fB\fIxxx\fR\fR +options apply in this case. +.TP 3n +\(bu +\fB\-\-stress\-init\-file=\fR\fB\fIfile_name\fR\fR +.sp +\fIfile_name\fR +is the location of the file that contains the list of tests. The default file is +\fIstress_init.txt\fR +in the test suite directory. +.TP 3n +\(bu +\fB\-\-stress\-loop\-count=\fR\fB\fIN\fR\fR +.sp +In sequential stress\-test mode, the number of loops to execute before exiting. +.TP 3n +\(bu +\fB\-\-stress\-mode=\fR\fB\fImode\fR\fR +.sp +This option indicates the test order in stress\-test mode. The +\fImode\fR +value is either +random +to select tests in random order or +seq +to run tests in each thread in the order specified in the test list file. The default mode is +random. +.TP 3n +\(bu +\fB\-\-stress\-suite=\fR\fB\fIsuite_name\fR\fR +.sp +The name of the test suite to use for stress testing. The default suite name is +main +(the regular test suite located in the +\fImysql\-test\fR +directory). +.TP 3n +\(bu +\fB\-\-stress\-test\-count=\fR\fB\fIN\fR\fR +.sp +For stress testing, the number of tests to execute before exiting. +.TP 3n +\(bu +\fB\-\-stress\-test\-duration=\fR\fB\fIN\fR\fR +.sp +For stress testing, the duration of stress testing in seconds. +.TP 3n +\(bu +\fB\-\-stress\-test\-file=\fR\fB\fIfile_name\fR\fR +.sp +The file that contains the list of tests to use in stress testing. The tests should be named without the +\fI.test\fR +extension. The default file is +\fIstress_tests.txt\fR +in the test suite directory. +.TP 3n +\(bu +\fB\-\-stress\-threads=\fR\fB\fIN\fR\fR +.sp +The number of threads to use in stress testing. The default is 5. +.TP 3n +\(bu +\fB\-\-suite=\fR\fB\fIsuite_name\fR\fR +.sp +Run the named test suite. The default name is +main +(the regular test suite located in the +\fImysql\-test\fR +directory). +.TP 3n +\(bu +\fB\-\-suite\-timeout=\fR\fB\fIminutes\fR\fR +.sp +Specify the maximum test suite runtime. +.TP 3n +\(bu +\fB\-\-testcase\-timeout\fR +.sp +Specify the maximum test case runtime. +.TP 3n +\(bu +\fB\-\-timer\fR +.sp +Cause +\fBmysqltest\fR +to generate a timing file. The default file is named +\fI./var/log/timer\fR. +.TP 3n +\(bu +\fB\-\-tmpdir=\fR\fB\fIpath\fR\fR +.sp +The directory where temporary file are stored. The default location is +\fI./var/tmp\fR. +.TP 3n +\(bu +\fB\-\-unified\-diff\fR, +\fB\-\-udiff\fR +.sp +Use unified diff format when presenting differences between expected and actual test case results. +.TP 3n +\(bu +\fB\-\-use\-old\-data\fR +.sp +Do not install the test databases. (Use existing ones.) +.TP 3n +\(bu +\fB\-\-user\-test=\fR\fB\fIval\fR\fR +.sp +Unused. +.TP 3n +\(bu +\fB\-\-user=\fR\fB\fIuser_name\fR\fR +.sp +The MySQL user name to use when connecting to the server. +.TP 3n +\(bu +\fB\-\-valgrind\fR +.sp +Run +\fBmysqltest\fR +and +\fBmysqld\fR +with +\fBvalgrind\fR. +.TP 3n +\(bu +\fB\-\-valgrind\-all\fR +.sp +Like +\fB\-\-valgrind\fR, but passes the +\fB\-\-verbose\fR +and +\fB\-\-show\-reachable\fR +options to +\fBvalgrind\fR. +.TP 3n +\(bu +\fB\-\-valgrind\-mysqltest\fR +.sp +Run +\fBmysqltest\fR +with +\fBvalgrind\fR. +.TP 3n +\(bu +\fB\-\-valgrind\-mysqltest\-all\fR +.sp +Like +\fB\-\-valgrind\-mysqltest\fR, but passes the +\fB\-\-verbose\fR +and +\fB\-\-show\-reachable\fR +options to +\fBvalgrind\fR. +.TP 3n +\(bu +\fB\-\-valgrind\-options=\fR\fB\fIstr\fR\fR +.sp +Extra options to pass to +\fBvalgrind\fR. +.TP 3n +\(bu +\fB\-\-valgrind\-path=\fR\fB\fIpath\fR\fR +.sp +Specify the path name to the +\fBvalgrind\fR +executable. +.TP 3n +\(bu +\fB\-\-vardir=\fR\fB\fIpath\fR\fR +.sp +Specify the path where files generated during the test run are stored. The default location is +\fI./var\fR. +.TP 3n +\(bu +\fB\-\-view\-protocol\fR +.sp +Pass the +\fB\-\-view\-protocol\fR +option to +\fBmysqltest\fR. +.TP 3n +\(bu +\fB\-\-vs\-config=\fR\fB\fIconfig_val\fR\fR +.sp +Specify the configuration used to build MySQL (for example, +\fB\-\-vs\-config=debug\fR +\fB\-\-vs\-config=release\fR). This option is for Windows only. It is available as of MySQL 4.1.23, 5.0.30, and 5.1.14. +.TP 3n +\(bu +\fB\-\-wait\-timeout=\fR\fB\fIN\fR\fR +.sp +Unused? +.TP 3n +\(bu +\fB\-\-warnings\fR +.sp +This option is a synonym for +\fB\-\-log\-warnings\fR. +.TP 3n +\(bu +\fB\-\-with\-ndbcluster\fR +.sp +Use NDB Cluster and enable test cases that require it. +.TP 3n +\(bu +\fB\-\-with\-ndbcluster\-all\fR +.sp +Use NDB Cluster in all tests. +.TP 3n +\(bu +\fB\-\-with\-ndbcluster\-only\fR +.sp +Run only test cases that have +ndb +in their name. +.TP 3n +\(bu +\fB\-\-with\-ndbcluster\-slave\fR +.sp +Unknown. +.TP 3n +\(bu +\fB\-\-with\-openssl\fR +.sp +This option is a synonym for +\fB\-\-ssl\fR. +.sp +.RE +.sp +.it 1 an-trap +.nr an-no-space-flag 1 +.nr an-break-flag 1 +.br +\fBNote\fR +.PP +\fBmysql\-test\-run\fR +supports the following options not supported by +\fBmysql\-test\-run.pl\fR: +\fB\-\-local\fR, +\fB\-\-local\-master\fR, +\fB\-\-ndb\-verbose\fR, +\fB\-\-ndb_mgm\-extra\-opts\fR, +\fB\-\-ndb_mgmd\-extra\-opts\fR, +\fB\-\-ndbd\-extra\-opts\fR, +\fB\-\-old\-master\fR, +\fB\-\-purify\fR, +\fB\-\-use\-old\-data\fR, +\fB\-\-valgrind\-mysqltest\-all\fR. +.PP +Conversely, +\fBmysql\-test\-run.pl\fR +supports the following options not supported by +\fBmysql\-test\-run\fR: +\fB\-\-benchdir\fR, +\fB\-\-check\-testcases\fR, +\fB\-\-client\-ddd\fR, +\fB\-\-client\-debugger\fR, +\fB\-\-cursor\-protocol\fR, +\fB\-\-debugger\fR, +\fB\-\-im\-mysqld1\-port\fR, +\fB\-\-im\-mysqld2\-port\fR, +\fB\-\-im\-port\fR, +\fB\-\-manual\-debug\fR, +\fB\-\-netware\fR, +\fB\-\-notimer\fR, +\fB\-\-reorder\fR, +\fB\-\-script\-debug\fR, +\fB\-\-skip\-im\fR, +\fB\-\-skip\-ssl\fR, +\fB\-\-sp\-protocol\fR, +\fB\-\-start\-dirty\fR, +\fB\-\-suite\fR, +\fB\-\-suite\-timeout\fR, +\fB\-\-testcase\-timeout\fR, +\fB\-\-udiff\fR, +\fB\-\-unified\-diff\fR,, +\fB\-\-valgrind\-path\fR, +\fB\-\-vardir\fR, +\fB\-\-view\-protocol\fR. +.SH "COPYRIGHT" +.PP +Copyright 2007\-2008 MySQL AB, 2009 Sun Microsystems, Inc. +.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/. +.SH "REFERENCES" +.TP 3 +1.\ Typical configure Options +\%http://dev.mysql.com/doc/refman/5.1/en/configure\-options.html +.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 +MySQL AB (http://www.mysql.com/). diff --git a/man/mysql.1 b/man/mysql.1 new file mode 100644 index 00000000000..544ad973e46 --- /dev/null +++ b/man/mysql.1 @@ -0,0 +1,1699 @@ +.\" Title: \fBmysql\fR +.\" Author: +.\" Generator: DocBook XSL Stylesheets v1.70.1 <http://docbook.sf.net/> +.\" Date: 03/31/2009 +.\" Manual: MySQL Database System +.\" Source: MySQL 5.1 +.\" +.TH "\fBMYSQL\fR" "1" "03/31/2009" "MySQL 5.1" "MySQL Database System" +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.SH "NAME" +mysql \- the MySQL command\-line tool +.SH "SYNOPSIS" +.HP 24 +\fBmysql [\fR\fB\fIoptions\fR\fR\fB] \fR\fB\fIdb_name\fR\fR +.SH "DESCRIPTION" +.PP +\fBmysql\fR +is a simple SQL shell (with GNU +readline +capabilities). It supports interactive and non\-interactive use. When used interactively, query results are presented in an ASCII\-table format. When used non\-interactively (for example, as a filter), the result is presented in tab\-separated format. The output format can be changed using command options. +.PP +If you have problems due to insufficient memory for large result sets, use the +\fB\-\-quick\fR +option. This forces +\fBmysql\fR +to retrieve results from the server a row at a time rather than retrieving the entire result set and buffering it in memory before displaying it. This is done by returning the result set using the +mysql_use_result() +C API function in the client/server library rather than +mysql_store_result(). +.PP +Using +\fBmysql\fR +is very easy. Invoke it from the prompt of your command interpreter as follows: +.sp +.RS 3n +.nf +shell> \fBmysql \fR\fB\fIdb_name\fR\fR +.fi +.RE +.PP +Or: +.sp +.RS 3n +.nf +shell> \fBmysql \-\-user=\fR\fB\fIuser_name\fR\fR\fB \-\-password=\fR\fB\fIyour_password\fR\fR\fB \fR\fB\fIdb_name\fR\fR +.fi +.RE +.PP +Then type an SQL statement, end it with +\(lq;\(rq, +\\g, or +\\G +and press Enter. +.PP +As of MySQL 5.1.10, typing Control\-C causes +\fBmysql\fR +to attempt to kill the current statement. If this cannot be done, or Control\-C is typed again before the statement is killed, +\fBmysql\fR +exits. Previously, Control\-C caused +\fBmysql\fR +to exit in all cases. +.PP +You can execute SQL statements in a script file (batch file) like this: +.sp +.RS 3n +.nf +shell> \fBmysql \fR\fB\fIdb_name\fR\fR\fB < \fR\fB\fIscript.sql\fR\fR\fB > \fR\fB\fIoutput.tab\fR\fR +.fi +.RE +.SH "\fBMYSQL\fR OPTIONS" +.PP +\fBmysql\fR +supports the following options: +.TP 3n +\(bu +\fB\-\-help\fR, +\fB\-?\fR +.sp +Display a help message and exit. +.TP 3n +\(bu +\fB\-\-auto\-rehash\fR +.sp +Enable automatic rehashing. This option is on by default, which enables database, table, and column name completion. Use +\fB\-\-disable\-auto\-rehash\fR +to disable rehashing. That causes +\fBmysql\fR +to start faster, but you must issue the +rehash +command if you want to use name completion. +.sp +To complete a name, enter the first part and press Tab. If the name is unambiguous, +\fBmysql\fR +completes it. Otherwise, you can press Tab again to see the possible names that begin with what you have typed so far. Completion does not occur if there is no default database. +.TP 3n +\(bu +\fB\-\-batch\fR, +\fB\-B\fR +.sp +Print results using tab as the column separator, with each row on a new line. With this option, +\fBmysql\fR +does not use the history file. +.sp +Batch mode results in non\-tabular output format and escaping of special characters. Escaping may be disabled by using raw mode; see the description for the +\fB\-\-raw\fR +option. +.TP 3n +\(bu +\fB\-\-character\-sets\-dir=\fR\fB\fIpath\fR\fR +.sp +The directory where character sets are installed. See +Section\ 9.2, \(lqThe Character Set Used for Data and Sorting\(rq. +.TP 3n +\(bu +\fB\-\-column\-names\fR +.sp +Write column names in results. +.TP 3n +\(bu +\fB\-\-column\-type\-info\fR, +\fB\-m\fR +.sp +Display result set metadata. This option was added in MySQL 5.1.14. (Before that, use +\fB\-\-debug\-info\fR.) The +\fB\-m\fR +short option was added in MySQL 5.1.21. +.TP 3n +\(bu +\fB\-\-comments\fR, +\fB\-c\fR +.sp +Whether to preserve comments in statements sent to the server. The default is \-\-skip\-comments (discard comments), enable with \-\-comments (preserve comments). This option was added in MySQL 5.1.23. +.TP 3n +\(bu +\fB\-\-compress\fR, +\fB\-C\fR +.sp +Compress all information sent between the client and the server if both support compression. +.TP 3n +\(bu +\fB\-\-database=\fR\fB\fIdb_name\fR\fR, +\fB\-D \fR\fB\fIdb_name\fR\fR +.sp +The database to use. This is useful primarily in an option file. +.TP 3n +\(bu +\fB\-\-debug[=\fR\fB\fIdebug_options\fR\fR\fB]\fR, +\fB\-# [\fR\fB\fIdebug_options\fR\fR\fB]\fR +.sp +Write a debugging log. The +\fIdebug_options\fR +string often is +\'d:t:o,\fIfile_name\fR'. The default is +\'d:t:o,/tmp/mysql.trace'. +.TP 3n +\(bu +\fB\-\-debug\-check\fR +.sp +Print some debugging information when the program exits. This option was added in MySQL 5.1.21. +.TP 3n +\(bu +\fB\-\-debug\-info\fR, +\fB\-T\fR +.sp +Before MySQL 5.1.14, this option prints debugging information and memory and CPU usage statistics when the program exits, and also causes display of result set metadata during execution. As of MySQL 5.1.14, use +\fB\-\-column\-type\-info\fR +to display result set metadata. +.TP 3n +\(bu +\fB\-\-default\-character\-set=\fR\fB\fIcharset_name\fR\fR +.sp +Use +\fIcharset_name\fR +as the default character set. See +Section\ 9.2, \(lqThe Character Set Used for Data and Sorting\(rq. +.TP 3n +\(bu +\fB\-\-delimiter=\fR\fB\fIstr\fR\fR +.sp +Set the statement delimiter. The default is the semicolon character (\(lq;\(rq). +.TP 3n +\(bu +\fB\-\-disable\-named\-commands\fR +.sp +Disable named commands. Use the +\\* +form only, or use named commands only at the beginning of a line ending with a semicolon (\(lq;\(rq). +\fBmysql\fR +starts with this option +\fIenabled\fR +by default. However, even with this option, long\-format commands still work from the first line. See +the section called \(lq\fBMYSQL\fR COMMANDS\(rq. +.TP 3n +\(bu +\fB\-\-execute=\fR\fB\fIstatement\fR\fR, +\fB\-e \fR\fB\fIstatement\fR\fR +.sp +Execute the statement and quit. The default output format is like that produced with +\fB\-\-batch\fR. See +Section\ 4.2.3.1, \(lqUsing Options on the Command Line\(rq, for some examples. +.TP 3n +\(bu +\fB\-\-force\fR, +\fB\-f\fR +.sp +Continue even if an SQL error occurs. +.TP 3n +\(bu +\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. +.TP 3n +\(bu +\fB\-\-html\fR, +\fB\-H\fR +.sp +Produce HTML output. +.TP 3n +\(bu +\fB\-\-ignore\-spaces\fR, +\fB\-i\fR +.sp +Ignore spaces after function names. The effect of this is described in the discussion for the +IGNORE_SPACE +SQL mode (see +Section\ 5.1.7, \(lqServer SQL Modes\(rq). +.TP 3n +\(bu +\fB\-\-line\-numbers\fR +.sp +Write line numbers for errors. Disable this with +\fB\-\-skip\-line\-numbers\fR. +.TP 3n +\(bu +\fB\-\-local\-infile[={0|1}]\fR +.sp +Enable or disable +LOCAL +capability for +LOAD DATA INFILE. With no value, the option enables +LOCAL. The option may be given as +\fB\-\-local\-infile=0\fR +or +\fB\-\-local\-infile=1\fR +to explicitly disable or enable +LOCAL. Enabling +LOCAL +has no effect if the server does not also support it. +.TP 3n +\(bu +\fB\-\-named\-commands\fR, +\fB\-G\fR +.sp +Enable named +\fBmysql\fR +commands. Long\-format commands are allowed, not just short\-format commands. For example, +quit +and +\\q +both are recognized. Use +\fB\-\-skip\-named\-commands\fR +to disable named commands. See +the section called \(lq\fBMYSQL\fR COMMANDS\(rq. +.TP 3n +\(bu +\fB\-\-no\-auto\-rehash\fR, +\fB\-A\fR +.sp +Deprecated form of +\fB\-skip\-auto\-rehash\fR. Use +\fB\-\-disable\-auto\-rehash\fR +instead. See the description for +\fB\-\-auto\-rehash\fR. +.TP 3n +\(bu +\fB\-\-no\-beep\fR, +\fB\-b\fR +.sp +Do not beep when errors occur. +.TP 3n +\(bu +\fB\-\-no\-named\-commands\fR, +\fB\-g\fR +.sp +Deprecated, use +\fB\-\-disable\-named\-commands\fR +instead. +.TP 3n +\(bu +\fB\-\-no\-pager\fR +.sp +Deprecated form of +\fB\-\-skip\-pager\fR. See the +\fB\-\-pager\fR +option. +.TP 3n +\(bu +\fB\-\-no\-tee\fR +.sp +Do not copy output to a file. +the section called \(lq\fBMYSQL\fR COMMANDS\(rq, discusses tee files further. +.TP 3n +\(bu +\fB\-\-one\-database\fR, +\fB\-o\fR +.sp +Ignore statements except those for the default database named on the command line. This is useful for skipping updates to other databases in the binary log. +.TP 3n +\(bu +\fB\-\-pager[=\fR\fB\fIcommand\fR\fR\fB]\fR +.sp +Use the given command for paging query output. If the command is omitted, the default pager is the value of your +PAGER +environment variable. Valid pagers are +\fBless\fR, +\fBmore\fR, +\fBcat [> filename]\fR, and so forth. This option works only on Unix. It does not work in batch mode. To disable paging, use +\fB\-\-skip\-pager\fR. +the section called \(lq\fBMYSQL\fR COMMANDS\(rq, discusses output paging further. +.TP 3n +\(bu +\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, you are prompted for one. +.sp +Specifying a password on the command line should be considered insecure. See +Section\ 5.5.6.2, \(lqEnd\-User Guidelines for Password Security\(rq. +.TP 3n +\(bu +\fB\-\-pipe\fR, +\fB\-W\fR +.sp +On Windows, connect to the server via a named pipe. This option applies only for connections to a local server, and only if the server supports named\-pipe connections. +.TP 3n +\(bu +\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. +.TP 3n +\(bu +\fB\-\-prompt=\fR\fB\fIformat_str\fR\fR +.sp +Set the prompt to the specified format. The default is +mysql>. The special sequences that the prompt can contain are described in +the section called \(lq\fBMYSQL\fR COMMANDS\(rq. +.TP 3n +\(bu +\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 allowable values, see +Section\ 4.2.2, \(lqConnecting to the MySQL Server\(rq. +.TP 3n +\(bu +\fB\-\-quick\fR, +\fB\-q\fR +.sp +Do not cache each query result, print each row as it is received. This may slow down the server if the output is suspended. With this option, +\fBmysql\fR +does not use the history file. +.TP 3n +\(bu +\fB\-\-raw\fR, +\fB\-r\fR +.sp +For tabular output, the +\(lqboxing\(rq +around columns enables one column value to be distinguished from another. For non\-tabular output (such as is produced in batch mode or when the +\fB\-\-batch\fR +or +\fB\-\-silent\fR +option is given), special characters are escaped in the output so they can be identified easily. Newline, tab, +NUL, and backslash are written as +\\n, +\\t, +\\0, and +\\\\. The +\fB\-\-raw\fR +option disables this character escaping. +.sp +The following example demonstrates tabular versus non\-tabular output and the use of raw mode to disable escaping: +.sp +.RS 3n +.nf +% \fBmysql\fR +mysql> SELECT CHAR(92); ++\-\-\-\-\-\-\-\-\-\-+ +| CHAR(92) | ++\-\-\-\-\-\-\-\-\-\-+ +| \\ | ++\-\-\-\-\-\-\-\-\-\-+ +% \fBmysql \-s\fR +mysql> SELECT CHAR(92); +CHAR(92) +\\\\ +% \fBmysql \-s \-r\fR +mysql> SELECT CHAR(92); +CHAR(92) +\\ +.fi +.RE +.TP 3n +\(bu +\fB\-\-reconnect\fR +.sp +If the connection to the server is lost, automatically try to reconnect. A single reconnect attempt is made each time the connection is lost. To suppress reconnection behavior, use +\fB\-\-skip\-reconnect\fR. +.TP 3n +\(bu +\fB\-\-safe\-updates\fR, +\fB\-\-i\-am\-a\-dummy\fR, +\fB\-U\fR +.sp +Allow only those +UPDATE +and +DELETE +statements that specify which rows to modify by using key values. If you have set this option in an option file, you can override it by using +\fB\-\-safe\-updates\fR +on the command line. See +the section called \(lq\fBMYSQL\fR TIPS\(rq, for more information about this option. +.TP 3n +\(bu +\fB\-\-secure\-auth\fR +.sp +Do not send passwords to the server in old (pre\-4.1.1) format. This prevents connections except for servers that use the newer password format. +.TP 3n +\(bu +\fB\-\-show\-warnings\fR +.sp +Cause warnings to be shown after each statement if there are any. This option applies to interactive and batch mode. +.TP 3n +\(bu +\fB\-\-sigint\-ignore\fR +.sp +Ignore +SIGINT +signals (typically the result of typing Control\-C). +.TP 3n +\(bu +\fB\-\-silent\fR, +\fB\-s\fR +.sp +Silent mode. Produce less output. This option can be given multiple times to produce less and less output. +.sp +This option results in non\-tabular output format and escaping of special characters. Escaping may be disabled by using raw mode; see the description for the +\fB\-\-raw\fR +option. +.TP 3n +\(bu +\fB\-\-skip\-column\-names\fR, +\fB\-N\fR +.sp +Do not write column names in results. The short format, +\fB\-N\fR +is deprecated, use the long format instead. +.TP 3n +\(bu +\fB\-\-skip\-line\-numbers\fR, +\fB\-L\fR +.sp +Do not write line numbers for errors. Useful when you want to compare result files that include error messages. The short format, +\fB\-L\fR +is deprecated, use the long format instead. +.TP 3n +\(bu +\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. +.TP 3n +\(bu +\fB\-\-ssl*\fR +.sp +Options that begin with +\fB\-\-ssl\fR +specify whether to connect to the server via SSL and indicate where to find SSL keys and certificates. See +Section\ 5.5.7.3, \(lqSSL Command Options\(rq. +.TP 3n +\(bu +\fB\-\-table\fR, +\fB\-t\fR +.sp +Display output in table format. This is the default for interactive use, but can be used to produce table output in batch mode. +.TP 3n +\(bu +\fB\-\-tee=\fR\fB\fIfile_name\fR\fR +.sp +Append a copy of output to the given file. This option does not work in batch mode. +the section called \(lq\fBMYSQL\fR COMMANDS\(rq, discusses tee files further. +.TP 3n +\(bu +\fB\-\-unbuffered\fR, +\fB\-n\fR +.sp +Flush the buffer after each query. +.TP 3n +\(bu +\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. +.TP 3n +\(bu +\fB\-\-verbose\fR, +\fB\-v\fR +.sp +Verbose mode. Produce more output about what the program does. This option can be given multiple times to produce more and more output. (For example, +\fB\-v \-v \-v\fR +produces table output format even in batch mode.) +.TP 3n +\(bu +\fB\-\-version\fR, +\fB\-V\fR +.sp +Display version information and exit. +.TP 3n +\(bu +\fB\-\-vertical\fR, +\fB\-E\fR +.sp +Print query output rows vertically (one line per column value). Without this option, you can specify vertical output for individual statements by terminating them with +\\G. +.TP 3n +\(bu +\fB\-\-wait\fR, +\fB\-w\fR +.sp +If the connection cannot be established, wait and retry instead of aborting. +.TP 3n +\(bu +\fB\-\-xml\fR, +\fB\-X\fR +.sp +Produce XML output. +.sp +.it 1 an-trap +.nr an-no-space-flag 1 +.nr an-break-flag 1 +.br +\fBNote\fR +Prior to MySQL 5.1.12, there was no differentiation in the output when using this option between columns containing the +NULL +value and columns containing the string literal +\'NULL'; both were represented as +.sp +.RS 3n +.nf +<field name="\fIcolumn_name\fR">NULL</field> +.fi +.RE +Beginning with MySQL 5.1.12, the output when +\fB\-\-xml\fR +is used with +\fBmysql\fR +matches that of +\fBmysqldump \fR\fB\fB\-\-xml\fR\fR. See +\fBmysqldump\fR(1) +for details. +.sp +Beginning with MySQL 5.1.18, the XML output also uses an XML namespace, as shown here: +.sp +.RS 3n +.nf +shell> \fBmysql \-\-xml \-uroot \-e "SHOW VARIABLES LIKE 'version%'"\fR +<?xml version="1.0"?> +<resultset statement="SHOW VARIABLES LIKE 'version%'" xmlns:xsi="http://www.w3.org/2001/XMLSchema\-instance"> +<row> +<field name="Variable_name">version</field> +<field name="Value">5.0.40\-debug</field> +</row> +<row> +<field name="Variable_name">version_comment</field> +<field name="Value">Source distribution</field> +</row> +<row> +<field name="Variable_name">version_compile_machine</field> +<field name="Value">i686</field> +</row> +<row> +<field name="Variable_name">version_compile_os</field> +<field name="Value">suse\-linux\-gnu</field> +</row> +</resultset> +.fi +.RE +.sp +(See +[1]\&\fIBug#25946\fR.) +.sp +.RE +.PP +You can also set the following variables by using +\fB\-\-\fR\fB\fIvar_name\fR\fR\fB=\fR\fB\fIvalue\fR\fR. The +\fB\-\-set\-variable\fR +format is deprecated. +.TP 3n +\(bu +connect_timeout +.sp +The number of seconds before connection timeout. (Default value is +0.) +.TP 3n +\(bu +max_allowed_packet +.sp +The maximum packet length to send to or receive from the server. (Default value is 16MB.) +.TP 3n +\(bu +max_join_size +.sp +The automatic limit for rows in a join when using +\fB\-\-safe\-updates\fR. (Default value is 1,000,000.) +.TP 3n +\(bu +net_buffer_length +.sp +The buffer size for TCP/IP and socket communication. (Default value is 16KB.) +.TP 3n +\(bu +select_limit +.sp +The automatic limit for +SELECT +statements when using +\fB\-\-safe\-updates\fR. (Default value is 1,000.) +.sp +.RE +.PP +On Unix, the +\fBmysql\fR +client writes a record of executed statements to a history file. By default, this file is named +\fI.mysql_history\fR +and is created in your home directory. To specify a different file, set the value of the +MYSQL_HISTFILE +environment variable. +.PP +The +\fI.mysql_history\fR +should be protected with a restrictive access mode because sensitive information might be written to it, such as the text of SQL statements that contain passwords. See +Section\ 5.5.6.2, \(lqEnd\-User Guidelines for Password Security\(rq. +.PP +If you do not want to maintain a history file, first remove +\fI.mysql_history\fR +if it exists, and then use either of the following techniques: +.TP 3n +\(bu +Set the +MYSQL_HISTFILE +variable to +\fI/dev/null\fR. To cause this setting to take effect each time you log in, put the setting in one of your shell's startup files. +.TP 3n +\(bu +Create +\fI.mysql_history\fR +as a symbolic link to +\fI/dev/null\fR: +.sp +.RS 3n +.nf +shell> \fBln \-s /dev/null $HOME/.mysql_history\fR +.fi +.RE +You need do this only once. +.SH "\fBMYSQL\fR COMMANDS" +.PP +\fBmysql\fR +sends each SQL statement that you issue to the server to be executed. There is also a set of commands that +\fBmysql\fR +itself interprets. For a list of these commands, type +help +or +\\h +at the +mysql> +prompt: +.sp +.RS 3n +.nf +mysql> \fBhelp\fR +List of all MySQL commands: +Note that all text commands must be first on line and end with ';' +? (\\?) Synonym for `help'. +clear (\\c) Clear command. +connect (\\r) Reconnect to the server. Optional arguments are db and host. +delimiter (\\d) Set statement delimiter. +edit (\\e) Edit command with $EDITOR. +ego (\\G) Send command to mysql server, display result vertically. +exit (\\q) Exit mysql. Same as quit. +go (\\g) Send command to mysql server. +help (\\h) Display this help. +nopager (\\n) Disable pager, print to stdout. +notee (\\t) Don't write into outfile. +pager (\\P) Set PAGER [to_pager]. Print the query results via PAGER. +print (\\p) Print current command. +prompt (\\R) Change your mysql prompt. +quit (\\q) Quit mysql. +rehash (\\#) Rebuild completion hash. +source (\\.) Execute an SQL script file. Takes a file name as an argument. +status (\\s) Get status information from the server. +system (\\!) Execute a system shell command. +tee (\\T) Set outfile [to_outfile]. Append everything into given + outfile. +use (\\u) Use another database. Takes database name as argument. +charset (\\C) Switch to another charset. Might be needed for processing + binlog with multi\-byte charsets. +warnings (\\W) Show warnings after every statement. +nowarning (\\w) Don't show warnings after every statement. +For server side help, type 'help contents' +.fi +.RE +.PP +Each command has both a long and short form. The long form is not case sensitive; the short form is. The long form can be followed by an optional semicolon terminator, but the short form should not. +.PP +The use of short\-form commands within multi\-line +/* ... */ +comments is not supported. +.TP 3n +\(bu +\fBhelp [\fR\fB\fIarg\fR\fR\fB]\fR, +\fB\\h [\fR\fB\fIarg\fR\fR\fB]\fR, +\fB\\? [\fR\fB\fIarg\fR\fR\fB]\fR, +\fB? [\fR\fB\fIarg\fR\fR\fB]\fR +.sp +Displays a help message listing the available +\fBmysql\fR +commands. +.sp +If you provide an argument to the +help +command, +\fBmysql\fR +uses it as a search string to access server\-side help from the contents of the MySQL Reference Manual. For more information, see +the section called \(lq\fBMYSQL\fR SERVER\-SIDE HELP\(rq. +.TP 3n +\(bu +\fBcharset \fR\fB\fIcharset_name\fR\fR, +\fB\\C \fR\fB\fIcharset_name\fR\fR +.sp +The +charset +command changes the default character set and issues a +SET NAMES +statement. This enables the character set to remain synchronized on the client and server if +\fBmysql\fR +is run with auto\-reconnect enabled (which is not recommended), because the specified character set is used for reconnects. This command was added in MySQL 5.1.7. +.TP 3n +\(bu +\fBclear\fR, +\fB\\c\fR +.sp +Clears the current input. Use this if you change your mind about executing the statement that you are entering. +.TP 3n +\(bu +\fBconnect [\fR\fB\fIdb_name\fR\fR\fB \fR\fB\fIhost_name\fR\fR\fB]]\fR, +\fB\\r [\fR\fB\fIdb_name\fR\fR\fB \fR\fB\fIhost_name\fR\fR\fB]]\fR +.sp +Reconnects to the server. The optional database name and host name arguments may be given to specify the default database or the host where the server is running. If omitted, the current values are used. +.TP 3n +\(bu +\fBdelimiter \fR\fB\fIstr\fR\fR, +\fB\\d \fR\fB\fIstr\fR\fR +.sp +The +delimiter +command changes the string that +\fBmysql\fR +interprets as the separator between SQL statements. The default is the semicolon character (\(lq;\(rq). +.sp +The delimiter can be specified as an unquoted or quoted argument. Quoting can be done with either single quote (') or douple quote (") characters. To include a quote within a quoted string, either quote the string with the other quote character or escape the quote with a backslash (\(lq\\\(rq) character. Backslash should be avoided outside of quoted strings because it is the escape character for MySQL. For an unquoted argument, the delmiter is read up to the first space or end of line. For a quoted argument, the delimiter is read up to the matching quote on the line. +.sp +When the delimiter recognized by +\fBmysql\fR +is set to something other than the default of +\(lq;\(rq, instances of that character are sent to the server without interpretation. However, the server itself still interprets +\(lq;\(rq +as a statement delimiter and processes statements accordingly. This behavior on the server side comes into play for multiple\-statement execution (see +Section\ 21.10.12, \(lqC API Support for Multiple Statement Execution\(rq), and for parsing the body of stored procedures and functions, triggers, and events (see +Section\ 19.1, \(lqDefining Stored Programs\(rq). +.TP 3n +\(bu +\fBedit\fR, +\fB\\e\fR +.sp +Edits the current input statement. +\fBmysql\fR +checks the values of the +EDITOR +and +VISUAL +environment variables to determine which editor to use. The default editor is +\fBvi\fR +if neither variable is set. +.sp +The +\fBedit\fR +command works only in Unix. +.TP 3n +\(bu +\fBego\fR, +\fB\\G\fR +.sp +Sends the current statement to the server to be executed and displays the result using vertical format. +.TP 3n +\(bu +\fBexit\fR, +\fB\\q\fR +.sp +Exits +\fBmysql\fR. +.TP 3n +\(bu +\fBgo\fR, +\fB\\g\fR +.sp +Sends the current statement to the server to be executed. +.TP 3n +\(bu +\fBnopager\fR, +\fB\\n\fR +.sp +Disables output paging. See the description for +\fBpager\fR. +.sp +The +\fBnopager\fR +command works only in Unix. +.TP 3n +\(bu +\fBnotee\fR, +\fB\\t\fR +.sp +Disables output copying to the tee file. See the description for +\fBtee\fR. +.TP 3n +\(bu +\fBnowarning\fR, +\fB\\w\fR +.sp +Enables display of warnings after each statement. +.TP 3n +\(bu +\fBpager [\fR\fB\fIcommand\fR\fR\fB]\fR, +\fB\\P [\fR\fB\fIcommand\fR\fR\fB]\fR +.sp +By using the +\fB\-\-pager\fR +option when you invoke +\fBmysql\fR, it is possible to browse or search query results in interactive mode with Unix programs such as +\fBless\fR, +\fBmore\fR, or any other similar program. If you specify no value for the option, +\fBmysql\fR +checks the value of the +PAGER +environment variable and sets the pager to that. +.sp +Output paging can be enabled interactively with the +\fBpager\fR +command and disabled with +\fBnopager\fR. The command takes an optional argument; if given, the paging program is set to that. With no argument, the pager is set to the pager that was set on the command line, or +stdout +if no pager was specified. +.sp +Output paging works only in Unix because it uses the +popen() +function, which does not exist on Windows. For Windows, the +\fBtee\fR +option can be used instead to save query output, although it is not as convenient as +\fBpager\fR +for browsing output in some situations. +.TP 3n +\(bu +\fBprint\fR, +\fB\\p\fR +.sp +Prints the current input statement without executing it. +.TP 3n +\(bu +\fBprompt [\fR\fB\fIstr\fR\fR\fB]\fR, +\fB\\R [\fR\fB\fIstr\fR\fR\fB]\fR +.sp +Reconfigures the +\fBmysql\fR +prompt to the given string. The special character sequences that can be used in the prompt are described later in this section. +.sp +If you specify the +prompt +command with no argument, +\fBmysql\fR +resets the prompt to the default of +mysql>. +.TP 3n +\(bu +\fBquit\fR, +\fB\\q\fR +.sp +Exits +\fBmysql\fR. +.TP 3n +\(bu +\fBrehash\fR, +\fB\\#\fR +.sp +Rebuilds the completion hash that enables database, table, and column name completion while you are entering statements. (See the description for the +\fB\-\-auto\-rehash\fR +option.) +.TP 3n +\(bu +\fBsource \fR\fB\fIfile_name\fR\fR, +\fB\\. \fR\fB\fIfile_name\fR\fR +.sp +Reads the named file and executes the statements contained therein. On Windows, you can specify path name separators as +/ +or +\\\\. +.TP 3n +\(bu +\fBstatus\fR, +\fB\\s\fR +.sp +The +status +command provides some information about the connection and the server you are using. If you are running in +\fB\-\-safe\-updates\fR +mode, +status +also prints the values for the +\fBmysql\fR +variables that affect your queries. +.TP 3n +\(bu +\fBsystem \fR\fB\fIcommand\fR\fR, +\fB\\! \fR\fB\fIcommand\fR\fR +.sp +Executes the given command using your default command interpreter. +.sp +The +\fBsystem\fR +command works only in Unix. +.TP 3n +\(bu +\fBtee [\fR\fB\fIfile_name\fR\fR\fB]\fR, +\fB\\T [\fR\fB\fIfile_name\fR\fR\fB]\fR +.sp +By using the +\fB\-\-tee\fR +option when you invoke +\fBmysql\fR, you can log statements and their output. All the data displayed on the screen is appended into a given file. This can be very useful for debugging purposes also. +\fBmysql\fR +flushes results to the file after each statement, just before it prints its next prompt. +.sp +You can enable this feature interactively with the +\fBtee\fR +command. Without a parameter, the previous file is used. The +\fBtee\fR +file can be disabled with the +\fBnotee\fR +command. Executing +\fBtee\fR +again re\-enables logging. +.TP 3n +\(bu +\fBuse \fR\fB\fIdb_name\fR\fR, +\fB\\u \fR\fB\fIdb_name\fR\fR +.sp +Uses +\fIdb_name\fR +as the default database. +.TP 3n +\(bu +\fBwarnings\fR, +\fB\\W\fR +.sp +Enables display of warnings after each statement (if there are any). +.sp +.RE +.PP +Here are a few tips about the +\fBpager\fR +command: +.TP 3n +\(bu +You can use it to write to a file and the results go only to the file: +.sp +.RS 3n +.nf +mysql> \fBpager cat > /tmp/log.txt\fR +.fi +.RE +You can also pass any options for the program that you want to use as your pager: +.sp +.RS 3n +.nf +mysql> \fBpager less \-n \-i \-S\fR +.fi +.RE +.TP 3n +\(bu +In the preceding example, note the +\fB\-S\fR +option. You may find it very useful for browsing wide query results. Sometimes a very wide result set is difficult to read on the screen. The +\fB\-S\fR +option to +\fBless\fR +can make the result set much more readable because you can scroll it horizontally using the left\-arrow and right\-arrow keys. You can also use +\fB\-S\fR +interactively within +\fBless\fR +to switch the horizontal\-browse mode on and off. For more information, read the +\fBless\fR +manual page: +.sp +.RS 3n +.nf +shell> \fBman less\fR +.fi +.RE +.TP 3n +\(bu +The +\fB\-F\fR +and +\fB\-X\fR +options may be used with +\fBless\fR +to cause it to exit if output fits on one screen, which is convenient when no scrolling is necessary: +.sp +.RS 3n +.nf +mysql> \fBpager less \-n \-i \-S \-F \-X\fR +.fi +.RE +.TP 3n +\(bu +You can specify very complex pager commands for handling query output: +.sp +.RS 3n +.nf +mysql> \fBpager cat | tee /dr1/tmp/res.txt \\\fR + \fB| tee /dr2/tmp/res2.txt | less \-n \-i \-S\fR +.fi +.RE +In this example, the command would send query results to two files in two different directories on two different file systems mounted on +\fI/dr1\fR +and +\fI/dr2\fR, yet still display the results onscreen via +\fBless\fR. +.sp +.RE +.PP +You can also combine the +\fBtee\fR +and +\fBpager\fR +functions. Have a +\fBtee\fR +file enabled and +\fBpager\fR +set to +\fBless\fR, and you are able to browse the results using the +\fBless\fR +program and still have everything appended into a file the same time. The difference between the Unix +\fBtee\fR +used with the +\fBpager\fR +command and the +\fBmysql\fR +built\-in +\fBtee\fR +command is that the built\-in +\fBtee\fR +works even if you do not have the Unix +\fBtee\fR +available. The built\-in +\fBtee\fR +also logs everything that is printed on the screen, whereas the Unix +\fBtee\fR +used with +\fBpager\fR +does not log quite that much. Additionally, +\fBtee\fR +file logging can be turned on and off interactively from within +\fBmysql\fR. This is useful when you want to log some queries to a file, but not others. +.PP +The +\fBprompt\fR +command reconfigures the default +mysql> +prompt. The string for defining the prompt can contain the following special sequences. +.TS +allbox tab(:); +l l +l l +l l +l l +l l +l l +l l +l l +l l +l l +l l +l l +l l +l l +l l +l l +l l +l l +l l +l l +l l +l l +l l +l l +l l +l l +l l +l l +l l. +T{ +\fBOption\fR +T}:T{ +\fBDescription\fR +T} +T{ +\\o +T}:T{ +The current month in numeric format +T} +T{ +\\P +T}:T{ +am/pm +T} +T{ +\\p +T}:T{ +The current TCP/IP port or socket file +T} +T{ +\\R +T}:T{ +The current time, in 24\-hour military time (0\-23) +T} +T{ +\\r +T}:T{ +The current time, standard 12\-hour time (1\-12) +T} +T{ +\\S +T}:T{ +Semicolon +T} +T{ +\\s +T}:T{ +Seconds of the current time +T} +T{ +\\t +T}:T{ +A tab character +T} +T{ +\\U +T}:T{ +Your full + \fIuser_name\fR@\fIhost_name\fR + account name +T} +T{ +\\u +T}:T{ +Your user name +T} +T{ +\\c +T}:T{ +A counter that increments for each statement you issue +T} +T{ +\\v +T}:T{ +The server version +T} +T{ +\\w +T}:T{ +The current day of the week in three\-letter format (Mon, Tue, \&...) +T} +T{ +\\Y +T}:T{ +The current year, four digits +T} +T{ +\\y +T}:T{ +The current year, two digits +T} +T{ +\\_ +T}:T{ +A space +T} +T{ +\\\ +T}:T{ +A space (a space follows the backslash) +T} +T{ +\\' +T}:T{ +Single quote +T} +T{ +\\" +T}:T{ +Double quote +T} +T{ +\\\\ +T}:T{ +A literal \(lq\\\(rq backslash character +T} +T{ +\\\fIx\fR +T}:T{ +\fIx\fR, for any + \(lq\fIx\fR\(rq not listed + above +T} +T{ +\\D +T}:T{ +The full current date +T} +T{ +\\d +T}:T{ +The default database +T} +T{ +\\h +T}:T{ +The server host +T} +T{ +\\l +T}:T{ +The current delimiter (new in 5.1.12) +T} +T{ +\\m +T}:T{ +Minutes of the current time +T} +T{ +\\n +T}:T{ +A newline character +T} +T{ +\\O +T}:T{ +The current month in three\-letter format (Jan, Feb, \&...) +T} +.TE +.sp +.PP +You can set the prompt in several ways: +.TP 3n +\(bu +\fIUse an environment variable.\fR +You can set the +MYSQL_PS1 +environment variable to a prompt string. For example: +.sp +.RS 3n +.nf +shell> \fBexport MYSQL_PS1="(\\u@\\h) [\\d]> "\fR +.fi +.RE +.TP 3n +\(bu +\fIUse a command\-line option.\fR +You can set the +\fB\-\-prompt\fR +option on the command line to +\fBmysql\fR. For example: +.sp +.RS 3n +.nf +shell> \fBmysql \-\-prompt="(\\u@\\h) [\\d]> "\fR +(user@host) [database]> +.fi +.RE +.TP 3n +\(bu +\fIUse an option file.\fR +You can set the +prompt +option in the +[mysql] +group of any MySQL option file, such as +\fI/etc/my.cnf\fR +or the +\fI.my.cnf\fR +file in your home directory. For example: +.sp +.RS 3n +.nf +[mysql] +prompt=(\\\\u@\\\\h) [\\\\d]>\\\\_ +.fi +.RE +In this example, note that the backslashes are doubled. If you set the prompt using the +prompt +option in an option file, it is advisable to double the backslashes when using the special prompt options. There is some overlap in the set of allowable prompt options and the set of special escape sequences that are recognized in option files. (These sequences are listed in +Section\ 4.2.3.2, \(lqUsing Option Files\(rq.) The overlap may cause you problems if you use single backslashes. For example, +\\s +is interpreted as a space rather than as the current seconds value. The following example shows how to define a prompt within an option file to include the current time in +HH:MM:SS> +format: +.sp +.RS 3n +.nf +[mysql] +prompt="\\\\r:\\\\m:\\\\s> " +.fi +.RE +.TP 3n +\(bu +\fISet the prompt interactively.\fR +You can change your prompt interactively by using the +prompt +(or +\\R) command. For example: +.sp +.RS 3n +.nf +mysql> \fBprompt (\\u@\\h) [\\d]>\\_\fR +PROMPT set to '(\\u@\\h) [\\d]>\\_' +(\fIuser\fR@\fIhost\fR) [\fIdatabase\fR]> +(\fIuser\fR@\fIhost\fR) [\fIdatabase\fR]> prompt +Returning to default PROMPT of mysql> +mysql> +.fi +.RE +.SH "\fBMYSQL\fR SERVER\-SIDE HELP" +.sp +.RS 3n +.nf +mysql> \fBhelp \fR\fB\fIsearch_string\fR\fR +.fi +.RE +.PP +If you provide an argument to the +help +command, +\fBmysql\fR +uses it as a search string to access server\-side help from the contents of the MySQL Reference Manual. The proper operation of this command requires that the help tables in the +mysql +database be initialized with help topic information (see +Section\ 5.1.8, \(lqServer\-Side Help\(rq). +.PP +If there is no match for the search string, the search fails: +.sp +.RS 3n +.nf +mysql> \fBhelp me\fR +Nothing found +Please try to run 'help contents' for a list of all accessible topics +.fi +.RE +.PP +Use +\fBhelp contents\fR +to see a list of the help categories: +.sp +.RS 3n +.nf +mysql> \fBhelp contents\fR +You asked for help about help category: "Contents" +For more information, type 'help <item>', where <item> is one of the +following categories: + Account Management + Administration + Data Definition + Data Manipulation + Data Types + Functions + Functions and Modifiers for Use with GROUP BY + Geographic Features + Language Structure + Plugins + Storage Engines + Stored Routines + Table Maintenance + Transactions + Triggers +.fi +.RE +.PP +If the search string matches multiple items, +\fBmysql\fR +shows a list of matching topics: +.sp +.RS 3n +.nf +mysql> \fBhelp logs\fR +Many help items for your request exist. +To make a more specific request, please type 'help <item>', +where <item> is one of the following topics: + SHOW + SHOW BINARY LOGS + SHOW ENGINE + SHOW LOGS +.fi +.RE +.PP +Use a topic as the search string to see the help entry for that topic: +.sp +.RS 3n +.nf +mysql> \fBhelp show binary logs\fR +Name: 'SHOW BINARY LOGS' +Description: +Syntax: +SHOW BINARY LOGS +SHOW MASTER LOGS +Lists the binary log files on the server. This statement is used as +part of the procedure described in [purge\-binary\-logs], that shows how +to determine which logs can be purged. +mysql> SHOW BINARY LOGS; ++\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-\-\-+ +| Log_name | File_size | ++\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-\-\-+ +| binlog.000015 | 724935 | +| binlog.000016 | 733481 | ++\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-\-\-+ +.fi +.RE +.SH "EXECUTING SQL STATEMENTS FROM A TEXT FILE" +.PP +The +\fBmysql\fR +client typically is used interactively, like this: +.sp +.RS 3n +.nf +shell> \fBmysql \fR\fB\fIdb_name\fR\fR +.fi +.RE +.PP +However, it is also possible to put your SQL statements in a file and then tell +\fBmysql\fR +to read its input from that file. To do so, create a text file +\fItext_file\fR +that contains the statements you wish to execute. Then invoke +\fBmysql\fR +as shown here: +.sp +.RS 3n +.nf +shell> \fBmysql \fR\fB\fIdb_name\fR\fR\fB < \fR\fB\fItext_file\fR\fR +.fi +.RE +.PP +If you place a +USE \fIdb_name\fR +statement as the first statement in the file, it is unnecessary to specify the database name on the command line: +.sp +.RS 3n +.nf +shell> \fBmysql < text_file\fR +.fi +.RE +.PP +If you are already running +\fBmysql\fR, you can execute an SQL script file using the +source +command or +\\. +command: +.sp +.RS 3n +.nf +mysql> \fBsource \fR\fB\fIfile_name\fR\fR +mysql> \fB\\. \fR\fB\fIfile_name\fR\fR +.fi +.RE +.PP +Sometimes you may want your script to display progress information to the user. For this you can insert statements like this: +.sp +.RS 3n +.nf +SELECT '<info_to_display>' AS ' '; +.fi +.RE +.PP +The statement shown outputs +<info_to_display>. +.PP +As of MySQL 5.1.23, +\fBmysql\fR +ignores Unicode byte order mark (BOM) characters at the beginning of input files. Previously, it read them and sent them to the server, resulting in a syntax error. Presence of a BOM does not cause +\fBmysql\fR +to change its default character set. To do that, invoke +\fBmysql\fR +with an option such as +\fB\-\-default\-character\-set=utf8\fR. +.PP +For more information about batch mode, see +Section\ 3.5, \(lqUsing \fBmysql\fR in Batch Mode\(rq. +.SH "\fBMYSQL\fR TIPS" +.PP +This section describes some techniques that can help you use +\fBmysql\fR +more effectively. +.SS "Displaying Query Results Vertically" +.PP +Some query results are much more readable when displayed vertically, instead of in the usual horizontal table format. Queries can be displayed vertically by terminating the query with \\G instead of a semicolon. For example, longer text values that include newlines often are much easier to read with vertical output: +.sp +.RS 3n +.nf +mysql> \fBSELECT * FROM mails WHERE LENGTH(txt) < 300 LIMIT 300,1\\G\fR +*************************** 1. row *************************** + msg_nro: 3068 + date: 2000\-03\-01 23:29:50 +time_zone: +0200 +mail_from: Monty + reply: monty@no.spam.com + mail_to: "Thimble Smith" <tim@no.spam.com> + sbj: UTF\-8 + txt: >>>>> "Thimble" == Thimble Smith writes: +Thimble> Hi. I think this is a good idea. Is anyone familiar +Thimble> with UTF\-8 or Unicode? Otherwise, I'll put this on my +Thimble> TODO list and see what happens. +Yes, please do that. +Regards, +Monty + file: inbox\-jani\-1 + hash: 190402944 +1 row in set (0.09 sec) +.fi +.RE +.\" end of SS subsection "Displaying Query Results Vertically" +.SS "Using the \-\-safe\-updates Option" +.PP +For beginners, a useful startup option is +\fB\-\-safe\-updates\fR +(or +\fB\-\-i\-am\-a\-dummy\fR, which has the same effect). It is helpful for cases when you might have issued a +DELETE FROM \fItbl_name\fR +statement but forgotten the +WHERE +clause. Normally, such a statement deletes all rows from the table. With +\fB\-\-safe\-updates\fR, you can delete rows only by specifying the key values that identify them. This helps prevent accidents. +.PP +When you use the +\fB\-\-safe\-updates\fR +option, +\fBmysql\fR +issues the following statement when it connects to the MySQL server: +.sp +.RS 3n +.nf +SET sql_safe_updates=1, sql_select_limit=1000, sql_max_join_size=1000000; +.fi +.RE +.PP +See +Section\ 5.1.4, \(lqSession System Variables\(rq. +.PP +The +SET +statement has the following effects: +.TP 3n +\(bu +You are not allowed to execute an +UPDATE +or +DELETE +statement unless you specify a key constraint in the +WHERE +clause or provide a +LIMIT +clause (or both). For example: +.sp +.RS 3n +.nf +UPDATE \fItbl_name\fR SET \fInot_key_column\fR=\fIval\fR WHERE \fIkey_column\fR=\fIval\fR; +UPDATE \fItbl_name\fR SET \fInot_key_column\fR=\fIval\fR LIMIT 1; +.fi +.RE +.TP 3n +\(bu +The server limits all large +SELECT +results to 1,000 rows unless the statement includes a +LIMIT +clause. +.TP 3n +\(bu +The server aborts multiple\-table +SELECT +statements that probably need to examine more than 1,000,000 row combinations. +.sp +.RE +.PP +To specify limits different from 1,000 and 1,000,000, you can override the defaults by using the +\fB\-\-select_limit\fR +and +\fB\-\-max_join_size\fR +options: +.sp +.RS 3n +.nf +shell> \fBmysql \-\-safe\-updates \-\-select_limit=500 \-\-max_join_size=10000\fR +.fi +.RE +.\" end of SS subsection "Using the \-\-safe\-updates Option" +.SS "Disabling mysql Auto\-Reconnect" +.PP +If the +\fBmysql\fR +client loses its connection to the server while sending a statement, it immediately and automatically tries to reconnect once to the server and send the statement again. However, even if +\fBmysql\fR +succeeds in reconnecting, your first connection has ended and all your previous session objects and settings are lost: temporary tables, the autocommit mode, and user\-defined and session variables. Also, any current transaction rolls back. This behavior may be dangerous for you, as in the following example where the server was shut down and restarted between the first and second statements without you knowing it: +.sp +.RS 3n +.nf +mysql> \fBSET @a=1;\fR +Query OK, 0 rows affected (0.05 sec) +mysql> \fBINSERT INTO t VALUES(@a);\fR +ERROR 2006: MySQL server has gone away +No connection. Trying to reconnect... +Connection id: 1 +Current database: test +Query OK, 1 row affected (1.30 sec) +mysql> \fBSELECT * FROM t;\fR ++\-\-\-\-\-\-+ +| a | ++\-\-\-\-\-\-+ +| NULL | ++\-\-\-\-\-\-+ +1 row in set (0.05 sec) +.fi +.RE +.PP +The +@a +user variable has been lost with the connection, and after the reconnection it is undefined. If it is important to have +\fBmysql\fR +terminate with an error if the connection has been lost, you can start the +\fBmysql\fR +client with the +\fB\-\-skip\-reconnect\fR +option. +.PP +For more information about auto\-reconnect and its effect on state information when a reconnection occurs, see +Section\ 21.10.11, \(lqControlling Automatic Reconnection Behavior\(rq. +.\" end of SS subsection "Disabling mysql Auto\-Reconnect" +.SH "COPYRIGHT" +.PP +Copyright 2007\-2008 MySQL AB, 2009 Sun Microsystems, Inc. +.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/. +.SH "REFERENCES" +.TP 3 +1.\ Bug#25946 +\%http://bugs.mysql.com/25946 +.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 +MySQL AB (http://www.mysql.com/). diff --git a/man/mysql.server.1 b/man/mysql.server.1 new file mode 100644 index 00000000000..6535322f971 --- /dev/null +++ b/man/mysql.server.1 @@ -0,0 +1,111 @@ +.\" Title: \fBmysql.server\fR +.\" Author: +.\" Generator: DocBook XSL Stylesheets v1.70.1 <http://docbook.sf.net/> +.\" Date: 03/31/2009 +.\" Manual: MySQL Database System +.\" Source: MySQL 5.1 +.\" +.TH "\fBMYSQL.SERVER\fR" "1" "03/31/2009" "MySQL 5.1" "MySQL Database System" +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.SH "NAME" +mysql.server \- MySQL server startup script +.SH "SYNOPSIS" +.HP 19 +\fBmysql {start|stop}\fR +.SH "DESCRIPTION" +.PP +MySQL distributions on Unix include a script named +\fBmysql.server\fR. It can be used on systems such as Linux and Solaris that use System V\-style run directories to start and stop system services. It is also used by the Mac OS X Startup Item for MySQL. +.PP +\fBmysql.server\fR +can be found in the +\fIsupport\-files\fR +directory under your MySQL installation directory or in a MySQL source distribution. +.PP +If you use the Linux server RPM package (MySQL\-server\-\fIVERSION\fR.rpm), the +\fBmysql.server\fR +script will be installed in the +\fI/etc/init.d\fR +directory with the name +\fImysql\fR. You need not install it manually. See +Section\ 2.4, \(lqInstalling MySQL from RPM Packages on Linux\(rq, for more information on the Linux RPM packages. +.PP +Some vendors provide RPM packages that install a startup script under a different name such as +\fBmysqld\fR. +.PP +If you install MySQL from a source distribution or using a binary distribution format that does not install +\fBmysql.server\fR +automatically, you can install it manually. Instructions are provided in +Section\ 2.11.2.2, \(lqStarting and Stopping MySQL Automatically\(rq. +.PP +\fBmysql.server\fR +reads options from the +[mysql.server] +and +[mysqld] +sections of option files. For backward compatibility, it also reads +[mysql_server] +sections, although you should rename such sections to +[mysql.server] +when using MySQL 5.1. +.PP +\fBmysql.server\fR +understands the following options: +.TP 3n +\(bu +\fB\-\-basedir=\fR\fB\fIpath\fR\fR +.sp +The path to the MySQL installation directory. +.TP 3n +\(bu +\fB\-\-datadir=\fR\fB\fIpath\fR\fR +.sp +The path to the MySQL data directory. +.TP 3n +\(bu +\fB\-\-pid\-file=\fR\fB\fIfile_name\fR\fR +.sp +The path name of the file in which the server should write its process ID. +.TP 3n +\(bu +\fB\-\-service\-startup\-timeout=\fR\fB\fIfile_name\fR\fR +.sp +How long in seconds to wait for confirmation of server startup. If the server does not start within this time, +\fBmysql.server\fR +exits with an error. The default value is 900. A value of 0 means not to wait at all for startup. Negative values mean to wait forever (no timeout). This option was added in MySQL 5.1.17. Before that, a value of 900 is always used. +.TP 3n +\(bu +\fB\-\-use\-mysqld_safe\fR +.sp +Use +\fBmysqld_safe\fR +to start the server. This is the default. +.TP 3n +\(bu +\fB\-\-use\-manager\fR +.sp +Use Instance Manager to start the server. +.TP 3n +\(bu +\fB\-\-user=\fR\fB\fIuser_name\fR\fR +.sp +The login user name to use for running +\fBmysqld\fR. +.SH "COPYRIGHT" +.PP +Copyright 2007\-2008 MySQL AB, 2009 Sun Microsystems, Inc. +.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/. +.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 +MySQL AB (http://www.mysql.com/). diff --git a/man/mysql_client_test.1 b/man/mysql_client_test.1 new file mode 100644 index 00000000000..ce125cb22eb --- /dev/null +++ b/man/mysql_client_test.1 @@ -0,0 +1,166 @@ +.\" Title: \fBmysql_client_test\fR +.\" Author: +.\" Generator: DocBook XSL Stylesheets v1.70.1 <http://docbook.sf.net/> +.\" Date: 03/27/2009 +.\" Manual: MySQL Database System +.\" Source: MySQL +.\" +.TH "\fBMYSQL_CLIENT_TEST" "1" "03/27/2009" "MySQL" "MySQL Database System" +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.SH "NAME" +mysql_client_test \- test client API +.br +mysql_client_test_embedded \- test client API for embedded server +.SH "SYNOPSIS" +.HP 44 +\fBmysql_client_test [\fR\fB\fIoptions\fR\fR\fB] [\fR\fB\fItest_name\fR\fR\fB] ...\fR +.HP 53 +\fBmysql_client_test_embedded [\fR\fB\fIoptions\fR\fR\fB] [\fR\fB\fItest_name\fR\fR\fB] ...\fR +.SH "DESCRIPTION" +.PP +The +\fBmysql_client_test\fR +program is used for testing aspects of the MySQL client API that cannot be tested using +\fBmysqltest\fR +and its test language. +\fBmysql_client_test_embedded\fR +is similar but used for testing the embedded server. Both programs are run as part of the test suite. +.PP +The source code for the programs can be found in in +\fItest/mysql_client_test.c\fR +in a source distribution. The program serves as a good source of examples illustrating how to use various features of the client API. +.PP +\fBmysql_client_test\fR +supports the following options: +.TP 3n +\(bu +\fB\-\-help\fR, +\fB\-?\fR +.sp +Display a help message and exit. +.TP 3n +\(bu +\fB\-b \fR\fB\fIdir_name\fR\fR, +\fB\-\-basedir=\fR\fB\fIdir_name\fR\fR +.sp +The base directory for the tests. +.TP 3n +\(bu +\fB\-t \fR\fB\fIcount\fR\fR, +\fB\-\-count=\fR\fB\fIcount\fR\fR +.sp +The number of times to execute the tests. +.TP 3n +\(bu +\fB\-\-database=\fR\fB\fIdb_name\fR\fR, +\fB\-D \fR\fB\fIdb_name\fR\fR +.sp +The database to use. +.TP 3n +\(bu +\fB\-\-debug[=\fR\fB\fIdebug_options\fR\fR\fB]\fR, +\fB\-#[\fR\fB\fIdebug_options\fR\fR\fB]\fR +.sp +Write a debugging log if MySQL is built with debugging support. The default +\fIdebug_options\fR +value is +\'d:t:o,/tmp/mysql_client_test.trace'. +.TP 3n +\(bu +\fB\-g \fR\fB\fIoption\fR\fR, +\fB\-\-getopt\-ll\-test=\fR\fB\fIoption\fR\fR +.sp +Option to use for testing bugs in the +getopt +library. +.TP 3n +\(bu +\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. +.TP 3n +\(bu +\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, you are prompted for one. +.TP 3n +\(bu +\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. +.TP 3n +\(bu +\fB\-A \fR\fB\fIarg\fR\fR, +\fB\-\-server\-arg=\fR\fB\fIarg\fR\fR +.sp +Argument to send to the embedded server. +.TP 3n +\(bu +\fB\-T\fR, +\fB\-\-show\-tests\fR +.sp +Show all test names. +.TP 3n +\(bu +\fB\-\-silent\fR, +\fB\-s\fR +.sp +Be more silent. +.TP 3n +\(bu +\fB\-\-socket=\fR\fB\fIpath\fR\fR, +\fB\-S \fR\fB\fIpath\fR\fR +.sp +The socket file to use when connecting to +localhost +(which is the default host). +.TP 3n +\(bu +\fB\-c\fR, +\fB\-\-testcase\fR +.sp +The option may disable some code when run as a +\fBmysql\-test\-run.pl\fR +test case. +.TP 3n +\(bu +\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. +.TP 3n +\(bu +\fB\-v \fR\fB\fIdir_name\fR\fR, +\fB\-\-vardir=\fR\fB\fIdir_name\fR\fR +.sp +The data directory for tests. The default is +\fImysql\-test/var\fR. +.SH "COPYRIGHT" +.PP +Copyright 2007\-2008 MySQL AB, 2009 Sun Microsystems, Inc. +.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/. +.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 +MySQL AB (http://www.mysql.com/). diff --git a/man/mysql_client_test_embedded.1 b/man/mysql_client_test_embedded.1 new file mode 100644 index 00000000000..41f528017b3 --- /dev/null +++ b/man/mysql_client_test_embedded.1 @@ -0,0 +1 @@ +.so man1/mysql_client_test.1 diff --git a/man/mysql_config.1 b/man/mysql_config.1 new file mode 100644 index 00000000000..47fff0dce6c --- /dev/null +++ b/man/mysql_config.1 @@ -0,0 +1,131 @@ +.\" Title: \fBmysql_config\fR +.\" Author: +.\" Generator: DocBook XSL Stylesheets v1.70.1 <http://docbook.sf.net/> +.\" Date: 03/31/2009 +.\" Manual: MySQL Database System +.\" Source: MySQL 5.1 +.\" +.TH "\fBMYSQL_CONFIG\fR" "1" "03/31/2009" "MySQL 5.1" "MySQL Database System" +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.SH "NAME" +mysql_config \- get compile options for compiling clients +.SH "SYNOPSIS" +.HP 21 +\fBmysql_config \fR\fB\fIoptions\fR\fR +.SH "DESCRIPTION" +.PP +\fBmysql_config\fR +provides you with useful information for compiling your MySQL client and connecting it to MySQL. +.PP +\fBmysql_config\fR +supports the following options: +.TP 3n +\(bu +\fB\-\-cflags\fR +.sp +Compiler flags to find include files and critical compiler flags and defines used when compiling the +libmysqlclient +library. The options returned are tied to the specific compiler that was used when the library was created and might clash with the settings for your own compiler. Use +\fB\-\-include\fR +for more portable options that contain only include paths. +.TP 3n +\(bu +\fB\-\-include\fR +.sp +Compiler options to find MySQL include files. +.TP 3n +\(bu +\fB\-\-libmysqld\-libs\fR, +\fB\-\-embedded\fR +.sp +Libraries and options required to link with the MySQL embedded server. +.TP 3n +\(bu +\fB\-\-libs\fR +.sp +Libraries and options required to link with the MySQL client library. +.TP 3n +\(bu +\fB\-\-libs_r\fR +.sp +Libraries and options required to link with the thread\-safe MySQL client library. +.TP 3n +\(bu +\fB\-\-plugindir\fR +.sp +The default plugin directory path name, defined when configuring MySQL. This option was added in MySQL 5.1.24. +.TP 3n +\(bu +\fB\-\-port\fR +.sp +The default TCP/IP port number, defined when configuring MySQL. +.TP 3n +\(bu +\fB\-\-socket\fR +.sp +The default Unix socket file, defined when configuring MySQL. +.TP 3n +\(bu +\fB\-\-version\fR +.sp +Version number for the MySQL distribution. +.sp +.RE +.PP +If you invoke +\fBmysql_config\fR +with no options, it displays a list of all options that it supports, and their values: +.sp +.RS 3n +.nf +shell> \fBmysql_config\fR +Usage: /usr/local/mysql/bin/mysql_config [options] +Options: + \-\-cflags [\-I/usr/local/mysql/include/mysql \-mcpu=pentiumpro] + \-\-include [\-I/usr/local/mysql/include/mysql] + \-\-libs [\-L/usr/local/mysql/lib/mysql \-lmysqlclient \-lz + \-lcrypt \-lnsl \-lm \-L/usr/lib \-lssl \-lcrypto] + \-\-libs_r [\-L/usr/local/mysql/lib/mysql \-lmysqlclient_r + \-lpthread \-lz \-lcrypt \-lnsl \-lm \-lpthread] + \-\-socket [/tmp/mysql.sock] + \-\-port [3306] + \-\-version [4.0.16] + \-\-libmysqld\-libs [\-L/usr/local/mysql/lib/mysql \-lmysqld \-lpthread \-lz + \-lcrypt \-lnsl \-lm \-lpthread \-lrt] +.fi +.RE +.PP +You can use +\fBmysql_config\fR +within a command line to include the value that it displays for a particular option. For example, to compile a MySQL client program, use +\fBmysql_config\fR +as follows: +.sp +.RS 3n +.nf +shell> \fBCFG=/usr/local/mysql/bin/mysql_config\fR +shell> \fBsh \-c "gcc \-o progname `$CFG \-\-include` progname.c `$CFG \-\-libs`"\fR +.fi +.RE +.PP +When you use +\fBmysql_config\fR +this way, be sure to invoke it within backtick (\(lq`\(rq) characters. That tells the shell to execute it and substitute its output into the surrounding command. +.SH "COPYRIGHT" +.PP +Copyright 2007\-2008 MySQL AB, 2009 Sun Microsystems, Inc. +.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/. +.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 +MySQL AB (http://www.mysql.com/). diff --git a/man/mysql_convert_table_format.1 b/man/mysql_convert_table_format.1 new file mode 100644 index 00000000000..244c2022b67 --- /dev/null +++ b/man/mysql_convert_table_format.1 @@ -0,0 +1,117 @@ +.\" Title: \fBmysql_convert_table_format\fR +.\" Author: +.\" Generator: DocBook XSL Stylesheets v1.70.1 <http://docbook.sf.net/> +.\" Date: 03/31/2009 +.\" Manual: MySQL Database System +.\" Source: MySQL 5.1 +.\" +.TH "\fBMYSQL_CONVERT_TAB" "1" "03/31/2009" "MySQL 5.1" "MySQL Database System" +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.SH "NAME" +mysql_convert_table_format \- convert tables to use a given storage engine +.SH "SYNOPSIS" +.HP 45 +\fBmysql_convert_table_format [\fR\fB\fIoptions\fR\fR\fB] \fR\fB\fIdb_name\fR\fR +.SH "DESCRIPTION" +.PP +\fBmysql_convert_table_format\fR +converts the tables in a database to use a particular storage engine (MyISAM +by default). +\fBmysql_convert_table_format\fR +is written in Perl and requires that the +DBI +and +DBD::mysql +Perl modules be installed (see +Section\ 2.15, \(lqPerl Installation Notes\(rq). +.PP +Invoke +\fBmysql_convert_table_format\fR +like this: +.sp +.RS 3n +.nf +shell> \fBmysql_convert_table_format [\fR\fB\fIoptions\fR\fR\fB]\fR\fB\fIdb_name\fR\fR +.fi +.RE +.PP +The +\fIdb_name\fR +argument indicates the database containing the tables to be converted. +.PP +\fBmysql_convert_table_format\fR +understands the options described in the following list. +.TP 3n +\(bu +\fB\-\-help\fR +.sp +Display a help message and exit. +.TP 3n +\(bu +\fB\-\-force\fR +.sp +Continue even if errors occur. +.TP 3n +\(bu +\fB\-\-host=\fR\fB\fIhost_name\fR\fR +.sp +Connect to the MySQL server on the given host. +.TP 3n +\(bu +\fB\-\-password=\fR\fB\fIpassword\fR\fR +.sp +The password to use when connecting to the server. Note that the password value is not optional for this option, unlike for other MySQL programs. You can use an option file to avoid giving the password on the command line. +.sp +Specifying a password on the command line should be considered insecure. See +Section\ 5.5.6.2, \(lqEnd\-User Guidelines for Password Security\(rq. +.TP 3n +\(bu +\fB\-\-port=\fR\fB\fIport_num\fR\fR +.sp +The TCP/IP port number to use for the connection. +.TP 3n +\(bu +\fB\-\-socket=\fR\fB\fIpath\fR\fR +.sp +For connections to +localhost, the Unix socket file to use. +.TP 3n +\(bu +\fB\-\-type=\fR\fB\fIengine_name\fR\fR +.sp +Specify the storage engine that the tables should be converted to use. The default is +MyISAM +if this option is not given. +.TP 3n +\(bu +\fB\-\-user=\fR\fB\fIuser_name\fR\fR +.sp +The MySQL user name to use when connecting to the server. +.TP 3n +\(bu +\fB\-\-verbose\fR +.sp +Verbose mode. Print more information about what the program does. +.TP 3n +\(bu +\fB\-\-version\fR +.sp +Display version information and exit. +.SH "COPYRIGHT" +.PP +Copyright 2007\-2008 MySQL AB, 2009 Sun Microsystems, Inc. +.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/. +.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 +MySQL AB (http://www.mysql.com/). diff --git a/man/mysql_find_rows.1 b/man/mysql_find_rows.1 new file mode 100644 index 00000000000..cd265b96934 --- /dev/null +++ b/man/mysql_find_rows.1 @@ -0,0 +1,98 @@ +.\" Title: \fBmysql_find_rows\fR +.\" Author: +.\" Generator: DocBook XSL Stylesheets v1.70.1 <http://docbook.sf.net/> +.\" Date: 03/31/2009 +.\" Manual: MySQL Database System +.\" Source: MySQL 5.1 +.\" +.TH "\fBMYSQL_FIND_ROWS\\F" "1" "03/31/2009" "MySQL 5.1" "MySQL Database System" +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.SH "NAME" +mysql_find_rows \- extract SQL statements from files +.SH "SYNOPSIS" +.HP 42 +\fBmysql_find_rows [\fR\fB\fIoptions\fR\fR\fB] [\fR\fB\fIfile_name\fR\fR\fB ...]\fR +.SH "DESCRIPTION" +.PP +\fBmysql_find_rows\fR +reads files containing SQL statements and extracts statements that match a given regular expression or that contain +USE \fIdb_name\fR +or +SET +statements. The utility was written for use with update log files (as used prior to MySQL 5.0) and as such expects statements to be terminated with semicolon (;) characters. It may be useful with other files that contain SQL statements as long as statements are terminated with semicolons. +.PP +Invoke +\fBmysql_find_rows\fR +like this: +.sp +.RS 3n +.nf +shell> \fBmysql_find_rows [\fR\fB\fIoptions\fR\fR\fB] [\fR\fB\fIfile_name\fR\fR\fB ...]\fR +.fi +.RE +.PP +Each +\fIfile_name\fR +argument should be the name of file containing SQL statements. If no file names are given, +\fBmysql_find_rows\fR +reads the standard input. +.PP +Examples: +.sp +.RS 3n +.nf +mysql_find_rows \-\-regexp=problem_table \-\-rows=20 < update.log +mysql_find_rows \-\-regexp=problem_table update\-log.1 update\-log.2 +.fi +.RE +.PP +\fBmysql_find_rows\fR +supports the following options: +.TP 3n +\(bu +\fB\-\-help\fR, +\fB\-\-Information\fR +.sp +Display a help message and exit. +.TP 3n +\(bu +\fB\-\-regexp=\fR\fB\fIpattern\fR\fR +.sp +Display queries that match the pattern. +.TP 3n +\(bu +\fB\-\-rows=\fR\fB\fIN\fR\fR +.sp +Quit after displaying +\fIN\fR +queries. +.TP 3n +\(bu +\fB\-\-skip\-use\-db\fR +.sp +Do not include +USE \fIdb_name\fR +statements in the output. +.TP 3n +\(bu +\fB\-\-start_row=\fR\fB\fIN\fR\fR +.sp +Start output from this row. +.SH "COPYRIGHT" +.PP +Copyright 2007\-2008 MySQL AB, 2009 Sun Microsystems, Inc. +.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/. +.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 +MySQL AB (http://www.mysql.com/). diff --git a/man/mysql_fix_extensions.1 b/man/mysql_fix_extensions.1 new file mode 100644 index 00000000000..0b3d6dc215d --- /dev/null +++ b/man/mysql_fix_extensions.1 @@ -0,0 +1,62 @@ +.\" Title: \fBmysql_fix_extensions\fR +.\" Author: +.\" Generator: DocBook XSL Stylesheets v1.70.1 <http://docbook.sf.net/> +.\" Date: 03/31/2009 +.\" Manual: MySQL Database System +.\" Source: MySQL 5.1 +.\" +.TH "\fBMYSQL_FIX_EXTENSI" "1" "03/31/2009" "MySQL 5.1" "MySQL Database System" +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.SH "NAME" +mysql_fix_extensions \- normalize table file name extensions +.SH "SYNOPSIS" +.HP 30 +\fBmysql_fix_extensions \fR\fB\fIdata_dir\fR\fR +.SH "DESCRIPTION" +.PP +\fBmysql_fix_extensions\fR +converts the extensions for +MyISAM +(or +ISAM) table files to their canonical forms. It looks for files with extensions matching any lettercase variant of +\fI.frm\fR, +\fI.myd\fR, +\fI.myi\fR, +\fI.isd\fR, and +\fI.ism\fR +and renames them to have extensions of +\fI.frm\fR, +\fI.MYD\fR, +\fI.MYI\fR, +\fI.ISD\fR, and +\fI.ISM\fR, respectively. This can be useful after transferring the files from a system with case\-insensitive file names (such as Windows) to a system with case\-sensitive file names. +.PP +Invoke +\fBmysql_fix_extensions\fR +like this, where +\fIdata_dir\fR +is the path name to the MySQL data directory. +.sp +.RS 3n +.nf +shell> \fBmysql_fix_extensions \fR\fB\fIdata_dir\fR\fR +.fi +.RE +.SH "COPYRIGHT" +.PP +Copyright 2007\-2008 MySQL AB, 2009 Sun Microsystems, Inc. +.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/. +.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 +MySQL AB (http://www.mysql.com/). diff --git a/man/mysql_fix_privilege_tables.1 b/man/mysql_fix_privilege_tables.1 new file mode 100644 index 00000000000..ba498f3474a --- /dev/null +++ b/man/mysql_fix_privilege_tables.1 @@ -0,0 +1,123 @@ +.\" Title: \fBmysql_fix_privilege_tables\fR +.\" Author: +.\" Generator: DocBook XSL Stylesheets v1.70.1 <http://docbook.sf.net/> +.\" Date: 03/31/2009 +.\" Manual: MySQL Database System +.\" Source: MySQL 5.1 +.\" +.TH "\fBMYSQL_FIX_PRIVILE" "1" "03/31/2009" "MySQL 5.1" "MySQL Database System" +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.SH "NAME" +mysql_fix_privilege_tables \- upgrade MySQL system tables +.SH "SYNOPSIS" +.HP 52 +\fBmysql_fix_privilege_tables \-\-password=\fR\fB\fIroot_password\fR\fR +.SH "DESCRIPTION" +.PP +Some releases of MySQL introduce changes to the structure of the system tables in the +mysql +database to add new privileges or support new features. When you update to a new version of MySQL, you should update your system tables as well to make sure that their structure is up to date. Otherwise, there might be capabilities that you cannot take advantage of. First, make a backup of your +mysql +database, and then use the following procedure. +.sp +.it 1 an-trap +.nr an-no-space-flag 1 +.nr an-break-flag 1 +.br +\fBNote\fR +.PP +As of MySQL 5.1.7, +\fBmysql_fix_privilege_tables\fR +is superseded by +\fBmysql_upgrade\fR, which should be used instead. See +\fBmysql_upgrade\fR(1). +.PP +On Unix or Unix\-like systems, update the system tables by running the +\fBmysql_fix_privilege_tables\fR +script: +.sp +.RS 3n +.nf +shell> \fBmysql_fix_privilege_tables\fR +.fi +.RE +.PP +You must run this script while the server is running. It attempts to connect to the server running on the local host as +root. If your +root +account requires a password, indicate the password on the command line like this: +.sp +.RS 3n +.nf +shell> \fBmysql_fix_privilege_tables \-\-password=\fR\fB\fIroot_password\fR\fR +.fi +.RE +.PP +The +\fBmysql_fix_privilege_tables\fR +script performs any actions necessary to convert your system tables to the current format. You might see some +Duplicate column name +warnings as it runs; you can ignore them. +.PP +After running the script, stop the server and restart it so that it uses any changes that were made to the system tables. +.PP +On Windows systems, MySQL distributions include a +\fImysql_fix_privilege_tables.sql\fR +SQL script that you can run using the +\fBmysql\fR +client. For example, if your MySQL installation is located at +\fIC:\\Program Files\\MySQL\\MySQL Server 5.1\fR, the commands look like this: +.sp +.RS 3n +.nf +C:\\> \fBcd "C:\\Program Files\\MySQL\\MySQL Server 5.1"\fR +C:\\> \fBbin\\mysql \-u root \-p mysql\fR +mysql> \fBSOURCE share/mysql_fix_privilege_tables.sql\fR +.fi +.RE +.sp +.it 1 an-trap +.nr an-no-space-flag 1 +.nr an-break-flag 1 +.br +\fBNote\fR +.PP +Prior to version 5.1.17, this script is found in the +\fIscripts\fR +directory. +.PP +The +\fBmysql\fR +command will prompt you for the +root +password; enter it when prompted. +.PP +If your installation is located in some other directory, adjust the path names appropriately. +.PP +As with the Unix procedure, you might see some +Duplicate column name +warnings as +\fBmysql\fR +processes the statements in the +\fImysql_fix_privilege_tables.sql\fR +script; you can ignore them. +.PP +After running the script, stop the server and restart it. +.SH "COPYRIGHT" +.PP +Copyright 2007\-2008 MySQL AB, 2009 Sun Microsystems, Inc. +.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/. +.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 +MySQL AB (http://www.mysql.com/). diff --git a/man/mysql_install_db.1 b/man/mysql_install_db.1 new file mode 100644 index 00000000000..bf20b97a7fc --- /dev/null +++ b/man/mysql_install_db.1 @@ -0,0 +1,153 @@ +.\" Title: \fBmysql_install_db\fR +.\" Author: +.\" Generator: DocBook XSL Stylesheets v1.70.1 <http://docbook.sf.net/> +.\" Date: 03/31/2009 +.\" Manual: MySQL Database System +.\" Source: MySQL 5.1 +.\" +.TH "\fBMYSQL_INSTALL_DB\\" "1" "03/31/2009" "MySQL 5.1" "MySQL Database System" +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.SH "NAME" +mysql_install_db \- initialize MySQL data directory +.SH "SYNOPSIS" +.HP 27 +\fBmysql_install_db [\fR\fB\fIoptions\fR\fR\fB]\fR +.SH "DESCRIPTION" +.PP +\fBmysql_install_db\fR +initializes the MySQL data directory and creates the system tables that it contains, if they do not exist. +.PP +To invoke +\fBmysql_install_db\fR, use the following syntax: +.sp +.RS 3n +.nf +shell> \fBmysql_install_db [\fR\fB\fIoptions\fR\fR\fB]\fR +.fi +.RE +.PP +Because the MySQL server, +\fBmysqld\fR, needs to access the data directory when it runs later, you should either run +\fBmysql_install_db\fR +from the same account that will be used for running +\fBmysqld\fR +or run it as +root +and use the +\fB\-\-user\fR +option to indicate the user name that +\fBmysqld\fR +will run as. It might be necessary to specify other options such as +\fB\-\-basedir\fR +or +\fB\-\-datadir\fR +if +\fBmysql_install_db\fR +does not use the correct locations for the installation directory or data directory. For example: +.sp +.RS 3n +.nf +shell> \fBbin/mysql_install_db \-\-user=mysql \\\fR + \fB\-\-basedir=/opt/mysql/mysql \\\fR + \fB\-\-datadir=/opt/mysql/mysql/data\fR +.fi +.RE +.PP +\fBmysql_install_db\fR +needs to invoke +\fBmysqld\fR +with the +\fB\-\-bootstrap\fR +and +\fB\-\-skip\-grant\-tables\fR +options (see +Section\ 2.10.2, \(lqTypical \fBconfigure\fR Options\(rq). If MySQL was configured with the +\fB\-\-disable\-grant\-options\fR +option, +\fB\-\-bootstrap\fR +and +\fB\-\-skip\-grant\-tables\fR +will be disabled. To handle this, set the +MYSQLD_BOOTSTRAP +environment variable to the full path name of a server that has all options enabled. +\fBmysql_install_db\fR +will use that server. +.PP +\fBmysql_install_db\fR +supports the options in the following list. It also reads option files and supports the options for processing them described at +Section\ 4.2.3.2.1, \(lqCommand\-Line Options that Affect Option\-File Handling\(rq. +.TP 3n +\(bu +\fB\-\-basedir=\fR\fB\fIpath\fR\fR +.sp +The path to the MySQL installation directory. +.TP 3n +\(bu +\fB\-\-force\fR +.sp +Causes +\fBmysql_install_db\fR +to run even if DNS does not work. In that case, grant table entries that normally use host names will use IP addresses. +.TP 3n +\(bu +\fB\-\-datadir=\fR\fB\fIpath\fR\fR, +\fB\-\-ldata=\fR\fB\fIpath\fR\fR +.sp +The path to the MySQL data directory. +.TP 3n +\(bu +\fB\-\-rpm\fR +.sp +For internal use. This option is used by RPM files during the MySQL installation process. +.TP 3n +\(bu +\fB\-\-skip\-name\-resolve\fR +.sp +Use IP addresses rather than host names when creating grant table entries. This option can be useful if your DNS does not work. +.TP 3n +\(bu +\fB\-\-srcdir=\fR\fB\fIpath\fR\fR +.sp +For internal use. The directory under which +\fBmysql_install_db\fR +looks for support files such as the error message file and the file for populating the help tables. This option was added in MySQL 5.1.14. +.TP 3n +\(bu +\fB\-\-user=\fR\fB\fIuser_name\fR\fR +.sp +The login user name to use for running +\fBmysqld\fR. Files and directories created by +\fBmysqld\fR +will be owned by this user. You must be +root +to use this option. By default, +\fBmysqld\fR +runs using your current login name and files and directories that it creates will be owned by you. +.TP 3n +\(bu +\fB\-\-verbose\fR +.sp +Verbose mode. Print more information about what the program does. +.TP 3n +\(bu +\fB\-\-windows\fR +.sp +For internal use. This option is used for creating Windows distributions. +.SH "COPYRIGHT" +.PP +Copyright 2007\-2008 MySQL AB, 2009 Sun Microsystems, Inc. +.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/. +.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 +MySQL AB (http://www.mysql.com/). diff --git a/man/mysql_secure_installation.1 b/man/mysql_secure_installation.1 new file mode 100644 index 00000000000..524db26b5b5 --- /dev/null +++ b/man/mysql_secure_installation.1 @@ -0,0 +1,67 @@ +.\" Title: \fBmysql_secure_installation\fR +.\" Author: +.\" Generator: DocBook XSL Stylesheets v1.70.1 <http://docbook.sf.net/> +.\" Date: 03/31/2009 +.\" Manual: MySQL Database System +.\" Source: MySQL 5.1 +.\" +.TH "\fBMYSQL_SECURE_INST" "1" "03/31/2009" "MySQL 5.1" "MySQL Database System" +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.SH "NAME" +mysql_secure_installation \- improve MySQL installation security +.SH "SYNOPSIS" +.HP 26 +\fBmysql_secure_installation\fR +.SH "DESCRIPTION" +.PP +This program enables you to improve the security of your MySQL installation in the following ways: +.TP 3n +\(bu +You can set a password for +root +accounts. +.TP 3n +\(bu +You can remove +root +accounts that are accessible from outside the local host. +.TP 3n +\(bu +You can remove anonymous\-user accounts. +.TP 3n +\(bu +You can remove the +test +database, which by default can be accessed by anonymous users. +.sp +.RE +.PP +Invoke +\fBmysql_secure_installation\fR +without arguments: +.sp +.RS 3n +.nf +shell> \fBmysql_secure_installation\fR +.fi +.RE +.PP +The script will prompt you to determine which actions to perform. +.SH "COPYRIGHT" +.PP +Copyright 2007\-2008 MySQL AB, 2009 Sun Microsystems, Inc. +.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/. +.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 +MySQL AB (http://www.mysql.com/). diff --git a/man/mysql_setpermission.1 b/man/mysql_setpermission.1 new file mode 100644 index 00000000000..95ee1d1c8c7 --- /dev/null +++ b/man/mysql_setpermission.1 @@ -0,0 +1,104 @@ +.\" Title: \fBmysql_setpermission\fR +.\" Author: +.\" Generator: DocBook XSL Stylesheets v1.70.1 <http://docbook.sf.net/> +.\" Date: 03/31/2009 +.\" Manual: MySQL Database System +.\" Source: MySQL 5.1 +.\" +.TH "\fBMYSQL_SETPERMISSI" "1" "03/31/2009" "MySQL 5.1" "MySQL Database System" +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.SH "NAME" +mysql_setpermission \- interactively set permissions in grant tables +.SH "SYNOPSIS" +.HP 30 +\fBmysql_setpermission [\fR\fB\fIoptions\fR\fR\fB]\fR +.SH "DESCRIPTION" +.PP +\fBmysql_setpermission\fR +is a Perl script that was originally written and contributed by Luuk de Boer. It interactively sets permissions in the MySQL grant tables. +\fBmysql_setpermission\fR +is written in Perl and requires that the +DBI +and +DBD::mysql +Perl modules be installed (see +Section\ 2.15, \(lqPerl Installation Notes\(rq). +.PP +Invoke +\fBmysql_setpermission\fR +like this: +.sp +.RS 3n +.nf +shell> \fBmysql_setpermission [\fR\fB\fIoptions\fR\fR\fB]\fR +.fi +.RE +.PP +\fIoptions\fR +should be either +\fB\-\-help\fR +to display the help message, or options that indicate how to connect to the MySQL server. The account used when you connect determines which permissions you have when attempting to modify existing permissions in the grant tables. +.PP +\fBmysql_setpermissions\fR +also reads options from the +[client] +and +[perl] +groups in the +\fI.my.cnf\fR +file in your home directory, if the file exists. +.PP +\fBmysql_setpermission\fR +understands the following options: +.TP 3n +\(bu +\fB\-\-help\fR +.sp +Display a help message and exit. +.TP 3n +\(bu +\fB\-\-host=\fR\fB\fIhost_name\fR\fR +.sp +Connect to the MySQL server on the given host. +.TP 3n +\(bu +\fB\-\-password=\fR\fB\fIpassword\fR\fR +.sp +The password to use when connecting to the server. Note that the password value is not optional for this option, unlike for other MySQL programs. You can use an option file to avoid giving the password on the command line. +.sp +Specifying a password on the command line should be considered insecure. See +Section\ 5.5.6.2, \(lqEnd\-User Guidelines for Password Security\(rq. +.TP 3n +\(bu +\fB\-\-port=\fR\fB\fIport_num\fR\fR +.sp +The TCP/IP port number to use for the connection. +.TP 3n +\(bu +\fB\-\-socket=\fR\fB\fIpath\fR\fR +.sp +For connections to +localhost, the Unix socket file to use. +.TP 3n +\(bu +\fB\-\-user=\fR\fB\fIuser_name\fR\fR +.sp +The MySQL user name to use when connecting to the server. +.SH "COPYRIGHT" +.PP +Copyright 2007\-2008 MySQL AB, 2009 Sun Microsystems, Inc. +.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/. +.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 +MySQL AB (http://www.mysql.com/). diff --git a/man/mysql_tzinfo_to_sql.1 b/man/mysql_tzinfo_to_sql.1 new file mode 100644 index 00000000000..7652f837ae2 --- /dev/null +++ b/man/mysql_tzinfo_to_sql.1 @@ -0,0 +1,101 @@ +.\" Title: \fBmysql_tzinfo_to_sql\fR +.\" Author: +.\" Generator: DocBook XSL Stylesheets v1.70.1 <http://docbook.sf.net/> +.\" Date: 03/31/2009 +.\" Manual: MySQL Database System +.\" Source: MySQL 5.1 +.\" +.TH "\fBMYSQL_TZINFO_TO_S" "1" "03/31/2009" "MySQL 5.1" "MySQL Database System" +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.SH "NAME" +mysql_tzinfo_to_sql \- load the time zone tables +.SH "SYNOPSIS" +.HP 30 +\fBmysql_tzinfo_to_sql \fR\fB\fIarguments\fR\fR +.SH "DESCRIPTION" +.PP +The +\fBmysql_tzinfo_to_sql\fR +program loads the time zone tables in the +mysql +database. It is used on systems that have a +zoneinfo +database (the set of files describing time zones). Examples of such systems are Linux, FreeBSD, Sun Solaris, and Mac OS X. One likely location for these files is the +\fI/usr/share/zoneinfo\fR +directory (\fI/usr/share/lib/zoneinfo\fR +on Solaris). If your system does not have a zoneinfo database, you can use the downloadable package described in +Section\ 9.7, \(lqMySQL Server Time Zone Support\(rq. +.PP +\fBmysql_tzinfo_to_sql\fR +can be invoked several ways: +.sp +.RS 3n +.nf +shell> \fBmysql_tzinfo_to_sql \fR\fB\fItz_dir\fR\fR +shell> \fBmysql_tzinfo_to_sql \fR\fB\fItz_file tz_name\fR\fR +shell> \fBmysql_tzinfo_to_sql \-\-leap \fR\fB\fItz_file\fR\fR +.fi +.RE +.PP +For the first invocation syntax, pass the zoneinfo directory path name to +\fBmysql_tzinfo_to_sql\fR +and send the output into the +\fBmysql\fR +program. For example: +.sp +.RS 3n +.nf +shell> \fBmysql_tzinfo_to_sql /usr/share/zoneinfo | mysql \-u root mysql\fR +.fi +.RE +.PP +\fBmysql_tzinfo_to_sql\fR +reads your system's time zone files and generates SQL statements from them. +\fBmysql\fR +processes those statements to load the time zone tables. +.PP +The second syntax causes +\fBmysql_tzinfo_to_sql\fR +to load a single time zone file +\fItz_file\fR +that corresponds to a time zone name +\fItz_name\fR: +.sp +.RS 3n +.nf +shell> \fBmysql_tzinfo_to_sql \fR\fB\fItz_file\fR\fR\fB \fR\fB\fItz_name\fR\fR\fB | mysql \-u root mysql\fR +.fi +.RE +.PP +If your time zone needs to account for leap seconds, invoke +\fBmysql_tzinfo_to_sql\fR +using the third syntax, which initializes the leap second information. +\fItz_file\fR +is the name of your time zone file: +.sp +.RS 3n +.nf +shell> \fBmysql_tzinfo_to_sql \-\-leap \fR\fB\fItz_file\fR\fR\fB | mysql \-u root mysql\fR +.fi +.RE +.PP +After running +\fBmysql_tzinfo_to_sql\fR, it is best to restart the server so that it does not continue to use any previously cached time zone data. +.SH "COPYRIGHT" +.PP +Copyright 2007\-2008 MySQL AB, 2009 Sun Microsystems, Inc. +.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/. +.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 +MySQL AB (http://www.mysql.com/). diff --git a/man/mysql_upgrade.1 b/man/mysql_upgrade.1 new file mode 100644 index 00000000000..e729f20096b --- /dev/null +++ b/man/mysql_upgrade.1 @@ -0,0 +1,190 @@ +.\" Title: \fBmysql_upgrade\fR +.\" Author: +.\" Generator: DocBook XSL Stylesheets v1.70.1 <http://docbook.sf.net/> +.\" Date: 03/31/2009 +.\" Manual: MySQL Database System +.\" Source: MySQL 5.1 +.\" +.TH "\fBMYSQL_UPGRADE\fR" "1" "03/31/2009" "MySQL 5.1" "MySQL Database System" +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.SH "NAME" +mysql_upgrade \- check tables for MySQL upgrade +.SH "SYNOPSIS" +.HP 24 +\fBmysql_upgrade [\fR\fB\fIoptions\fR\fR\fB]\fR +.SH "DESCRIPTION" +.PP +\fBmysql_upgrade\fR +should be executed each time you upgrade MySQL. It checks all tables in all databases for incompatibilities with the current version of MySQL Server. If a table is found to have a possible incompatibility, it is checked. If any problems are found, the table is repaired. +\fBmysql_upgrade\fR +also upgrades the system tables so that you can take advantage of new privileges or capabilities that might have been added. +.PP +All checked and repaired tables are marked with the current MySQL version number. This ensures that next time you run +\fBmysql_upgrade\fR +with the same version of the server, it can tell whether there is any need to check or repair the table again. +.PP +\fBmysql_upgrade\fR +also saves the MySQL version number in a file named +\fImysql_upgrade_info\fR +in the data directory. This is used to quickly check if all tables have been checked for this release so that table\-checking can be skipped. To ignore this file, use the +\fB\-\-force\fR +option. +.sp +.it 1 an-trap +.nr an-no-space-flag 1 +.nr an-break-flag 1 +.br +\fBCaution\fR +.PP +Some upgrade incompatibilities may require special handling +\fIbefore\fR +you upgrade your MySQL installation and run +\fBmysql_upgrade\fR. See +Section\ 2.12.1, \(lqUpgrading MySQL\(rq, for instructions on determining whether any such incompatibilities apply to your installation and how to handle them. +.PP +To check and repair tables and to upgrade the system tables, +\fBmysql_upgrade\fR +executes the following commands: +.sp +.RS 3n +.nf +mysqlcheck \-\-check\-upgrade \-\-all\-databases \-\-auto\-repair +mysql_fix_privilege_tables +mysqlcheck \-\-all\-databases \-\-check\-upgrade \-\-fix\-db\-names \-\-fix\-table\-names +.fi +.RE +.sp +.it 1 an-trap +.nr an-no-space-flag 1 +.nr an-break-flag 1 +.br +\fBNote\fR +.PP +Prior to MySQL 5.1.31, +\fBmysql_upgrade\fR +does not run the third command, which is necessary to re\-encode database or table names that contain non\-alphanumeric characters. (They still appear after the upgrade with the +#mysql50# +prefix described in +Section\ 8.2.3, \(lqMapping of Identifiers to File Names\(rq.) If you have such database or table names, execute the third command manually after executing +\fBmysql_upgrade\fR. +.PP +\fBmysql_upgrade\fR +supersedes the older +\fBmysql_fix_privilege_tables\fR +script. In MySQL 5.1.7, +\fBmysql_upgrade \fR +was added as a shell script and worked only for Unix systems. As of MySQL 5.1.10, +\fBmysql_upgrade\fR +is an executable binary and is available on all systems. On systems older than those supporting +\fBmysql_upgrade\fR, you can execute the +\fBmysqlcheck\fR +command manually, and then upgrade your system tables as described in +\fBmysql_fix_privilege_tables\fR(1). +.PP +If you install MySQL from RPM packages on Linux, you must install the server and client RPMs. +\fBmysql_upgrade\fR +is included in the server RPM but requires the client RPM because the latter includes +\fBmysqlcheck\fR. (See +Section\ 2.4, \(lqInstalling MySQL from RPM Packages on Linux\(rq.) +.PP +For details about what is checked, see the description of the +FOR UPGRADE +option of the +CHECK TABLE +statement (see +Section\ 12.5.2.3, \(lqCHECK TABLE Syntax\(rq). +.PP +To use +\fBmysql_upgrade\fR, make sure that the server is running, and then invoke it like this: +.sp +.RS 3n +.nf +shell> \fBmysql_upgrade [\fR\fB\fIoptions\fR\fR\fB]\fR +.fi +.RE +.PP +After running +\fBmysql_upgrade\fR, stop the server and restart it so that it uses any changes that were made to the system tables. +.PP +\fBmysql_upgrade\fR +reads options from the command line and from the +[mysql_upgrade] +group in option files. It supports the options in the following list. Other options are passed to +\fBmysqlcheck\fR +and to +\fBmysql_fix_privilege_tables\fR. For example, it might be necessary to specify the +\fB\-\-password[=\fR\fB\fIpassword\fR\fR\fB]\fR +option. +.TP 3n +\(bu +\fB\-\-help\fR +.sp +Display a short help message and exit. +.TP 3n +\(bu +\fB\-\-basedir=\fR\fB\fIpath\fR\fR +.sp +The path to the MySQL installation directory. +.TP 3n +\(bu +\fB\-\-datadir=\fR\fB\fIpath\fR\fR +.sp +The path to the data directory. +.TP 3n +\(bu +\fB\-\-debug\-check\fR +.sp +Print some debugging information when the program exits. This option was added in MySQL 5.1.21. +.TP 3n +\(bu +\fB\-\-debug\-info\fR, +\fB\-T\fR +.sp +Print debugging information and memory and CPU usage statistics when the program exits. This option was added in MySQL 5.1.21. +.TP 3n +\(bu +\fB\-\-force\fR +.sp +Force execution of +\fBmysqlcheck\fR +even if +\fBmysql_upgrade\fR +has already been executed for the current version of MySQL. (In other words, this option causes the +\fImysql_upgrade_info\fR +file to be ignored.) +.TP 3n +\(bu +\fB\-\-tmpdir=\fR\fB\fIpath\fR\fR, +\fB\-t \fR\fB\fIpath\fR\fR +.sp +The path name of the directory to use for creating temporary files. This option was added in MySQL 5.1.25. +.TP 3n +\(bu +\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. The default user name is +root. +.TP 3n +\(bu +\fB\-\-verbose\fR +.sp +Verbose mode. Print more information about what the program does. +.SH "COPYRIGHT" +.PP +Copyright 2007\-2008 MySQL AB, 2009 Sun Microsystems, Inc. +.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/. +.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 +MySQL AB (http://www.mysql.com/). diff --git a/man/mysql_waitpid.1 b/man/mysql_waitpid.1 new file mode 100644 index 00000000000..1dc2b8844f1 --- /dev/null +++ b/man/mysql_waitpid.1 @@ -0,0 +1,91 @@ +.\" Title: \fBmysql_waitpid\fR +.\" Author: +.\" Generator: DocBook XSL Stylesheets v1.70.1 <http://docbook.sf.net/> +.\" Date: 03/31/2009 +.\" Manual: MySQL Database System +.\" Source: MySQL 5.1 +.\" +.TH "\fBMYSQL_WAITPID\fR" "1" "03/31/2009" "MySQL 5.1" "MySQL Database System" +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.SH "NAME" +mysql_waitpid \- kill process and wait for its termination +.SH "SYNOPSIS" +.HP 38 +\fBmysql_waitpid [\fR\fB\fIoptions\fR\fR\fB] \fR\fB\fIpid\fR\fR\fB \fR\fB\fIwait_time\fR\fR +.SH "DESCRIPTION" +.PP +\fBmysql_waitpid\fR +signals a process to terminate and waits for the process to exit. It uses the +kill() +system call and Unix signals, so it runs on Unix and Unix\-like systems. +.PP +Invoke +\fBmysql_waitpid\fR +like this: +.sp +.RS 3n +.nf +shell> \fBmysql_waitpid [\fR\fB\fIoptions\fR\fR\fB] \fR\fB\fIpid\fR\fR\fB \fR\fB\fIwait_time\fR\fR +.fi +.RE +.PP +\fBmysql_waitpid\fR +sends signal 0 to the process identified by +\fIpid\fR +and waits up to +\fIwait_time\fR +seconds for the process to terminate. +\fIpid\fR +and +\fIwait_time\fR +must be positive integers. +.PP +If process termination occurs within the wait time or the process does not exist, +\fBmysql_waitpid\fR +returns 0. Otherwise, it returns 1. +.PP +If the +kill() +system call cannot handle signal 0, +\fBmysql_waitpid()\fR +uses signal 1 instead. +.PP +\fBmysql_waitpid\fR +understands the following options: +.TP 3n +\(bu +\fB\-\-help\fR, +\fB\-?\fR, +\fB\-I\fR +.sp +Display a help message and exit. +.TP 3n +\(bu +\fB\-\-verbose\fR, +\fB\-v\fR +.sp +Verbose mode. Display a warning if signal 0 could not be used and signal 1 is used instead. +.TP 3n +\(bu +\fB\-\-version\fR, +\fB\-V\fR +.sp +Display version information and exit. +.SH "COPYRIGHT" +.PP +Copyright 2007\-2008 MySQL AB, 2009 Sun Microsystems, Inc. +.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/. +.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 +MySQL AB (http://www.mysql.com/). diff --git a/man/mysql_zap.1 b/man/mysql_zap.1 new file mode 100644 index 00000000000..0af61e9b2c3 --- /dev/null +++ b/man/mysql_zap.1 @@ -0,0 +1,93 @@ +.\" Title: \fBmysql_zap\fR +.\" Author: +.\" Generator: DocBook XSL Stylesheets v1.70.1 <http://docbook.sf.net/> +.\" Date: 03/31/2009 +.\" Manual: MySQL Database System +.\" Source: MySQL 5.1 +.\" +.TH "\fBMYSQL_ZAP\fR" "1" "03/31/2009" "MySQL 5.1" "MySQL Database System" +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.SH "NAME" +mysql_zap \- kill processes that match a pattern +.SH "SYNOPSIS" +.HP 36 +\fBmysql_zap [\-\fR\fB\fIsignal\fR\fR\fB] [\-?Ift] \fR\fB\fIpattern\fR\fR +.SH "DESCRIPTION" +.PP +\fBmysql_zap\fR +kills processes that match a pattern. It uses the +\fBps\fR +command and Unix signals, so it runs on Unix and Unix\-like systems. +.PP +Invoke +\fBmysql_zap\fR +like this: +.sp +.RS 3n +.nf +shell> \fBmysql_zap [\-\fR\fB\fIsignal\fR\fR\fB] [\-?Ift] \fR\fB\fIpattern\fR\fR +.fi +.RE +.PP +A process matches if its output line from the +\fBps\fR +command contains the pattern. By default, +\fBmysql_zap\fR +asks for confirmation for each process. Respond +y +to kill the process, or +q +to exit +\fBmysql_zap\fR. For any other response, +\fBmysql_zap\fR +does not attempt to kill the process. +.PP +If the +\fB\-\fR\fB\fIsignal\fR\fR +option is given, it specifies the name or number of the signal to send to each process. Otherwise, +\fBmysql_zap\fR +tries first with +TERM +(signal 15) and then with +KILL +(signal 9). +.PP +\fBmysql_zap\fR +understands the following additional options: +.TP 3n +\(bu +\fB\-\-help\fR, +\fB\-?\fR, +\fB\-I\fR +.sp +Display a help message and exit. +.TP 3n +\(bu +\fB\-f\fR +.sp +Force mode. +\fBmysql_zap\fR +attempts to kill each process without confirmation. +.TP 3n +\(bu +\fB\-t\fR +.sp +Test mode. Display information about each process but do not kill it. +.SH "COPYRIGHT" +.PP +Copyright 2007\-2008 MySQL AB, 2009 Sun Microsystems, Inc. +.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/. +.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 +MySQL AB (http://www.mysql.com/). diff --git a/man/mysqlaccess.1 b/man/mysqlaccess.1 new file mode 100644 index 00000000000..deae3d7ec7b --- /dev/null +++ b/man/mysqlaccess.1 @@ -0,0 +1,218 @@ +.\" Title: \fBmysqlaccess\fR +.\" Author: +.\" Generator: DocBook XSL Stylesheets v1.70.1 <http://docbook.sf.net/> +.\" Date: 03/31/2009 +.\" Manual: MySQL Database System +.\" Source: MySQL 5.1 +.\" +.TH "\fBMYSQLACCESS\fR" "1" "03/31/2009" "MySQL 5.1" "MySQL Database System" +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.SH "NAME" +mysqlaccess \- client for checking access privileges +.SH "SYNOPSIS" +.HP 56 +\fBmysqlaccess [\fR\fB\fIhost_name\fR\fR\fB [\fR\fB\fIuser_name\fR\fR\fB [\fR\fB\fIdb_name\fR\fR\fB]]] [\fR\fB\fIoptions\fR\fR\fB]\fR +.SH "DESCRIPTION" +.PP +\fBmysqlaccess\fR +is a diagnostic tool that Yves Carlier has provided for the MySQL distribution. It checks the access privileges for a host name, user name, and database combination. Note that +\fBmysqlaccess\fR +checks access using only the +user, +db, and +host +tables. It does not check table, column, or routine privileges specified in the +tables_priv, +columns_priv, or +procs_priv +tables. +.PP +Invoke +\fBmysqlaccess\fR +like this: +.sp +.RS 3n +.nf +shell> \fBmysqlaccess [\fR\fB\fIhost_name\fR\fR\fB [\fR\fB\fIuser_name\fR\fR\fB [\fR\fB\fIdb_name\fR\fR\fB]]] [\fR\fB\fIoptions\fR\fR\fB]\fR +.fi +.RE +.PP +\fBmysqlaccess\fR +understands the following options: +.TP 3n +\(bu +\fB\-\-help\fR, +\fB\-?\fR +.sp +Display a help message and exit. +.TP 3n +\(bu +\fB\-\-brief\fR, +\fB\-b\fR +.sp +Generate reports in single\-line tabular format. +.TP 3n +\(bu +\fB\-\-commit\fR +.sp +Copy the new access privileges from the temporary tables to the original grant tables. The grant tables must be flushed for the new privileges to take effect. (For example, execute a +\fBmysqladmin reload\fR +command.) +.TP 3n +\(bu +\fB\-\-copy\fR +.sp +Reload the temporary grant tables from original ones. +.TP 3n +\(bu +\fB\-\-db=\fR\fB\fIdb_name\fR\fR, +\fB\-d \fR\fB\fIdb_name\fR\fR +.sp +Specify the database name. +.TP 3n +\(bu +\fB\-\-debug=\fR\fB\fIN\fR\fR +.sp +Specify the debug level. +\fIN\fR +can be an integer from 0 to 3. +.TP 3n +\(bu +\fB\-\-host=\fR\fB\fIhost_name\fR\fR, +\fB\-h \fR\fB\fIhost_name\fR\fR +.sp +The host name to use in the access privileges. +.TP 3n +\(bu +\fB\-\-howto\fR +.sp +Display some examples that show how to use +\fBmysqlaccess\fR. +.TP 3n +\(bu +\fB\-\-old_server\fR +.sp +Assume that the server is an old MySQL server (before MySQL 3.21) that does not yet know how to handle full +WHERE +clauses. +.TP 3n +\(bu +\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 omit the +\fIpassword\fR +value following the +\fB\-\-password\fR +or +\fB\-p\fR +option on the command line, you are prompted for one. +.sp +Specifying a password on the command line should be considered insecure. See +Section\ 5.5.6.2, \(lqEnd\-User Guidelines for Password Security\(rq. +.TP 3n +\(bu +\fB\-\-plan\fR +.sp +Display suggestions and ideas for future releases. +.TP 3n +\(bu +\fB\-\-preview\fR +.sp +Show the privilege differences after making changes to the temporary grant tables. +.TP 3n +\(bu +\fB\-\-relnotes\fR +.sp +Display the release notes. +.TP 3n +\(bu +\fB\-\-rhost=\fR\fB\fIhost_name\fR\fR, +\fB\-H \fR\fB\fIhost_name\fR\fR +.sp +Connect to the MySQL server on the given host. +.TP 3n +\(bu +\fB\-\-rollback\fR +.sp +Undo the most recent changes to the temporary grant tables. +.TP 3n +\(bu +\fB\-\-spassword[=\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 as the superuser. If you omit the +\fIpassword\fR +value following the +\fB\-\-password\fR +or +\fB\-p\fR +option on the command line, you are prompted for one. +.sp +Specifying a password on the command line should be considered insecure. See +Section\ 5.5.6.2, \(lqEnd\-User Guidelines for Password Security\(rq. +.TP 3n +\(bu +\fB\-\-superuser=\fR\fB\fIuser_name\fR\fR, +\fB\-U \fR\fB\fIuser_name\fR\fR +.sp +Specify the user name for connecting as the superuser. +.TP 3n +\(bu +\fB\-\-table\fR, +\fB\-t\fR +.sp +Generate reports in table format. +.TP 3n +\(bu +\fB\-\-user=\fR\fB\fIuser_name\fR\fR, +\fB\-u \fR\fB\fIuser_name\fR\fR +.sp +The user name to use in the access privileges. +.TP 3n +\(bu +\fB\-\-version\fR, +\fB\-v\fR +.sp +Display version information and exit. +.sp +.RE +.PP +If your MySQL distribution is installed in some non\-standard location, you must change the location where +\fBmysqlaccess\fR +expects to find the +\fBmysql\fR +client. Edit the +\fImysqlaccess\fR +script at approximately line 18. Search for a line that looks like this: +.sp +.RS 3n +.nf +$MYSQL = '/usr/local/bin/mysql'; # path to mysql executable +.fi +.RE +.PP +Change the path to reflect the location where +\fBmysql\fR +actually is stored on your system. If you do not do this, a +Broken pipe +error will occur when you run +\fBmysqlaccess\fR. +.SH "COPYRIGHT" +.PP +Copyright 2007\-2008 MySQL AB, 2009 Sun Microsystems, Inc. +.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/. +.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 +MySQL AB (http://www.mysql.com/). diff --git a/man/mysqladmin.1 b/man/mysqladmin.1 new file mode 100644 index 00000000000..aae118414eb --- /dev/null +++ b/man/mysqladmin.1 @@ -0,0 +1,510 @@ +.\" Title: \fBmysqladmin\fR +.\" Author: +.\" Generator: DocBook XSL Stylesheets v1.70.1 <http://docbook.sf.net/> +.\" Date: 03/31/2009 +.\" Manual: MySQL Database System +.\" Source: MySQL 5.1 +.\" +.TH "\fBMYSQLADMIN\fR" "1" "03/31/2009" "MySQL 5.1" "MySQL Database System" +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.SH "NAME" +mysqladmin \- client for administering a MySQL server +.SH "SYNOPSIS" +.HP 79 +\fBmysqladmin [\fR\fB\fIoptions\fR\fR\fB] \fR\fB\fIcommand\fR\fR\fB [\fR\fB\fIcommand\-options\fR\fR\fB] [\fR\fB\fIcommand\fR\fR\fB [\fR\fB\fIcommand\-options\fR\fR\fB]] ...\fR +.SH "DESCRIPTION" +.PP +\fBmysqladmin\fR +is a client for performing administrative operations. You can use it to check the server's configuration and current status, to create and drop databases, and more. +.PP +Invoke +\fBmysqladmin\fR +like this: +.sp +.RS 3n +.nf +shell> \fBmysqladmin [\fR\fB\fIoptions\fR\fR\fB] \fR\fB\fIcommand\fR\fR\fB [\fR\fB\fIcommand\-arg\fR\fR\fB] [\fR\fB\fIcommand\fR\fR\fB [\fR\fB\fIcommand\-arg\fR\fR\fB]] ...\fR +.fi +.RE +.PP +\fBmysqladmin\fR +supports the commands described in the following list. Some of the commands take an argument following the command name. +.TP 3n +\(bu +create \fIdb_name\fR +.sp +Create a new database named +\fIdb_name\fR. +.TP 3n +\(bu +debug +.sp +Tell the server to write debug information to the error log. +.sp +Beginning with MySQL 5.1.12, this includes information about the Event Scheduler. See +Section\ 19.4.5, \(lqEvent Scheduler Status\(rq. +.TP 3n +\(bu +drop \fIdb_name\fR +.sp +Delete the database named +\fIdb_name\fR +and all its tables. +.TP 3n +\(bu +extended\-status +.sp +Display the server status variables and their values. +.TP 3n +\(bu +flush\-hosts +.sp +Flush all information in the host cache. +.TP 3n +\(bu +flush\-logs +.sp +Flush all logs. +.TP 3n +\(bu +flush\-privileges +.sp +Reload the grant tables (same as +reload). +.TP 3n +\(bu +flush\-status +.sp +Clear status variables. +.TP 3n +\(bu +flush\-tables +.sp +Flush all tables. +.TP 3n +\(bu +flush\-threads +.sp +Flush the thread cache. +.TP 3n +\(bu +kill \fIid\fR,\fIid\fR,... +.sp +Kill server threads. If multiple thread ID values are given, there must be no spaces in the list. +.TP 3n +\(bu +old\-password \fInew\-password\fR +.sp +This is like the +password +command but stores the password using the old (pre\-4.1) password\-hashing format. (See +Section\ 5.5.6.3, \(lqPassword Hashing in MySQL\(rq.) +.TP 3n +\(bu +password \fInew\-password\fR +.sp +Set a new password. This changes the password to +\fInew\-password\fR +for the account that you use with +\fBmysqladmin\fR +for connecting to the server. Thus, the next time you invoke +\fBmysqladmin\fR +(or any other client program) using the same account, you will need to specify the new password. +.sp +If the +\fInew\-password\fR +value contains spaces or other characters that are special to your command interpreter, you need to enclose it within quotes. On Windows, be sure to use double quotes rather than single quotes; single quotes are not stripped from the password, but rather are interpreted as part of the password. For example: +.sp +.RS 3n +.nf +shell> \fBmysqladmin password "my new password"\fR +.fi +.RE +.sp +.it 1 an-trap +.nr an-no-space-flag 1 +.nr an-break-flag 1 +.br +\fBCaution\fR +Do not use this command used if the server was started with the +\fB\-\-skip\-grant\-tables\fR +option. No password change will be applied. This is true even if you precede the +password +command with +flush\-privileges +on the same command line to re\-enable the grant tables because the flush operation occurs after you connect. However, you can use +\fBmysqladmin flush\-privileges\fR +to re\-enable the grant table and then use a separate +\fBmysqladmin password\fR +command to change the password. +.TP 3n +\(bu +ping +.sp +Check whether the server is alive. The return status from +\fBmysqladmin\fR +is 0 if the server is running, 1 if it is not. This is 0 even in case of an error such as +Access denied, because this means that the server is running but refused the connection, which is different from the server not running. +.TP 3n +\(bu +processlist +.sp +Show a list of active server threads. This is like the output of the +SHOW PROCESSLIST +statement. If the +\fB\-\-verbose\fR +option is given, the output is like that of +SHOW FULL PROCESSLIST. (See +Section\ 12.5.5.31, \(lqSHOW PROCESSLIST Syntax\(rq.) +.TP 3n +\(bu +reload +.sp +Reload the grant tables. +.TP 3n +\(bu +refresh +.sp +Flush all tables and close and open log files. +.TP 3n +\(bu +shutdown +.sp +Stop the server. +.TP 3n +\(bu +start\-slave +.sp +Start replication on a slave server. +.TP 3n +\(bu +status +.sp +Display a short server status message. +.TP 3n +\(bu +stop\-slave +.sp +Stop replication on a slave server. +.TP 3n +\(bu +variables +.sp +Display the server system variables and their values. +.TP 3n +\(bu +version +.sp +Display version information from the server. +.sp +.RE +.PP +All commands can be shortened to any unique prefix. For example: +.sp +.RS 3n +.nf +shell> \fBmysqladmin proc stat\fR ++\-\-\-\-+\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-\-\-+\-\-\-\-+\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-+\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+ +| Id | User | Host | db | Command | Time | State | Info | ++\-\-\-\-+\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-\-\-+\-\-\-\-+\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-+\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+ +| 51 | monty | localhost | | Query | 0 | | show processlist | ++\-\-\-\-+\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-\-\-+\-\-\-\-+\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-+\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+ +Uptime: 1473624 Threads: 1 Questions: 39487 +Slow queries: 0 Opens: 541 Flush tables: 1 +Open tables: 19 Queries per second avg: 0.0268 +.fi +.RE +.PP +The +\fBmysqladmin status\fR +command result displays the following values: +.TP 3n +\(bu +Uptime +.sp +The number of seconds the MySQL server has been running. +.TP 3n +\(bu +Threads +.sp +The number of active threads (clients). +.TP 3n +\(bu +Questions +.sp +The number of questions (queries) from clients since the server was started. +.TP 3n +\(bu +Slow queries +.sp +The number of queries that have taken more than +long_query_time +seconds. See +Section\ 5.2.5, \(lqThe Slow Query Log\(rq. +.TP 3n +\(bu +Opens +.sp +The number of tables the server has opened. +.TP 3n +\(bu +Flush tables +.sp +The number of +flush\-*, +refresh, and +reload +commands the server has executed. +.TP 3n +\(bu +Open tables +.sp +The number of tables that currently are open. +.TP 3n +\(bu +Memory in use +.sp +The amount of memory allocated directly by +\fBmysqld\fR. This value is displayed only when MySQL has been compiled with +\fB\-\-with\-debug=full\fR. +.TP 3n +\(bu +Maximum memory used +.sp +The maximum amount of memory allocated directly by +\fBmysqld\fR. This value is displayed only when MySQL has been compiled with +\fB\-\-with\-debug=full\fR. +.sp +.RE +.PP +If you execute +\fBmysqladmin shutdown\fR +when connecting to a local server using a Unix socket file, +\fBmysqladmin\fR +waits until the server's process ID file has been removed, to ensure that the server has stopped properly. +.PP +\fBmysqladmin\fR +supports the following options: +.TP 3n +\(bu +\fB\-\-help\fR, +\fB\-?\fR +.sp +Display a help message and exit. +.TP 3n +\(bu +\fB\-\-character\-sets\-dir=\fR\fB\fIpath\fR\fR +.sp +The directory where character sets are installed. See +Section\ 9.2, \(lqThe Character Set Used for Data and Sorting\(rq. +.TP 3n +\(bu +\fB\-\-compress\fR, +\fB\-C\fR +.sp +Compress all information sent between the client and the server if both support compression. +.TP 3n +\(bu +\fB\-\-count=\fR\fB\fIN\fR\fR, +\fB\-c \fR\fB\fIN\fR\fR +.sp +The number of iterations to make for repeated command execution if the +\fB\-\-sleep\fR +option is given. +.TP 3n +\(bu +\fB\-\-debug[=\fR\fB\fIdebug_options\fR\fR\fB]\fR, +\fB\-# [\fR\fB\fIdebug_options\fR\fR\fB]\fR +.sp +Write a debugging log. The +\fIdebug_options\fR +string often is +\'d:t:o,\fIfile_name\fR'. The default is +\'d:t:o,/tmp/mysqladmin.trace'. +.TP 3n +\(bu +\fB\-\-debug\-check\fR +.sp +Print some debugging information when the program exits. This option was added in MySQL 5.1.21. +.TP 3n +\(bu +\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. +.TP 3n +\(bu +\fB\-\-default\-character\-set=\fR\fB\fIcharset_name\fR\fR +.sp +Use +\fIcharset_name\fR +as the default character set. See +Section\ 9.2, \(lqThe Character Set Used for Data and Sorting\(rq. +.TP 3n +\(bu +\fB\-\-force\fR, +\fB\-f\fR +.sp +Do not ask for confirmation for the +drop \fIdb_name\fR +command. With multiple commands, continue even if an error occurs. +.TP 3n +\(bu +\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. +.TP 3n +\(bu +\fB\-\-no\-beep\fR, +\fB\-b\fR +.sp +Suppress the warning beep that is emitted by default for errors such as a failure to connect to the server. This option was added in MySQL 5.1.17. +.TP 3n +\(bu +\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, you are prompted for one. +.sp +Specifying a password on the command line should be considered insecure. See +Section\ 5.5.6.2, \(lqEnd\-User Guidelines for Password Security\(rq. +.TP 3n +\(bu +\fB\-\-pipe\fR, +\fB\-W\fR +.sp +On Windows, connect to the server via a named pipe. This option applies only for connections to a local server, and only if the server supports named\-pipe connections. +.TP 3n +\(bu +\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. +.TP 3n +\(bu +\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 allowable values, see +Section\ 4.2.2, \(lqConnecting to the MySQL Server\(rq. +.TP 3n +\(bu +\fB\-\-relative\fR, +\fB\-r\fR +.sp +Show the difference between the current and previous values when used with the +\fB\-\-sleep\fR +option. Currently, this option works only with the +extended\-status +command. +.TP 3n +\(bu +\fB\-\-silent\fR, +\fB\-s\fR +.sp +Exit silently if a connection to the server cannot be established. +.TP 3n +\(bu +\fB\-\-sleep=\fR\fB\fIdelay\fR\fR, +\fB\-i \fR\fB\fIdelay\fR\fR +.sp +Execute commands repeatedly, sleeping for +\fIdelay\fR +seconds in between. The +\fB\-\-count\fR +option determines the number of iterations. If +\fB\-\-count\fR +is not given, +\fBmysqladmin\fR +executes commands indefinitely until interrupted. +.TP 3n +\(bu +\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. +.TP 3n +\(bu +\fB\-\-ssl*\fR +.sp +Options that begin with +\fB\-\-ssl\fR +specify whether to connect to the server via SSL and indicate where to find SSL keys and certificates. See +Section\ 5.5.7.3, \(lqSSL Command Options\(rq. +.TP 3n +\(bu +\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. +.TP 3n +\(bu +\fB\-\-verbose\fR, +\fB\-v\fR +.sp +Verbose mode. Print more information about what the program does. +.TP 3n +\(bu +\fB\-\-version\fR, +\fB\-V\fR +.sp +Display version information and exit. +.TP 3n +\(bu +\fB\-\-vertical\fR, +\fB\-E\fR +.sp +Print output vertically. This is similar to +\fB\-\-relative\fR, but prints output vertically. +.TP 3n +\(bu +\fB\-\-wait[=\fR\fB\fIcount\fR\fR\fB]\fR, +\fB\-w[\fR\fB\fIcount\fR\fR\fB]\fR +.sp +If the connection cannot be established, wait and retry instead of aborting. If a +\fIcount\fR +value is given, it indicates the number of times to retry. The default is one time. +.sp +.RE +.PP +You can also set the following variables by using +\fB\-\-\fR\fB\fIvar_name\fR\fR\fB=\fR\fB\fIvalue\fR\fR +The +\fB\-\-set\-variable\fR +format is deprecated. syntax: +.TP 3n +\(bu +connect_timeout +.sp +The maximum number of seconds before connection timeout. The default value is 43200 (12 hours). +.TP 3n +\(bu +shutdown_timeout +.sp +The maximum number of seconds to wait for server shutdown. The default value is 3600 (1 hour). +.SH "COPYRIGHT" +.PP +Copyright 2007\-2008 MySQL AB, 2009 Sun Microsystems, Inc. +.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/. +.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 +MySQL AB (http://www.mysql.com/). diff --git a/man/mysqlbinlog.1 b/man/mysqlbinlog.1 new file mode 100644 index 00000000000..d9f879cdab6 --- /dev/null +++ b/man/mysqlbinlog.1 @@ -0,0 +1,1230 @@ +.\" Title: \fBmysqlbinlog\fR +.\" Author: +.\" Generator: DocBook XSL Stylesheets v1.70.1 <http://docbook.sf.net/> +.\" Date: 03/31/2009 +.\" Manual: MySQL Database System +.\" Source: MySQL 5.1 +.\" +.TH "\fBMYSQLBINLOG\fR" "1" "03/31/2009" "MySQL 5.1" "MySQL Database System" +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.SH "NAME" +mysqlbinlog \- utility for processing binary log files +.SH "SYNOPSIS" +.HP 35 +\fBmysqlbinlog [\fR\fBoptions\fR\fB] \fR\fB\fIlog_file\fR\fR\fB ...\fR +.SH "DESCRIPTION" +.PP +The server's binary log consists of files containing +\(lqevents\(rq +that describe modifications to database contents. The server writes these files in binary format. To display their contents in text format, use the +\fBmysqlbinlog\fR +utility. You can also use +\fBmysqlbinlog\fR +to display the contents of relay log files written by a slave server in a replication setup because relay logs have the same format as binary logs. The binary log and relay log are discussed further in +Section\ 5.2.4, \(lqThe Binary Log\(rq, and +Section\ 16.4.2, \(lqReplication Relay and Status Files\(rq. +.PP +Invoke +\fBmysqlbinlog\fR +like this: +.sp +.RS 3n +.nf +shell> \fBmysqlbinlog [\fR\fB\fIoptions\fR\fR\fB] \fR\fB\fIlog_file\fR\fR\fB ...\fR +.fi +.RE +.PP +For example, to display the contents of the binary log file named +\fIbinlog.000003\fR, use this command: +.sp +.RS 3n +.nf +shell> \fBmysqlbinlog binlog.0000003\fR +.fi +.RE +.PP +The output includes events contained in +\fIbinlog.000003\fR. Event information includes the statement, the ID of the server on which it was executed, the timestamp when the statement was executed, how much time it took, and so forth. +.PP +The output from +\fBmysqlbinlog\fR +can be re\-executed (for example, by using it as input to +\fBmysql\fR) to reapply the statements in the log. This is useful for recovery operations after a server crash. For other usage examples, see the discussion later in this section. +.PP +Normally, you use +\fBmysqlbinlog\fR +to read binary log files directly and apply them to the local MySQL server. It is also possible to read binary logs from a remote server by using the +\fB\-\-read\-from\-remote\-server\fR +option. When you read remote binary logs, the connection parameter options can be given to indicate how to connect to the server. These options are +\fB\-\-host\fR, +\fB\-\-password\fR, +\fB\-\-port\fR, +\fB\-\-protocol\fR, +\fB\-\-socket\fR, and +\fB\-\-user\fR; they are ignored except when you also use the +\fB\-\-read\-from\-remote\-server\fR +option. +.PP +\fBmysqlbinlog\fR +supports the following options: +.TP 3n +\(bu +\fB\-\-help\fR, +\fB\-?\fR +.sp +Display a help message and exit. +.TP 3n +\(bu +\fB\-\-base64\-output[=\fR\fB\fIvalue\fR\fR\fB]\fR +.sp +This option determines when events should be displayed encoded as base\-64 strings using +BINLOG +statements. The option has these allowable values (not case sensitive): +.RS 3n +.TP 3n +\(bu +AUTO +("automatic") or +UNSPEC +("unspecified") displays +BINLOG +statements automatically when necessary (that is, for format description events and row events). This is the default if no +\fB\-\-base64\-output\fR +option is given. +.sp +.it 1 an-trap +.nr an-no-space-flag 1 +.nr an-break-flag 1 +.br +\fBNote\fR +Automatic +BINLOG +display is the only safe behavior if you intend to use the output of +\fBmysqlbinlog\fR +to re\-execute binary log file contents. The other option values are intended only for debugging or testing purposes because they may produce output that does not include all events in executable form. +.TP 3n +\(bu +ALWAYS +displays +BINLOG +statements whenever possible. This is the implied value if the option is given as +\fB\-\-base64\-output\fR +without a value. +.TP 3n +\(bu +NEVER +causes +BINLOG +statements not to be displayed. +\fBmysqlbinlog\fR +exits with an error if a row event is found that must be displayed using +BINLOG. +.TP 3n +\(bu +DECODE\-ROWS +specifies to +\fBmysqlbinlog\fR +that you intend for row events to be decoded and displayed as commented SQL statements by also specifying the +\fB\-\-verbose\fR +option. Like +NEVER, +DECODE\-ROWS +suppresses display of +BINLOG +statements, but unlike +NEVER, it does not exit with an error if a row event is found. +.RE +.IP "" 3n +The +\fB\-\-base64\-output\fR +option was introduced in MySQL 5.1.5, to be given as +\fB\-\-base64\-output\fR +or +\fB\-\-skip\-base64\-output\fR +(with the sense of +AUTO +or +NEVER). The option values described in the preceding list may be used as of MySQL 5.1.24, with the exception of +UNSPEC +and +DECODE\-ROWS, which are available as of MySQL 5.1.28. +.sp +For examples that show the effect of +\fB\-\-base64\-output\fR +and +\fB\-\-verbose\fR +on row event output, see +the section called \(lq\fBMYSQLBINLOG\fR ROW EVENT DISPLAY\(rq. +.TP 3n +\(bu +\fB\-\-character\-sets\-dir=\fR\fB\fIpath\fR\fR +.sp +The directory where character sets are installed. See +Section\ 9.2, \(lqThe Character Set Used for Data and Sorting\(rq. +.TP 3n +\(bu +\fB\-\-database=\fR\fB\fIdb_name\fR\fR, +\fB\-d \fR\fB\fIdb_name\fR\fR +.sp +List entries for just this database (local log only). You can only specify one database with this option \- if you specify multiple +\fB\-\-database\fR +options, only the last one is used. This option forces +\fBmysqlbinlog\fR +to output entries from the binary log where the default database (that is, the one selected by +USE) is +\fIdb_name\fR. Note that this does not replicate cross\-database statements such as +UPDATE \fIsome_db.some_table\fR SET foo='bar' +while having selected a different database or no database. +.TP 3n +\(bu +\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 often +\'d:t:o,\fIfile_name\fR'. +.TP 3n +\(bu +\fB\-\-debug\-check\fR +.sp +Print some debugging information when the program exits. This option was added in MySQL 5.1.21. +.TP 3n +\(bu +\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.21. +.TP 3n +\(bu +\fB\-\-disable\-log\-bin\fR, +\fB\-D\fR +.sp +Disable binary logging. This is useful for avoiding an endless loop if you use the +\fB\-\-to\-last\-log\fR +option and are sending the output to the same MySQL server. This option also is useful when restoring after a crash to avoid duplication of the statements you have logged. +.sp +This option requires that you have the +SUPER +privilege. It causes +\fBmysqlbinlog\fR +to include a +SET sql_log_bin = 0 +statement in its output to disable binary logging of the remaining output. The +SET +statement is ineffective unless you have the +SUPER +privilege. +.TP 3n +\(bu +\fB\-\-force\-read\fR, +\fB\-f\fR +.sp +With this option, if +\fBmysqlbinlog\fR +reads a binary log event that it does not recognize, it prints a warning, ignores the event, and continues. Without this option, +\fBmysqlbinlog\fR +stops if it reads such an event. +.TP 3n +\(bu +\fB\-\-hexdump\fR, +\fB\-H\fR +.sp +Display a hex dump of the log in comments, as described in +the section called \(lq\fBMYSQLBINLOG\fR HEX DUMP FORMAT\(rq. This output can be helpful for replication debugging. This option was added in MySQL 5.1.2. +.TP 3n +\(bu +\fB\-\-host=\fR\fB\fIhost_name\fR\fR, +\fB\-h \fR\fB\fIhost_name\fR\fR +.sp +Get the binary log from the MySQL server on the given host. +.TP 3n +\(bu +\fB\-\-local\-load=\fR\fB\fIpath\fR\fR, +\fB\-l \fR\fB\fIpath\fR\fR +.sp +Prepare local temporary files for +LOAD DATA INFILE +in the specified directory. +.TP 3n +\(bu +\fB\-\-offset=\fR\fB\fIN\fR\fR, +\fB\-o \fR\fB\fIN\fR\fR +.sp +Skip the first +\fIN\fR +entries in the log. +.TP 3n +\(bu +\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, you are prompted for one. +.sp +Specifying a password on the command line should be considered insecure. See +Section\ 5.5.6.2, \(lqEnd\-User Guidelines for Password Security\(rq. +.TP 3n +\(bu +\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 connecting to a remote server. +.TP 3n +\(bu +\fB\-\-position=\fR\fB\fIN\fR\fR, +\fB\-j \fR\fB\fIN\fR\fR +.sp +Deprecated. Use +\fB\-\-start\-position\fR +instead. +.TP 3n +\(bu +\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 allowable values, see +Section\ 4.2.2, \(lqConnecting to the MySQL Server\(rq. +.TP 3n +\(bu +\fB\-\-read\-from\-remote\-server\fR, +\fB\-R\fR +.sp +Read the binary log from a MySQL server rather than reading a local log file. Any connection parameter options are ignored unless this option is given as well. These options are +\fB\-\-host\fR, +\fB\-\-password\fR, +\fB\-\-port\fR, +\fB\-\-protocol\fR, +\fB\-\-socket\fR, and +\fB\-\-user\fR. +.sp +This option requires that the remote server be running. It works only for binary log files on the remote server, not relay log files. +.TP 3n +\(bu +\fB\-\-result\-file=\fR\fB\fIname\fR\fR, +\fB\-r \fR\fB\fIname\fR\fR +.sp +Direct output to the given file. +.TP 3n +\(bu +\fB\-\-server\-id=\fR\fB\fIid\fR\fR +.sp +Extract only those events created by the server having the given server ID. This option is available as of MySQL 5.1.4. +.TP 3n +\(bu +\fB\-\-set\-charset=\fR\fB\fIcharset_name\fR\fR +.sp +Add a +SET NAMES \fIcharset_name\fR +statement to the output to specify the character set to be used for processing log files. This option was added in MySQL 5.1.12. +.TP 3n +\(bu +\fB\-\-short\-form\fR, +\fB\-s\fR +.sp +Display only the statements contained in the log, without any extra information. +.TP 3n +\(bu +\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. +.TP 3n +\(bu +\fB\-\-start\-datetime=\fR\fB\fIdatetime\fR\fR +.sp +Start reading the binary log at the first event having a timestamp equal to or later than the +\fIdatetime\fR +argument. The +\fIdatetime\fR +value is relative to the local time zone on the machine where you run +\fBmysqlbinlog\fR. The value should be in a format accepted for the +DATETIME +or +TIMESTAMP +data types. For example: +.sp +.RS 3n +.nf +shell> \fBmysqlbinlog \-\-start\-datetime="2005\-12\-25 11:25:56" binlog.000003\fR +.fi +.RE +This option is useful for point\-in\-time recovery. See +Section\ 6.2, \(lqExample Backup and Recovery Strategy\(rq. +.TP 3n +\(bu +\fB\-\-start\-position=\fR\fB\fIN\fR\fR +.sp +Start reading the binary log at the first event having a position equal to or greater than +\fIN\fR. This option applies to the first log file named on the command line. +.TP 3n +\(bu +\fB\-\-stop\-datetime=\fR\fB\fIdatetime\fR\fR +.sp +Stop reading the binary log at the first event having a timestamp equal to or later than the +\fIdatetime\fR +argument. This option is useful for point\-in\-time recovery. See the description of the +\fB\-\-start\-datetime\fR +option for information about the +\fIdatetime\fR +value. +.TP 3n +\(bu +\fB\-\-stop\-position=\fR\fB\fIN\fR\fR +.sp +Stop reading the binary log at the first event having a position equal to or greater than +\fIN\fR. This option applies to the last log file named on the command line. +.TP 3n +\(bu +\fB\-\-to\-last\-log\fR, +\fB\-t\fR +.sp +Do not stop at the end of the requested binary log from a MySQL server, but rather continue printing until the end of the last binary log. If you send the output to the same MySQL server, this may lead to an endless loop. This option requires +\fB\-\-read\-from\-remote\-server\fR. +.TP 3n +\(bu +\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 a remote server. +.TP 3n +\(bu +\fB\-\-verbose\fR, +\fB\-v\fR +.sp +Reconstruct row events and display them as commented SQL statements. If given twice, the output includes comments to indicate column data types and some metadata. This option was added in MySQL 5.1.28. +.sp +For examples that show the effect of +\fB\-\-base64\-output\fR +and +\fB\-\-verbose\fR +on row event output, see +the section called \(lq\fBMYSQLBINLOG\fR ROW EVENT DISPLAY\(rq. +.TP 3n +\(bu +\fB\-\-version\fR, +\fB\-V\fR +.sp +Display version information and exit. +.TP 3n +\(bu +\fB\-\-write\-binlog\fR +.sp +This option is enabled by default, so that +ANALYZE TABLE, +OPTIMIZE TABLE, and +REPAIR TABLE +statements generated by +\fBmysqlcheck\fR +are written to the binary log. Use +\fB\-\-skip\-write\-binlog\fR +to cause +NO_WRITE_TO_BINLOG +to be added to the statements so that they are not logged. Use the +\fB\-\-skip\-write\-binlog\fR +when these statements should not be sent to replication slaves or run when using the binary logs for recovery from backup. This option was added in MySQL 5.1.18. +.sp +.RE +.PP +You can also set the following variable by using +\fB\-\-\fR\fB\fIvar_name\fR\fR\fB=\fR\fB\fIvalue\fR\fR +syntax: +.TP 3n +\(bu +open_files_limit +.sp +Specify the number of open file descriptors to reserve. +.sp +.RE +.PP +You can pipe the output of +\fBmysqlbinlog\fR +into the +\fBmysql\fR +client to execute the statements contained in the binary log. This is used to recover from a crash when you have an old backup (see +Section\ 6.1, \(lqDatabase Backups\(rq). For example: +.sp +.RS 3n +.nf +shell> \fBmysqlbinlog binlog.000001 | mysql\fR +.fi +.RE +.PP +Or: +.sp +.RS 3n +.nf +shell> \fBmysqlbinlog binlog.[0\-9]* | mysql\fR +.fi +.RE +.PP +You can also redirect the output of +\fBmysqlbinlog\fR +to a text file instead, if you need to modify the statement log first (for example, to remove statements that you do not want to execute for some reason). After editing the file, execute the statements that it contains by using it as input to the +\fBmysql\fR +program. +.PP +\fBmysqlbinlog\fR +has the +\fB\-\-start\-position\fR +option, which prints only those statements with an offset in the binary log greater than or equal to a given position (the given position must match the start of one event). It also has options to stop and start when it sees an event with a given date and time. This enables you to perform point\-in\-time recovery using the +\fB\-\-stop\-datetime\fR +option (to be able to say, for example, +\(lqroll forward my databases to how they were today at 10:30 a.m.\(rq). +.PP +If you have more than one binary log to execute on the MySQL server, the safe method is to process them all using a single connection to the server. Here is an example that demonstrates what may be +\fIunsafe\fR: +.sp +.RS 3n +.nf +shell> \fBmysqlbinlog binlog.000001 | mysql # DANGER!!\fR +shell> \fBmysqlbinlog binlog.000002 | mysql # DANGER!!\fR +.fi +.RE +.PP +Processing binary logs this way using different connections to the server causes problems if the first log file contains a +CREATE TEMPORARY TABLE +statement and the second log contains a statement that uses the temporary table. When the first +\fBmysql\fR +process terminates, the server drops the temporary table. When the second +\fBmysql\fR +process attempts to use the table, the server reports +\(lqunknown table.\(rq +.PP +To avoid problems like this, use a +\fIsingle\fR +connection to execute the contents of all binary logs that you want to process. Here is one way to do so: +.sp +.RS 3n +.nf +shell> \fBmysqlbinlog binlog.000001 binlog.000002 | mysql\fR +.fi +.RE +.PP +Another approach is to write all the logs to a single file and then process the file: +.sp +.RS 3n +.nf +shell> \fBmysqlbinlog binlog.000001 > /tmp/statements.sql\fR +shell> \fBmysqlbinlog binlog.000002 >> /tmp/statements.sql\fR +shell> \fBmysql \-e "source /tmp/statements.sql"\fR +.fi +.RE +.PP +\fBmysqlbinlog\fR +can produce output that reproduces a +LOAD DATA INFILE +operation without the original data file. +\fBmysqlbinlog\fR +copies the data to a temporary file and writes a +LOAD DATA LOCAL INFILE +statement that refers to the file. The default location of the directory where these files are written is system\-specific. To specify a directory explicitly, use the +\fB\-\-local\-load\fR +option. +.PP +Because +\fBmysqlbinlog\fR +converts +LOAD DATA INFILE +statements to +LOAD DATA LOCAL INFILE +statements (that is, it adds +LOCAL), both the client and the server that you use to process the statements must be configured to allow +LOCAL +capability. See +Section\ 5.3.4, \(lqSecurity Issues with LOAD DATA LOCAL\(rq. +.sp +.it 1 an-trap +.nr an-no-space-flag 1 +.nr an-break-flag 1 +.br +\fBWarning\fR +.PP +The temporary files created for +LOAD DATA LOCAL +statements are +\fInot\fR +automatically deleted because they are needed until you actually execute those statements. You should delete the temporary files yourself after you no longer need the statement log. The files can be found in the temporary file directory and have names like +\fIoriginal_file_name\-#\-#\fR. +.SH "\fBMYSQLBINLOG\fR HEX DUMP FORMAT" +.PP +The +\fB\-\-hexdump\fR +option produces a hex dump of the log contents: +.sp +.RS 3n +.nf +shell> \fBmysqlbinlog \-\-hexdump master\-bin.000001\fR +.fi +.RE +.PP +The hex output consists of comment lines beginning with +#, so the output might look like this for the preceding command: +.sp +.RS 3n +.nf +/*!40019 SET @@session.max_insert_delayed_threads=0*/; +/*!50003 SET @OLD_COMPLETION_TYPE=@@COMPLETION_TYPE,COMPLETION_TYPE=0*/; +# at 4 +#051024 17:24:13 server id 1 end_log_pos 98 +# Position Timestamp Type Master ID Size Master Pos Flags +# 00000004 9d fc 5c 43 0f 01 00 00 00 5e 00 00 00 62 00 00 00 00 00 +# 00000017 04 00 35 2e 30 2e 31 35 2d 64 65 62 75 67 2d 6c |..5.0.15.debug.l| +# 00000027 6f 67 00 00 00 00 00 00 00 00 00 00 00 00 00 00 |og..............| +# 00000037 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 |................| +# 00000047 00 00 00 00 9d fc 5c 43 13 38 0d 00 08 00 12 00 |.......C.8......| +# 00000057 04 04 04 04 12 00 00 4b 00 04 1a |.......K...| +# Start: binlog v 4, server v 5.0.15\-debug\-log created 051024 17:24:13 +# at startup +ROLLBACK; +.fi +.RE +.PP +Hex dump output currently contains the following elements. This format is subject to change. +.TP 3n +\(bu +Position: The byte position within the log file. +.TP 3n +\(bu +Timestamp: The event timestamp. In the example shown, +\'9d fc 5c 43' +is the representation of +\'051024 17:24:13' +in hexadecimal. +.TP 3n +\(bu +Type: The event type code. In the example shown, +\'0f' +indicates a +FORMAT_DESCRIPTION_EVENT. The following table lists the possible type codes. +.TS +allbox tab(:); +l l l +l l l +l l l +l l l +l l l +l l l +l l l +l l l +l l l +l l l +l l l +l l l +l l l +l l l +l l l +l l l +l l l +l l l +l l l +l l l +l l l +l l l +l l l +l l l +l l l +l l l +l l l +l l l. +T{ +Type +T}:T{ +Name +T}:T{ +Meaning +T} +T{ +08 +T}:T{ +CREATE_FILE_EVENT +T}:T{ +Used for LOAD DATA + INFILE statements. This indicates the + start of execution of such a statement. A temporary + file is created on the slave. Used in MySQL 4 only. +T} +T{ +09 +T}:T{ +APPEND_BLOCK_EVENT +T}:T{ +Contains data for use in a + LOAD DATA + INFILE statement. The data is stored in + the temporary file on the slave. +T} +T{ +0a +T}:T{ +EXEC_LOAD_EVENT +T}:T{ +Used for LOAD DATA + INFILE statements. The contents of the + temporary file is stored in the table on the slave. + Used in MySQL 4 only. +T} +T{ +0b +T}:T{ +DELETE_FILE_EVENT +T}:T{ +Rollback of a LOAD DATA + INFILE statement. The temporary file + should be deleted on the slave. +T} +T{ +0c +T}:T{ +NEW_LOAD_EVENT +T}:T{ +Used for LOAD DATA + INFILE in MySQL 4 and earlier. +T} +T{ +0d +T}:T{ +RAND_EVENT +T}:T{ +Used to send information about random values if the + RAND() function is + used in the statement. +T} +T{ +0e +T}:T{ +USER_VAR_EVENT +T}:T{ +Used to replicate user variables. +T} +T{ +0f +T}:T{ +FORMAT_DESCRIPTION_EVENT +T}:T{ +This indicates the start of a log file written by MySQL 5 or later. +T} +T{ +10 +T}:T{ +XID_EVENT +T}:T{ +Event indicating commit of an XA transaction. +T} +T{ +11 +T}:T{ +BEGIN_LOAD_QUERY_EVENT +T}:T{ +Used for LOAD DATA + INFILE statements in MySQL 5 and later. +T} +T{ +00 +T}:T{ +UNKNOWN_EVENT +T}:T{ +This event should never be present in the log. +T} +T{ +12 +T}:T{ +EXECUTE_LOAD_QUERY_EVENT +T}:T{ +Used for LOAD DATA + INFILE statements in MySQL 5 and later. +T} +T{ +13 +T}:T{ +TABLE_MAP_EVENT +T}:T{ +Information about a table definition. Used in MySQL 5.1.5 and later. +T} +T{ +14 +T}:T{ +PRE_GA_WRITE_ROWS_EVENT +T}:T{ +Row data for a single table that should be created. Used in MySQL 5.1.5 + to 5.1.17. +T} +T{ +15 +T}:T{ +PRE_GA_UPDATE_ROWS_EVENT +T}:T{ +Row data for a single table that needs to be updated. Used in MySQL + 5.1.5 to 5.1.17. +T} +T{ +16 +T}:T{ +PRE_GA_DELETE_ROWS_EVENT +T}:T{ +Row data for a single table that should be deleted. Used in MySQL 5.1.5 + to 5.1.17. +T} +T{ +17 +T}:T{ +WRITE_ROWS_EVENT +T}:T{ +Row data for a single table that should be created. Used in MySQL 5.1.18 + and later. +T} +T{ +18 +T}:T{ +UPDATE_ROWS_EVENT +T}:T{ +Row data for a single table that needs to be updated. Used in MySQL + 5.1.18 and later. +T} +T{ +19 +T}:T{ +DELETE_ROWS_EVENT +T}:T{ +Row data for a single table that should be deleted. Used in MySQL 5.1.18 + and later. +T} +T{ +1a +T}:T{ +INCIDENT_EVENT +T}:T{ +Something out of the ordinary happened. Added in MySQL 5.1.18. +T} +T{ +01 +T}:T{ +START_EVENT_V3 +T}:T{ +This indicates the start of a log file written by MySQL 4 or earlier. +T} +T{ +02 +T}:T{ +QUERY_EVENT +T}:T{ +The most common type of events. These contain statements executed on the + master. +T} +T{ +03 +T}:T{ +STOP_EVENT +T}:T{ +Indicates that master has stopped. +T} +T{ +04 +T}:T{ +ROTATE_EVENT +T}:T{ +Written when the master switches to a new log file. +T} +T{ +05 +T}:T{ +INTVAR_EVENT +T}:T{ +Used for AUTO_INCREMENT values or when the + LAST_INSERT_ID() + function is used in the statement. +T} +T{ +06 +T}:T{ +LOAD_EVENT +T}:T{ +Used for LOAD DATA + INFILE in MySQL 3.23. +T} +T{ +07 +T}:T{ +SLAVE_EVENT +T}:T{ +Reserved for future use. +T} +.TE +.sp +.TP 3n +\(bu +Master ID: The server ID of the master that created the event. +.TP 3n +\(bu +Size: The size in bytes of the event. +.TP 3n +\(bu +Master Pos: The position of the next event in the original master log file. +.TP 3n +\(bu +Flags: 16 flags. Currently, the following flags are used. The others are reserved for future use. +.TS +allbox tab(:); +l l l +l l l +l l l +l l l +l l l. +T{ +Flag +T}:T{ +Name +T}:T{ +Meaning +T} +T{ +01 +T}:T{ +LOG_EVENT_BINLOG_IN_USE_F +T}:T{ +Log file correctly closed. (Used only in + FORMAT_DESCRIPTION_EVENT.) If + this flag is set (if the flags are, for example, + '01 00') in a + FORMAT_DESCRIPTION_EVENT, the log + file has not been properly closed. Most probably + this is because of a master crash (for example, due + to power failure). +T} +T{ +02 +T}:T{ +\ +T}:T{ +Reserved for future use. +T} +T{ +04 +T}:T{ +LOG_EVENT_THREAD_SPECIFIC_F +T}:T{ +Set if the event is dependent on the connection it was executed in (for + example, '04 00'), for example, + if the event uses temporary tables. +T} +T{ +08 +T}:T{ +LOG_EVENT_SUPPRESS_USE_F +T}:T{ +Set in some circumstances when the event is not dependent on the default + database. +T} +.TE +.sp +.SH "\fBMYSQLBINLOG\fR ROW EVENT DISPLAY" +.PP +The following examples illustrate how +\fBmysqlbinlog\fR +displays row events that specify data modifications. These correspond to events with the +WRITE_ROWS_EVENT, +UPDATE_ROWS_EVENT, and +DELETE_ROWS_EVENT +type codes. The +\fB\-\-base64\-output=DECODE\-ROWS\fR +and +\fB\-\-verbose\fR +options may be used to affect row event output. These options are available as of MySQL 5.1.28. +.PP +Suppose that the server is using row\-based binary logging and that you execute the following sequence of statements: +.sp +.RS 3n +.nf +CREATE TABLE t +( + id INT NOT NULL, + name VARCHAR(20) NOT NULL, + date DATE NULL +) ENGINE = InnoDB; +START TRANSACTION; +INSERT INTO t VALUES(1, 'apple', NULL); +UPDATE t SET name = 'pear', date = '2009\-01\-01' WHERE id = 1; +DELETE FROM t WHERE id = 1; +COMMIT; +.fi +.RE +.PP +By default, +\fBmysqlbinlog\fR +displays row events encoded as base\-64 strings using +BINLOG +statements. Omitting extraneous lines, the output for the row events produced by the preceding statement sequence looks like this: +.sp +.RS 3n +.nf +shell> \fBmysqlbinlog \fR\fB\fIlog_file\fR\fR +... +# at 218 +#080828 15:03:08 server id 1 end_log_pos 258 Write_rows: table id 17 flags: STMT_END_F +BINLOG ' +fAS3SBMBAAAALAAAANoAAAAAABEAAAAAAAAABHRlc3QAAXQAAwMPCgIUAAQ= +fAS3SBcBAAAAKAAAAAIBAAAQABEAAAAAAAEAA//8AQAAAAVhcHBsZQ== +\'/*!*/; +... +# at 302 +#080828 15:03:08 server id 1 end_log_pos 356 Update_rows: table id 17 flags: STMT_END_F +BINLOG ' +fAS3SBMBAAAALAAAAC4BAAAAABEAAAAAAAAABHRlc3QAAXQAAwMPCgIUAAQ= +fAS3SBgBAAAANgAAAGQBAAAQABEAAAAAAAEAA////AEAAAAFYXBwbGX4AQAAAARwZWFyIbIP +\'/*!*/; +... +# at 400 +#080828 15:03:08 server id 1 end_log_pos 442 Delete_rows: table id 17 flags: STMT_END_F +BINLOG ' +fAS3SBMBAAAALAAAAJABAAAAABEAAAAAAAAABHRlc3QAAXQAAwMPCgIUAAQ= +fAS3SBkBAAAAKgAAALoBAAAQABEAAAAAAAEAA//4AQAAAARwZWFyIbIP +\'/*!*/; +.fi +.RE +.PP +To see the row events as comments in the form of +\(lqpseudo\-SQL\(rq +statements, run +\fBmysqlbinlog\fR +with the +\fB\-\-verbose\fR +or +\fB\-v\fR +option. The output will contain lines beginning with +###: +.sp +.RS 3n +.nf +shell> \fBmysqlbinlog \-v \fR\fB\fIlog_file\fR\fR +... +# at 218 +#080828 15:03:08 server id 1 end_log_pos 258 Write_rows: table id 17 flags: STMT_END_F +BINLOG ' +fAS3SBMBAAAALAAAANoAAAAAABEAAAAAAAAABHRlc3QAAXQAAwMPCgIUAAQ= +fAS3SBcBAAAAKAAAAAIBAAAQABEAAAAAAAEAA//8AQAAAAVhcHBsZQ== +\'/*!*/; +### INSERT INTO test.t +### SET +### @1=1 +### @2='apple' +### @3=NULL +... +# at 302 +#080828 15:03:08 server id 1 end_log_pos 356 Update_rows: table id 17 flags: STMT_END_F +BINLOG ' +fAS3SBMBAAAALAAAAC4BAAAAABEAAAAAAAAABHRlc3QAAXQAAwMPCgIUAAQ= +fAS3SBgBAAAANgAAAGQBAAAQABEAAAAAAAEAA////AEAAAAFYXBwbGX4AQAAAARwZWFyIbIP +\'/*!*/; +### UPDATE test.t +### WHERE +### @1=1 +### @2='apple' +### @3=NULL +### SET +### @1=1 +### @2='pear' +### @3='2009:01:01' +... +# at 400 +#080828 15:03:08 server id 1 end_log_pos 442 Delete_rows: table id 17 flags: STMT_END_F +BINLOG ' +fAS3SBMBAAAALAAAAJABAAAAABEAAAAAAAAABHRlc3QAAXQAAwMPCgIUAAQ= +fAS3SBkBAAAAKgAAALoBAAAQABEAAAAAAAEAA//4AQAAAARwZWFyIbIP +\'/*!*/; +### DELETE FROM test.t +### WHERE +### @1=1 +### @2='pear' +### @3='2009:01:01' +.fi +.RE +.PP +Specify +\fB\-\-verbose\fR +or +\fB\-v\fR +twice to also display data types and some metadata for each column. The output will contain an additional comment following each column change: +.sp +.RS 3n +.nf +shell> \fBmysqlbinlog \-vv \fR\fB\fIlog_file\fR\fR +... +# at 218 +#080828 15:03:08 server id 1 end_log_pos 258 Write_rows: table id 17 flags: STMT_END_F +BINLOG ' +fAS3SBMBAAAALAAAANoAAAAAABEAAAAAAAAABHRlc3QAAXQAAwMPCgIUAAQ= +fAS3SBcBAAAAKAAAAAIBAAAQABEAAAAAAAEAA//8AQAAAAVhcHBsZQ== +\'/*!*/; +### INSERT INTO test.t +### SET +### @1=1 /* INT meta=0 nullable=0 is_null=0 */ +### @2='apple' /* VARSTRING(20) meta=20 nullable=0 is_null=0 */ +### @3=NULL /* VARSTRING(20) meta=0 nullable=1 is_null=1 */ +... +# at 302 +#080828 15:03:08 server id 1 end_log_pos 356 Update_rows: table id 17 flags: STMT_END_F +BINLOG ' +fAS3SBMBAAAALAAAAC4BAAAAABEAAAAAAAAABHRlc3QAAXQAAwMPCgIUAAQ= +fAS3SBgBAAAANgAAAGQBAAAQABEAAAAAAAEAA////AEAAAAFYXBwbGX4AQAAAARwZWFyIbIP +\'/*!*/; +### UPDATE test.t +### WHERE +### @1=1 /* INT meta=0 nullable=0 is_null=0 */ +### @2='apple' /* VARSTRING(20) meta=20 nullable=0 is_null=0 */ +### @3=NULL /* VARSTRING(20) meta=0 nullable=1 is_null=1 */ +### SET +### @1=1 /* INT meta=0 nullable=0 is_null=0 */ +### @2='pear' /* VARSTRING(20) meta=20 nullable=0 is_null=0 */ +### @3='2009:01:01' /* DATE meta=0 nullable=1 is_null=0 */ +... +# at 400 +#080828 15:03:08 server id 1 end_log_pos 442 Delete_rows: table id 17 flags: STMT_END_F +BINLOG ' +fAS3SBMBAAAALAAAAJABAAAAABEAAAAAAAAABHRlc3QAAXQAAwMPCgIUAAQ= +fAS3SBkBAAAAKgAAALoBAAAQABEAAAAAAAEAA//4AQAAAARwZWFyIbIP +\'/*!*/; +### DELETE FROM test.t +### WHERE +### @1=1 /* INT meta=0 nullable=0 is_null=0 */ +### @2='pear' /* VARSTRING(20) meta=20 nullable=0 is_null=0 */ +### @3='2009:01:01' /* DATE meta=0 nullable=1 is_null=0 */ +.fi +.RE +.PP +You can tell +\fBmysqlbinlog\fR +to suppress the +BINLOG +statements for row events by using the +\fB\-\-base64\-output=DECODE\-ROWS\fR +option. This is similar to +\fB\-\-base64\-output=NEVER\fR +but does not exit with an error if a row event is found. The combination of +\fB\-\-base64\-output=DECODE\-ROWS\fR +and +\fB\-\-verbose\fR +provides a convenient way to see row events only as SQL statements: +.sp +.RS 3n +.nf +shell> \fBmysqlbinlog \-v \-\-base64\-output=DECODE\-ROWS \fR\fB\fIlog_file\fR\fR +... +# at 218 +#080828 15:03:08 server id 1 end_log_pos 258 Write_rows: table id 17 flags: STMT_END_F +### INSERT INTO test.t +### SET +### @1=1 +### @2='apple' +### @3=NULL +... +# at 302 +#080828 15:03:08 server id 1 end_log_pos 356 Update_rows: table id 17 flags: STMT_END_F +### UPDATE test.t +### WHERE +### @1=1 +### @2='apple' +### @3=NULL +### SET +### @1=1 +### @2='pear' +### @3='2009:01:01' +... +# at 400 +#080828 15:03:08 server id 1 end_log_pos 442 Delete_rows: table id 17 flags: STMT_END_F +### DELETE FROM test.t +### WHERE +### @1=1 +### @2='pear' +### @3='2009:01:01' +.fi +.RE +.sp +.it 1 an-trap +.nr an-no-space-flag 1 +.nr an-break-flag 1 +.br +\fBNote\fR +.PP +You should not suppress +BINLOG +statements if you intend to re\-execute +\fBmysqlbinlog\fR +output. +.PP +The SQL statements produced by +\fB\-\-verbose\fR +for row events are much more readable than the corresponding +BINLOG +statements. However, they do not correspond exactly to the original SQL statements that generated the events. The following limitations apply: +.TP 3n +\(bu +The original column names are lost and replace by +@\fIN\fR, where +\fIN\fR +is a column number. +.TP 3n +\(bu +Character set information is not available in the binary log, which affects string column display: +.RS 3n +.TP 3n +\(bu +There is no distinction made between corresponding binary and non\-binary string types (BINARY +and +CHAR, +VARBINARY +and +VARCHAR, +BLOB +and +TEXT). The output uses a data type of +STRING +for fixed\-length strings and +VARSTRING +for variable\-length strings. +.TP 3n +\(bu +For multi\-byte character sets, the maximum number of bytes per character is not present in the binary log, so the length for string types is displayed in bytes rather than in characters. For example, +STRING(4) +will be used as the data type for values from either of these column types: +.sp +.RS 3n +.nf +CHAR(4) CHARACTER SET latin1 +CHAR(2) CHARACTER SET ucs2 +.fi +.RE +.TP 3n +\(bu +Due to the storage format for events of type +UPDATE_ROWS_EVENT, +UPDATE +statements are displayed with the +WHERE +clause preceding the +SET +clause. +.RE +.SH "COPYRIGHT" +.PP +Copyright 2007\-2008 MySQL AB, 2009 Sun Microsystems, Inc. +.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/. +.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 +MySQL AB (http://www.mysql.com/). diff --git a/man/mysqlbug.1 b/man/mysqlbug.1 new file mode 100644 index 00000000000..7b7edf996f5 --- /dev/null +++ b/man/mysqlbug.1 @@ -0,0 +1,63 @@ +.\" Title: \fBmysqlbug\fR +.\" Author: +.\" Generator: DocBook XSL Stylesheets v1.70.1 <http://docbook.sf.net/> +.\" Date: 03/31/2009 +.\" Manual: MySQL Database System +.\" Source: MySQL 5.1 +.\" +.TH "\fBMYSQLBUG\fR" "1" "03/31/2009" "MySQL 5.1" "MySQL Database System" +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.SH "NAME" +mysqlbug \- generate bug report +.SH "SYNOPSIS" +.HP 9 +\fBmysqlbug\fR +.SH "DESCRIPTION" +.PP +This program enables you to generate a bug report and send it to MySQL AB. It is a shell script and runs on Unix. +.PP +The normal way to report bugs is to visit +\fI\%http://bugs.mysql.com/\fR, which is the address for our bugs database. This database is public and can be browsed and searched by anyone. If you log in to the system, you can enter new reports. If you have no Web access, you can generate a bug report by using the +\fBmysqlbug\fR +script. +.PP +\fBmysqlbug\fR +helps you generate a report by determining much of the following information automatically, but if something important is missing, please include it with your message. +\fBmysqlbug\fR +can be found in the +\fIscripts\fR +directory (source distribution) and in the +\fIbin\fR +directory under your MySQL installation directory (binary distribution). +.PP +Invoke +\fBmysqlbug\fR +without arguments: +.sp +.RS 3n +.nf +shell> \fBmysqlbug\fR +.fi +.RE +.PP +The script will place you in an editor with a copy of the report to be sent. Edit the lines near the beginning that indicate the nature of the problem. Then write the file to save your changes, quit the editor, and +\fBmysqlbug\fR +will send the report by email. perform. +.SH "COPYRIGHT" +.PP +Copyright 2007\-2008 MySQL AB, 2009 Sun Microsystems, Inc. +.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/. +.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 +MySQL AB (http://www.mysql.com/). diff --git a/man/mysqlcheck.1 b/man/mysqlcheck.1 new file mode 100644 index 00000000000..1ddfc68c042 --- /dev/null +++ b/man/mysqlcheck.1 @@ -0,0 +1,411 @@ +.\" Title: \fBmysqlcheck\fR +.\" Author: +.\" Generator: DocBook XSL Stylesheets v1.70.1 <http://docbook.sf.net/> +.\" Date: 03/31/2009 +.\" Manual: MySQL Database System +.\" Source: MySQL 5.1 +.\" +.TH "\fBMYSQLCHECK\fR" "1" "03/31/2009" "MySQL 5.1" "MySQL Database System" +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.SH "NAME" +mysqlcheck \- a table maintenance and repair program +.SH "SYNOPSIS" +.HP 46 +\fBmysqlcheck [\fR\fB\fIoptions\fR\fR\fB] [\fR\fB\fIdb_name\fR\fR\fB [\fR\fB\fItbl_name\fR\fR\fB ...]]\fR +.SH "DESCRIPTION" +.PP +The +\fBmysqlcheck\fR +client checks, repairs, optimizes, and analyzes tables. +.PP +\fBmysqlcheck\fR +is similar in function to +\fBmyisamchk\fR, but works differently. The main operational difference is that +\fBmysqlcheck\fR +must be used when the +\fBmysqld\fR +server is running, whereas +\fBmyisamchk\fR +should be used when it is not. The benefit of using +\fBmysqlcheck\fR +is that you do not have to stop the server to check or repair your tables. +.PP +\fBmysqlcheck\fR +uses the SQL statements +CHECK TABLE, +REPAIR TABLE, +ANALYZE TABLE, and +OPTIMIZE TABLE +in a convenient way for the user. It determines which statements to use for the operation you want to perform, and then sends the statements to the server to be executed. For details about which storage engines each statement works with, see the descriptions for those statements in +Chapter\ 12, SQL Statement Syntax. +.PP +The +MyISAM +storage engine supports all four statements, so +\fBmysqlcheck\fR +can be used to perform all four operations on +MyISAM +tables. Other storage engines do not necessarily support all operations. In such cases, an error message is displayed. For example, if +test.t +is a +MEMORY +table, an attempt to check it produces this result: +.sp +.RS 3n +.nf +shell> \fBmysqlcheck test t\fR +test.t +note : The storage engine for the table doesn't support check +.fi +.RE +.PP +The use of +\fBmysqlcheck\fR +with partitioned tables is not supported before MySQL 5.1.27. +.sp +.it 1 an-trap +.nr an-no-space-flag 1 +.nr an-break-flag 1 +.br +\fBCaution\fR +.PP +It is best to make a backup of a table before performing a table repair operation; under some circumstances the operation might cause data loss. Possible causes include but are not limited to file system errors. +.PP +There are three general ways to invoke +\fBmysqlcheck\fR: +.sp +.RS 3n +.nf +shell> \fBmysqlcheck [\fR\fB\fIoptions\fR\fR\fB] \fR\fB\fIdb_name\fR\fR\fB [\fR\fB\fItables\fR\fR\fB]\fR +shell> \fBmysqlcheck [\fR\fB\fIoptions\fR\fR\fB] \-\-databases \fR\fB\fIdb_name1\fR\fR\fB [\fR\fB\fIdb_name2\fR\fR\fB \fR\fB\fIdb_name3\fR\fR\fB...]\fR +shell> \fBmysqlcheck [\fR\fB\fIoptions\fR\fR\fB] \-\-all\-databases\fR +.fi +.RE +.PP +If you do not name any tables following +\fIdb_name\fR +or if you use the +\fB\-\-databases\fR +or +\fB\-\-all\-databases\fR +option, entire databases are checked. +.PP +\fBmysqlcheck\fR +has a special feature compared to other client programs. The default behavior of checking tables (\fB\-\-check\fR) can be changed by renaming the binary. If you want to have a tool that repairs tables by default, you should just make a copy of +\fBmysqlcheck\fR +named +\fBmysqlrepair\fR, or make a symbolic link to +\fBmysqlcheck\fR +named +\fBmysqlrepair\fR. If you invoke +\fBmysqlrepair\fR, it repairs tables. +.PP +The following names can be used to change +\fBmysqlcheck\fR +default behavior. +.TS +allbox tab(:); +l l +l l +l l. +T{ +\fBmysqlrepair\fR +T}:T{ +The default option is \fB\-\-repair\fR +T} +T{ +\fBmysqlanalyze\fR +T}:T{ +The default option is \fB\-\-analyze\fR +T} +T{ +\fBmysqloptimize\fR +T}:T{ +The default option is \fB\-\-optimize\fR +T} +.TE +.sp +.PP +\fBmysqlcheck\fR +supports the following options: +.TP 3n +\(bu +\fB\-\-help\fR, +\fB\-?\fR +.sp +Display a help message and exit. +.TP 3n +\(bu +\fB\-\-all\-databases\fR, +\fB\-A\fR +.sp +Check all tables in all databases. This is the same as using the +\fB\-\-databases\fR +option and naming all the databases on the command line. +.TP 3n +\(bu +\fB\-\-all\-in\-1\fR, +\fB\-1\fR +.sp +Instead of issuing a statement for each table, execute a single statement for each database that names all the tables from that database to be processed. +.TP 3n +\(bu +\fB\-\-analyze\fR, +\fB\-a\fR +.sp +Analyze the tables. +.TP 3n +\(bu +\fB\-\-auto\-repair\fR +.sp +If a checked table is corrupted, automatically fix it. Any necessary repairs are done after all tables have been checked. +.TP 3n +\(bu +\fB\-\-character\-sets\-dir=\fR\fB\fIpath\fR\fR +.sp +The directory where character sets are installed. See +Section\ 9.2, \(lqThe Character Set Used for Data and Sorting\(rq. +.TP 3n +\(bu +\fB\-\-check\fR, +\fB\-c\fR +.sp +Check the tables for errors. This is the default operation. +.TP 3n +\(bu +\fB\-\-check\-only\-changed\fR, +\fB\-C\fR +.sp +Check only tables that have changed since the last check or that have not been closed properly. +.TP 3n +\(bu +\fB\-\-check\-upgrade\fR, +\fB\-g\fR +.sp +Invoke +CHECK TABLE +with the +FOR UPGRADE +option to check tables for incompatibilities with the current version of the server. This option automatically enables the +\fB\-\-fix\-db\-names\fR +and +\fB\-\-fix\-table\-names\fR +options. +\fB\-\-check\-upgrade\fR +was added in MySQL 5.1.7. +.TP 3n +\(bu +\fB\-\-compress\fR +.sp +Compress all information sent between the client and the server if both support compression. +.TP 3n +\(bu +\fB\-\-databases\fR, +\fB\-B\fR +.sp +Process all tables in the named databases. Normally, +\fBmysqlcheck\fR +treats the first name argument on the command line as a database name and following names as table names. With this option, it treats all name arguments as database names. +.TP 3n +\(bu +\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 often +\'d:t:o,\fIfile_name\fR'. +.TP 3n +\(bu +\fB\-\-debug\-check\fR +.sp +Print some debugging information when the program exits. This option was added in MySQL 5.1.21. +.TP 3n +\(bu +\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. +.TP 3n +\(bu +\fB\-\-default\-character\-set=\fR\fB\fIcharset_name\fR\fR +.sp +Use +\fIcharset_name\fR +as the default character set. See +Section\ 9.2, \(lqThe Character Set Used for Data and Sorting\(rq. +.TP 3n +\(bu +\fB\-\-extended\fR, +\fB\-e\fR +.sp +If you are using this option to check tables, it ensures that they are 100% consistent but takes a long time. +.sp +If you are using this option to repair tables, it runs an extended repair that may not only take a long time to execute, but may produce a lot of garbage rows also! +.TP 3n +\(bu +\fB\-\-fast\fR, +\fB\-F\fR +.sp +Check only tables that have not been closed properly. +.TP 3n +\(bu +\fB\-\-fix\-db\-names\fR +.sp +Convert database names to 5.1 format. Only database names that contain special characters are affected. This option was added in MySQL 5.1.7. +.TP 3n +\(bu +\fB\-\-fix\-table\-names\fR +.sp +Convert table names to 5.1 format. Only table names that contain special characters are affected. This option was added in MySQL 5.1.7. As of MySQL 5.1.23, this option also applies to views. +.TP 3n +\(bu +\fB\-\-force\fR, +\fB\-f\fR +.sp +Continue even if an SQL error occurs. +.TP 3n +\(bu +\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. +.TP 3n +\(bu +\fB\-\-medium\-check\fR, +\fB\-m\fR +.sp +Do a check that is faster than an +\fB\-\-extended\fR +operation. This finds only 99.99% of all errors, which should be good enough in most cases. +.TP 3n +\(bu +\fB\-\-optimize\fR, +\fB\-o\fR +.sp +Optimize the tables. +.TP 3n +\(bu +\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, you are prompted for one. +.sp +Specifying a password on the command line should be considered insecure. See +Section\ 5.5.6.2, \(lqEnd\-User Guidelines for Password Security\(rq. +.TP 3n +\(bu +\fB\-\-pipe\fR, +\fB\-W\fR +.sp +On Windows, connect to the server via a named pipe. This option applies only for connections to a local server, and only if the server supports named\-pipe connections. +.TP 3n +\(bu +\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. +.TP 3n +\(bu +\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 allowable values, see +Section\ 4.2.2, \(lqConnecting to the MySQL Server\(rq. +.TP 3n +\(bu +\fB\-\-quick\fR, +\fB\-q\fR +.sp +If you are using this option to check tables, it prevents the check from scanning the rows to check for incorrect links. This is the fastest check method. +.sp +If you are using this option to repair tables, it tries to repair only the index tree. This is the fastest repair method. +.TP 3n +\(bu +\fB\-\-repair\fR, +\fB\-r\fR +.sp +Perform a repair that can fix almost anything except unique keys that are not unique. +.TP 3n +\(bu +\fB\-\-silent\fR, +\fB\-s\fR +.sp +Silent mode. Print only error messages. +.TP 3n +\(bu +\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. +.TP 3n +\(bu +\fB\-\-ssl*\fR +.sp +Options that begin with +\fB\-\-ssl\fR +specify whether to connect to the server via SSL and indicate where to find SSL keys and certificates. See +Section\ 5.5.7.3, \(lqSSL Command Options\(rq. +.TP 3n +\(bu +\fB\-\-tables\fR +.sp +Overrides the +\fB\-\-databases\fR +or +\fB\-B\fR +option. All name arguments following the option are regarded as table names. +.TP 3n +\(bu +\fB\-\-use\-frm\fR +.sp +For repair operations on +MyISAM +tables, get the table structure from the +\fI.frm\fR +file so that the table can be repaired even if the +\fI.MYI\fR +header is corrupted. +.TP 3n +\(bu +\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. +.TP 3n +\(bu +\fB\-\-verbose\fR, +\fB\-v\fR +.sp +Verbose mode. Print information about the various stages of program operation. +.TP 3n +\(bu +\fB\-\-version\fR, +\fB\-V\fR +.sp +Display version information and exit. +.SH "COPYRIGHT" +.PP +Copyright 2007\-2008 MySQL AB, 2009 Sun Microsystems, Inc. +.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/. +.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 +MySQL AB (http://www.mysql.com/). diff --git a/man/mysqld.8 b/man/mysqld.8 new file mode 100644 index 00000000000..ba387c88b4b --- /dev/null +++ b/man/mysqld.8 @@ -0,0 +1,53 @@ +.\" Title: \fBmysqld\fR +.\" Author: +.\" Generator: DocBook XSL Stylesheets v1.70.1 <http://docbook.sf.net/> +.\" Date: 03/31/2009 +.\" Manual: MySQL Database System +.\" Source: MySQL 5.1 +.\" +.TH "\fBMYSQLD\fR" "8" "03/31/2009" "MySQL 5.1" "MySQL Database System" +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.SH "NAME" +mysqld \- the MySQL server +.SH "SYNOPSIS" +.HP 17 +\fBmysqld [\fR\fB\fIoptions\fR\fR\fB]\fR +.SH "DESCRIPTION" +.PP +\fBmysqld\fR, also known as MySQL Server, is the main program that does most of the work in a MySQL installation. MySQL Server manages access to the MySQL data directory that contains databases and tables. The data directory is also the default location for other information such as log files and status files. +.PP +When MySQL server starts, it listens for network connections from client programs and manages access to databases on behalf of those clients. +.PP +The +\fBmysqld\fR +program has many options that can be specified at startup. For a complete list of options, run this command: +.sp +.RS 3n +.nf +shell> \fBmysqld \-\-verbose \-\-help\fR +.fi +.RE +.PP +MySQL Server also has a set of system variables that affect its operation as it runs. System variables can be set at server startup, and many of them can be changed at runtime to effect dynamic server reconfiguration. MySQL Server also has a set of status variables that provide information about its operation. You can monitor these status variables to access runtime performance characteristics. +.PP +For a full description of MySQL Server command options, system variables, and status variables, see +Section\ 5.1, \(lqThe MySQL Server\(rq. For information about installing MySQL and setting up the initial configuration, see +Chapter\ 2, Installing and Upgrading MySQL. +.SH "COPYRIGHT" +.PP +Copyright 2007\-2008 MySQL AB, 2009 Sun Microsystems, Inc. +.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/. +.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 +MySQL AB (http://www.mysql.com/). diff --git a/man/mysqld_multi.1 b/man/mysqld_multi.1 new file mode 100644 index 00000000000..a6f3c778fb7 --- /dev/null +++ b/man/mysqld_multi.1 @@ -0,0 +1,457 @@ +.\" Title: \fBmysqld_multi\fR +.\" Author: +.\" Generator: DocBook XSL Stylesheets v1.70.1 <http://docbook.sf.net/> +.\" Date: 03/31/2009 +.\" Manual: MySQL Database System +.\" Source: MySQL 5.1 +.\" +.TH "\fBMYSQLD_MULTI\fR" "1" "03/31/2009" "MySQL 5.1" "MySQL Database System" +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.SH "NAME" +mysqld_multi \- manage multiple MySQL servers +.SH "SYNOPSIS" +.HP 59 +\fBmysqld_multi [\fR\fB\fIoptions\fR\fR\fB] {start|stop|report} [\fR\fB\fIGNR\fR\fR\fB[,\fR\fB\fIGNR\fR\fR\fB] ...]\fR +.SH "DESCRIPTION" +.PP +\fBmysqld_multi\fR +is designed to manage several +\fBmysqld\fR +processes that listen for connections on different Unix socket files and TCP/IP ports. It can start or stop servers, or report their current status. The MySQL Instance Manager is an alternative means of managing multiple servers (see +\fBmysqlmanager\fR(8)). +.PP +\fBmysqld_multi\fR +searches for groups named +[mysqld\fIN\fR] +in +\fImy.cnf\fR +(or in the file named by the +\fB\-\-config\-file\fR +option). +\fIN\fR +can be any positive integer. This number is referred to in the following discussion as the option group number, or +\fIGNR\fR. Group numbers distinguish option groups from one another and are used as arguments to +\fBmysqld_multi\fR +to specify which servers you want to start, stop, or obtain a status report for. Options listed in these groups are the same that you would use in the +[mysqld] +group used for starting +\fBmysqld\fR. (See, for example, +Section\ 2.11.2.2, \(lqStarting and Stopping MySQL Automatically\(rq.) However, when using multiple servers, it is necessary that each one use its own value for options such as the Unix socket file and TCP/IP port number. For more information on which options must be unique per server in a multiple\-server environment, see +Section\ 5.6, \(lqRunning Multiple MySQL Servers on the Same Machine\(rq. +.PP +To invoke +\fBmysqld_multi\fR, use the following syntax: +.sp +.RS 3n +.nf +shell> \fBmysqld_multi [\fR\fB\fIoptions\fR\fR\fB] {start|stop|report} [\fR\fB\fIGNR\fR\fR\fB[,\fR\fB\fIGNR\fR\fR\fB] ...]\fR +.fi +.RE +.PP +start, +stop, and +report +indicate which operation to perform. You can perform the designated operation for a single server or multiple servers, depending on the +\fIGNR\fR +list that follows the option name. If there is no list, +\fBmysqld_multi\fR +performs the operation for all servers in the option file. +.PP +Each +\fIGNR\fR +value represents an option group number or range of group numbers. The value should be the number at the end of the group name in the option file. For example, the +\fIGNR\fR +for a group named +[mysqld17] +is +17. To specify a range of numbers, separate the first and last numbers by a dash. The +\fIGNR\fR +value +10\-13 +represents groups +[mysqld10] +through +[mysqld13]. Multiple groups or group ranges can be specified on the command line, separated by commas. There must be no whitespace characters (spaces or tabs) in the +\fIGNR\fR +list; anything after a whitespace character is ignored. +.PP +This command starts a single server using option group +[mysqld17]: +.sp +.RS 3n +.nf +shell> \fBmysqld_multi start 17\fR +.fi +.RE +.PP +This command stops several servers, using option groups +[mysqld8] +and +[mysqld10] +through +[mysqld13]: +.sp +.RS 3n +.nf +shell> \fBmysqld_multi stop 8,10\-13\fR +.fi +.RE +.PP +For an example of how you might set up an option file, use this command: +.sp +.RS 3n +.nf +shell> \fBmysqld_multi \-\-example\fR +.fi +.RE +.PP +As of MySQL 5.1.18, +\fBmysqld_multi\fR +searches for option files as follows: +.TP 3n +\(bu +With +\fB\-\-no\-defaults\fR, no option files are read. +.TP 3n +\(bu +With +\fB\-\-defaults\-file=\fR\fB\fIfile_name\fR\fR, only the named file is read. +.TP 3n +\(bu +Otherwise, option files in the standard list of locations are read, including any file named by the +\fB\-\-defaults\-extra\-file=\fR\fB\fIfile_name\fR\fR +option, if one is given. (If the option is given multiple times, the last value is used.) +.sp +.RE +.PP +Option files read are searched for +[mysqld_multi] +and +[mysqld\fIN\fR] +option groups. +.PP +Before MySQL 5.1.18, the preceding options are not recognized. Files in the standard locations are read, and any file named by the +\fB\-\-config\-file=\fR\fB\fIfile_name\fR\fR +option, if one is given. A file named by +\fB\-\-config\-file\fR +is read only for +[mysqld\fIN\fR] +option groups, not the +[mysqld_multi] +group. +.PP +\fBmysqld_multi\fR +supports the following options: +.TP 3n +\(bu +\fB\-\-help\fR +.sp +Display a help message and exit. +.TP 3n +\(bu +\fB\-\-config\-file=\fR\fB\fIfile_name\fR\fR +.sp +As of MySQL 5.1.18, this option is deprecated. If given, it is treated the same way as +\fB\-\-defaults\-extra\-file\fR, described earlier. +.sp +Before MySQL 5.1.18, this option specifies the name of an extra option file. It affects where +\fBmysqld_multi\fR +looks for +[mysqld\fIN\fR] +option groups. Without this option, all options are read from the usual +\fImy.cnf\fR +file. The option does not affect where +\fBmysqld_multi\fR +reads its own options, which are always taken from the +[mysqld_multi] +group in the usual +\fImy.cnf\fR +file. +.TP 3n +\(bu +\fB\-\-example\fR +.sp +Display a sample option file. +.TP 3n +\(bu +\fB\-\-log=\fR\fB\fIfile_name\fR\fR +.sp +Specify the name of the log file. If the file exists, log output is appended to it. +.TP 3n +\(bu +\fB\-\-mysqladmin=\fR\fB\fIprog_name\fR\fR +.sp +The +\fBmysqladmin\fR +binary to be used to stop servers. +.TP 3n +\(bu +\fB\-\-mysqld=\fR\fB\fIprog_name\fR\fR +.sp +The +\fBmysqld\fR +binary to be used. Note that you can specify +\fBmysqld_safe\fR +as the value for this option also. If you use +\fBmysqld_safe\fR +to start the server, you can include the +mysqld +or +ledir +options in the corresponding +[mysqld\fIN\fR] +option group. These options indicate the name of the server that +\fBmysqld_safe\fR +should start and the path name of the directory where the server is located. (See the descriptions for these options in +\fBmysqld_safe\fR(1).) Example: +.sp +.RS 3n +.nf +[mysqld38] +mysqld = mysqld\-debug +ledir = /opt/local/mysql/libexec +.fi +.RE +.TP 3n +\(bu +\fB\-\-no\-log\fR +.sp +Print log information to +stdout +rather than to the log file. By default, output goes to the log file. +.TP 3n +\(bu +\fB\-\-password=\fR\fB\fIpassword\fR\fR +.sp +The password of the MySQL account to use when invoking +\fBmysqladmin\fR. Note that the password value is not optional for this option, unlike for other MySQL programs. +.TP 3n +\(bu +\fB\-\-silent\fR +.sp +Silent mode; disable warnings. +.TP 3n +\(bu +\fB\-\-tcp\-ip\fR +.sp +Connect to each MySQL server via the TCP/IP port instead of the Unix socket file. (If a socket file is missing, the server might still be running, but accessible only via the TCP/IP port.) By default, connections are made using the Unix socket file. This option affects +stop +and +report +operations. +.TP 3n +\(bu +\fB\-\-user=\fR\fB\fIuser_name\fR\fR +.sp +The user name of the MySQL account to use when invoking +\fBmysqladmin\fR. +.TP 3n +\(bu +\fB\-\-verbose\fR +.sp +Be more verbose. +.TP 3n +\(bu +\fB\-\-version\fR +.sp +Display version information and exit. +.sp +.RE +.PP +Some notes about +\fBmysqld_multi\fR: +.TP 3n +\(bu +\fBMost important\fR: Before using +\fBmysqld_multi\fR +be sure that you understand the meanings of the options that are passed to the +\fBmysqld\fR +servers and +\fIwhy\fR +you would want to have separate +\fBmysqld\fR +processes. Beware of the dangers of using multiple +\fBmysqld\fR +servers with the same data directory. Use separate data directories, unless you +\fIknow\fR +what you are doing. Starting multiple servers with the same data directory does +\fInot\fR +give you extra performance in a threaded system. See +Section\ 5.6, \(lqRunning Multiple MySQL Servers on the Same Machine\(rq. +.TP 3n +\(bu +.sp +.it 1 an-trap +.nr an-no-space-flag 1 +.nr an-break-flag 1 +.br +\fBImportant\fR +Make sure that the data directory for each server is fully accessible to the Unix account that the specific +\fBmysqld\fR +process is started as. +\fIDo not\fR +use the Unix +\fIroot\fR +account for this, unless you +\fIknow\fR +what you are doing. See +Section\ 5.3.5, \(lqHow to Run MySQL as a Normal User\(rq. +.TP 3n +\(bu +Make sure that the MySQL account used for stopping the +\fBmysqld\fR +servers (with the +\fBmysqladmin\fR +program) has the same user name and password for each server. Also, make sure that the account has the +SHUTDOWN +privilege. If the servers that you want to manage have different user names or passwords for the administrative accounts, you might want to create an account on each server that has the same user name and password. For example, you might set up a common +multi_admin +account by executing the following commands for each server: +.sp +.RS 3n +.nf +shell> \fBmysql \-u root \-S /tmp/mysql.sock \-p\fR +Enter password: +mysql> \fBGRANT SHUTDOWN ON *.*\fR + \-> \fBTO 'multi_admin'@'localhost' IDENTIFIED BY 'multipass';\fR +.fi +.RE +See +Section\ 5.4, \(lqThe MySQL Access Privilege System\(rq. You have to do this for each +\fBmysqld\fR +server. Change the connection parameters appropriately when connecting to each one. Note that the host name part of the account name must allow you to connect as +multi_admin +from the host where you want to run +\fBmysqld_multi\fR. +.TP 3n +\(bu +The Unix socket file and the TCP/IP port number must be different for every +\fBmysqld\fR. (Alternatively, if the host has multiple network addresses, you can use +\fB\-\-bind\-address\fR +to cause different servers to listen to different interfaces.) +.TP 3n +\(bu +The +\fB\-\-pid\-file\fR +option is very important if you are using +\fBmysqld_safe\fR +to start +\fBmysqld\fR +(for example, +\fB\-\-mysqld=mysqld_safe\fR) Every +\fBmysqld\fR +should have its own process ID file. The advantage of using +\fBmysqld_safe\fR +instead of +\fBmysqld\fR +is that +\fBmysqld_safe\fR +monitors its +\fBmysqld\fR +process and restarts it if the process terminates due to a signal sent using +kill \-9 +or for other reasons, such as a segmentation fault. Please note that the +\fBmysqld_safe\fR +script might require that you start it from a certain place. This means that you might have to change location to a certain directory before running +\fBmysqld_multi\fR. If you have problems starting, please see the +\fBmysqld_safe\fR +script. Check especially the lines: +.sp +.RS 3n +.nf +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- +MY_PWD=`pwd` +# Check if we are starting this relative (for the binary release) +if test \-d $MY_PWD/data/mysql \-a \\ + \-f ./share/mysql/english/errmsg.sys \-a \\ + \-x ./bin/mysqld +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- +.fi +.RE +The test performed by these lines should be successful, or you might encounter problems. See +\fBmysqld_safe\fR(1). +.TP 3n +\(bu +You might want to use the +\fB\-\-user\fR +option for +\fBmysqld\fR, but to do this you need to run the +\fBmysqld_multi\fR +script as the Unix +root +user. Having the option in the option file doesn't matter; you just get a warning if you are not the superuser and the +\fBmysqld\fR +processes are started under your own Unix account. +.sp +.RE +.PP +The following example shows how you might set up an option file for use with +\fBmysqld_multi\fR. The order in which the +\fBmysqld\fR +programs are started or stopped depends on the order in which they appear in the option file. Group numbers need not form an unbroken sequence. The first and fifth +[mysqld\fIN\fR] +groups were intentionally omitted from the example to illustrate that you can have +\(lqgaps\(rq +in the option file. This gives you more flexibility. +.sp +.RS 3n +.nf +# This file should probably be in your home dir (~/.my.cnf) +# or /etc/my.cnf +# Version 2.1 by Jani Tolonen +[mysqld_multi] +mysqld = /usr/local/bin/mysqld_safe +mysqladmin = /usr/local/bin/mysqladmin +user = multi_admin +password = multipass +[mysqld2] +socket = /tmp/mysql.sock2 +port = 3307 +pid\-file = /usr/local/mysql/var2/hostname.pid2 +datadir = /usr/local/mysql/var2 +language = /usr/local/share/mysql/english +user = john +[mysqld3] +socket = /tmp/mysql.sock3 +port = 3308 +pid\-file = /usr/local/mysql/var3/hostname.pid3 +datadir = /usr/local/mysql/var3 +language = /usr/local/share/mysql/swedish +user = monty +[mysqld4] +socket = /tmp/mysql.sock4 +port = 3309 +pid\-file = /usr/local/mysql/var4/hostname.pid4 +datadir = /usr/local/mysql/var4 +language = /usr/local/share/mysql/estonia +user = tonu +[mysqld6] +socket = /tmp/mysql.sock6 +port = 3311 +pid\-file = /usr/local/mysql/var6/hostname.pid6 +datadir = /usr/local/mysql/var6 +language = /usr/local/share/mysql/japanese +user = jani +.fi +.RE +.PP +See +Section\ 4.2.3.2, \(lqUsing Option Files\(rq. +.SH "COPYRIGHT" +.PP +Copyright 2007\-2008 MySQL AB, 2009 Sun Microsystems, Inc. +.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/. +.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 +MySQL AB (http://www.mysql.com/). diff --git a/man/mysqld_safe.1 b/man/mysqld_safe.1 new file mode 100644 index 00000000000..19cb2ad979b --- /dev/null +++ b/man/mysqld_safe.1 @@ -0,0 +1,506 @@ +.\" Title: \fBmysqld_safe\fR +.\" Author: +.\" Generator: DocBook XSL Stylesheets v1.70.1 <http://docbook.sf.net/> +.\" Date: 03/31/2009 +.\" Manual: MySQL Database System +.\" Source: MySQL 5.1 +.\" +.TH "\fBMYSQLD_SAFE\fR" "1" "03/31/2009" "MySQL 5.1" "MySQL Database System" +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.SH "NAME" +mysqld_safe \- MySQL server startup script +.SH "SYNOPSIS" +.HP 20 +\fBmysqld_safe \fR\fB\fIoptions\fR\fR +.SH "DESCRIPTION" +.PP +\fBmysqld_safe\fR +is the recommended way to start a +\fBmysqld\fR +server on Unix and NetWare. +\fBmysqld_safe\fR +adds some safety features such as restarting the server when an error occurs and logging runtime information to an error log file. Descriptions of error logging and NetWare\-specific behaviors are given later in this section. +.sp +.it 1 an-trap +.nr an-no-space-flag 1 +.nr an-break-flag 1 +.br +\fBNote\fR +.PP +In MySQL 5.1.20 (only), the default error logging behavior with +\fBmysqld_safe\fR +is to write errors to +syslog +on systems that support the +\fBlogger\fR +program. This differs from the default behavior of writing an error log file for other versions. +.PP +\fBIn 5.1.20, logging to \fR\fBsyslog\fR\fB may fail to operate correctly in some cases, so we recommend that you use \fR\fB\fB\-\-skip\-syslog\fR\fR\fB to use the default log file or \fR\fB\fB\-\-log\-error=\fR\fB\fIfile_name\fR\fR\fR\fB to specify a log file name explicitly.\fR +.PP +\fBmysqld_safe\fR +tries to start an executable named +\fBmysqld\fR. To override the default behavior and specify explicitly the name of the server you want to run, specify a +\fB\-\-mysqld\fR +or +\fB\-\-mysqld\-version\fR +option to +\fBmysqld_safe\fR. You can also use +\fB\-\-ledir\fR +to indicate the directory where +\fBmysqld_safe\fR +should look for the server. +.PP +Many of the options to +\fBmysqld_safe\fR +are the same as the options to +\fBmysqld\fR. See +Section\ 5.1.2, \(lqServer Command Options\(rq. +.PP +All options specified to +\fBmysqld_safe\fR +on the command line are passed to +\fBmysqld\fR. If you want to use any options that are specific to +\fBmysqld_safe\fR +and that +\fBmysqld\fR +doesn't support, do not specify them on the command line. Instead, list them in the +[mysqld_safe] +group of an option file. See +Section\ 4.2.3.2, \(lqUsing Option Files\(rq. +.PP +\fBmysqld_safe\fR +reads all options from the +[mysqld], +[server], and +[mysqld_safe] +sections in option files. For example, if you specify a +[mysqld] +section like this, +\fBmysqld_safe\fR +will find and use the +\fB\-\-log\-error\fR +option: +.sp +.RS 3n +.nf +[mysqld] +log\-error=error.log +.fi +.RE +.PP +For backward compatibility, +\fBmysqld_safe\fR +also reads +[safe_mysqld] +sections, although you should rename such sections to +[mysqld_safe] +in MySQL 5.1 installations. +.PP +\fBmysqld_safe\fR +supports the following options: +.TP 3n +\(bu +\fB\-\-help\fR +.sp +Display a help message and exit. +.TP 3n +\(bu +\fB\-\-autoclose\fR +.sp +(NetWare only) On NetWare, +\fBmysqld_safe\fR +provides a screen presence. When you unload (shut down) the +\fBmysqld_safe\fR +NLM, the screen does not by default go away. Instead, it prompts for user input: +.sp +.RS 3n +.nf +*<NLM has terminated; Press any key to close the screen>* +.fi +.RE +If you want NetWare to close the screen automatically instead, use the +\fB\-\-autoclose\fR +option to +\fBmysqld_safe\fR. +.TP 3n +\(bu +\fB\-\-basedir=\fR\fB\fIpath\fR\fR +.sp +The path to the MySQL installation directory. +.TP 3n +\(bu +\fB\-\-core\-file\-size=\fR\fB\fIsize\fR\fR +.sp +The size of the core file that +\fBmysqld\fR +should be able to create. The option value is passed to +\fBulimit \-c\fR. +.TP 3n +\(bu +\fB\-\-datadir=\fR\fB\fIpath\fR\fR +.sp +The path to the data directory. +.TP 3n +\(bu +\fB\-\-defaults\-extra\-file=\fR\fB\fIpath\fR\fR +.sp +The name of an option file to be read in addition to the usual option files. This must be the first option on the command line if it is used. If the file does not exist or is otherwise inaccessible, the server will exit with an error. +.TP 3n +\(bu +\fB\-\-defaults\-file=\fR\fB\fIfile_name\fR\fR +.sp +The name of an option file to be read instead of the usual option files. This must be the first option on the command line if it is used. +.TP 3n +\(bu +\fB\-\-ledir=\fR\fB\fIpath\fR\fR +.sp +If +\fBmysqld_safe\fR +cannot find the server, use this option to indicate the path name to the directory where the server is located. +.TP 3n +\(bu +\fB\-\-log\-error=\fR\fB\fIfile_name\fR\fR +.sp +Write the error log to the given file. See +Section\ 5.2.2, \(lqThe Error Log\(rq. +.TP 3n +\(bu +\fB\-\-mysqld=\fR\fB\fIprog_name\fR\fR +.sp +The name of the server program (in the +ledir +directory) that you want to start. This option is needed if you use the MySQL binary distribution but have the data directory outside of the binary distribution. If +\fBmysqld_safe\fR +cannot find the server, use the +\fB\-\-ledir\fR +option to indicate the path name to the directory where the server is located. +.TP 3n +\(bu +\fB\-\-mysqld\-version=\fR\fB\fIsuffix\fR\fR +.sp +This option is similar to the +\fB\-\-mysqld\fR +option, but you specify only the suffix for the server program name. The basename is assumed to be +\fBmysqld\fR. For example, if you use +\fB\-\-mysqld\-version=debug\fR, +\fBmysqld_safe\fR +starts the +\fBmysqld\-debug\fR +program in the +ledir +directory. If the argument to +\fB\-\-mysqld\-version\fR +is empty, +\fBmysqld_safe\fR +uses +\fBmysqld\fR +in the +ledir +directory. +.TP 3n +\(bu +\fB\-\-nice=\fR\fB\fIpriority\fR\fR +.sp +Use the +nice +program to set the server's scheduling priority to the given value. +.TP 3n +\(bu +\fB\-\-no\-defaults\fR +.sp +Do not read any option files. This must be the first option on the command line if it is used. +.TP 3n +\(bu +\fB\-\-open\-files\-limit=\fR\fB\fIcount\fR\fR +.sp +The number of files that +\fBmysqld\fR +should be able to open. The option value is passed to +\fBulimit \-n\fR. Note that you need to start +\fBmysqld_safe\fR +as +root +for this to work properly! +.TP 3n +\(bu +\fB\-\-pid\-file=\fR\fB\fIfile_name\fR\fR +.sp +The path name of the process ID file. +.TP 3n +\(bu +\fB\-\-port=\fR\fB\fIport_num\fR\fR +.sp +The port number that the server should use when listening for TCP/IP connections. The port number must be 1024 or higher unless the server is started by the +root +system user. +.TP 3n +\(bu +\fB\-\-skip\-kill\-mysqld\fR +.sp +Do not try to kill stray +\fBmysqld\fR +processes at startup. This option works only on Linux. +.TP 3n +\(bu +\fB\-\-socket=\fR\fB\fIpath\fR\fR +.sp +The Unix socket file that the server should use when listening for local connections. +.TP 3n +\(bu +\fB\-\-syslog\fR, +\fB\-\-skip\-syslog\fR +.sp +\fB\-\-syslog\fR +causes error messages to be sent to +syslog +on systems that support the +\fBlogger\fR +program. +\-\-skip\-syslog +suppresses the use of +syslog; messages are written to an error log file. These options were added in MySQL 5.1.20. +.TP 3n +\(bu +\fB\-\-syslog\-tag=\fR\fB\fItag\fR\fR +.sp +For logging to +syslog, messages from +\fBmysqld_safe\fR +and +\fBmysqld\fR +are written with a tag of +mysqld_safe +and +mysqld, respectively. To specify a suffix for the tag, use +\fB\-\-syslog\-tag=\fR\fB\fItag\fR\fR, which modifies the tags to be +mysqld_safe\-\fItag\fR +and +mysqld\-\fItag\fR. This option was added in MySQL 5.1.21. +.TP 3n +\(bu +\fB\-\-timezone=\fR\fB\fItimezone\fR\fR +.sp +Set the +TZ +time zone environment variable to the given option value. Consult your operating system documentation for legal time zone specification formats. +.TP 3n +\(bu +\fB\-\-user={\fR\fB\fIuser_name\fR\fR\fB|\fR\fB\fIuser_id\fR\fR\fB}\fR +.sp +Run the +\fBmysqld\fR +server as the user having the name +\fIuser_name\fR +or the numeric user ID +\fIuser_id\fR. (\(lqUser\(rq +in this context refers to a system login account, not a MySQL user listed in the grant tables.) +.sp +.RE +.PP +If you execute +\fBmysqld_safe\fR +with the +\fB\-\-defaults\-file\fR +or +\fB\-\-defaults\-extra\-file\fR +option to name an option file, the option must be the first one given on the command line or the option file will not be used. For example, this command will not use the named option file: +.sp +.RS 3n +.nf +mysql> \fBmysqld_safe \-\-port=\fR\fB\fIport_num\fR\fR\fB \-\-defaults\-file=\fR\fB\fIfile_name\fR\fR +.fi +.RE +.PP +Instead, use the following command: +.sp +.RS 3n +.nf +mysql> \fBmysqld_safe \-\-defaults\-file=\fR\fB\fIfile_name\fR\fR\fB \-\-port=\fR\fB\fIport_num\fR\fR +.fi +.RE +.PP +The +\fBmysqld_safe\fR +script is written so that it normally can start a server that was installed from either a source or a binary distribution of MySQL, even though these types of distributions typically install the server in slightly different locations. (See +Section\ 2.1.5, \(lqInstallation Layouts\(rq.) +\fBmysqld_safe\fR +expects one of the following conditions to be true: +.TP 3n +\(bu +The server and databases can be found relative to the working directory (the directory from which +\fBmysqld_safe\fR +is invoked). For binary distributions, +\fBmysqld_safe\fR +looks under its working directory for +\fIbin\fR +and +\fIdata\fR +directories. For source distributions, it looks for +\fIlibexec\fR +and +\fIvar\fR +directories. This condition should be met if you execute +\fBmysqld_safe\fR +from your MySQL installation directory (for example, +\fI/usr/local/mysql\fR +for a binary distribution). +.TP 3n +\(bu +If the server and databases cannot be found relative to the working directory, +\fBmysqld_safe\fR +attempts to locate them by absolute path names. Typical locations are +\fI/usr/local/libexec\fR +and +\fI/usr/local/var\fR. The actual locations are determined from the values configured into the distribution at the time it was built. They should be correct if MySQL is installed in the location specified at configuration time. +.sp +.RE +.PP +Because +\fBmysqld_safe\fR +tries to find the server and databases relative to its own working directory, you can install a binary distribution of MySQL anywhere, as long as you run +\fBmysqld_safe\fR +from the MySQL installation directory: +.sp +.RS 3n +.nf +shell> \fBcd \fR\fB\fImysql_installation_directory\fR\fR +shell> \fBbin/mysqld_safe &\fR +.fi +.RE +.PP +If +\fBmysqld_safe\fR +fails, even when invoked from the MySQL installation directory, you can specify the +\fB\-\-ledir\fR +and +\fB\-\-datadir\fR +options to indicate the directories in which the server and databases are located on your system. +.PP +When you use +\fBmysqld_safe\fR +to start +\fBmysqld\fR, +\fBmysqld_safe\fR +arranges for error (and notice) messages from itself and from +\fBmysqld\fR +to go to the same destination. +.PP +As of MySQL 5.1.20, there are several +\fBmysqld_safe\fR +options for controlling the destination of these messages: +.TP 3n +\(bu +\fB\-\-syslog\fR: Write error messages to +syslog +on systems that support the +\fBlogger\fR +program. +.TP 3n +\(bu +\fB\-\-skip\-syslog\fR: Do not write error messages to +syslog. Messages are written to the default error log file (\fI\fIhost_name\fR\fR\fI.err\fR +in the data directory), or to a named file if the +\fB\-\-log\-error\fR +option is given. +.TP 3n +\(bu +\fB\-\-log\-error=\fR\fB\fIfile_name\fR\fR: Write error messages to the named error file. +.sp +.RE +.PP +If none of these options is given, the default is +\fB\-\-skip\-syslog\fR. +.sp +.it 1 an-trap +.nr an-no-space-flag 1 +.nr an-break-flag 1 +.br +\fBNote\fR +.PP +In MySQL 5.1.20 +\fIonly\fR, the default is +\fB\-\-syslog\fR. This differs from logging behavior for other versions of MySQL, for which the default is to write messages to the default error log file. +.PP +If +\fB\-\-syslog\fR +and +\fB\-\-log\-error\fR +are both given, a warning is issued and +\fB\-\-log\-error\fR +takes precedence. +.PP +When +\fBmysqld_safe\fR +writes a message, notices go to the logging destination (syslog +or the error log file) and +stdout. Errors go to the logging destination and +stderr. +.PP +Before MySQL 5.1.20, error logging is controlled only with the +\fB\-\-log\-error\fR +option. If it is given, messages go to the named error file. Otherwise, messages go to the default error file. +.PP +Normally, you should not edit the +\fBmysqld_safe\fR +script. Instead, configure +\fBmysqld_safe\fR +by using command\-line options or options in the +[mysqld_safe] +section of a +\fImy.cnf\fR +option file. In rare cases, it might be necessary to edit +\fBmysqld_safe\fR +to get it to start the server properly. However, if you do this, your modified version of +\fBmysqld_safe\fR +might be overwritten if you upgrade MySQL in the future, so you should make a copy of your edited version that you can reinstall. +.PP +On NetWare, +\fBmysqld_safe\fR +is a NetWare Loadable Module (NLM) that is ported from the original Unix shell script. It starts the server as follows: +.TP 3n +1. +Runs a number of system and option checks. +.TP 3n +2. +Runs a check on +MyISAM +tables. +.TP 3n +3. +Provides a screen presence for the MySQL server. +.TP 3n +4. +Starts +\fBmysqld\fR, monitors it, and restarts it if it terminates in error. +.TP 3n +5. +Sends error messages from +\fBmysqld\fR +to the +\fI\fIhost_name\fR\fR\fI.err\fR +file in the data directory. +.TP 3n +6. +Sends +\fBmysqld_safe\fR +screen output to the +\fI\fIhost_name\fR\fR\fI.safe\fR +file in the data directory. +.SH "COPYRIGHT" +.PP +Copyright 2007\-2008 MySQL AB, 2009 Sun Microsystems, Inc. +.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/. +.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 +MySQL AB (http://www.mysql.com/). diff --git a/man/mysqldump.1 b/man/mysqldump.1 new file mode 100644 index 00000000000..e390c1639bb --- /dev/null +++ b/man/mysqldump.1 @@ -0,0 +1,1250 @@ +.\" Title: \fBmysqldump\fR +.\" Author: +.\" Generator: DocBook XSL Stylesheets v1.70.1 <http://docbook.sf.net/> +.\" Date: 03/31/2009 +.\" Manual: MySQL Database System +.\" Source: MySQL 5.1 +.\" +.TH "\fBMYSQLDUMP\fR" "1" "03/31/2009" "MySQL 5.1" "MySQL Database System" +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.SH "NAME" +mysqldump \- a database backup program +.SH "SYNOPSIS" +.HP 45 +\fBmysqldump [\fR\fB\fIoptions\fR\fR\fB] [\fR\fB\fIdb_name\fR\fR\fB [\fR\fB\fItbl_name\fR\fR\fB ...]]\fR +.SH "DESCRIPTION" +.PP +The +\fBmysqldump\fR +client is a backup program originally written by Igor Romanenko. It can be used to dump a database or a collection of databases for backup or transfer to another SQL server (not necessarily a MySQL server). The dump typically contains SQL statements to create the table, populate it, or both. However, +\fBmysqldump\fR +can also be used to generate files in CSV, other delimited text, or XML format. +.PP +If you are doing a backup on the server and your tables all are +MyISAM +tables, consider using the +\fBmysqlhotcopy\fR +instead because it can accomplish faster backups and faster restores. See +\fBmysqlhotcopy\fR(1). +.PP +There are three general ways to invoke +\fBmysqldump\fR: +.sp +.RS 3n +.nf +shell> \fBmysqldump [\fR\fB\fIoptions\fR\fR\fB] \fR\fB\fIdb_name\fR\fR\fB [\fR\fB\fItables\fR\fR\fB]\fR +shell> \fBmysqldump [\fR\fB\fIoptions\fR\fR\fB] \-\-databases \fR\fB\fIdb_name1\fR\fR\fB [\fR\fB\fIdb_name2\fR\fR\fB \fR\fB\fIdb_name3\fR\fR\fB...]\fR +shell> \fBmysqldump [\fR\fB\fIoptions\fR\fR\fB] \-\-all\-databases\fR +.fi +.RE +.PP +If you do not name any tables following +\fIdb_name\fR +or if you use the +\fB\-\-databases\fR +or +\fB\-\-all\-databases\fR +option, entire databases are dumped. +.PP +\fBmysqldump\fR +does not dump the +INFORMATION_SCHEMA +database. If you name that database explicitly on the command line, +\fBmysqldump\fR +silently ignores it. +.PP +To get a list of the options your version of +\fBmysqldump\fR +supports, execute +\fBmysqldump \-\-help\fR. +.PP +Some +\fBmysqldump\fR +options are shorthand for groups of other options. +\fB\-\-opt\fR +and +\fB\-\-compact\fR +fall into this category. For example, use of +\fB\-\-opt\fR +is the same as specifying +\fB\-\-add\-drop\-table\fR +\fB\-\-add\-locks\fR +\fB\-\-create\-options\fR +\fB\-\-disable\-keys\fR +\fB\-\-extended\-insert\fR +\fB\-\-lock\-tables\fR +\fB\-\-quick\fR +\fB\-\-set\-charset\fR. Note that all of the options that +\fB\-\-opt\fR +stands for also are on by default because +\fB\-\-opt\fR +is on by default. +.PP +To reverse the effect of a group option, uses its +\fB\-\-skip\-\fR\fB\fIxxx\fR\fR +form (\fB\-\-skip\-opt\fR +or +\fB\-\-skip\-compact\fR). It is also possible to select only part of the effect of a group option by following it with options that enable or disable specific features. Here are some examples: +.TP 3n +\(bu +To select the effect of +\fB\-\-opt\fR +except for some features, use the +\fB\-\-skip\fR +option for each feature. For example, to disable extended inserts and memory buffering, use +\fB\-\-opt\fR +\fB\-\-skip\-extended\-insert\fR +\fB\-\-skip\-quick\fR. (As of MySQL 5.1, +\fB\-\-skip\-extended\-insert\fR +\fB\-\-skip\-quick\fR +is sufficient because +\fB\-\-opt\fR +is on by default.) +.TP 3n +\(bu +To reverse +\fB\-\-opt\fR +for all features except index disabling and table locking, use +\fB\-\-skip\-opt\fR +\fB\-\-disable\-keys\fR +\fB\-\-lock\-tables\fR. +.sp +.RE +.PP +When you selectively enable or disable the effect of a group option, order is important because options are processed first to last. For example, +\fB\-\-disable\-keys\fR +\fB\-\-lock\-tables\fR +\fB\-\-skip\-opt\fR +would not have the intended effect; it is the same as +\fB\-\-skip\-opt\fR +by itself. +.PP +\fBmysqldump\fR +can retrieve and dump table contents row by row, or it can retrieve the entire content from a table and buffer it in memory before dumping it. Buffering in memory can be a problem if you are dumping large tables. To dump tables row by row, use the +\fB\-\-quick\fR +option (or +\fB\-\-opt\fR, which enables +\fB\-\-quick\fR). The +\fB\-\-opt\fR +option (and hence +\fB\-\-quick\fR) is enabled by default in MySQL 5.1; to enable memory buffering, use +\fB\-\-skip\-quick\fR. +.PP +If you are using a recent version of +\fBmysqldump\fR +to generate a dump to be reloaded into a very old MySQL server, you should not use the +\fB\-\-opt\fR +or +\fB\-\-extended\-insert\fR +option. Use +\fB\-\-skip\-opt\fR +instead. +.sp +.it 1 an-trap +.nr an-no-space-flag 1 +.nr an-break-flag 1 +.br +\fBNote\fR +.PP +\fBmysqldump\fR +from the MySQL 5.1.21 distribution cannot be used to create dumps from MySQL server versions 5.1.20 and older. This issue is fixed in MySQL 5.1.22. ([1]\&\fIBug#30123\fR) +.PP +\fBmysqldump\fR +supports the following options: +.TP 3n +\(bu +\fB\-\-help\fR, +\fB\-?\fR +.sp +Display a help message and exit. +.TP 3n +\(bu +\fB\-\-add\-drop\-database\fR +.sp +Add a +DROP DATABASE +statement before each +CREATE DATABASE +statement. +.TP 3n +\(bu +\fB\-\-add\-drop\-table\fR +.sp +Add a +DROP TABLE +statement before each +CREATE TABLE +statement. +.TP 3n +\(bu +\fB\-\-add\-locks\fR +.sp +Surround each table dump with +LOCK TABLES +and +UNLOCK TABLES +statements. This results in faster inserts when the dump file is reloaded. See +Section\ 7.2.20, \(lqSpeed of INSERT Statements\(rq. +.TP 3n +\(bu +\fB\-\-all\-databases\fR, +\fB\-A\fR +.sp +Dump all tables in all databases. This is the same as using the +\fB\-\-databases\fR +option and naming all the databases on the command line. +.TP 3n +\(bu +\fB\-\-all\-tablespaces\fR, +\fB\-Y\fR +.sp +Adds to a table dump all SQL statements needed to create any tablespaces used by an +NDBCLUSTER +table. This information is not otherwise included in the output from +\fBmysqldump\fR. This option is currently relevant only to MySQL Cluster tables. +.sp +This option was added in MySQL 5.1.6. +.TP 3n +\(bu +\fB\-\-allow\-keywords\fR +.sp +Allow creation of column names that are keywords. This works by prefixing each column name with the table name. +.TP 3n +\(bu +\fB\-\-character\-sets\-dir=\fR\fB\fIpath\fR\fR +.sp +The directory where character sets are installed. See +Section\ 9.2, \(lqThe Character Set Used for Data and Sorting\(rq. +.TP 3n +\(bu +\fB\-\-comments\fR, +\fB\-i\fR +.sp +Write additional information in the dump file such as program version, server version, and host. This option is enabled by default. To suppress this additional information, use +\fB\-\-skip\-comments\fR. +.TP 3n +\(bu +\fB\-\-compact\fR +.sp +Produce less verbose output. This option enables the +\fB\-\-skip\-add\-drop\-table\fR, +\fB\-\-skip\-add\-locks\fR, +\fB\-\-skip\-comments\fR, +\fB\-\-skip\-disable\-keys\fR, and +\fB\-\-skip\-set\-charset\fR +options. +.sp +.it 1 an-trap +.nr an-no-space-flag 1 +.nr an-break-flag 1 +.br +\fBNote\fR +Prior to release 5.1.21, this option did not create valid SQL if the database dump contained views. The recreation of views requires the creation and removal of temporary tables and this option suppressed the removal of those temporary tables. As a workaround, use +\fB\-\-compact\fR +with the +\fB\-\-add\-drop\-table\fR +option and then manually adjust the dump file. +.TP 3n +\(bu +\fB\-\-compatible=\fR\fB\fIname\fR\fR +.sp +Produce output that is more compatible with other database systems or with older MySQL servers. The value of +name +can be +ansi, +mysql323, +mysql40, +postgresql, +oracle, +mssql, +db2, +maxdb, +no_key_options, +no_table_options, or +no_field_options. To use several values, separate them by commas. These values have the same meaning as the corresponding options for setting the server SQL mode. See +Section\ 5.1.7, \(lqServer SQL Modes\(rq. +.sp +This option does not guarantee compatibility with other servers. It only enables those SQL mode values that are currently available for making dump output more compatible. For example, +\fB\-\-compatible=oracle\fR +does not map data types to Oracle types or use Oracle comment syntax. +.sp +\fIThis option requires a server version of 4.1.0 or higher\fR. With older servers, it does nothing. +.TP 3n +\(bu +\fB\-\-complete\-insert\fR, +\fB\-c\fR +.sp +Use complete +INSERT +statements that include column names. +.TP 3n +\(bu +\fB\-\-compress\fR, +\fB\-C\fR +.sp +Compress all information sent between the client and the server if both support compression. +.TP 3n +\(bu +\fB\-\-create\-options\fR +.sp +Include all MySQL\-specific table options in the +CREATE TABLE +statements. +.TP 3n +\(bu +\fB\-\-databases\fR, +\fB\-B\fR +.sp +Dump several databases. Normally, +\fBmysqldump\fR +treats the first name argument on the command line as a database name and following names as table names. With this option, it treats all name arguments as database names. +CREATE DATABASE +and +USE +statements are included in the output before each new database. +.TP 3n +\(bu +\fB\-\-debug[=\fR\fB\fIdebug_options\fR\fR\fB]\fR, +\fB\-# [\fR\fB\fIdebug_options\fR\fR\fB]\fR +.sp +Write a debugging log. The +\fIdebug_options\fR +string is often +\'d:t:o,\fIfile_name\fR'. The default value is +\'d:t:o,/tmp/mysqldump.trace'. +.TP 3n +\(bu +\fB\-\-debug\-check\fR +.sp +Print some debugging information when the program exits. This option was added in MySQL 5.1.21. +.TP 3n +\(bu +\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. +.TP 3n +\(bu +\fB\-\-default\-character\-set=\fR\fB\fIcharset_name\fR\fR +.sp +Use +\fIcharset_name\fR +as the default character set. See +Section\ 9.2, \(lqThe Character Set Used for Data and Sorting\(rq. If no character set is specified, +\fBmysqldump\fR +uses +utf8, and earlier versions use +latin1. +.sp +This option has no effect for output data files produced by using the +\fB\-\-tab\fR +option. See the description for that option. +.TP 3n +\(bu +\fB\-\-delayed\-insert\fR +.sp +Write +INSERT DELAYED +statements rather than +INSERT +statements. +.TP 3n +\(bu +\fB\-\-delete\-master\-logs\fR +.sp +On a master replication server, delete the binary logs after performing the dump operation. This option automatically enables +\fB\-\-master\-data\fR. +.TP 3n +\(bu +\fB\-\-disable\-keys\fR, +\fB\-K\fR +.sp +For each table, surround the +INSERT +statements with +/*!40000 ALTER TABLE \fItbl_name\fR DISABLE KEYS */; +and +/*!40000 ALTER TABLE \fItbl_name\fR ENABLE KEYS */; +statements. This makes loading the dump file faster because the indexes are created after all rows are inserted. This option is effective only for non\-unique indexes of +MyISAM +tables. +.TP 3n +\(bu +\fB\-\-dump\-date\fR +.sp +\fBmysqldump\fR +produces a +\-\- Dump completed on \fIDATE\fR +comment at the end of the dump if the +\fB\-\-comments\fR +option is given. However, the date causes dump files for identical data take at different times to appear to be different. +\fB\-\-dump\-date\fR +and +\fB\-\-skip\-dump\-date\fR +control whether the date is added to the comment. The default is +\fB\-\-dump\-date\fR +(include the date in the comment). +\fB\-\-skip\-dump\-date\fR +suppresses date printing. This option was added in MySQL 5.1.23. +.TP 3n +\(bu +\fB\-\-events\fR, +\fB\-E\fR +.sp +Dump events from the dumped databases. This option was added in MySQL 5.1.8. +.TP 3n +\(bu +\fB\-\-extended\-insert\fR, +\fB\-e\fR +.sp +Use multiple\-row +INSERT +syntax that include several +VALUES +lists. This results in a smaller dump file and speeds up inserts when the file is reloaded. +.TP 3n +\(bu +\fB\-\-fields\-terminated\-by=...\fR, +\fB\-\-fields\-enclosed\-by=...\fR, +\fB\-\-fields\-optionally\-enclosed\-by=...\fR, +\fB\-\-fields\-escaped\-by=...\fR +.sp +These options are used with the +\fB\-T\fR +option and have the same meaning as the corresponding clauses for +LOAD DATA INFILE. See +Section\ 12.2.6, \(lqLOAD DATA INFILE Syntax\(rq. +.TP 3n +\(bu +\fB\-\-first\-slave\fR, +\fB\-x\fR +.sp +Deprecated. Now renamed to +\fB\-\-lock\-all\-tables\fR. +.TP 3n +\(bu +\fB\-\-flush\-logs\fR, +\fB\-F\fR +.sp +Flush the MySQL server log files before starting the dump. This option requires the +RELOAD +privilege. Note that if you use this option in combination with the +\fB\-\-all\-databases\fR +(or +\fB\-A\fR) option, the logs are flushed +\fIfor each database dumped\fR. The exception is when using +\fB\-\-lock\-all\-tables\fR +or +\fB\-\-master\-data\fR: In this case, the logs are flushed only once, corresponding to the moment that all tables are locked. If you want your dump and the log flush to happen at exactly the same moment, you should use +\fB\-\-flush\-logs\fR +together with either +\fB\-\-lock\-all\-tables\fR +or +\fB\-\-master\-data\fR. +.TP 3n +\(bu +\fB\-\-flush\-privileges\fR +.sp +Emit a +FLUSH PRIVILEGES +statement after dumping the +mysql +database. This option should be used any time the dump contains the +mysql +database and any other database that depends on the data in the +mysql +database for proper restoration. This option was added in MySQL 5.1.12. +.TP 3n +\(bu +\fB\-\-force\fR, +\fB\-f\fR +.sp +Continue even if an SQL error occurs during a table dump. +.sp +One use for this option is to cause +\fBmysqldump\fR +to continue executing even when it encounters a view that has become invalid because the definition refers to a table that has been dropped. Without +\fB\-\-force\fR, +\fBmysqldump\fR +exits with an error message. With +\fB\-\-force\fR, +\fBmysqldump\fR +prints the error message, but it also writes an SQL comment containing the view definition to the dump output and continues executing. +.TP 3n +\(bu +\fB\-\-host=\fR\fB\fIhost_name\fR\fR, +\fB\-h \fR\fB\fIhost_name\fR\fR +.sp +Dump data from the MySQL server on the given host. The default host is +localhost. +.TP 3n +\(bu +\fB\-\-hex\-blob\fR +.sp +Dump binary columns using hexadecimal notation (for example, +\'abc' +becomes +0x616263). The affected data types are +BINARY, +VARBINARY, +BLOB, and +BIT. +.TP 3n +\(bu +\fB\-\-ignore\-table=\fR\fB\fIdb_name.tbl_name\fR\fR +.sp +Do not dump the given table, which must be specified using both the database and table names. To ignore multiple tables, use this option multiple times. This option also can be used to ignore views. +.TP 3n +\(bu +\fB\-\-insert\-ignore\fR +.sp +Write +INSERT +statements with the +IGNORE +option. +.TP 3n +\(bu +\fB\-\-lines\-terminated\-by=...\fR +.sp +This option is used with the +\fB\-T\fR +option and has the same meaning as the corresponding clause for +LOAD DATA INFILE. See +Section\ 12.2.6, \(lqLOAD DATA INFILE Syntax\(rq. +.TP 3n +\(bu +\fB\-\-lock\-all\-tables\fR, +\fB\-x\fR +.sp +Lock all tables across all databases. This is achieved by acquiring a global read lock for the duration of the whole dump. This option automatically turns off +\fB\-\-single\-transaction\fR +and +\fB\-\-lock\-tables\fR. +.TP 3n +\(bu +\fB\-\-lock\-tables\fR, +\fB\-l\fR +.sp +Lock all tables before dumping them. The tables are locked with +READ LOCAL +to allow concurrent inserts in the case of +MyISAM +tables. For transactional tables such as +InnoDB +and +BDB, +\fB\-\-single\-transaction\fR +is a much better option, because it does not need to lock the tables at all. +.sp +Please note that when dumping multiple databases, +\fB\-\-lock\-tables\fR +locks tables for each database separately. Therefore, this option does not guarantee that the tables in the dump file are logically consistent between databases. Tables in different databases may be dumped in completely different states. +.TP 3n +\(bu +\fB\-\-log\-error=\fR\fB\fIfile_name\fR\fR +.sp +Append warnings and errors to the named file. This option was added in MySQL 5.1.18. +.TP 3n +\(bu +\fB\-\-master\-data[=\fR\fB\fIvalue\fR\fR\fB]\fR +.sp +Use this option to dump a master replication server to produce a dump file that can be used to set up another server as a slave of the master. It causes the dump output to include a +CHANGE MASTER TO +statement that indicates the binary log coordinates (file name and position) of the dumped server. These are the master server coordinates from which the slave should start replicating. +.sp +If the option value is 2, the +CHANGE MASTER TO +statement is written as an SQL comment, and thus is informative only; it has no effect when the dump file is reloaded. If the option value is 1, the statement takes effect when the dump file is reloaded. If the option value is not specified, the default value is 1. +.sp +This option requires the +RELOAD +privilege and the binary log must be enabled. +.sp +The +\fB\-\-master\-data\fR +option automatically turns off +\fB\-\-lock\-tables\fR. It also turns on +\fB\-\-lock\-all\-tables\fR, unless +\fB\-\-single\-transaction\fR +also is specified, in which case, a global read lock is acquired only for a short time at the beginning of the dump (see the description for +\fB\-\-single\-transaction\fR). In all cases, any action on logs happens at the exact moment of the dump. +.sp +It is also possible to set up a slave by dumping an existing slave of the master. To do this, use the following procedure on the existing slave: +.RS 3n +.TP 3n +1. +Stop the slave's SQL thread and get its current status: +.sp +.RS 3n +.nf +mysql> \fBSTOP SLAVE SQL_THREAD;\fR +mysql> \fBSHOW SLAVE STATUS;\fR +.fi +.RE +.TP 3n +2. +From the output of the SHOW SLAVE STATUS statement, get the binary log coordinates of the master server from which the new slave should start replicating. These coordinates are the values of the Relay_Master_Log_File and Exec_Master_Log_Pos values. Denote those values as file_name and file_pos. +.TP 3n +3. +Dump the slave server: +.sp +.RS 3n +.nf +shell> \fBmysqldump \-\-master\-data=2 \-\-all\-databases > dumpfile\fR +.fi +.RE +.TP 3n +4. +Restart the slave: +.sp +.RS 3n +.nf +mysql> \fBSTART SLAVE;\fR +.fi +.RE +.TP 3n +5. +On the new slave, reload the dump file: +.sp +.RS 3n +.nf +shell> \fBmysql < dumpfile\fR +.fi +.RE +.TP 3n +6. +On the new slave, set the replication coordinates to those of the master server obtained earlier: +.sp +.RS 3n +.nf +mysql> \fBCHANGE MASTER TO\fR + \-> \fBMASTER_LOG_FILE = 'file_name', MASTER_LOG_POS = file_pos;\fR +.fi +.RE +The +CHANGE MASTER TO +statement might also need other parameters, such as +MASTER_HOST +to point the slave to the correct master server host. Add any such parameters as necessary. +.RE +.TP 3n +\(bu +\fB\-\-no\-autocommit\fR +.sp +Enclose the +INSERT +statements for each dumped table within +SET autocommit = 0 +and +COMMIT +statements. +.TP 3n +\(bu +\fB\-\-no\-create\-db\fR, +\fB\-n\fR +.sp +This option suppresses the +CREATE DATABASE +statements that are otherwise included in the output if the +\fB\-\-databases\fR +or +\fB\-\-all\-databases\fR +option is given. +.TP 3n +\(bu +\fB\-\-no\-create\-info\fR, +\fB\-t\fR +.sp +Do not write +CREATE TABLE +statements that re\-create each dumped table. +.TP 3n +\(bu +\fB\-\-no\-data\fR, +\fB\-d\fR +.sp +Do not write any table row information (that is, do not dump table contents). This is very useful if you want to dump only the +CREATE TABLE +statement for the table. +.TP 3n +\(bu +\fB\-\-opt\fR +.sp +This option is shorthand; it is the same as specifying +\fB\-\-add\-drop\-table\fR +\fB\-\-add\-locks\fR +\fB\-\-create\-options\fR +\fB\-\-disable\-keys\fR +\fB\-\-extended\-insert\fR +\fB\-\-lock\-tables\fR +\fB\-\-quick\fR +\fB\-\-set\-charset\fR. It should give you a fast dump operation and produce a dump file that can be reloaded into a MySQL server quickly. +.sp +\fIThe \fR\fI\fB\-\-opt\fR\fR\fI option is enabled by default. Use \fR\fI\fB\-\-skip\-opt\fR\fR\fI to disable it.\fR +See the discussion at the beginning of this section for information about selectively enabling or disabling certain of the options affected by +\fB\-\-opt\fR. +.TP 3n +\(bu +\fB\-\-order\-by\-primary\fR +.sp +Sorts each table's rows by its primary key, or by its first unique index, if such an index exists. This is useful when dumping a +MyISAM +table to be loaded into an +InnoDB +table, but will make the dump itself take considerably longer. +.TP 3n +\(bu +\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, you are prompted for one. +.sp +Specifying a password on the command line should be considered insecure. See +Section\ 5.5.6.2, \(lqEnd\-User Guidelines for Password Security\(rq. +.TP 3n +\(bu +\fB\-\-pipe\fR, +\fB\-W\fR +.sp +On Windows, connect to the server via a named pipe. This option applies only for connections to a local server, and only if the server supports named\-pipe connections. +.TP 3n +\(bu +\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. +.TP 3n +\(bu +\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 allowable values, see +Section\ 4.2.2, \(lqConnecting to the MySQL Server\(rq. +.TP 3n +\(bu +\fB\-\-quick\fR, +\fB\-q\fR +.sp +This option is useful for dumping large tables. It forces +\fBmysqldump\fR +to retrieve rows for a table from the server a row at a time rather than retrieving the entire row set and buffering it in memory before writing it out. +.TP 3n +\(bu +\fB\-\-quote\-names\fR, +\fB\-Q\fR +.sp +Quote database, table, and column names within +\(lq`\(rq +characters. If the +ANSI_QUOTES +SQL mode is enabled, names are quoted within +\(lq"\(rq +characters. This option is enabled by default. It can be disabled with +\fB\-\-skip\-quote\-names\fR, but this option should be given after any option such as +\fB\-\-compatible\fR +that may enable +\fB\-\-quote\-names\fR. +.TP 3n +\(bu +\fB\-\-replace\fR +.sp +Write +REPLACE +statements rather than +INSERT +statements. Available as of MySQL 5.1.3. +.TP 3n +\(bu +\fB\-\-result\-file=\fR\fB\fIfile_name\fR\fR, +\fB\-r \fR\fB\fIfile_name\fR\fR +.sp +Direct output to a given file. This option should be used on Windows to prevent newline +\(lq\\n\(rq +characters from being converted to +\(lq\\r\\n\(rq +carriage return/newline sequences. The result file is created and its contents overwritten, even if an error occurs while generating the dump. The previous contents are lost. +.TP 3n +\(bu +\fB\-\-routines\fR, +\fB\-R\fR +.sp +Dump stored routines (procedures and functions) from the dumped databases. Use of this option requires the +SELECT +privilege for the +mysql.proc +table. The output generated by using +\fB\-\-routines\fR +contains +CREATE PROCEDURE +and +CREATE FUNCTION +statements to re\-create the routines. However, these statements do not include attributes such as the routine creation and modification timestamps. This means that when the routines are reloaded, they will be created with the timestamps equal to the reload time. +.sp +If you require routines to be re\-created with their original timestamp attributes, do not use +\fB\-\-routines\fR. Instead, dump and reload the contents of the +mysql.proc +table directly, using a MySQL account that has appropriate privileges for the +mysql +database. +.sp +This option was added in MySQL 5.1.2. Before that, stored routines are not dumped. Routine +DEFINER +values are not dumped until MySQL 5.1.8. This means that before 5.1.8, when routines are reloaded, they will be created with the definer set to the reloading user. If you require routines to be re\-created with their original definer, dump and load the contents of the +mysql.proc +table directly as described earlier. +.TP 3n +\(bu +\fB\-\-set\-charset\fR +.sp +Add +SET NAMES \fIdefault_character_set\fR +to the output. This option is enabled by default. To suppress the +SET NAMES +statement, use +\fB\-\-skip\-set\-charset\fR. +.TP 3n +\(bu +\fB\-\-single\-transaction\fR +.sp +This option issues a +BEGIN +SQL statement before dumping data from the server. It is useful only with transactional tables such as +InnoDB, because then it dumps the consistent state of the database at the time when +BEGIN +was issued without blocking any applications. +.sp +When using this option, you should keep in mind that only +InnoDB +tables are dumped in a consistent state. For example, any +MyISAM +or +MEMORY +tables dumped while using this option may still change state. +.sp +While a +\fB\-\-single\-transaction\fR +dump is in process, to ensure a valid dump file (correct table contents and binary log position), no other connection should use the following statements: +ALTER TABLE, +DROP TABLE, +RENAME TABLE, +TRUNCATE TABLE. A consistent read is not isolated from those statements, so use of them on a table to be dumped can cause the +SELECT +performed by +\fBmysqldump\fR +to retrieve the table contents to obtain incorrect contents or fail. +.sp +This option is not supported for MySQL Cluster tables; the results cannot be guaranteed to be consistent due to the fact that the +NDBCLUSTER +storage engine supports only the +READ_COMMITTED +transaction isolation level. You should always use +NDB +backup and restore instead. +.sp +The +\fB\-\-single\-transaction\fR +option and the +\fB\-\-lock\-tables\fR +option are mutually exclusive, because +LOCK TABLES +causes any pending transactions to be committed implicitly. +.sp +To dump large tables, you should combine this option with +\fB\-\-quick\fR. +.TP 3n +\(bu +\fB\-\-skip\-comments\fR +.sp +See the description for the +\fB\-\-comments\fR +option. +.TP 3n +\(bu +\fB\-\-skip\-opt\fR +.sp +See the description for the +\fB\-\-opt\fR +option. +.TP 3n +\(bu +\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. +.TP 3n +\(bu +\fB\-\-ssl*\fR +.sp +Options that begin with +\fB\-\-ssl\fR +specify whether to connect to the server via SSL and indicate where to find SSL keys and certificates. See +Section\ 5.5.7.3, \(lqSSL Command Options\(rq. +.TP 3n +\(bu +\fB\-\-tab=\fR\fB\fIpath\fR\fR, +\fB\-T \fR\fB\fIpath\fR\fR +.sp +Produce tab\-separated data files. For each dumped table, +\fBmysqldump\fR +creates a +\fI\fItbl_name\fR\fR\fI.sql\fR +file that contains the +CREATE TABLE +statement that creates the table, and a +\fI\fItbl_name\fR\fR\fI.txt\fR +file that contains its data. The option value is the directory in which to write the files. +.sp +By default, the +\fI.txt\fR +data files are formatted using tab characters between column values and a newline at the end of each line. The format can be specified explicitly using the +\fB\-\-fields\-\fR\fB\fIxxx\fR\fR +and +\fB\-\-lines\-terminated\-by\fR +options. +.sp +Column values are dumped using the +binary +character set and the +\fB\-\-default\-character\-set\fR +option is ignored. In effect, there is no character set conversion. If a table contains columns in several character sets, the output data file will as well and you may not be able to reload the file correctly. +.sp +.it 1 an-trap +.nr an-no-space-flag 1 +.nr an-break-flag 1 +.br +\fBNote\fR +This option should be used only when +\fBmysqldump\fR +is run on the same machine as the +\fBmysqld\fR +server. You must have the +FILE +privilege, and the server must have permission to write files in the directory that you specify. +.TP 3n +\(bu +\fB\-\-tables\fR +.sp +Override the +\fB\-\-databases\fR +or +\fB\-B\fR +option. +\fBmysqldump\fR +regards all name arguments following the option as table names. +.TP 3n +\(bu +\fB\-\-triggers\fR +.sp +Dump triggers for each dumped table. This option is enabled by default; disable it with +\fB\-\-skip\-triggers\fR. +.TP 3n +\(bu +\fB\-\-tz\-utc\fR +.sp +This option enables +TIMESTAMP +columns to be dumped and reloaded between servers in different time zones. +\fBmysqldump\fR +sets its connection time zone to UTC and adds +SET TIME_ZONE='+00:00' +to the dump file. Without this option, +TIMESTAMP +columns are dumped and reloaded in the time zones local to the source and destination servers, which can cause the values to change. +\fB\-\-tz\-utc\fR +also protects against changes due to daylight saving time. +\fB\-\-tz\-utc\fR +is enabled by default. To disable it, use +\fB\-\-skip\-tz\-utc\fR. This option was added in MySQL 5.1.2. +.TP 3n +\(bu +\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. +.TP 3n +\(bu +\fB\-\-verbose\fR, +\fB\-v\fR +.sp +Verbose mode. Print more information about what the program does. +.TP 3n +\(bu +\fB\-\-version\fR, +\fB\-V\fR +.sp +Display version information and exit. +.TP 3n +\(bu +\fB\-\-where='\fR\fB\fIwhere_condition\fR\fR\fB'\fR, +\fB\-w '\fR\fB\fIwhere_condition\fR\fR\fB'\fR +.sp +Dump only rows selected by the given +WHERE +condition. Quotes around the condition are mandatory if it contains spaces or other characters that are special to your command interpreter. +.sp +Examples: +.sp +.RS 3n +.nf +\-\-where="user='jimf'" +\-w"userid>1" +\-w"userid<1" +.fi +.RE +.TP 3n +\(bu +\fB\-\-xml\fR, +\fB\-X\fR +.sp +Write dump output as well\-formed XML. +.sp +\fBNULL\fR\fB, \fR\fB'NULL'\fR\fB, and Empty Values\fR: For some column named +\fIcolumn_name\fR, the +NULL +value, an empty string, and the string value +\'NULL' +are distinguished from one another in the output generated by this option as follows. +.TS +allbox tab(:); +l l +l l +l l +l l. +T{ +\fBValue\fR: +T}:T{ +\fBXML Representation\fR: +T} +T{ +NULL (\fIunknown value\fR) +T}:T{ +<field name="\fIcolumn_name\fR" + xsi:nil="true" /> +T} +T{ +\'' (\fIempty string\fR) +T}:T{ +<field + name="\fIcolumn_name\fR"></field> +T} +T{ +\'NULL' (\fIstring value\fR) +T}:T{ +<field + name="\fIcolumn_name\fR">NULL</field> +T} +.TE +.sp +Beginning with MySQL 5.1.12, the output from the +\fBmysql\fR +client when run using the +\fB\-\-xml\fR +option also follows these rules. (See +the section called \(lq\fBMYSQL\fR OPTIONS\(rq.) +.sp +Beginning with MySQL 5.1.18, XML output from +\fBmysqldump\fR +includes the XML namespace, as shown here: +.sp +.RS 3n +.nf +shell> \fBmysqldump \-\-xml \-u root world City\fR +<?xml version="1.0"?> +<mysqldump xmlns:xsi="http://www.w3.org/2001/XMLSchema\-instance"> +<database name="world"> +<table_structure name="City"> +<field Field="ID" Type="int(11)" Null="NO" Key="PRI" Extra="auto_increment" /> +<field Field="Name" Type="char(35)" Null="NO" Key="" Default="" Extra="" /> +<field Field="CountryCode" Type="char(3)" Null="NO" Key="" Default="" Extra="" /> +<field Field="District" Type="char(20)" Null="NO" Key="" Default="" Extra="" /> +<field Field="Population" Type="int(11)" Null="NO" Key="" Default="0" Extra="" /> +<key Table="City" Non_unique="0" Key_name="PRIMARY" Seq_in_index="1" Column_name="ID" Collation="A" Cardinality="4079" +Null="" Index_type="BTREE" Comment="" /> +<options Name="City" Engine="MyISAM" Version="10" Row_format="Fixed" Rows="4079" Avg_row_length="67" Data_length="27329 +3" Max_data_length="18858823439613951" Index_length="43008" Data_free="0" Auto_increment="4080" Create_time="2007\-03\-31 01:47:01" Updat +e_time="2007\-03\-31 01:47:02" Collation="latin1_swedish_ci" Create_options="" Comment="" /> +</table_structure> +<table_data name="City"> +<row> +<field name="ID">1</field> +<field name="Name">Kabul</field> +<field name="CountryCode">AFG</field> +<field name="District">Kabol</field> +<field name="Population">1780000</field> +</row> +\fI...\fR +<row> +<field name="ID">4079</field> +<field name="Name">Rafah</field> +<field name="CountryCode">PSE</field> +<field name="District">Rafah</field> +<field name="Population">92020</field> +</row> +</table_data> +</database> +</mysqldump> +.fi +.RE +.sp +.sp +.RE +.PP +You can also set the following variables by using +\fB\-\-\fR\fB\fIvar_name\fR\fR\fB=\fR\fB\fIvalue\fR\fR +syntax: +.TP 3n +\(bu +max_allowed_packet +.sp +The maximum size of the buffer for client/server communication. The maximum is 1GB. +.TP 3n +\(bu +net_buffer_length +.sp +The initial size of the buffer for client/server communication. When creating multiple\-row\-insert statements (as with option +\fB\-\-extended\-insert\fR +or +\fB\-\-opt\fR), +\fBmysqldump\fR +creates rows up to +net_buffer_length +length. If you increase this variable, you should also ensure that the +net_buffer_length +variable in the MySQL server is at least this large. +.sp +.RE +.PP +The most common use of +\fBmysqldump\fR +is probably for making a backup of an entire database: +.sp +.RS 3n +.nf +shell> \fBmysqldump \fR\fB\fIdb_name\fR\fR\fB > \fR\fB\fIbackup\-file.sql\fR\fR +.fi +.RE +.PP +You can read the dump file back into the server like this: +.sp +.RS 3n +.nf +shell> \fBmysql \fR\fB\fIdb_name\fR\fR\fB < \fR\fB\fIbackup\-file.sql\fR\fR +.fi +.RE +.PP +Or like this: +.sp +.RS 3n +.nf +shell> \fBmysql \-e "source \fR\fB\fI/path\-to\-backup/backup\-file.sql\fR\fR\fB" \fR\fB\fIdb_name\fR\fR +.fi +.RE +.PP +\fBmysqldump\fR +is also very useful for populating databases by copying data from one MySQL server to another: +.sp +.RS 3n +.nf +shell> \fBmysqldump \-\-opt \fR\fB\fIdb_name\fR\fR\fB | mysql \-\-host=\fR\fB\fIremote_host\fR\fR\fB \-C \fR\fB\fIdb_name\fR\fR +.fi +.RE +.PP +It is possible to dump several databases with one command: +.sp +.RS 3n +.nf +shell> \fBmysqldump \-\-databases \fR\fB\fIdb_name1\fR\fR\fB [\fR\fB\fIdb_name2\fR\fR\fB ...] > my_databases.sql\fR +.fi +.RE +.PP +To dump all databases, use the +\fB\-\-all\-databases\fR +option: +.sp +.RS 3n +.nf +shell> \fBmysqldump \-\-all\-databases > all_databases.sql\fR +.fi +.RE +.PP +For +InnoDB +tables, +\fBmysqldump\fR +provides a way of making an online backup: +.sp +.RS 3n +.nf +shell> \fBmysqldump \-\-all\-databases \-\-single\-transaction > all_databases.sql\fR +.fi +.RE +.PP +This backup acquires a global read lock on all tables (using +FLUSH TABLES WITH READ LOCK) at the beginning of the dump. As soon as this lock has been acquired, the binary log coordinates are read and the lock is released. If long updating statements are running when the +FLUSH +statement is issued, the MySQL server may get stalled until those statements finish. After that, the dump becomes lock\-free and does not disturb reads and writes on the tables. If the update statements that the MySQL server receives are short (in terms of execution time), the initial lock period should not be noticeable, even with many updates. +.PP +For point\-in\-time recovery (also known as +\(lqroll\-forward,\(rq +when you need to restore an old backup and replay the changes that happened since that backup), it is often useful to rotate the binary log (see +Section\ 5.2.4, \(lqThe Binary Log\(rq) or at least know the binary log coordinates to which the dump corresponds: +.sp +.RS 3n +.nf +shell> \fBmysqldump \-\-all\-databases \-\-master\-data=2 > all_databases.sql\fR +.fi +.RE +.PP +Or: +.sp +.RS 3n +.nf +shell> \fBmysqldump \-\-all\-databases \-\-flush\-logs \-\-master\-data=2\fR + \fB> all_databases.sql\fR +.fi +.RE +.PP +The +\fB\-\-master\-data\fR +and +\fB\-\-single\-transaction\fR +options can be used simultaneously, which provides a convenient way to make an online backup suitable for point\-in\-time recovery if tables are stored using the +InnoDB +storage engine. +.PP +For more information on making backups, see +Section\ 6.1, \(lqDatabase Backups\(rq, and +Section\ 6.2, \(lqExample Backup and Recovery Strategy\(rq. +.PP +If you encounter problems backing up views, please read the section that covers restrictions on views which describes a workaround for backing up views when this fails due to insufficient privileges. See +Section\ D.4, \(lqRestrictions on Views\(rq. +.SH "COPYRIGHT" +.PP +Copyright 2007\-2008 MySQL AB, 2009 Sun Microsystems, Inc. +.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/. +.SH "REFERENCES" +.TP 3 +1.\ Bug#30123 +\%http://bugs.mysql.com/30123 +.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 +MySQL AB (http://www.mysql.com/). diff --git a/man/mysqldumpslow.1 b/man/mysqldumpslow.1 new file mode 100644 index 00000000000..4bc6a1e8b6c --- /dev/null +++ b/man/mysqldumpslow.1 @@ -0,0 +1,176 @@ +.\" Title: \fBmysqldumpslow\fR +.\" Author: +.\" Generator: DocBook XSL Stylesheets v1.70.1 <http://docbook.sf.net/> +.\" Date: 03/31/2009 +.\" Manual: MySQL Database System +.\" Source: MySQL 5.1 +.\" +.TH "\fBMYSQLDUMPSLOW\fR" "1" "03/31/2009" "MySQL 5.1" "MySQL Database System" +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.SH "NAME" +mysqldumpslow \- Summarize slow query log files +.SH "SYNOPSIS" +.HP 39 +\fBmysqldumpslow [\fR\fBoptions\fR\fB] [\fR\fB\fIlog_file\fR\fR\fB ...]\fR +.SH "DESCRIPTION" +.PP +The MySQL slow query log contains information about queries that take a long time to execute (see +Section\ 5.2.5, \(lqThe Slow Query Log\(rq). +\fBmysqldumpslow\fR +parses MySQL slow query log files and prints a summary of their contents. +.PP +Normally, +\fBmysqldumpslow\fR +groups queries that are similar except for the particular values of number and string data values. It +\(lqabstracts\(rq +these values to +N +and +\'S' +when displaying summary output. The +\fB\-a\fR +and +\fB\-n\fR +options can be used to modify value abstracting behavior. +.PP +Invoke +\fBmysqldumpslow\fR +like this: +.sp +.RS 3n +.nf +shell> \fBmysqldumpslow [\fR\fB\fIoptions\fR\fR\fB] [\fR\fB\fIlog_file\fR\fR\fB ...]\fR +.fi +.RE +.PP +\fBmysqldumpslow\fR +supports the following options: +.TP 3n +\(bu +\fB\-\-help\fR +.sp +Display a help message and exit. +.TP 3n +\(bu +\fB\-a\fR +.sp +Do not abstract all numbers to +N +and strings to +\'S'. +.TP 3n +\(bu +\fB\-\-debug\fR, +\fB\-d\fR +.sp +Run in debug mode. +.TP 3n +\(bu +\fB\-g \fR\fB\fIpattern\fR\fR +.sp +Consider only queries that match the (\fBgrep\fR\-style) pattern. +.TP 3n +\(bu +\fB\-h \fR\fB\fIhost_name\fR\fR +.sp +Host name of MySQL server for +\fI*\-slow.log\fR +file name. The value can contain a wildcare. The default is +* +(match all). +.TP 3n +\(bu +\fB\-i \fR\fB\fIname\fR\fR +.sp +Name of server instance (if using +\fBmysql.server\fR +startup script). +.TP 3n +\(bu +\fB\-l\fR +.sp +Do not subtract lock time from total time. +.TP 3n +\(bu +\fB\-n \fR\fB\fIN\fR\fR +.sp +Abstract numbers with at least +\fIN\fR +digits within names. +.TP 3n +\(bu +\fB\-r\fR +.sp +Reverse the sort order. +.TP 3n +\(bu +\fB\-s \fR\fB\fIsort_type\fR\fR +.sp +How to sort the output. The value of +\fIsort_type\fR +should be chosen from the following list: +.RS 3n +.TP 3n +\(bu +t, +at: Sort by query time or average query time +.TP 3n +\(bu +l, +al: Sort by lock time or average lock time +.TP 3n +\(bu +s, +as: Sort by rows sent or average rows went +.TP 3n +\(bu +c: Sort by count +.RE +.TP 3n +\(bu +\fB\-t \fR\fB\fIN\fR\fR +.sp +Display only the first +\fIN\fR +queries in the output. +.TP 3n +\(bu +\fB\-\-verbose\fR, +\fB\-v\fR +.sp +Verbose mode. Print more information about what the program does. +.sp +.RE +.PP +Example of usage: +.sp +.RS 3n +.nf +shell> \fBmysqldumpslow\fR +Reading mysql slow query log from /usr/local/mysql/data/mysqld51\-apple\-slow.log +Count: 1 Time=4.32s (4s) Lock=0.00s (0s) Rows=0.0 (0), root[root]@localhost + insert into t2 select * from t1 +Count: 3 Time=2.53s (7s) Lock=0.00s (0s) Rows=0.0 (0), root[root]@localhost + insert into t2 select * from t1 limit N +Count: 3 Time=2.13s (6s) Lock=0.00s (0s) Rows=0.0 (0), root[root]@localhost + insert into t1 select * from t1 +.fi +.RE +.SH "COPYRIGHT" +.PP +Copyright 2007\-2008 MySQL AB, 2009 Sun Microsystems, Inc. +.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/. +.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 +MySQL AB (http://www.mysql.com/). diff --git a/man/mysqlhotcopy.1 b/man/mysqlhotcopy.1 new file mode 100644 index 00000000000..2a2ae07fd69 --- /dev/null +++ b/man/mysqlhotcopy.1 @@ -0,0 +1,265 @@ +.\" Title: \fBmysqlhotcopy\fR +.\" Author: +.\" Generator: DocBook XSL Stylesheets v1.70.1 <http://docbook.sf.net/> +.\" Date: 03/31/2009 +.\" Manual: MySQL Database System +.\" Source: MySQL 5.1 +.\" +.TH "\fBMYSQLHOTCOPY\fR" "1" "03/31/2009" "MySQL 5.1" "MySQL Database System" +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.SH "NAME" +mysqlhotcopy \- a database backup program +.SH "SYNOPSIS" +.HP 23 +\fBmysqlhotcopy \fR\fB\fIarguments\fR\fR +.SH "DESCRIPTION" +.PP +\fBmysqlhotcopy\fR +is a Perl script that was originally written and contributed by Tim Bunce. It uses +LOCK TABLES, +FLUSH TABLES, and +cp +or +scp +to make a database backup quickly. It is the fastest way to make a backup of the database or single tables, but it can be run only on the same machine where the database directories are located. +\fBmysqlhotcopy\fR +works only for backing up +MyISAM +and +ARCHIVE +tables. It runs on Unix and NetWare. +.sp +.RS 3n +.nf +shell> \fBmysqlhotcopy \fR\fB\fIdb_name\fR\fR\fB [\fR\fB\fI/path/to/new_directory\fR\fR\fB]\fR +.fi +.RE +.sp +.RS 3n +.nf +shell> \fBmysqlhotcopy \fR\fB\fIdb_name_1\fR\fR\fB ... \fR\fB\fIdb_name_n\fR\fR\fB \fR\fB\fI/path/to/new_directory\fR\fR +.fi +.RE +.PP +Back up tables in the given database that match a regular expression: +.sp +.RS 3n +.nf +shell> \fBmysqlhotcopy \fR\fB\fIdb_name\fR\fR\fB./\fR\fB\fIregex\fR\fR\fB/\fR +.fi +.RE +.PP +The regular expression for the table name can be negated by prefixing it with a tilde (\(lq~\(rq): +.sp +.RS 3n +.nf +shell> \fBmysqlhotcopy \fR\fB\fIdb_name\fR\fR\fB./~\fR\fB\fIregex\fR\fR\fB/\fR +.fi +.RE +.PP +\fBmysqlhotcopy\fR +supports the following options: +.TP 3n +\(bu +\fB\-\-help\fR, +\fB\-?\fR +.sp +Display a help message and exit. +.TP 3n +\(bu +\fB\-\-addtodest\fR +.sp +Do not rename target directory (if it exists); merely add files to it. +.TP 3n +\(bu +\fB\-\-allowold\fR +.sp +Do not abort if a target exists; rename it by adding an +_old +suffix. +.TP 3n +\(bu +\fB\-\-checkpoint=\fR\fB\fIdb_name\fR\fR\fB.\fR\fB\fItbl_name\fR\fR +.sp +Insert checkpoint entries into the specified database +\fIdb_name\fR +and table +\fItbl_name\fR. +.TP 3n +\(bu +\fB\-\-chroot=\fR\fB\fIpath\fR\fR +.sp +Base directory of the +\fBchroot\fR +jail in which +\fBmysqld\fR +operates. The +\fIpath\fR +value should match that of the +\fB\-\-chroot\fR +option given to +\fBmysqld\fR. +.TP 3n +\(bu +\fB\-\-debug\fR +.sp +Enable debug output. +.TP 3n +\(bu +\fB\-\-dryrun\fR, +\fB\-n\fR +.sp +Report actions without performing them. +.TP 3n +\(bu +\fB\-\-flushlog\fR +.sp +Flush logs after all tables are locked. +.TP 3n +\(bu +\fB\-\-host=\fR\fB\fIhost_name\fR\fR, +\fB\-h \fR\fB\fIhost_name\fR\fR +.sp +The host name of the local host to use for making a TCP/IP connection to the local server. By default, the connection is made to +localhost +using a Unix socket file. +.TP 3n +\(bu +\fB\-\-keepold\fR +.sp +Do not delete previous (renamed) target when done. +.TP 3n +\(bu +\fB\-\-method=\fR\fB\fIcommand\fR\fR +.sp +The method for copying files (cp +or +scp). +.TP 3n +\(bu +\fB\-\-noindices\fR +.sp +Do not include full index files in the backup. This makes the backup smaller and faster. The indexes for reloaded tables can be reconstructed later with +\fBmyisamchk \-rq\fR. +.TP 3n +\(bu +\fB\-\-password=\fR\fB\fIpassword\fR\fR, +\fB\-p\fR\fB\fIpassword\fR\fR +.sp +The password to use when connecting to the server. Note that the password value is not optional for this option, unlike for other MySQL programs. You can use an option file to avoid giving the password on the command line. +.sp +Specifying a password on the command line should be considered insecure. See +Section\ 5.5.6.2, \(lqEnd\-User Guidelines for Password Security\(rq. +.TP 3n +\(bu +\fB\-\-port=\fR\fB\fIport_num\fR\fR, +\fB\-P \fR\fB\fIport_num\fR\fR +.sp +The TCP/IP port number to use when connecting to the local server. +.TP 3n +\(bu +\fB\-\-quiet\fR, +\fB\-q\fR +.sp +Be silent except for errors. +.TP 3n +\(bu +\fB\-\-record_log_pos=\fR\fB\fIdb_name\fR\fR\fB.\fR\fB\fItbl_name\fR\fR +.sp +Record master and slave status in the specified database +\fIdb_name\fR +and table +\fItbl_name\fR. +.TP 3n +\(bu +\fB\-\-regexp=\fR\fB\fIexpr\fR\fR +.sp +Copy all databases with names that match the given regular expression. +.TP 3n +\(bu +\fB\-\-resetmaster\fR +.sp +Reset the binary log after locking all the tables. +.TP 3n +\(bu +\fB\-\-resetslave\fR +.sp +Reset the +\fImaster.info\fR +file after locking all the tables. +.TP 3n +\(bu +\fB\-\-socket=\fR\fB\fIpath\fR\fR, +\fB\-S \fR\fB\fIpath\fR\fR +.sp +The Unix socket file to use for the connection. +.TP 3n +\(bu +\fB\-\-suffix=\fR\fB\fIstr\fR\fR +.sp +The suffix for names of copied databases. +.TP 3n +\(bu +\fB\-\-tmpdir=\fR\fB\fIpath\fR\fR +.sp +The temporary directory. The default is +\fI/tmp\fR. +.TP 3n +\(bu +\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. +.sp +.RE +.PP +\fBmysqlhotcopy\fR +reads the +[client] +and +[mysqlhotcopy] +option groups from option files. +.PP +To execute +\fBmysqlhotcopy\fR, you must have access to the files for the tables that you are backing up, the +SELECT +privilege for those tables, the +RELOAD +privilege (to be able to execute +FLUSH TABLES), and the +LOCK TABLES +privilege (to be able to lock the tables). +.PP +Use +perldoc +for additional +\fBmysqlhotcopy\fR +documentation, including information about the structure of the tables needed for the +\fB\-\-checkpoint\fR +and +\fB\-\-record_log_pos\fR +options: +.sp +.RS 3n +.nf +shell> \fBperldoc mysqlhotcopy\fR +.fi +.RE +.SH "COPYRIGHT" +.PP +Copyright 2007\-2008 MySQL AB, 2009 Sun Microsystems, Inc. +.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/. +.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 +MySQL AB (http://www.mysql.com/). diff --git a/man/mysqlimport.1 b/man/mysqlimport.1 new file mode 100644 index 00000000000..55edf6764fa --- /dev/null +++ b/man/mysqlimport.1 @@ -0,0 +1,320 @@ +.\" Title: \fBmysqlimport\fR +.\" Author: +.\" Generator: DocBook XSL Stylesheets v1.70.1 <http://docbook.sf.net/> +.\" Date: 03/31/2009 +.\" Manual: MySQL Database System +.\" Source: MySQL 5.1 +.\" +.TH "\fBMYSQLIMPORT\fR" "1" "03/31/2009" "MySQL 5.1" "MySQL Database System" +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.SH "NAME" +mysqlimport \- a data import program +.SH "SYNOPSIS" +.HP 44 +\fBmysqlimport [\fR\fB\fIoptions\fR\fR\fB] \fR\fB\fIdb_name\fR\fR\fB \fR\fB\fItextfile1\fR\fR\fB ...\fR +.SH "DESCRIPTION" +.PP +The +\fBmysqlimport\fR +client provides a command\-line interface to the +LOAD DATA INFILE +SQL statement. Most options to +\fBmysqlimport\fR +correspond directly to clauses of +LOAD DATA INFILE +syntax. See +Section\ 12.2.6, \(lqLOAD DATA INFILE Syntax\(rq. +.PP +Invoke +\fBmysqlimport\fR +like this: +.sp +.RS 3n +.nf +shell> \fBmysqlimport [\fR\fB\fIoptions\fR\fR\fB] \fR\fB\fIdb_name\fR\fR\fB \fR\fB\fItextfile1\fR\fR\fB [\fR\fB\fItextfile2\fR\fR\fB ...]\fR +.fi +.RE +.PP +For each text file named on the command line, +\fBmysqlimport\fR +strips any extension from the file name and uses the result to determine the name of the table into which to import the file's contents. For example, files named +\fIpatient.txt\fR, +\fIpatient.text\fR, and +\fIpatient\fR +all would be imported into a table named +patient. +.PP +\fBmysqlimport\fR +supports the following options: +.TP 3n +\(bu +\fB\-\-help\fR, +\fB\-?\fR +.sp +Display a help message and exit. +.TP 3n +\(bu +\fB\-\-character\-sets\-dir=\fR\fB\fIpath\fR\fR +.sp +The directory where character sets are installed. See +Section\ 9.2, \(lqThe Character Set Used for Data and Sorting\(rq. +.TP 3n +\(bu +\fB\-\-columns=\fR\fB\fIcolumn_list\fR\fR, +\fB\-c \fR\fB\fIcolumn_list\fR\fR +.sp +This option takes a comma\-separated list of column names as its value. The order of the column names indicates how to match data file columns with table columns. +.TP 3n +\(bu +\fB\-\-compress\fR, +\fB\-C\fR +.sp +Compress all information sent between the client and the server if both support compression. +.TP 3n +\(bu +\fB\-\-debug[=\fR\fB\fIdebug_options\fR\fR\fB]\fR, +\fB\-# [\fR\fB\fIdebug_options\fR\fR\fB]\fR +.sp +Write a debugging log. The +\fIdebug_options\fR +string often is +\'d:t:o,\fIfile_name\fR'. +.TP 3n +\(bu +\fB\-\-debug\-check\fR +.sp +Print some debugging information when the program exits. This option was added in MySQL 5.1.21. +.TP 3n +\(bu +\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. +.TP 3n +\(bu +\fB\-\-default\-character\-set=\fR\fB\fIcharset_name\fR\fR +.sp +Use +\fIcharset_name\fR +as the default character set. See +Section\ 9.2, \(lqThe Character Set Used for Data and Sorting\(rq. +.TP 3n +\(bu +\fB\-\-delete\fR, +\fB\-D\fR +.sp +Empty the table before importing the text file. +.TP 3n +\(bu +\fB\-\-fields\-terminated\-by=...\fR, +\fB\-\-fields\-enclosed\-by=...\fR, +\fB\-\-fields\-optionally\-enclosed\-by=...\fR, +\fB\-\-fields\-escaped\-by=...\fR +.sp +These options have the same meaning as the corresponding clauses for +LOAD DATA INFILE. See +Section\ 12.2.6, \(lqLOAD DATA INFILE Syntax\(rq. +.TP 3n +\(bu +\fB\-\-force\fR, +\fB\-f\fR +.sp +Ignore errors. For example, if a table for a text file does not exist, continue processing any remaining files. Without +\fB\-\-force\fR, +\fBmysqlimport\fR +exits if a table does not exist. +.TP 3n +\(bu +\fB\-\-host=\fR\fB\fIhost_name\fR\fR, +\fB\-h \fR\fB\fIhost_name\fR\fR +.sp +Import data to the MySQL server on the given host. The default host is +localhost. +.TP 3n +\(bu +\fB\-\-ignore\fR, +\fB\-i\fR +.sp +See the description for the +\fB\-\-replace\fR +option. +.TP 3n +\(bu +\fB\-\-ignore\-lines=\fR\fB\fIN\fR\fR +.sp +Ignore the first +\fIN\fR +lines of the data file. +.TP 3n +\(bu +\fB\-\-lines\-terminated\-by=...\fR +.sp +This option has the same meaning as the corresponding clause for +LOAD DATA INFILE. For example, to import Windows files that have lines terminated with carriage return/linefeed pairs, use +\fB\-\-lines\-terminated\-by="\\r\\n"\fR. (You might have to double the backslashes, depending on the escaping conventions of your command interpreter.) See +Section\ 12.2.6, \(lqLOAD DATA INFILE Syntax\(rq. +.TP 3n +\(bu +\fB\-\-local\fR, +\fB\-L\fR +.sp +Read input files locally from the client host. +.TP 3n +\(bu +\fB\-\-lock\-tables\fR, +\fB\-l\fR +.sp +Lock +\fIall\fR +tables for writing before processing any text files. This ensures that all tables are synchronized on the server. +.TP 3n +\(bu +\fB\-\-low\-priority\fR +.sp +Use +LOW_PRIORITY +when loading the table. This affects only storage engines that use only table\-level locking (MyISAM, +MEMORY, +MERGE). +.TP 3n +\(bu +\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, you are prompted for one. +.sp +Specifying a password on the command line should be considered insecure. See +Section\ 5.5.6.2, \(lqEnd\-User Guidelines for Password Security\(rq. +.TP 3n +\(bu +\fB\-\-pipe\fR, +\fB\-W\fR +.sp +On Windows, connect to the server via a named pipe. This option applies only for connections to a local server, and only if the server supports named\-pipe connections. +.TP 3n +\(bu +\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. +.TP 3n +\(bu +\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 allowable values, see +Section\ 4.2.2, \(lqConnecting to the MySQL Server\(rq. +.TP 3n +\(bu +\fB\-\-replace\fR, +\fB\-r\fR +.sp +The +\fB\-\-replace\fR +and +\fB\-\-ignore\fR +options control handling of input rows that duplicate existing rows on unique key values. If you specify +\fB\-\-replace\fR, new rows replace existing rows that have the same unique key value. If you specify +\fB\-\-ignore\fR, input rows that duplicate an existing row on a unique key value are skipped. If you do not specify either option, an error occurs when a duplicate key value is found, and the rest of the text file is ignored. +.TP 3n +\(bu +\fB\-\-silent\fR, +\fB\-s\fR +.sp +Silent mode. Produce output only when errors occur. +.TP 3n +\(bu +\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. +.TP 3n +\(bu +\fB\-\-ssl*\fR +.sp +Options that begin with +\fB\-\-ssl\fR +specify whether to connect to the server via SSL and indicate where to find SSL keys and certificates. See +Section\ 5.5.7.3, \(lqSSL Command Options\(rq. +.TP 3n +\(bu +\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. +.TP 3n +\(bu +\fB\-\-use\-threads=\fR\fB\fIN\fR\fR +.sp +Load files in parallel using +\fIN\fR +threads. This option was added in MySQL 5.1.7. +.TP 3n +\(bu +\fB\-\-verbose\fR, +\fB\-v\fR +.sp +Verbose mode. Print more information about what the program does. +.TP 3n +\(bu +\fB\-\-version\fR, +\fB\-V\fR +.sp +Display version information and exit. +.sp +.RE +.PP +Here is a sample session that demonstrates use of +\fBmysqlimport\fR: +.sp +.RS 3n +.nf +shell> \fBmysql \-e 'CREATE TABLE imptest(id INT, n VARCHAR(30))' test\fR +shell> \fBed\fR +a +100 Max Sydow +101 Count Dracula +. +w imptest.txt +32 +q +shell> \fBod \-c imptest.txt\fR +0000000 1 0 0 \\t M a x S y d o w \\n 1 0 +0000020 1 \\t C o u n t D r a c u l a \\n +0000040 +shell> \fBmysqlimport \-\-local test imptest.txt\fR +test.imptest: Records: 2 Deleted: 0 Skipped: 0 Warnings: 0 +shell> \fBmysql \-e 'SELECT * FROM imptest' test\fR ++\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+ +| id | n | ++\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+ +| 100 | Max Sydow | +| 101 | Count Dracula | ++\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+ +.fi +.RE +.SH "COPYRIGHT" +.PP +Copyright 2007\-2008 MySQL AB, 2009 Sun Microsystems, Inc. +.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/. +.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 +MySQL AB (http://www.mysql.com/). diff --git a/man/mysqlmanager.8 b/man/mysqlmanager.8 new file mode 100644 index 00000000000..5936901ef1a --- /dev/null +++ b/man/mysqlmanager.8 @@ -0,0 +1,1216 @@ +.\" Title: \fBmysqlmanager\fR +.\" Author: +.\" Generator: DocBook XSL Stylesheets v1.70.1 <http://docbook.sf.net/> +.\" Date: 03/31/2009 +.\" Manual: MySQL Database System +.\" Source: MySQL 5.1 +.\" +.TH "\fBMYSQLMANAGER\fR" "8" "03/31/2009" "MySQL 5.1" "MySQL Database System" +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.SH "NAME" +mysqlmanager \- the MySQL Instance Manager +.SH "SYNOPSIS" +.HP 23 +\fBmysqlmanager [\fR\fB\fIoptions\fR\fR\fB]\fR +.SH "DESCRIPTION" +.sp +.it 1 an-trap +.nr an-no-space-flag 1 +.nr an-break-flag 1 +.br +\fBImportant\fR +.PP +MySQL Instance Manager has been deprecated and is removed in MySQL 6.0. +.PP +\fBmysqlmanager\fR +is the MySQL Instance Manager (IM). This program monitors and manages MySQL Database Server instances. MySQL Instance Manager is available for Unix\-like operating systems, as well as Windows. It runs as a daemon that listens on a TCP/IP port. On Unix, it also listens on a Unix socket file. +.PP +MySQL Instance Manager can be used in place of the +mysqld_safe +script to start and stop one or more instances of MySQL Server. Because Instance Manager can manage multiple server instances, it can also be used in place of the +\fBmysqld_multi\fR +script. Instance Manager offers these capabilities: +.TP 3n +\(bu +Instance Manager can start and stop instances, and report on the status of instances. +.TP 3n +\(bu +Server instances can be treated as guarded or unguarded: +.RS 3n +.TP 3n +\(bu +When Instance Manager starts, it starts each guarded instance. If the instance crashes, Instance Manager detects this and restarts it. When Instance Manager stops, it stops the instance. +.TP 3n +\(bu +A nonguarded instance is not started when Instance Manager starts or monitored by it. If the instance crashes after being started, Instance Manager does not restart it. When Instance Manager exits, it does not stop the instance if it is running. +.RE +.IP "" 3n +Instances are guarded by default. An instance can be designated as nonguarded by including the +\fBnonguarded\fR +option in the configuration file. +.TP 3n +\(bu +Instance Manager provides an interactive interface for configuring instances, so that the need to edit the configuration file manually is reduced or eliminated. +.TP 3n +\(bu +Instance Manager provides remote instance management. That is, it runs on the host where you want to control MySQL Server instances, but you can connect to it from a remote host to perform instance\-management operations. +.sp +.RE +.PP +The following sections describe MySQL Instance Manager operation in more detail. +.SH "MYSQL INSTANCE MANAGER COMMAND OPTIONS" +.sp +.it 1 an-trap +.nr an-no-space-flag 1 +.nr an-break-flag 1 +.br +\fBImportant\fR +.PP +MySQL Instance Manager has been deprecated and is removed in MySQL 6.0. +.PP +The MySQL Instance Manager supports a number of command options. For a brief listing, invoke +\fBmysqlmanager\fR +with the +\fB\-\-help\fR +option. Options may be given on the command line or in the Instance Manager configuration file. On Windows, the standard configuration file is +\fImy.ini\fR +in the directory where Instance Manager is installed. On Unix, the standard file is +\fI/etc/my.cnf\fR. To specify a different configuration file, start Instance Manager with the +\fB\-\-defaults\-file\fR +option. +.PP +\fBmysqlmanager\fR +supports the options described in the following list. The options for managing entries in the password file are described further in +the section called \(lqINSTANCE MANAGER USER AND PASSWORD MANAGEMENT\(rq. +.TP 3n +\(bu +\fB\-\-help\fR, +\fB\-?\fR +.sp +Display a help message and exit. +.TP 3n +\(bu +\fB\-\-add\-user\fR +.sp +Add a new user (specified with the +\fB\-\-username\fR +option) to the password file. This option was added in MySQL 5.1.12. +.TP 3n +\(bu +\fB\-\-angel\-pid\-file=\fR\fB\fIfile_name\fR\fR +.sp +The file in which the angel process records its process ID when +\fBmysqlmanager\fR +runs in daemon mode (that is, when the +\fB\-\-run\-as\-service\fR +option is given). The default file name is +\fImysqlmanager.angel.pid\fR. +.sp +If the +\fB\-\-angel\-pid\-file\fR +option is not given, the default angel PID file has the same name as the PID file except that any PID file extension is replaced with an extension of +\fI.angel.pid\fR. (For example, +\fImysqlmanager.pid\fR +becomes +\fImysqlmanager.angel.pid\fR.) +.sp +This option was added in MySQL 5.1.11. +.TP 3n +\(bu +\fB\-\-bind\-address=\fR\fB\fIIP\fR\fR +.sp +The IP address to bind to. +.TP 3n +\(bu +\fB\-\-check\-password\-file\fR +.sp +Check the validity and consistency of the password file. This option was added in MySQL 5.1.12. +.TP 3n +\(bu +\fB\-\-clean\-password\-file\fR +.sp +Drop all users from the password file. This option was added in MySQL 5.1.12. +.TP 3n +\(bu +\fB\-\-debug=\fR\fB\fIdebug_options\fR\fR\fB, \-# \fR\fB\fIdebug_options\fR\fR +.sp +Write a debugging log. The +\fIdebug_options\fR +string often is +\'d:t:o,\fIfile_name\fR'. This option was added in MySQL 5.1.10. +.TP 3n +\(bu +\fB\-\-default\-mysqld\-path=\fR\fB\fIpath\fR\fR +.sp +The path name of the MySQL Server binary. This path name is used for all server instance sections in the configuration file for which no +\fBmysqld\-path\fR +option is present. The default value of this option is the compiled\-in path name, which depends on how the MySQL distribution was configured. Example: +\fB\-\-default\-mysqld\-path=/usr/sbin/mysqld\fR +.TP 3n +\(bu +\fB\-\-defaults\-file=\fR\fB\fIfile_name\fR\fR +.sp +Read Instance Manager and MySQL Server settings from the given file. All configuration changes made by the Instance Manager will be written to this file. This must be the first option on the command line if it is used, and the file must exist. +.sp +If this option is not given, Instance Manager uses its standard configuration file. On Windows, the standard file is +\fImy.ini\fR +in the directory where Instance Manager is installed. On Unix, the standard file is +\fI/etc/my.cnf\fR. +.TP 3n +\(bu +\fB\-\-drop\-user\fR +.sp +Drop a user (specified with the +\fB\-\-username\fR +option) from the password file. This option was added in MySQL 5.1.12. +.TP 3n +\(bu +\fB\-\-edit\-user\fR +.sp +Change an entry for an existing user (specified with the +\fB\-\-username\fR +option) in the password file. This option was added in MySQL 5.1.12. +.TP 3n +\(bu +\fB\-\-install\fR +.sp +On Windows, install Instance Manager as a Windows service. The service name is +MySQL Manager. +.TP 3n +\(bu +\fB\-\-list\-users\fR +.sp +List the users in the password file. This option was added in MySQL 5.1.12. +.TP 3n +\(bu +\fB\-\-log=\fR\fB\fIfile_name\fR\fR +.sp +The path to the Instance Manager log file. This option has no effect unless the +\fB\-\-run\-as\-service\fR +option is also given. If the file name specified for the option is a relative name, the log file is created under the directory from which Instance Manager is started. To ensure that the file is created in a specific directory, specify it as a full path name. +.sp +If +\fB\-\-run\-as\-service\fR +is given without +\fB\-\-log\fR, the log file is +\fImysqlmanager.log\fR +in the data directory. +.sp +If +\fB\-\-run\-as\-service\fR +is not given, log messages go to the standard output. To capture log output, you can redirect Instance Manager output to a file: +.sp +.RS 3n +.nf +mysqlmanager > im.log +.fi +.RE +.TP 3n +\(bu +\fB\-\-monitoring\-interval=\fR\fB\fIseconds\fR\fR +.sp +The interval in seconds for monitoring server instances. The default value is 20 seconds. Instance Manager tries to connect to each monitored (guarded) instance using the non\-existing +MySQL_Instance_Manager +user account to check whether it is alive/not hanging. If the result of the connection attempt indicates that the instance is unavailable, Instance Manager performs several attempts to restart the instance. +.sp +Normally, the +MySQL_Instance_Manager +account does not exist, so the connection attempts by Instance Manager cause the monitored instance to produce messages in its general query log similar to the following: +.sp +.RS 3n +.nf +Access denied for user 'MySQL_Instance_M'@'localhost' \(Fc + (using password: YES) +.fi +.RE +.sp +.sp +The +nonguarded +option in the appropriate server instance section disables monitoring for a particular instance. If the instance dies after being started, Instance Manager will not restart it. Instance Manager tries to connect to a nonguarded instance only when you request the instance's status (for example, with the +SHOW INSTANCES +status. +.sp +See +the section called \(lqMYSQL SERVER INSTANCE STATUS MONITORING\(rq, for more information. +.TP 3n +\(bu +\fB\-\-mysqld\-safe\-compatible\fR +.sp +Run in a +\fBmysqld_safe\fR\-compatible manner. For details, see +the section called \(lqSTARTING THE MYSQL SERVER WITH MYSQL INSTANCE MANAGER\(rq. This option was added in MySQL 5.1.12. +.TP 3n +\(bu +\fB\-\-password=\fR\fB\fIpassword\fR\fR, +\fB\-p \fR\fB\fIpassword\fR\fR +.sp +Specify the password for an entry to be added to or modified in the password file. Unlike the +\fB\-\-password\fR/\fB\-P\fR +option for most MySQL programs, the password value is required, not optional. See also +the section called \(lqINSTANCE MANAGER USER AND PASSWORD MANAGEMENT\(rq. This option was added in MySQL 5.1.12. +.TP 3n +\(bu +\fB\-\-password\-file=\fR\fB\fIfile_name\fR\fR +.sp +The name of the file where the Instance Manager looks for users and passwords. On Windows, the default is +\fImysqlmanager.passwd\fR +in the directory where Instance Manager is installed. On Unix, the default file is +\fI/etc/mysqlmanager.passwd\fR. See also +the section called \(lqINSTANCE MANAGER USER AND PASSWORD MANAGEMENT\(rq. +.TP 3n +\(bu +\fB\-\-pid\-file=\fR\fB\fIfile_name\fR\fR +.sp +The process ID file to use. On Windows, the default file is +\fImysqlmanager.pid\fR +in the directory where Instance Manager is installed. On Unix, the default is +\fImysqlmanager.pid\fR +in the data directory. +.TP 3n +\(bu +\fB\-\-port=\fR\fB\fIport_num\fR\fR +.sp +The port number to use when listening for TCP/IP connections from clients. The default port number (assigned by IANA) is 2273. +.TP 3n +\(bu +\fB\-\-print\-defaults\fR +.sp +Print the current defaults and exit. This must be the first option on the command line if it is used. +.TP 3n +\(bu +\fB\-\-print\-password\-line\fR +.sp +Prepare an entry for the password file, print it to the standard output, and exit. You can redirect the output from Instance Manager to a file to save the entry in the file. +.sp +Prior to MySQL 5.1.12, this option was named +\fB\-\-passwd\fR. +.TP 3n +\(bu +\fB\-\-remove\fR +.sp +On Windows, removes Instance Manager as a Windows service. This assumes that Instance Manager has been run with +\fB\-\-install\fR +previously. +.TP 3n +\(bu +\fB\-\-run\-as\-service\fR +.sp +On Unix, daemonize and start an angel process. The angel process monitors Instance Manager and restarts it if it crashes. (The angel process itself is simple and unlikely to crash.) +.TP 3n +\(bu +\fB\-\-socket=\fR\fB\fIpath\fR\fR +.sp +On Unix, the socket file to use for incoming connections. The default file is named +\fI/tmp/mysqlmanager.sock\fR. This option has no meaning on Windows. +.TP 3n +\(bu +\fB\-\-standalone\fR +.sp +This option is used on Windows to run Instance Manager in standalone mode. You should specify it when you start Instance Manager from the command line. +.TP 3n +\(bu +\fB\-\-user=\fR\fB\fIuser_name\fR\fR +.sp +On Unix, the user name of the system account to use for starting and running +\fBmysqlmanager\fR. This option generates a warning and has no effect unless you start +\fBmysqlmanager\fR +as +root +(so that it can change its effective user ID), or as the named user. It is recommended that you configure +\fBmysqlmanager\fR +to run using the same account used to run the +\fBmysqld\fR +server. (\(lqUser\(rq +in this context refers to a system login account, not a MySQL user listed in the grant tables.) +.TP 3n +\(bu +\fB\-\-username=\fR\fB\fIuser_name\fR\fR, +\fB\-u \fR\fB\fIuser_name\fR\fR +.sp +Specify the user name for an entry to be added to or modified in the password file. This option was added in MySQL 5.1.12. +.TP 3n +\(bu +\fB\-\-version\fR, +\fB\-V\fR +.sp +Display version information and exit. +.TP 3n +\(bu +\fB\-\-wait\-timeout=\fR\fB\fIN\fR\fR +.sp +The number of seconds to wait for activity on an incoming connection before closing it. The default is 28800 seconds (8 hours). +.sp +This option was added in MySQL 5.1.7. Before that, the timeout is 30 seconds and cannot be changed. +.SH "MYSQL INSTANCE MANAGER CONFIGURATION FILES" +.sp +.it 1 an-trap +.nr an-no-space-flag 1 +.nr an-break-flag 1 +.br +\fBImportant\fR +.PP +MySQL Instance Manager has been deprecated and is removed in MySQL 6.0. +.PP +Instance Manager uses its standard configuration file unless it is started with a +\fB\-\-defaults\-file\fR +option that specifies a different file. On Windows, the standard file is +\fImy.ini\fR +in the directory where Instance Manager is installed. On Unix, the standard file is +\fI/etc/my.cnf\fR. +.PP +Instance Manager reads options for itself from the +[manager] +section of the configuration file, and options for server instances from +[mysqld] +or +[mysqld\fIN\fR] +sections. The +[manager] +section contains any of the options listed in +the section called \(lqMYSQL INSTANCE MANAGER COMMAND OPTIONS\(rq, except for those specified as having to be given as the first option on the command line. Here is a sample +[manager] +section: +.sp +.RS 3n +.nf +# MySQL Instance Manager options section +[manager] +default\-mysqld\-path = /usr/local/mysql/libexec/mysqld +socket=/tmp/manager.sock +pid\-file=/tmp/manager.pid +password\-file = /home/cps/.mysqlmanager.passwd +monitoring\-interval = 2 +port = 1999 +bind\-address = 192.168.1.5 +.fi +.RE +.PP +Each +[mysqld] +or +[mysqld\fIN\fR] +instance section specifies options given by Instance Manager to a server instance at startup. These are mainly common MySQL Server options (see +Section\ 5.1.2, \(lqServer Command Options\(rq). In addition, a +[mysqld\fIN\fR] +section can contain the options in the following list, which are specific to Instance Manager. These options are interpreted by Instance Manager itself; it does not pass them to the server when it attempts to start that server. +.sp +.it 1 an-trap +.nr an-no-space-flag 1 +.nr an-break-flag 1 +.br +\fBWarning\fR +.PP +The Instance Manager\-specific options must not be used in a +[mysqld] +section. If a server is started without using Instance Manager, it will not recognize these options and will fail to start properly. +.TP 3n +\(bu +mysqld\-path = \fIpath\fR +.sp +The path name of the +\fBmysqld\fR +server binary to use for the server instance. +.TP 3n +\(bu +nonguarded +.sp +This option disables Instance Manager monitoring functionality for the server instance. By default, an instance is guarded: At Instance Manager start time, it starts the instance. It also monitors the instance status and attempts to restart it if it fails. At Instance Manager exit time, it stops the instance. None of these things happen for nonguarded instances. +.TP 3n +\(bu +shutdown\-delay = \fIseconds\fR +.sp +The number of seconds Instance Manager should wait for the server instance to shut down. The default value is 35 seconds. After the delay expires, Instance Manager assumes that the instance is hanging and attempts to terminate it. If you use +InnoDB +with large tables, you should increase this value. +.sp +.RE +.PP +Here are some sample instance sections: +.sp +.RS 3n +.nf +[mysqld1] +mysqld\-path=/usr/local/mysql/libexec/mysqld +socket=/tmp/mysql.sock +port=3307 +server_id=1 +skip\-stack\-trace +core\-file +log\-bin +log\-error +log=mylog +log\-slow\-queries +[mysqld2] +nonguarded +port=3308 +server_id=2 +mysqld\-path= /home/cps/mysql/trees/mysql\-5.1/sql/mysqld +socket = /tmp/mysql.sock5 +pid\-file = /tmp/hostname.pid5 +datadir= /home/cps/mysql_data/data_dir1 +language=/home/cps/mysql/trees/mysql\-5.1/sql/share/english +log\-bin +log=/tmp/fordel.log +.fi +.RE +.SH "STARTING THE MYSQL SERVER WITH MYSQL INSTANCE MANAGER" +.sp +.it 1 an-trap +.nr an-no-space-flag 1 +.nr an-break-flag 1 +.br +\fBImportant\fR +.PP +MySQL Instance Manager has been deprecated and is removed in MySQL 6.0. +.PP +This section discusses how Instance Manager starts server instances when it starts. However, before you start Instance Manager, you should set up a password file for it. Otherwise, you will not be able to connect to Instance Manager to control it after it starts. For details about creating Instance Manager accounts, see +the section called \(lqINSTANCE MANAGER USER AND PASSWORD MANAGEMENT\(rq. +.PP +On Unix, the +\fBmysqld\fR +MySQL database server normally is started with the +\fBmysql.server\fR +script, which usually resides in the +/etc/init.d/ +folder. That script invokes the +\fBmysqld_safe\fR +script by default. However, you can use Instance Manager instead if you modify the +\fI/etc/my.cnf\fR +configuration file by adding +use\-manager +to the +[mysql.server] +section: +.sp +.RS 3n +.nf +[mysql.server] +use\-manager +.fi +.RE +.PP +Before MySQL 5.1.12, Instance Manager always tries to start at least one server instance: When it starts, it reads its configuration file if it exists to find server instance sections and prepare a list of instances. Instance sections have names of the form +[mysqld] +or +[mysqld\fIN\fR], where +\fIN\fR +is an unsigned integer (for example, +[mysqld1], +[mysqld2], and so forth). +.PP +After preparing the list of instances, Instance Manager starts the guarded instances in the list. If there are no instances, Instance Manager creates an instance named +mysqld +and attempts to start it with default (compiled\-in) configuration values. This means that the Instance Manager cannot find the +\fBmysqld\fR +program if it is not installed in the default location. (Section\ 2.1.5, \(lqInstallation Layouts\(rq, describes default locations for components of MySQL distributions.) If you have installed the MySQL server in a non\-standard location, you should create the Instance Manager configuration file. +.PP +The startup behavior just described is similar to that of +\fBmysqld_safe\fR, which always attempts to start a server. However, it lacks the flexibility required for some operations because it is not possible to run Instance Manager in such a way that it refrains from starting any server instances. For example, you cannot invoke Instance Manager for the purpose of configuring an instance without also starting it (a task that a MySQL installer application might want to perform). Consequently, MySQL 5.1.12 introduces the following changes: +.TP 3n +\(bu +A new option, +\fB\-\-mysqld\-safe\-compatible\fR, may be used to cause Instance Manager to run with startup behavior similar to that used before MySQL 5.1.12: If Instance Manager finds a +[mysqld] +instance section in the configuration file, it will start it. If Instance Manager finds no +[mysqld] +section, it creates one using default configuration values, writes a +[mysqld] +section to the configuration file if it is accessible, and starts the +mysqld +instance. Instance Manager also starts any other guarded instances listed in the configuration file. +.TP 3n +\(bu +Without +\fB\-\-mysqld\-safe\-compatible\fR, Instance Manager reads its configuration file if it exists and starts instances for any guarded instance sections that it finds. If there are none, it starts no instances. +.sp +.RE +.PP +Instance Manager also stops all guarded server instances when it shuts down. +.PP +The allowable options for +[mysqld\fIN\fR] +server instance sections are described in +the section called \(lqMYSQL INSTANCE MANAGER CONFIGURATION FILES\(rq. In these sections, you can use a special +\fBmysqld\-path=\fR\fB\fIpath\-to\-mysqld\-binary\fR\fR +option that is recognized only by Instance Manager. Use this option to let Instance Manager know where the +\fBmysqld\fR +binary resides. If there are multiple instances, it may also be necessary to set other options such as +\fBdatadir\fR +and +\fBport\fR, to ensure that each instance has a different data directory and TCP/IP port number. +Section\ 5.6, \(lqRunning Multiple MySQL Servers on the Same Machine\(rq, discusses the configuration values that must differ for each instance when you run multiple instance on the same machine. +.sp +.it 1 an-trap +.nr an-no-space-flag 1 +.nr an-break-flag 1 +.br +\fBWarning\fR +.PP +The +[mysqld] +instance section, if it exists, must not contain any Instance Manager\-specific options. +.PP +The typical Unix startup/shutdown cycle for a MySQL server with the MySQL Instance Manager enabled is as follows: +.TP 3n +1. +The +\fB/etc/init.d/mysql\fR +script starts MySQL Instance Manager. +.TP 3n +2. +Instance Manager starts the guarded server instances and monitors them. +.TP 3n +3. +If a server instance fails, Instance Manager restarts it. +.TP 3n +4. +If Instance Manager is shut down (for example, with the +\fB/etc/init.d/mysql stop\fR +command), it shuts down all server instances. +.SH "INSTANCE MANAGER USER AND PASSWORD MANAGEMENT" +.sp +.it 1 an-trap +.nr an-no-space-flag 1 +.nr an-break-flag 1 +.br +\fBImportant\fR +.PP +MySQL Instance Manager has been deprecated and is removed in MySQL 6.0. +.PP +The Instance Manager stores its user information in a password file. On Windows, the default is +\fImysqlmanager.passwd\fR +in the directory where Instance Manager is installed. On Unix, the default file is +\fI/etc/mysqlmanager.passwd\fR. To specify a different location for the password file, use the +\fB\-\-password\-file\fR +option. +.PP +If the password file does not exist or contains no password entries, you cannot connect to the Instance Manager. +.sp +.it 1 an-trap +.nr an-no-space-flag 1 +.nr an-break-flag 1 +.br +\fBNote\fR +.PP +Any Instance Manager process that is running to monitor server instances does not notice changes to the password file. You must stop it and restart it after making password entry changes. +.PP +Entries in the password file have the following format, where the two fields are the account user name and encrypted password, separated by a colon: +.sp +.RS 3n +.nf +petr:*35110DC9B4D8140F5DE667E28C72DD2597B5C848 +.fi +.RE +.PP +Instance Manager password encryption is the same as that used by MySQL Server. It is a one\-way operation; no means are provided for decrypting encrypted passwords. +.PP +Instance Manager accounts differ somewhat from MySQL Server accounts: +.TP 3n +\(bu +MySQL Server accounts are associated with a host name, user name, and password (see +Section\ 5.5.1, \(lqUser Names and Passwords\(rq). +.TP 3n +\(bu +Instance Manager accounts are associated with a user name and password only. +.sp +.RE +.PP +This means that a client can connect to Instance Manager with a given user name from any host. To limit connections so that clients can connect only from the local host, start Instance Manager with the +\fB\-\-bind\-address=127.0.0.1\fR +option so that it listens only to the local network interface. Remote clients will not be able to connect. Local clients can connect like this: +.sp +.RS 3n +.nf +shell> \fBmysql \-h 127.0.0.1 \-P 2273\fR +.fi +.RE +.PP +Before MySQL 5.1.12, the only option for creating password file entries is +\fB\-\-passwd\fR, which causes Instance Manager to prompt for user name and password values and display the resulting entry. You can save the output in the +\fI/etc/mysqlmanager.passwd\fR +password file to store it. Here is an example: +.sp +.RS 3n +.nf +shell> \fBmysqlmanager \-\-passwd >> /etc/mysqlmanager.passwd\fR +Creating record for new user. +Enter user name: \fBmike\fR +Enter password: \fBmikepass\fR +Re\-type password: \fBmikepass\fR +.fi +.RE +.PP +At the prompts, enter the user name and password for the new Instance Manager user. You must enter the password twice. It does not echo to the screen, so double entry guards against entering a different password than you intend (if the two passwords do not match, no entry is generated). +.PP +The preceding command causes the following line to be added to +\fI/etc/mysqlmanager.passwd\fR: +.sp +.RS 3n +.nf +mike:*BBF1F551DD9DD96A01E66EC7DDC073911BAD17BA +.fi +.RE +.PP +Use of the +\fB\-\-password\fR +option fails if +\fBmysqlmanager\fR +is invoked directly from an IBM 5250 terminal. To work around this, use a command like the following from the command line to generate the password entry: +.sp +.RS 3n +.nf +shell< \fBmysql \-B \-\-skip\-column\-name \\\fR + \fB\-e 'SELECT CONCAT("\fR\fB\fIuser_name\fR\fR\fB",":",PASSWORD("\fR\fB\fIpass_val\fR\fR\fB"));'\fR +.fi +.RE +.PP +The output from the command can be used an entry in the +\fI/etc/mysqlmanager.passwd\fR +file. +.PP +Beginning with MySQL 5.1.12, the +\fB\-\-passwd\fR +option is renamed to +\fB\-\-print\-password\-line\fR +and there are several other options for managing user accounts from the command line. For example, the +\fB\-\-username\fR +and +\fB\-\-password\fR +options are available on the command line for specifying the user name and password for an account entry. You can use them to generate an entry with no prompting like this (type the command on a single line): +.sp +.RS 3n +.nf +shell> \fBmysqlmanager \-\-print\-password\-line\fR + \fB\-\-username=mike \-\-password=mikepass >> /etc/mysqlmanager.passwd\fR +.fi +.RE +.PP +If you omit the +\fB\-\-username\fR +or +\fB\-\-password\fR +option, Instance Manager prompts for the required value. +.PP +\fB\-\-print\-password\-line\fR +causes Instance Manager to send the resulting account entry to its output, which you can append to the password file. The following list describes other account\-management options that cause Instance Manager to operate directly on the password file. (These options make Instance Manager scriptable for account\-management purposes.) For operations on the password file to succeed, the file must exist and it must be accessible by Instance Manager. (The exception is +\fB\-\-clean\-password\-file\fR, which creates the file if it does not exist. Alternatively, if there is no password file, manually create it as an empty file and ensure that its ownership and access modes allow it to be read and written by Instance Manager.) The default password file is used unless you specify a +\fB\-\-password\-file\fR +option. +.PP +To ensure consistent treatment of the password file, it should be owned by the system account that you use for running Instance Manager to manage server instances, and you should invoke it from that account when you use it to manage accounts in the password file. +.TP 3n +\(bu +Create a new user: +.sp +.RS 3n +.nf +mysqlmanager \-\-add\-user \-\-username=\fIuser_name\fR [\-\-password=\fIpassword\fR] +.fi +.RE +This command adds a new entry with the given user name and password to the password file. The +\fB\-\-username\fR +(or +\fB\-u\fR) option is required. +\fBmysqlmanager\fR +prompts for the password if it is not given on the command line with the +\fB\-\-password\fR +(or +\fB\-p\fR) option. The command fails if the user already exists. +.TP 3n +\(bu +Drop an existing user: +.sp +.RS 3n +.nf +mysqlmanager \-\-drop\-user \-\-username=\fIuser_name\fR +.fi +.RE +This command removes the entry with the given user name from the password file. The user name is required. The command fails if the user does not exist. +.TP 3n +\(bu +Change the password for an existing user: +.sp +.RS 3n +.nf +mysqlmanager \-\-edit\-user \-\-username=\fIuser_name\fR [\-\-password=\fIpassword\fR] +.fi +.RE +This command changes the given user's password in the password file. The user name is required. +\fBmysqlmanager\fR +prompts for the password it is not given on the command line. The command fails if the user does not exist. +.TP 3n +\(bu +List existing users: +.sp +.RS 3n +.nf +mysqlmanager \-\-list\-users +.fi +.RE +This command lists the user names of the accounts in the password file. +.TP 3n +\(bu +Check the password file: +.sp +.RS 3n +.nf +mysqlmanager \-\-check\-password\-file +.fi +.RE +This command performs a consistency and validity check of the password file. The command fails if there is something wrong with the file. +.TP 3n +\(bu +Empty the password file: +.sp +.RS 3n +.nf +mysqlmanager \-\-clean\-password\-file +.fi +.RE +This command empties the password file, which has the effect of dropping all users listed in it. The option creates the password file if it does not exist, so it can be used to initialize a new password file to be used for other account\-management operations. Take care not to use this option to reinitialize a file containing accounts that you do not want to drop. +.SH "MYSQL SERVER INSTANCE STATUS MONITORING" +.sp +.it 1 an-trap +.nr an-no-space-flag 1 +.nr an-break-flag 1 +.br +\fBImportant\fR +.PP +MySQL Instance Manager has been deprecated and is removed in MySQL 6.0. +.PP +To monitor the status of each guarded server instance, the MySQL Instance Manager attempts to connect to the instance at regular intervals using the +MySQL_Instance_Manager@localhost +user account with a password of +check_connection. +.PP +You are +\fInot\fR +required to create this account for MySQL Server; in fact, it is expected that it will not exist. Instance Manager can tell that a server is operational if the server accepts the connection attempt but refuses access for the account by returning a login error. However, these failed connection attempts are logged by the server to its general query log (see +Section\ 5.2.3, \(lqThe General Query Log\(rq). +.PP +Instance Manager also attempts a connection to nonguarded server instances when you use the +SHOW INSTANCES +or +SHOW INSTANCE STATUS +command. This is the only status monitoring done for nonguarded instances. +.PP +Instance Manager knows if a server instance fails at startup because it receives a status from the attempt. For an instance that starts but later crashes, Instance Manager receives a signal because it is the parent process of the instance. +.PP +Beginning with MySQL 5.1.12, Instance Manager tracks instance states so that it can determine which commands are allowed for each instance. For example, commands that modify an instance's configuration are allowed only while the instance is offline. +.PP +Each instance is in one of the states described in the following table. Guarded instances can be in any of the states. Nonguarded instances can only be offline or online. Instance state information is displayed in the +status +column of the +SHOW INSTANCES +and +SHOW INSTANCE STATUS +commands. +.TS +allbox tab(:); +l l +l l +l l +l l +l l +l l +l l +l l. +T{ +\fBState\fR +T}:T{ +\fBMeaning\fR +T} +T{ +offline +T}:T{ +The instance has not been started and is not running. +T} +T{ +starting +T}:T{ +The instance is starting (initializing). Nonguarded instances cannot be + in this state. A nonguarded instance goes directly from + offline to online. +T} +T{ +stopping +T}:T{ +The instance is stopping. Nonguarded instances cannot be in this state. + A nonguarded instance goes directly from online to + offline, or stays offline if startup fails. +T} +T{ +online +T}:T{ +The instance has started and is running. +T} +T{ +failed +T}:T{ +The instance was online but it crashed and is being restarted by + Instance Manager, or else the instance failed to start + at all and Instance Manager is again attempting to start + it. Nonguarded instances cannot be in this state. +T} +T{ +crashed +T}:T{ +Instance Manager failed to start the instance after several attempts. + (Instance Manager will try again later.) Nonguarded + instances cannot be in this state. +T} +T{ +abandoned +T}:T{ +Instance Manager was not able to start the instance, has given up, and + will make no further attempts until instructed + otherwise. To tell Instance Manager to try again, you + must first use STOP INSTANCE to put + the instance in offline state, and then use + START INSTANCE to start the instance. + If it is necessary to make configuration changes for the + instance, you must do so after putting the instance + offline and before starting it. (Instance Manager + accepts configuration\-changing commands only for offline + instances.) Nonguarded instances cannot be in this + state. +T} +.TE +.sp +.SH "CONNECTING TO MYSQL INSTANCE MANAGER" +.sp +.it 1 an-trap +.nr an-no-space-flag 1 +.nr an-break-flag 1 +.br +\fBImportant\fR +.PP +MySQL Instance Manager has been deprecated and is removed in MySQL 6.0. +.PP +After you set up a password file for the MySQL Instance Manager and Instance Manager is running, you can connect to it. The MySQL client\-server protocol is used to communicate with the Instance Manager. For example, you can connect to it using the standard +\fBmysql\fR +client program: +.sp +.RS 3n +.nf +shell> \fBmysql \-\-port=2273 \-\-host=im.example.org \-\-user=mysql \-\-password\fR +.fi +.RE +.PP +Instance Manager supports the version of the MySQL client\-server protocol used by the client tools and libraries distributed with MySQL 4.1 or later, so other programs that use the MySQL C API also can connect to it. +.SH "MYSQL INSTANCE MANAGER COMMANDS" +.sp +.it 1 an-trap +.nr an-no-space-flag 1 +.nr an-break-flag 1 +.br +\fBImportant\fR +.PP +MySQL Instance Manager has been deprecated and is removed in MySQL 6.0. +.PP +After you connect to MySQL Instance Manager, you can issue commands. The following general principles apply to Instance Manager command execution: +.TP 3n +\(bu +Commands that take an instance name fail if the name is not a valid instance name. +.TP 3n +\(bu +Commands that take an instance name (other than +CREATE INSTANCE) fail if the instance does not exist. +.TP 3n +\(bu +As of MySQL 5.1.12, commands for an instance require that the instance be in an appropriate state. You cannot configure or start an instance that is not offline. You cannot start an instance that is online. +.TP 3n +\(bu +Instance Manager maintains information about instance configuration in an internal (in\-memory) cache. Initially, this information comes from the configuration file if it exists, but some commands change the configuration of an instance. Commands that modify the configuration file fail if the file does not exist or is not accessible to Instance Manager. +.sp +As of MySQL 5.1.12, configuration\-changing commands modify both the in\-memory cache and the server instance section recorded in the configuration file to maintain consistency between them. For this to occur, the instance must be offline and the configuration file must be accessible and not malformed. If the configuration file cannot be updated, the command fails and the cache remains unchanged. +.TP 3n +\(bu +On Windows, the standard file is +\fImy.ini\fR +in the directory where Instance Manager is installed. On Unix, the standard configuration file is +\fI/etc/my.cnf\fR. To specify a different configuration file, start Instance Manager with the +\fB\-\-defaults\-file\fR +option. +.TP 3n +\(bu +If a +[mysqld] +instance section exists in the configuration file, it must not contain any Instance Manager\-specific options (see +the section called \(lqMYSQL INSTANCE MANAGER CONFIGURATION FILES\(rq). Therefore, you must not add any of these options if you change the configuration for an instance named +mysqld. +.sp +.RE +.PP +The following list describes the commands that Instance Manager accepts, with examples. +.TP 3n +\(bu +CREATE INSTANCE \fIinstance_name\fR [\fIoption_name\fR[=\fIoption_value\fR], ...] +.sp +This command configures a new instance by creating an +[\fIinstance_name\fR] +section in the configuration file. The command fails if +\fIinstance_name\fR +is not a valid instance name or the instance already exists. +.sp +The created section instance is empty if no options are given. Otherwise, the options are added to the section. Options should be given in the same format used when you write options in option files. (See +Section\ 4.2.3.2, \(lqUsing Option Files\(rq +for a description of the allowable syntax.) If you specify multiple options, separate them by commas. +.sp +For example, to create an instance section named +[mysqld98], you might write something like this were you to modify the configuration file directly: +.sp +.RS 3n +.nf +[mysqld98] +basedir=/var/mysql98 +.fi +.RE +To achieve the same effect via +CREATE INSTANCE, issue this command to Instance Manager: +.sp +.RS 3n +.nf +mysql> \fBCREATE INSTANCE mysqld98 basedir="/var/mysql98";\fR +Query OK, 0 rows affected (0,00 sec) +.fi +.RE +CREATE INSTANCE +creates the instance but does not start it. +.sp +If the instance name is the (deprecated) name +mysqld, the option list cannot include any options that are specific to Instance Manager, such as +nonguarded +(see +the section called \(lqMYSQL INSTANCE MANAGER CONFIGURATION FILES\(rq). +.sp +This command was added in MySQL 5.1.12. +.TP 3n +\(bu +DROP INSTANCE \fIinstance_name\fR +.sp +This command removes the configuration for +\fIinstance_name\fR +from the configuration file. +.sp +.RS 3n +.nf +mysql> \fBDROP INSTANCE mysqld98;\fR +Query OK, 0 rows affected (0,00 sec) +.fi +.RE +The command fails if +\fIinstance_name\fR +is not a valid instance name, the instance does not exist, or is not offline. +.sp +This command was added in MySQL 5.1.12. +.TP 3n +\(bu +START INSTANCE \fIinstance_name\fR +.sp +This command attempts to start an offline instance. The command is asynchronous; it does not wait for the instance to start. +.sp +.RS 3n +.nf +mysql> \fBSTART INSTANCE mysqld4;\fR +Query OK, 0 rows affected (0,00 sec) +.fi +.RE +.TP 3n +\(bu +STOP INSTANCE \fIinstance_name\fR +.sp +This command attempts to stop an instance. The command is synchronous; it waits for the instance to stop. +.sp +.RS 3n +.nf +mysql> \fBSTOP INSTANCE mysqld4;\fR +Query OK, 0 rows affected (0,00 sec) +.fi +.RE +.TP 3n +\(bu +SHOW INSTANCES +.sp +Shows the names and status of all loaded instances. +.sp +.RS 3n +.nf +mysql> \fBSHOW INSTANCES;\fR ++\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-+ +| instance_name | status | ++\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-+ +| mysqld3 | offline | +| mysqld4 | online | +| mysqld2 | offline | ++\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-+ +.fi +.RE +.TP 3n +\(bu +SHOW INSTANCE STATUS \fIinstance_name\fR +.sp +Shows status and version information for an instance. +.sp +.RS 3n +.nf +mysql> \fBSHOW INSTANCE STATUS mysqld3;\fR ++\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-+ +| instance_name | status | version | ++\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-+ +| mysqld3 | online | unknown | ++\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-+ +.fi +.RE +.TP 3n +\(bu +SHOW INSTANCE OPTIONS \fIinstance_name\fR +.sp +Shows the options used by an instance. +.sp +.RS 3n +.nf +mysql> \fBSHOW INSTANCE OPTIONS mysqld3;\fR ++\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+ +| option_name | value | ++\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+ +| instance_name | mysqld3 | +| mysqld\-path | /home/cps/mysql/trees/mysql\-4.1/sql/mysqld | +| port | 3309 | +| socket | /tmp/mysql.sock3 | +| pid\-file | hostname.pid3 | +| datadir | /home/cps/mysql_data/data_dir1/ | +| language | /home/cps/mysql/trees/mysql\-4.1/sql/share/english | ++\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+ +.fi +.RE +.TP 3n +\(bu +SHOW \fIinstance_name\fR LOG FILES +.sp +The command lists all log files used by the instance. The result set contains the path to the log file and the log file size. If no log file path is specified in the instance section of the configuration file (for example, +log=/var/mysql.log), the Instance Manager tries to guess its placement. If Instance Manager is unable to guess the log file placement you should specify the log file location explicitly by using a log option in the appropriate instance section of the configuration file. +.sp +.RS 3n +.nf +mysql> \fBSHOW mysqld LOG FILES;\fR ++\-\-\-\-\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-\-+ +| Logfile | Path | Filesize | ++\-\-\-\-\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-\-+ +| ERROR LOG | /home/cps/var/mysql/owlet.err | 9186 | +| GENERAL LOG | /home/cps/var/mysql/owlet.log | 471503 | +| SLOW LOG | /home/cps/var/mysql/owlet\-slow.log | 4463 | ++\-\-\-\-\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-\-+ +.fi +.RE +SHOW ... LOG FILES +displays information only about log files. If a server instance uses log tables (see +Section\ 5.2.1, \(lqSelecting General Query and Slow Query Log Output Destinations\(rq), no information about those tables is shown. +.sp +Log options are described in +Section\ 5.1.2, \(lqServer Command Options\(rq. +.TP 3n +\(bu +SHOW \fIinstance_name\fR LOG {ERROR | SLOW | GENERAL} \fIsize\fR[,\fIoffset_from_end\fR] +.sp +This command retrieves a portion of the specified log file. Because most users are interested in the latest log messages, the +\fIsize\fR +parameter defines the number of bytes to retrieve from the end of the log. To retrieve data from the middle of the log file, specify the optional +\fIoffset_from_end\fR +parameter. The following example retrieves 21 bytes of data, starting 23 bytes before the end of the log file and ending 2 bytes before the end: +.sp +.RS 3n +.nf +mysql> \fBSHOW mysqld LOG GENERAL 21, 2;\fR ++\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+ +| Log | ++\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+ +| using password: YES | ++\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+ +.fi +.RE +.TP 3n +\(bu +SET \fIinstance_name\fR.\fIoption_name\fR[=\fIoption_value\fR] +.sp +This command edits the specified instance's configuration section to change or add instance options. The option is added to the section is it is not already present. Otherwise, the new setting replaces the existing one. +.sp +.RS 3n +.nf +mysql> \fBSET mysqld2.port=3322;\fR +Query OK, 0 rows affected (0.00 sec) +.fi +.RE +As of MySQL 5.1.12, you can specify multiple options (separated by commas), and +SET +can be used only for offline instances. Each option must indicate the instance name: +.sp +.RS 3n +.nf +mysql> \fBSET mysqld2.port=3322, mysqld3.nonguarded;\fR +Query OK, 0 rows affected (0.00 sec) +.fi +.RE +Before MySQL 5.1.12, only a single option can be specified. Also, changes made to the configuration file do not take effect until the MySQL server is restarted. In addition, these changes are not stored in the instance manager's local cache of instance settings until a +FLUSH INSTANCES +command is executed. +.TP 3n +\(bu +UNSET \fIinstance_name\fR.\fIoption_name\fR +.sp +This command removes an option from an instance's configuration section. +.sp +.RS 3n +.nf +mysql> \fBUNSET mysqld2.port;\fR +Query OK, 0 rows affected (0.00 sec) +.fi +.RE +As of MySQL 5.1.12, you can specify multiple options (separated by commas), and +UNSET +can be used only for offline instances. Each option must indicate the instance name: +.sp +.RS 3n +.nf +mysql> \fBUNSET mysqld2.port, mysqld4.nonguarded;\fR +Query OK, 0 rows affected (0.00 sec) +.fi +.RE +Before MySQL 5.1.12, only a single option can be specified. Also, changes made to the configuration file do not take effect until the MySQL server is restarted. In addition, these changes are not stored in the instance manager's local cache of instance settings until a +FLUSH INSTANCES +command is executed. +.TP 3n +\(bu +FLUSH INSTANCES +.sp +As of MySQL 5.1.12, +FLUSH INSTANCES +cannot be used unless all instances are offline. The command causes Instance Manager to reread the configuration file, update its in\-memory configuration cache, and start any guarded instances. +.sp +Before MySQL 5.1.12, this command forces Instance Manager reread the configuration file and to refresh internal structures. This command should be performed after editing the configuration file. The command does not restart instances. +.sp +.RS 3n +.nf +mysql> \fBFLUSH INSTANCES;\fR +Query OK, 0 rows affected (0.04 sec) +.fi +.RE +.SH "COPYRIGHT" +.PP +Copyright 2007\-2008 MySQL AB, 2009 Sun Microsystems, Inc. +.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/. +.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 +MySQL AB (http://www.mysql.com/). diff --git a/man/mysqlshow.1 b/man/mysqlshow.1 new file mode 100644 index 00000000000..8730339159c --- /dev/null +++ b/man/mysqlshow.1 @@ -0,0 +1,237 @@ +.\" Title: \fBmysqlshow\fR +.\" Author: +.\" Generator: DocBook XSL Stylesheets v1.70.1 <http://docbook.sf.net/> +.\" Date: 03/31/2009 +.\" Manual: MySQL Database System +.\" Source: MySQL 5.1 +.\" +.TH "\fBMYSQLSHOW\fR" "1" "03/31/2009" "MySQL 5.1" "MySQL Database System" +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.SH "NAME" +mysqlshow \- display database, table, and column information +.SH "SYNOPSIS" +.HP 52 +\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's columns or indexes. +.PP +\fBmysqlshow\fR +provides a command\-line interface to several SQL +SHOW +statements. See +Section\ 12.5.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 +.RS 3n +.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 +.RE +.TP 3n +\(bu +If no database is given, a list of database names is shown. +.TP 3n +\(bu +If no table is given, all matching tables in the database are shown. +.TP 3n +\(bu +If no column is given, all matching columns and column types in the table are shown. +.sp +.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: +.TP 3n +\(bu +\fB\-\-help\fR, +\fB\-?\fR +.sp +Display a help message and exit. +.TP 3n +\(bu +\fB\-\-character\-sets\-dir=\fR\fB\fIpath\fR\fR +.sp +The directory where character sets are installed. See +Section\ 9.2, \(lqThe Character Set Used for Data and Sorting\(rq. +.TP 3n +\(bu +\fB\-\-compress\fR, +\fB\-C\fR +.sp +Compress all information sent between the client and the server if both support compression. +.TP 3n +\(bu +\fB\-\-count\fR +.sp +Show the number of rows per table. This can be slow for non\-MyISAM +tables. +.TP 3n +\(bu +\fB\-\-debug[=\fR\fB\fIdebug_options\fR\fR\fB]\fR, +\fB\-# [\fR\fB\fIdebug_options\fR\fR\fB]\fR +.sp +Write a debugging log. The +\fIdebug_options\fR +string often is +\'d:t:o,\fIfile_name\fR'. +.TP 3n +\(bu +\fB\-\-debug\-check\fR +.sp +Print some debugging information when the program exits. This option was added in MySQL 5.1.21. +.TP 3n +\(bu +\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. +.TP 3n +\(bu +\fB\-\-default\-character\-set=\fR\fB\fIcharset_name\fR\fR +.sp +Use +\fIcharset_name\fR +as the default character set. See +Section\ 9.2, \(lqThe Character Set Used for Data and Sorting\(rq. +.TP 3n +\(bu +\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. +.TP 3n +\(bu +\fB\-\-keys\fR, +\fB\-k\fR +.sp +Show table indexes. +.TP 3n +\(bu +\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, you are prompted for one. +.sp +Specifying a password on the command line should be considered insecure. See +Section\ 5.5.6.2, \(lqEnd\-User Guidelines for Password Security\(rq. +.TP 3n +\(bu +\fB\-\-pipe\fR, +\fB\-W\fR +.sp +On Windows, connect to the server via a named pipe. This option applies only for connections to a local server, and only if the server supports named\-pipe connections. +.TP 3n +\(bu +\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. +.TP 3n +\(bu +\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 allowable values, see +Section\ 4.2.2, \(lqConnecting to the MySQL Server\(rq. +.TP 3n +\(bu +\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. +.TP 3n +\(bu +\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. +.TP 3n +\(bu +\fB\-\-ssl*\fR +.sp +Options that begin with +\fB\-\-ssl\fR +specify whether to connect to the server via SSL and indicate where to find SSL keys and certificates. See +Section\ 5.5.7.3, \(lqSSL Command Options\(rq. +.TP 3n +\(bu +\fB\-\-status\fR, +\fB\-i\fR +.sp +Display extra information about each table. +.TP 3n +\(bu +\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. +.TP 3n +\(bu +\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. +.TP 3n +\(bu +\fB\-\-version\fR, +\fB\-V\fR +.sp +Display version information and exit. +.SH "COPYRIGHT" +.PP +Copyright 2007\-2008 MySQL AB, 2009 Sun Microsystems, Inc. +.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/. +.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 +MySQL AB (http://www.mysql.com/). diff --git a/man/mysqlslap.1 b/man/mysqlslap.1 new file mode 100644 index 00000000000..8c9782060a4 --- /dev/null +++ b/man/mysqlslap.1 @@ -0,0 +1,454 @@ +.\" Title: \fBmysqlslap\fR +.\" Author: +.\" Generator: DocBook XSL Stylesheets v1.70.1 <http://docbook.sf.net/> +.\" Date: 03/31/2009 +.\" Manual: MySQL Database System +.\" Source: MySQL 5.1 +.\" +.TH "\fBMYSQLSLAP\fR" "1" "03/31/2009" "MySQL 5.1" "MySQL Database System" +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.SH "NAME" +mysqlslap \- load emulation client +.SH "SYNOPSIS" +.HP 20 +\fBmysqlslap [\fR\fB\fIoptions\fR\fR\fB]\fR +.SH "DESCRIPTION" +.PP +\fBmysqlslap\fR +is a diagnostic program designed to emulate client load for a MySQL server and to report the timing of each stage. It works as if multiple clients are accessing the server. +\fBmysqlslap\fR +is available as of MySQL 5.1.4. +.PP +Invoke +\fBmysqlslap\fR +like this: +.sp +.RS 3n +.nf +shell> \fBmysqlslap [\fR\fB\fIoptions\fR\fR\fB]\fR +.fi +.RE +.PP +Some options such as +\fB\-\-create\fR +or +\fB\-\-query\fR +enable you to specify a string containing an SQL statement or a file containing statements. If you specify a file, by default it must contain one statement per line. (That is, the implicit statement delimiter is the newline character.) Use the +\fB\-\-delimiter\fR +option to specify a different delimiter, which enables you to specify statements that span multiple lines or place multiple statements on a single line. You cannot include comments in a file; +\fBmysqlslap\fR +does not understand them. +.PP +\fBmysqlslap\fR +runs in three stages: +.TP 3n +1. +Create schema, table, and optionally any stored programs or data you want to using for the test. This stage uses a single client connection. +.TP 3n +2. +Run the load test. This stage can use many client connections. +.TP 3n +3. +Clean up (disconnect, drop table if specified). This stage uses a single client connection. +.sp +.RE +.PP +Examples: +.PP +Supply your own create and query SQL statements, with 50 clients querying and 200 selects for each: +.sp +.RS 3n +.nf +mysqlslap \-\-delimiter=";" \\ + \-\-create="CREATE TABLE a (b int);INSERT INTO a VALUES (23)" \\ + \-\-query="SELECT * FROM a" \-\-concurrency=50 \-\-iterations=200 +.fi +.RE +.PP +Let +\fBmysqlslap\fR +build the query SQL statement with a table of two +INT +columns and three +VARCHAR +columns. Use five clients querying 20 times each. Do not create the table or insert the data (that is, use the previous test's schema and data): +.sp +.RS 3n +.nf +mysqlslap \-\-concurrency=5 \-\-iterations=20 \\ + \-\-number\-int\-cols=2 \-\-number\-char\-cols=3 \\ + \-\-auto\-generate\-sql +.fi +.RE +.PP +Tell the program to load the create, insert, and query SQL statements from the specified files, where the +\fIcreate.sql\fR +file has multiple table creation statements delimited by +\';' +and multiple insert statements delimited by +\';'. The +\fB\-\-query\fR +file will have multiple queries delimited by +\';'. Run all the load statements, then run all the queries in the query file with five clients (five times each): +.sp +.RS 3n +.nf +mysqlslap \-\-concurrency=5 \\ + \-\-iterations=5 \-\-query=query.sql \-\-create=create.sql \\ + \-\-delimiter=";" +.fi +.RE +.PP +\fBmysqlslap\fR +supports the options in the following list. It also reads option files and supports the options for processing them described at +Section\ 4.2.3.2.1, \(lqCommand\-Line Options that Affect Option\-File Handling\(rq. +.TP 3n +\(bu +\fB\-\-help\fR, +\fB\-?\fR +.sp +Display a help message and exit. +.TP 3n +\(bu +\fB\-\-auto\-generate\-sql\fR, +\fB\-a\fR +.sp +Generate SQL statements automatically when they are not supplied in files or via command options. +.TP 3n +\(bu +\fB\-\-auto\-generate\-sql\-add\-autoincrement\fR +.sp +Add an +AUTO_INCREMENT +column to automatically generated tables. This option was added in MySQL 5.1.18. +.TP 3n +\(bu +\fB\-\-auto\-generate\-sql\-execute\-number=\fR\fB\fIN\fR\fR +.sp +Specify how many queries to generate automatically. This option was added in MySQL 5.1.18. +.TP 3n +\(bu +\fB\-\-auto\-generate\-sql\-guid\-primary\fR +.sp +Add a GUID\-based primary key to automatically generated tables. This option was added in MySQL 5.1.18. +.TP 3n +\(bu +\fB\-\-auto\-generate\-sql\-load\-type=\fR\fB\fItype\fR\fR +.sp +Specify the test load type. The allowable values are +read +(scan tables), +write +(insert into tables), +key +(read primary keys), +update +(update primary keys), or +mixed +(half inserts, half scanning selects). The default is +mixed. This option was added in MySQL 5.1.16. +.TP 3n +\(bu +\fB\-\-auto\-generate\-sql\-secondary\-indexes=\fR\fB\fIN\fR\fR +.sp +Specify how many secondary indexes to add to automatically generated tables. By default, none are added. This option was added in MySQL 5.1.18. +.TP 3n +\(bu +\fB\-\-auto\-generate\-sql\-unique\-query\-number=\fR\fB\fIN\fR\fR +.sp +How many different queries to generate for automatic tests. For example, if you run a +key +test that performs 1000 selects, you can use this option with a value of 1000 to run 1000 unique queries, or with a value of 50 to perform 50 different selects. The default is 10. This option was added in MySQL 5.1.18. +.TP 3n +\(bu +\fB\-\-auto\-generate\-sql\-unique\-write\-number=\fR\fB\fIN\fR\fR +.sp +How many different queries to generate for +\fB\-\-auto\-generate\-sql\-write\-number\fR. The default is 10. This option was added in MySQL 5.1.18. +.TP 3n +\(bu +\fB\-\-auto\-generate\-sql\-write\-number=\fR\fB\fIN\fR\fR +.sp +How many row inserts to perform on each thread. The default is 100. This option was added in MySQL 5.1.16. +.TP 3n +\(bu +\fB\-\-commit=\fR\fB\fIN\fR\fR +.sp +How many statements to execute before committing. The default is 0 (no commits are done). This option was added in MySQL 5.1.21. +.TP 3n +\(bu +\fB\-\-compress\fR, +\fB\-C\fR +.sp +Compress all information sent between the client and the server if both support compression. +.TP 3n +\(bu +\fB\-\-concurrency=\fR\fB\fIN\fR\fR, +\fB\-c \fR\fB\fIN\fR\fR +.sp +The number of clients to simulate when issuing the +SELECT +statement. +.TP 3n +\(bu +\fB\-\-create=\fR\fB\fIvalue\fR\fR +.sp +The file or string containing the statement to use for creating the table. +.TP 3n +\(bu +\fB\-\-create\-schema=\fR\fB\fIvalue\fR\fR +.sp +The schema in which to run the tests. This option was added in MySQL 5.1.5. +.TP 3n +\(bu +\fB\-\-csv[=\fR\fB\fIfile_name\fR\fR\fB]\fR +.sp +Generate output in comma\-separated values format. The output goes to the named file, or to the standard output if no file is given. This option was added in MySQL 5.1.5. +.TP 3n +\(bu +\fB\-\-debug[=\fR\fB\fIdebug_options\fR\fR\fB]\fR, +\fB\-# [\fR\fB\fIdebug_options\fR\fR\fB]\fR +.sp +Write a debugging log. The +\fIdebug_options\fR +string often is +\'d:t:o,\fIfile_name\fR'. +.TP 3n +\(bu +\fB\-\-debug\-check\fR +.sp +Print some debugging information when the program exits. This option was added in MySQL 5.1.21. +.TP 3n +\(bu +\fB\-\-debug\-info\fR, +\fB\-T\fR +.sp +Print debugging information and memory and CPU usage statistics when the program exits. This option was added in MySQL 5.1.21. +.TP 3n +\(bu +\fB\-\-delimiter=\fR\fB\fIstr\fR\fR, +\fB\-F \fR\fB\fIstr\fR\fR +.sp +The delimiter to use in SQL statements supplied in files or via command options. +.TP 3n +\(bu +\fB\-\-detach=\fR\fB\fIN\fR\fR +.sp +Detach (close and reopen) each connection after each +\fIN\fR +statements. The default is 0 (connections are not detached). This option was added in MySQL 5.1.21. +.TP 3n +\(bu +\fB\-\-engine=\fR\fB\fIengine_name\fR\fR, +\fB\-e \fR\fB\fIengine_name\fR\fR +.sp +The storage engine to use for creating tables. +.TP 3n +\(bu +\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. +.TP 3n +\(bu +\fB\-\-iterations=\fR\fB\fIN\fR\fR, +\fB\-i \fR\fB\fIN\fR\fR +.sp +The number of times to run the tests. +.TP 3n +\(bu +\fB\-\-lock\-directory=\fR\fB\fIpath\fR\fR +.sp +The directory to use for storing locks. This option was added in MySQL 5.1.5 and removed in 5.1.18. +.TP 3n +\(bu +\fB\-\-number\-char\-cols=\fR\fB\fIN\fR\fR, +\fB\-x \fR\fB\fIN\fR\fR +.sp +The number of +VARCHAR +columns to use if +\fB\-\-auto\-generate\-sql\fR +is specified. +.TP 3n +\(bu +\fB\-\-number\-int\-cols=\fR\fB\fIN\fR\fR, +\fB\-y \fR\fB\fIN\fR\fR +.sp +The number of +INT +columns to use if +\fB\-\-auto\-generate\-sql\fR +is specified. +.TP 3n +\(bu +\fB\-\-number\-of\-queries=\fR\fB\fIN\fR\fR +.sp +Limit each client to approximately this number of queries. This option was added in MySQL 5.1.5. +.TP 3n +\(bu +\fB\-\-only\-print\fR +.sp +Do not connect to databases. +\fBmysqlslap\fR +only prints what it would have done. This option was added in MySQL 5.1.5. +.TP 3n +\(bu +\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, you are prompted for one. +.sp +Specifying a password on the command line should be considered insecure. See +Section\ 5.5.6.2, \(lqEnd\-User Guidelines for Password Security\(rq. +.TP 3n +\(bu +\fB\-\-pipe\fR, +\fB\-W\fR +.sp +On Windows, connect to the server via a named pipe. This option applies only for connections to a local server, and only if the server supports named\-pipe connections. +.TP 3n +\(bu +\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. +.TP 3n +\(bu +\fB\-\-post\-query=\fR\fB\fIvalue\fR\fR +.sp +The file or string containing the statement to execute after the tests have completed. This execution is not counted for timing purposes. This option was added in MySQL 5.1.18. +.TP 3n +\(bu +\fB\-\-shared\-memory\-base\-name=\fR\fB\fIname\fR\fR +.sp +On Windows, the shared\-memory name to use, for connections made via shared memory to a local server. This option applies only if the server supports shared\-memory connections. +.TP 3n +\(bu +\fB\-\-post\-system=\fR\fB\fIstr\fR\fR +.sp +The string to execute via +system() +after the tests have completed. This execution is not counted for timing purposes. This option was added in MySQL 5.1.21. +.TP 3n +\(bu +\fB\-\-pre\-query=\fR\fB\fIvalue\fR\fR +.sp +The file or string containing the statement to execute before running the tests. This execution is not counted for timing purposes. This option was added in MySQL 5.1.18. +.TP 3n +\(bu +\fB\-\-pre\-system=\fR\fB\fIstr\fR\fR +.sp +The string to execute via +system() +before running the tests. This execution is not counted for timing purposes. This option was added in MySQL 5.1.21. +.TP 3n +\(bu +\fB\-\-preserve\-schema\fR +.sp +Preserve the schema from the +\fBmysqlslap\fR +run. The +\fB\-\-auto\-generate\-sql\fR +and +\fB\-\-create\fR +options disable this option. This option was added in MySQL 5.1.5 and removed in MySQL 5.1.23. +.TP 3n +\(bu +\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 allowable values, see +Section\ 4.2.2, \(lqConnecting to the MySQL Server\(rq. +.TP 3n +\(bu +\fB\-\-query=\fR\fB\fIvalue\fR\fR, +\fB\-q \fR\fB\fIvalue\fR\fR +.sp +The file or string containing the +SELECT +statement to use for retrieving data. +.TP 3n +\(bu +\fB\-\-silent\fR, +\fB\-s\fR +.sp +Silent mode. No output. +.TP 3n +\(bu +\fB\-\-slave\fR +.sp +Follow master locks for other +\fBmysqlslap\fR +clients. Use this option if you are trying to synchronize around one master server with +\fB\-\-lock\-directory\fR +plus NFS. This option was added in MySQL 5.1.5 and removed in 5.1.18. +.TP 3n +\(bu +\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. +.TP 3n +\(bu +\fB\-\-ssl*\fR +.sp +Options that begin with +\fB\-\-ssl\fR +specify whether to connect to the server via SSL and indicate where to find SSL keys and certificates. See +Section\ 5.5.7.3, \(lqSSL Command Options\(rq. +.TP 3n +\(bu +\fB\-\-use\-threads\fR +.sp +On Unix, the default is to use +fork() +calls and this option causes +\fBpthread\fR +calls to be used instead. (On Windows, the default is to use +pthread +calls and the option has no effect.) This option was added in MySQL 5.1.6 and removed in 5.1.18. +.TP 3n +\(bu +\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. +.TP 3n +\(bu +\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. +.TP 3n +\(bu +\fB\-\-version\fR, +\fB\-V\fR +.sp +Display version information and exit. +.SH "COPYRIGHT" +.PP +Copyright 2007\-2008 MySQL AB, 2009 Sun Microsystems, Inc. +.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/. +.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 +MySQL AB (http://www.mysql.com/). diff --git a/man/mysqltest.1 b/man/mysqltest.1 new file mode 100644 index 00000000000..340a8c64f72 --- /dev/null +++ b/man/mysqltest.1 @@ -0,0 +1,383 @@ +.\" Title: \fBmysqltest\fR +.\" Author: +.\" Generator: DocBook XSL Stylesheets v1.70.1 <http://docbook.sf.net/> +.\" Date: 03/27/2009 +.\" Manual: MySQL Database System +.\" Source: MySQL +.\" +.TH "\fBMYSQLTEST\fR" "1" "03/27/2009" "MySQL" "MySQL Database System" +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.SH "NAME" +mysqltest \- program to run test cases +.br +mysqltest_embedded \- program to run embedded test cases +.SH "SYNOPSIS" +.HP 30 +\fBmysqltest [\fR\fB\fIoptions\fR\fR\fB] [\fR\fB\fIdb_name\fR\fR\fB]\fR +.HP 39 +\fBmysqltest_embedded [\fR\fB\fIoptions\fR\fR\fB] [\fR\fB\fIdb_name\fR\fR\fB]\fR +.SH "DESCRIPTION" +.PP +The +\fBmysqltest\fR +program runs a test case against a MySQL server and optionally compares the output with a result file. This program reads input written in a special test language. Typically, you invoke +\fBmysqltest\fR +via +\fBmysql\-test\-run.pl\fR +rather than invoking it directly. +.PP +\fBmysqltest_embedded\fR +is similar but is built with support for the +libmysqld +embedded server. +.PP +Features of +\fBmysqltest\fR: +.TP 3n +\(bu +Can send SQL statements to MySQL servers for execution +.TP 3n +\(bu +Can execute external shell commands +.TP 3n +\(bu +Can test whether the result from an SQL statement or shell command is as expected +.TP 3n +\(bu +Can connect to one or more standalone +\fBmysqld\fR +servers and switch between connections +.TP 3n +\(bu +Can connect to an embedded server (libmysqld), if MySQL is compiled with support for +libmysqld. (In this case, the executable is named +\fBmysqltest_embedded\fR +rather than +\fBmysqltest\fR.) +.sp +.RE +.PP +By default, +\fBmysqltest\fR +reads the test case on the standard input. To run +\fBmysqltest\fR +this way, you normally invoke it like this: +.sp +.RS 3n +.nf +shell> \fBmysqltest [\fR\fB\fIoptions\fR\fR\fB] [\fR\fB\fIdb_name\fR\fR\fB] < \fR\fB\fItest_file\fR\fR +.fi +.RE +.PP +You can also name the test case file with a +\fB\-\-test\-file=\fR\fB\fIfile_name\fR\fR +option. +.PP +The exit value from +\fBmysqltest\fR +is 0 for success, 1 for failure, and 62 if it skips the test case (for example, if after checking some preconditions it decides not to run the test). +.PP +\fBmysqltest\fR +supports the following options: +.TP 3n +\(bu +\fB\-\-help\fR, +\fB\-?\fR +.sp +Display a help message and exit. +.TP 3n +\(bu +\fB\-\-basedir=\fR\fB\fIdir_name\fR\fR, +\fB\-b \fR\fB\fIdir_name\fR\fR +.sp +The base directory for tests. +.TP 3n +\(bu +\fB\-\-big\-test\fR, +\fB\-B\fR +.sp +Define the +\fBmysqltest\fR +variable +$BIG_TEST +as 1. This option was removed in MySQL 4.1.23, 5.0.30, and 5.1.13. +.TP 3n +\(bu +\fB\-\-character\-sets\-dir=\fR\fB\fIpath\fR\fR +.sp +The directory where character sets are installed. This option was added in MySQL 4.1.23, 5.0.32, and 5.1.13. +.TP 3n +\(bu +\fB\-\-compress\fR, +\fB\-C\fR +.sp +Compress all information sent between the client and the server if both support compression. +.TP 3n +\(bu +\fB\-\-cursor\-protocol\fR +.sp +Use cursors for prepared statements (implies +\fB\-\-ps\-protocol\fR). This option was added in MySQL 5.0.19. +.TP 3n +\(bu +\fB\-\-database=\fR\fB\fIdb_name\fR\fR, +\fB\-D \fR\fB\fIdb_name\fR\fR +.sp +The default database to use. +.TP 3n +\(bu +\fB\-\-debug[=\fR\fB\fIdebug_options\fR\fR\fB]\fR, +\fB\-#[\fR\fB\fIdebug_options\fR\fR\fB]\fR +.sp +Write a debugging log if MySQL is built with debugging support. The default +\fIdebug_options\fR +value is +\'d:t:S:i:O,/tmp/mysqltest.trace'. +.TP 3n +\(bu +\fB\-\-debug\-check\fR +.sp +Print some debugging information when the program exits. This option was added in MySQL 5.1.21. +.TP 3n +\(bu +\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. +.TP 3n +\(bu +\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. +.TP 3n +\(bu +\fB\-\-include=\fR\fB\fIfile_name\fR\fR, +\fB\-i \fR\fB\fIfile_name\fR\fR +.sp +Include the contents of the given file before processing the contents of the test file. The included file should have the same format as other +\fBmysqltest\fR +test files. This option has the same effect as putting a +\-\-source \fIfile_name\fR +command as the first line of the test file. This option was added in MySQL 4.1.23, 5.0.30, and 5.1.7. +.TP 3n +\(bu +\fB\-\-logdir=\fR\fB\fIdir_name\fR\fR +.sp +The directory to use for log files. This option was added in MySQL 5.1.14. +.TP 3n +\(bu +\fB\-\-mark\-progress\fR +.sp +Write the line number and elapsed time to +\fI\fItest_file\fR\fR\fI.progress\fR. This option was added in MySQL 4.1.23, 5.0.30, and 5.1.12. +.TP 3n +\(bu +\fB\-\-max\-connect\-retries=\fR\fB\fInum\fR\fR +.sp +The maximum number of connection attempts when connecting to server. This option was added in MySQL 4.1.23, 5.0.23, and 5.1.11. +.TP 3n +\(bu +\fB\-\-no\-defaults\fR +.sp +Do not read default options from any option files. +.TP 3n +\(bu +\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, you are prompted for one. +.TP 3n +\(bu +\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. +.TP 3n +\(bu +\fB\-\-ps\-protocol\fR +.sp +Use the prepared\-statement protocol for communication. +.TP 3n +\(bu +\fB\-\-quiet\fR +.sp +Suppress all normal output. This is a synonym for +\fB\-\-silent\fR. +.TP 3n +\(bu +\fB\-\-record\fR, +\fB\-r\fR +.sp +Record the output that results from running the test file into the file named by the +\fB\-\-result\-file\fR +option, if that option is given. +.TP 3n +\(bu +\fB\-\-result\-file=\fR\fB\fIfile_name\fR\fR, +\fB\-R \fR\fB\fIfile_name\fR\fR +.sp +This option specifies the file for test case expected results. +\fB\-\-result\-file\fR, together with +\fB\-\-record\fR, determines how +\fBmysqltest\fR +treats the test actual and expected results for a test case: +.RS 3n +.TP 3n +\(bu +If the test produces no results, +\fBmysqltest\fR +exits with an error message to that effect. +.TP 3n +\(bu +Otherwise, if +\fB\-\-result\-file\fR +is not given, +\fBmysqltest\fR +sends test results to the standard output. +.TP 3n +\(bu +With +\fB\-\-result\-file\fR +but not +\fB\-\-record\fR, +\fBmysqltest\fR +reads the expected results from the given file and compares them with the actual results. If the results do not match, +\fBmysqltest\fR +writes a +\fI.reject\fR +file in the same directory as the result file and exits with an error. +.TP 3n +\(bu +With both +\fB\-\-result\-file\fR +and +\fB\-\-record\fR, +\fBmysqltest\fR +updates the given file by writing the actual test results to it. +.RE +.TP 3n +\(bu +\fB\-\-server\-arg=\fR\fB\fIvalue\fR\fR, +\fB\-A \fR\fB\fIvalue\fR\fR +.sp +Pass the argument as an argument to the embedded server. For example, +\fB\-\-server\-arg=\-\-tmpdir=/tmp\fR +or +\fB\-\-server\-arg=\-\-core\fR. Up to 64 arguments can be given. +.TP 3n +\(bu +\fB\-\-server\-file=\fR\fB\fIfile_name\fR\fR, +\fB\-F \fR\fB\fIfile_name\fR\fR +.sp +Read arguments for the embedded server from the given file. The file should contain one argument per line. +.TP 3n +\(bu +\fB\-\-silent\fR, +\fB\-s\fR +.sp +Suppress all normal output. +.TP 3n +\(bu +\fB\-\-skip\-safemalloc\fR +.sp +Do not use memory allocation checking. +.TP 3n +\(bu +\fB\-\-sleep=\fR\fB\fInum\fR\fR, +\fB\-T \fR\fB\fInum\fR\fR +.sp +Cause all +sleep +commands in the test case file to sleep +\fInum\fR +seconds. This option does not affect +real_sleep +commands. +.sp +As of MySQL 5.0.23, an option value of 0 can be used, which effectively disables +sleep +commands in the test case. +.TP 3n +\(bu +\fB\-\-socket=\fR\fB\fIpath\fR\fR, +\fB\-S \fR\fB\fIpath\fR\fR +.sp +The socket file to use when connecting to +localhost +(which is the default host). +.TP 3n +\(bu +\fB\-\-sp\-protocol\fR +.sp +Execute DML statements within a stored procedure. For every DML statement, +\fBmysqltest\fR +creates and invokes a stored procedure that executes the statement rather than executing the statement directly. This option was added in MySQL 5.0.19. +.TP 3n +\(bu +\fB\-\-test\-file=\fR\fB\fIfile_name\fR\fR, +\fB\-x \fR\fB\fIfile_name\fR\fR +.sp +Read test input from this file. The default is to read from the standard input. +.TP 3n +\(bu +\fB\-\-timer\-file=\fR\fB\fIfile_name\fR\fR, +\fB\-m \fR\fB\fIfile_name\fR\fR +.sp +The file where the timing in microseconds is written. +.TP 3n +\(bu +\fB\-\-tmpdir=\fR\fB\fIdir_name\fR\fR, +\fB\-t \fR\fB\fIdir_name\fR\fR +.sp +The temporary directory where socket files are put. +.TP 3n +\(bu +\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. +.TP 3n +\(bu +\fB\-\-verbose\fR, +\fB\-v\fR +.sp +Verbose mode. Print out more information what the program does. +.TP 3n +\(bu +\fB\-\-version\fR, +\fB\-V\fR +.sp +Display version information and exit. +.TP 3n +\(bu +\fB\-\-view\-protocol\fR +.sp +Every +SELECT +statement is wrapped inside a view. This option was added in MySQL 5.0.19. +.SH "COPYRIGHT" +.PP +Copyright 2007\-2008 MySQL AB, 2009 Sun Microsystems, Inc. +.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/. +.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 +MySQL AB (http://www.mysql.com/). diff --git a/man/mysqltest_embedded.1 b/man/mysqltest_embedded.1 new file mode 100644 index 00000000000..a00489327b3 --- /dev/null +++ b/man/mysqltest_embedded.1 @@ -0,0 +1 @@ +.so man1/mysqltest.1 diff --git a/man/ndbd.8 b/man/ndbd.8 new file mode 100644 index 00000000000..d16a6190305 --- /dev/null +++ b/man/ndbd.8 @@ -0,0 +1,174 @@ +.\" Title: \fBndbd\fR +.\" Author: +.\" Generator: DocBook XSL Stylesheets v1.70.1 <http://docbook.sf.net/> +.\" Date: 03/31/2009 +.\" Manual: MySQL Database System +.\" Source: MySQL 5.1 +.\" +.TH "\fBNDBD\fR" "8" "03/31/2009" "MySQL 5.1" "MySQL Database System" +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.SH "NAME" +ndbd \- the storage engine node process +.SH "SYNOPSIS" +.HP 13 +\fBndbd \fR\fB\fIoptions\fR\fR +.SH "DESCRIPTION" +.PP +\fBndbd\fR +is the process that is used to handle all the data in tables using the NDB Cluster storage engine. This is the process that empowers a data node to accomplish distributed transaction handling, node recovery, checkpointing to disk, online backup, and related tasks. +.PP +In a MySQL Cluster, a set of +\fBndbd\fR +processes cooperate in handling data. These processes can execute on the same computer (host) or on different computers. The correspondences between data nodes and Cluster hosts is completely configurable. +.PP +\fBndbd\fR +generates a set of log files which are placed in the directory specified by +DataDir +in the +\fIconfig.ini\fR +configuration file. +.PP +These log files are listed below. +\fInode_id\fR +is the node's unique identifier. Note that +\fInode_id\fR +represents the node's unique identifier. For example, +\fIndb_2_error.log\fR +is the error log generated by the data node whose node ID is +2. +.TP 3n +\(bu +\fIndb_\fR\fI\fInode_id\fR\fR\fI_error.log\fR +is a file containing records of all crashes which the referenced +\fBndbd\fR +process has encountered. Each record in this file contains a brief error string and a reference to a trace file for this crash. A typical entry in this file might appear as shown here: +.sp +.RS 3n +.nf +Date/Time: Saturday 30 July 2004 \- 00:20:01 +Type of error: error +Message: Internal program error (failed ndbrequire) +Fault ID: 2341 +Problem data: DbtupFixAlloc.cpp +Object of reference: DBTUP (Line: 173) +ProgramName: NDB Kernel +ProcessID: 14909 +TraceFile: ndb_2_trace.log.2 +***EOM*** +.fi +.RE +Listings of possible +\fBndbd\fR +exit codes and messages generated when a data node process shuts down prematurely can be found in +[1]\&\fIndbd Error Messages\fR. +.sp +.it 1 an-trap +.nr an-no-space-flag 1 +.nr an-break-flag 1 +.br +\fBImportant\fR +\fIThe last entry in the error log file is not necessarily the newest one\fR +(nor is it likely to be). Entries in the error log are +\fInot\fR +listed in chronological order; rather, they correspond to the order of the trace files as determined in the +\fIndb_\fR\fI\fInode_id\fR\fR\fI_trace.log.next\fR +file (see below). Error log entries are thus overwritten in a cyclical and not sequential fashion. +.TP 3n +\(bu +\fIndb_\fR\fI\fInode_id\fR\fR\fI_trace.log.\fR\fI\fItrace_id\fR\fR +is a trace file describing exactly what happened just before the error occurred. This information is useful for analysis by the MySQL Cluster development team. +.sp +It is possible to configure the number of these trace files that will be created before old files are overwritten. +\fItrace_id\fR +is a number which is incremented for each successive trace file. +.TP 3n +\(bu +\fIndb_\fR\fI\fInode_id\fR\fR\fI_trace.log.next\fR +is the file that keeps track of the next trace file number to be assigned. +.TP 3n +\(bu +\fIndb_\fR\fI\fInode_id\fR\fR\fI_out.log\fR +is a file containing any data output by the +\fBndbd\fR +process. This file is created only if +\fBndbd\fR +is started as a daemon, which is the default behavior. +.TP 3n +\(bu +\fIndb_\fR\fI\fInode_id\fR\fR\fI.pid\fR +is a file containing the process ID of the +\fBndbd\fR +process when started as a daemon. It also functions as a lock file to avoid the starting of nodes with the same identifier. +.TP 3n +\(bu +\fIndb_\fR\fI\fInode_id\fR\fR\fI_signal.log\fR +is a file used only in debug versions of +\fBndbd\fR, where it is possible to trace all incoming, outgoing, and internal messages with their data in the +\fBndbd\fR +process. +.sp +.RE +.PP +It is recommended not to use a directory mounted through NFS because in some environments this can cause problems whereby the lock on the +\fI.pid\fR +file remains in effect even after the process has terminated. +.PP +To start +\fBndbd\fR, it may also be necessary to specify the host name of the management server and the port on which it is listening. Optionally, one may also specify the node ID that the process is to use. +.sp +.RS 3n +.nf +shell> \fBndbd \-\-connect\-string="nodeid=2;host=ndb_mgmd.mysql.com:1186"\fR +.fi +.RE +.PP +See +Section\ 17.3.4.3, \(lqThe MySQL Cluster Connectstring\(rq, for additional information about this issue. +Section\ 17.6.2, \(lqCommand Options for MySQL Cluster Processes\(rq, describes other options for +\fBndbd\fR. +.PP +When +\fBndbd\fR +starts, it actually initiates two processes. The first of these is called the +\(lqangel process\(rq; its only job is to discover when the execution process has been completed, and then to restart the +\fBndbd\fR +process if it is configured to do so. Thus, if you attempt to kill +\fBndbd\fR +via the Unix +\fBkill\fR +command, it is necessary to kill both processes, beginning with the angel process. The preferred method of terminating an +\fBndbd\fR +process is to use the management client and stop the process from there. +.PP +The execution process uses one thread for reading, writing, and scanning data, as well as all other activities. This thread is implemented asynchronously so that it can easily handle thousands of concurrent actions. In addition, a watch\-dog thread supervises the execution thread to make sure that it does not hang in an endless loop. A pool of threads handles file I/O, with each thread able to handle one open file. Threads can also be used for transporter connections by the transporters in the +\fBndbd\fR +process. In a multi\-processor system performing a large number of operations (including updates), the +\fBndbd\fR +process can consume up to 2 CPUs if permitted to do so. +.PP +For a machine with many CPUs it is possible to use several +\fBndbd\fR +processes which belong to different node groups; however, such a configuration is still considered experimental and is not supported for MySQL 5.1 in a production setting. See +Section\ 17.13, \(lqKnown Limitations of MySQL Cluster\(rq. +.SH "COPYRIGHT" +.PP +Copyright 2007\-2008 MySQL AB, 2009 Sun Microsystems, Inc. +.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/. +.SH "REFERENCES" +.TP 3 +1.\ ndbd Error Messages +\%http://dev.mysql.com/doc/ndbapi/en/ndbd\-error\-messages.html +.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 +MySQL AB (http://www.mysql.com/). diff --git a/man/ndbd_redo_log_reader.1 b/man/ndbd_redo_log_reader.1 new file mode 100644 index 00000000000..5c13cfc3302 --- /dev/null +++ b/man/ndbd_redo_log_reader.1 @@ -0,0 +1,85 @@ +.\" Title: \fBndbd_redo_log_reader\fR +.\" Author: +.\" Generator: DocBook XSL Stylesheets v1.70.1 <http://docbook.sf.net/> +.\" Date: 03/31/2009 +.\" Manual: MySQL Database System +.\" Source: MySQL 5.1 +.\" +.TH "\fBNDBD_REDO_LOG_REA" "1" "03/31/2009" "MySQL 5.1" "MySQL Database System" +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.SH "NAME" +ndbd_redo_log_reader \- check and print content of cluster redo log +.SH "SYNOPSIS" +.HP 41 +\fBndbd_redo_log_reader \fR\fB\fIfile_name\fR\fR\fB [\fR\fB\fIoptions\fR\fR\fB]\fR +.SH "DESCRIPTION" +.PP +Reads a redo log file, checking it for errors, printing its contents in a human\-readable format, or both. +\fBndbd_redo_log_reader\fR +is intended for use primarily by MySQL developers and support personnel in debugging and diagnosing problems. +.PP +This utility was made available as part of default builds beginning with MySQL Cluster NDB 6.1.3. It remains under development, and its syntax and behavior are subject to change in future releases. For this reason, it should be considered experimental at this time. +.PP +The C++ source files for +\fBndbd_redo_log_reader\fR +can be found in the directory +\fI/storage/ndb/src/kernel/blocks/dblqh/redoLogReader\fR. +.PP +\fBUsage\fR: +.sp +.RS 3n +.nf +ndbd_redo_log_reader \fIfile_name\fR [\fIoptions\fR] +.fi +.RE +.PP +\fIfile_name\fR +is the name of a cluster REDO log file. REDO log files are located in the numbered directories under the data node's data directory (DataDir); the path under this directory to the REDO log files matches the pattern +\fIndb_\fR\fI\fI#\fR\fR\fI_fs/D\fR\fI\fI#\fR\fR\fI/LCP/\fR\fI\fI#\fR\fR\fI/T\fR\fI\fI#\fR\fR\fIF\fR\fI\fI#\fR\fR\fI.Data\fR. In each case, the +\fI#\fR +represents a number (not necessarily the same number). For more information, see +[1]\&\fICluster Data Node FileSystemDir Files\fR. +.PP +\fBAdditional Options\fR: +.PP +The name of the file to be read may be followed by one or more of the options listed here: +.TP 3n +\(bu +\fB\-noprint\fR: Do not print the contents of the log file. +.TP 3n +\(bu +\fB\-nocheck\fR: Do not check the log filre for errors. +.sp +.RE +.PP +Like +\fBndb_print_backup_file\fR +and +\fBndb_print_schema_file\fR +(and unlike most of the +NDB +utilities that are intended to be run on a management server host or to connect to a management server) +\fBndbd_redo_log_reader\fR +must be run on a cluster data node, since it accesses the data node file system directly. Because it does not make use of the management server, this utility can be used when the management server is not running, and even when the cluster has been completely shut down. +.SH "COPYRIGHT" +.PP +Copyright 2007\-2008 MySQL AB, 2009 Sun Microsystems, Inc. +.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/. +.SH "REFERENCES" +.TP 3 +1.\ Cluster Data Node FileSystemDir Files +\%http://dev.mysql.com/doc/ndbapi/en/ndb\-internals\-ndbd\-filesystem.html#ndb\-internals\-ndbd\-filesystemdir\-files +.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 +MySQL AB (http://www.mysql.com/). diff --git a/man/ndbmtd.8 b/man/ndbmtd.8 new file mode 100644 index 00000000000..b1e977f7857 --- /dev/null +++ b/man/ndbmtd.8 @@ -0,0 +1,285 @@ +.\" Title: \fBndbmtd\fR +.\" Author: +.\" Generator: DocBook XSL Stylesheets v1.70.1 <http://docbook.sf.net/> +.\" Date: 03/31/2009 +.\" Manual: MySQL Database System +.\" Source: MySQL 5.1 +.\" +.TH "\fBNDBMTD\fR" "8" "03/31/2009" "MySQL 5.1" "MySQL Database System" +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.SH "NAME" +ndbmtd \- the MySQL Cluster storage engine node process (multi\-threaded version) +.SH "SYNOPSIS" +.HP 15 +\fBndbmtd \fR\fB\fIoptions\fR\fR +.SH "DESCRIPTION" +.PP +\fBndbmtd\fR +is a multi\-threaded version of +\fBndbd\fR, the process that is used to handle all the data in tables using the +NDBCLUSTER +storage engine. +\fBndbmtd\fR +is intended for use on host computers having multiple CPU cores. Except where otherwise noted, +\fBndbmtd\fR +functions in the same way as +\fBndbd\fR; therefore, in this section, we concentrate on the ways in which +\fBndbmtd\fR +differs from +\fBndbd\fR, and you should consult +\fBndbd\fR(8), for additional information about running MySQL Cluster data nodes that apply to both the single\-threaded and multi\-threaded versions of the data node process. +.PP +Command\-line options and configuration parameters used with +\fBndbd\fR +also apply to +\fBndbmtd\fR. For more information about these options and parameters, see +Section\ 17.6.2.1, \(lqCommand Options for \fBndbd\fR and \fBndbmtd\fR\(rq, and +Section\ 17.3.4.6, \(lqDefining MySQL Cluster Data Nodes\(rq, respectively. +.PP +\fBndbmtd\fR +is also file system\-compatible with +\fBndbd\fR. In other words, a data node running +\fBndbd\fR +can be stopped, the binary replaced with +\fBndbmtd\fR, and then restarted without any loss of data. (However, when doing this, you must make sure that +MaxNoOfExecutionThreads +is set to an apppriate value before restarting the node if you wish for +\fBndbmtd\fR +to run in multi\-threaded fashion.) Similarly, an +\fBndbmtd\fR +binary can be replaced with +\fBndbd\fR +simply by stopping the node and then starting +\fBndbd\fR +in place of the multi\-threaded binary. It is not necessary when switching between the two to start the data node binary using +\fB\-\-initial\fR. +.PP +Using +\fBndbmtd\fR +differs from using +\fBndbd\fR +in two key respects: +.TP 3n +1. +You must set an appropriate value for the +MaxNoOfExecutionThreads +configuration parameter in the +\fIconfig.ini\fR +file. If you do not do so, +\fBndbmtd\fR +runs in single\-threaded mode \(em that is, it behaves like +\fBndbd\fR. +.TP 3n +2. +Trace files are generated by critical errors in +\fBndbmtd\fR +processes in a somewhat different fashion from how these are generated by +\fBndbd\fR +failures. +.sp +.RE +.PP +These differences are discussed in more detail in the next few paragraphs. +.PP +\fBNumber of execution threads\fR. The +MaxNoOfExecutionThreads +configuration parameter is used to determine the number of local query handler (LQH) threads spawned by +\fBndbmtd\fR. Although this parameter is set in +[ndbd] +or +[ndbd default] +sections of the +\fIconfig.ini\fR +file, it is exclusive to +\fBndbmtd\fR +and does not apply to +\fBndbd\fR. +.PP +This parameter takes an integer value from 2 to 8 inclusive. Generally, you should set this to the number of CPU cores on the data node host, as shown in the following table: +.TS +allbox tab(:); +lB lB. +T{ +Number of Cores +T}:T{ +Recommended MaxNoOfExecutionThreads Value +T} +.T& +l l +l l +l l. +T{ +2 +T}:T{ +2 +T} +T{ +4 +T}:T{ +4 +T} +T{ +8 or more +T}:T{ +8 +T} +.TE +.sp +.PP +(It is possible to set this parameter to other values within the permitted range, but these are automatically rounded as shown in the +\fBValue Used\fR +column of the next table in this section.) +.PP +The multi\-threaded data node process always spawns at least 4 threads: +.TP 3n +\(bu +1 local query handler (LQH) thread +.TP 3n +\(bu +1 transaction coordinator (TC) thread +.TP 3n +\(bu +1 transporter thread +.TP 3n +\(bu +1 subscription manager (SUMA) thread +.sp +.RE +.PP +Setting this parameter to a value between 4 and 8 inclusive causes additional LQH threads to be used by +\fBndbmtd\fR +(up to a maximum of 4 LQH threads), as shown in the following table: +.TS +allbox tab(:); +lB lB lB. +T{ +\fIconfig.ini\fR Value +T}:T{ +Value Used +T}:T{ +Number of LQH Threads Used +T} +.T& +l l l +l l l +l l l. +T{ +3 +T}:T{ +2 +T}:T{ +1 +T} +T{ +5 or 6 +T}:T{ +4 +T}:T{ +2 +T} +T{ +7 +T}:T{ +8 +T}:T{ +4 +T} +.TE +.sp +.PP +Setting this parameter outside the permitted range of values causes the management server to abort on startup with the error +Error line \fInumber\fR: Illegal value \fIvalue\fR for parameter MaxNoOfExecutionThreads. +.sp +.it 1 an-trap +.nr an-no-space-flag 1 +.nr an-break-flag 1 +.br +\fBNote\fR +.PP +In MySQL Cluster NDB 6.4.0, it is not possible to set +MaxNoOfExecutionThreads +to 2. You can safely use the value 3 instead (it is treated as 2 internally). This issue is resolved in MySQL Cluster NDB 6.4.1. +.PP +In MySQL Cluster NDB 6.4.0 through 6.4.3, the default value for this parameter was undefined, although the default behavior for +\fBndbmtd\fR +was to use 1 LQH thread, as though +MaxNoOfExecutionThreads +had been set to 2. Beginning with MySQL Cluster NDB 7.0.4, this parameter has an explcit default value of 2, thus guaranteeing this default behavior. +.PP +In MySQL Cluster NDB 7.0, it is not possible to cause +\fBndbmtd\fR +to use more than 1 TC thread, although we plan to introduce this capability in a future MySQL Cluster release series. +.PP +Like +\fBndbd\fR, +\fBndbmtd\fR +generates a set of log files which are placed in the directory specified by +DataDir +in the +\fIconfig.ini\fR +configuration file. Except for trace files, these are generated in the same way and have the same names as those generated by +\fBndbd\fR. +.PP +In the event of a critical error, +\fBndbmtd\fR +generates trace files describing what happened just prior to the error' occurrence. These files, which can be found in the data node's +DataDir, are useful for analysis of problems by the MySQL Cluster Development and Support teams. One trace file is generated for each +\fBndbmtd\fR +thread. The names of these files follow the pattern +\fIndb_\fR\fI\fInode_id\fR\fR\fI_trace.log.\fR\fI\fItrace_id\fR\fR\fI_t\fR\fI\fIthread_id\fR\fR, where +\fInode_id\fR +is the data node's unique node ID in the cluster, +\fItrace_id\fR +is a trace sequence number, and +\fIthread_id\fR +is the thread ID. For example, in the event of the failure of an +\fBndbmtd\fR +process running as a MySQL Cluster data node having the node ID 3 and with +MaxNoOfExecutionThreads +equal to 4, four trace files are generated in the data node's data directory; if the is the first time this node has failed, then these files are named +\fIndb_3_trace.log.1_t1\fR, +\fIndb_3_trace.log.1_t2\fR, +\fIndb_3_trace.log.1_t3\fR, and +\fIndb_3_trace.log.1_t4\fR. Internally, these trace files follow the same format as +\fBndbd\fR +trace files. +.PP +The +\fBndbd\fR +exit codes and messages that are generated when a data node process shuts down prematurely are also used by +\fBndbmtd\fR. See +[1]\&\fIndbd Error Messages\fR, for a listing of these. +.sp +.it 1 an-trap +.nr an-no-space-flag 1 +.nr an-break-flag 1 +.br +\fBNote\fR +.PP +It is possible to use +\fBndbd\fR +and +\fBndbmtd\fR +concurrently on different data nodes in the same MySQL Cluster. However, such configurations have not been tested extensively; thus, we cannot not recommend doing so in a production setting at this time. +.SH "COPYRIGHT" +.PP +Copyright 2007\-2008 MySQL AB, 2009 Sun Microsystems, Inc. +.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/. +.SH "REFERENCES" +.TP 3 +1.\ ndbd Error Messages +\%http://dev.mysql.com/doc/ndbapi/en/ndbd\-error\-messages.html +.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 +MySQL AB (http://www.mysql.com/). diff --git a/man/perror.1 b/man/perror.1 new file mode 100644 index 00000000000..b1aeee19f92 --- /dev/null +++ b/man/perror.1 @@ -0,0 +1,117 @@ +.\" Title: \fBperror\fR +.\" Author: +.\" Generator: DocBook XSL Stylesheets v1.70.1 <http://docbook.sf.net/> +.\" Date: 03/31/2009 +.\" Manual: MySQL Database System +.\" Source: MySQL 5.1 +.\" +.TH "\fBPERROR\fR" "1" "03/31/2009" "MySQL 5.1" "MySQL Database System" +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.SH "NAME" +perror \- explain error codes +.SH "SYNOPSIS" +.HP 31 +\fBperror [\fR\fB\fIoptions\fR\fR\fB] \fR\fB\fIerrorcode\fR\fR\fB ...\fR +.SH "DESCRIPTION" +.PP +For most system errors, MySQL displays, in addition to an internal text message, the system error code in one of the following styles: +.sp +.RS 3n +.nf +message ... (errno: #) +message ... (Errcode: #) +.fi +.RE +.PP +You can find out what the error code means by examining the documentation for your system or by using the +\fBperror\fR +utility. +.PP +\fBperror\fR +prints a description for a system error code or for a storage engine (table handler) error code. +.PP +Invoke +\fBperror\fR +like this: +.sp +.RS 3n +.nf +shell> \fBperror [\fR\fB\fIoptions\fR\fR\fB] \fR\fB\fIerrorcode\fR\fR\fB ...\fR +.fi +.RE +.PP +Example: +.sp +.RS 3n +.nf +shell> \fBperror 13 64\fR +OS error code 13: Permission denied +OS error code 64: Machine is not on the network +.fi +.RE +.PP +To obtain the error message for a MySQL Cluster error code, invoke +\fBperror\fR +with the +\fB\-\-ndb\fR +option: +.sp +.RS 3n +.nf +shell> \fBperror \-\-ndb \fR\fB\fIerrorcode\fR\fR +.fi +.RE +.PP +Note that the meaning of system error messages may be dependent on your operating system. A given error code may mean different things on different operating systems. +.PP +\fBperror\fR +supports the following options: +.TP 3n +\(bu +\fB\-\-help\fR, +\fB\-\-info\fR, +\fB\-I\fR, +\fB\-?\fR +.sp +Display a help message and exit. +.TP 3n +\(bu +\fB\-\-ndb\fR +.sp +Print the error message for a MySQL Cluster error code. +.TP 3n +\(bu +\fB\-\-silent\fR, +\fB\-s\fR +.sp +Silent mode. Print only the error message. +.TP 3n +\(bu +\fB\-\-verbose\fR, +\fB\-v\fR +.sp +Verbose mode. Print error code and message. This is the default behavior. +.TP 3n +\(bu +\fB\-\-version\fR, +\fB\-V\fR +.sp +Display version information and exit. +.SH "COPYRIGHT" +.PP +Copyright 2007\-2008 MySQL AB, 2009 Sun Microsystems, Inc. +.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/. +.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 +MySQL AB (http://www.mysql.com/). diff --git a/man/replace.1 b/man/replace.1 new file mode 100644 index 00000000000..8502bd87ddb --- /dev/null +++ b/man/replace.1 @@ -0,0 +1,116 @@ +.\" Title: \fBreplace\fR +.\" Author: +.\" Generator: DocBook XSL Stylesheets v1.70.1 <http://docbook.sf.net/> +.\" Date: 03/31/2009 +.\" Manual: MySQL Database System +.\" Source: MySQL 5.1 +.\" +.TH "\fBREPLACE\fR" "1" "03/31/2009" "MySQL 5.1" "MySQL Database System" +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.SH "NAME" +replace \- a string\-replacement utility +.SH "SYNOPSIS" +.HP 18 +\fBreplace \fR\fB\fIarguments\fR\fR +.SH "DESCRIPTION" +.PP +The +\fBreplace\fR +utility program changes strings in place in files or on the standard input. +.PP +Invoke +\fBreplace\fR +in one of the following ways: +.sp +.RS 3n +.nf +shell> \fBreplace \fR\fB\fIfrom\fR\fR\fB \fR\fB\fIto\fR\fR\fB [\fR\fB\fIfrom\fR\fR\fB \fR\fB\fIto\fR\fR\fB] ... \-\- \fR\fB\fIfile_name\fR\fR\fB [\fR\fB\fIfile_name\fR\fR\fB] ...\fR +shell> \fBreplace \fR\fB\fIfrom\fR\fR\fB \fR\fB\fIto\fR\fR\fB [\fR\fB\fIfrom\fR\fR\fB \fR\fB\fIto\fR\fR\fB] ... < \fR\fB\fIfile_name\fR\fR +.fi +.RE +.PP +\fIfrom\fR +represents a string to look for and +\fIto\fR +represents its replacement. There can be one or more pairs of strings. +.PP +Use the +\fB\-\-\fR +option to indicate where the string\-replacement list ends and the file names begin. In this case, any file named on the command line is modified in place, so you may want to make a copy of the original before converting it. +\fIreplace\fR +prints a message indicating which of the input files it actually modifies. +.PP +If the +\fB\-\-\fR +option is not given, +\fBreplace\fR +reads the standard input and writes to the standard output. +.PP +\fBreplace\fR +uses a finite state machine to match longer strings first. It can be used to swap strings. For example, the following command swaps +a +and +b +in the given files, +\fIfile1\fR +and +\fIfile2\fR: +.sp +.RS 3n +.nf +shell> \fBreplace a b b a \-\- file1 file2 ...\fR +.fi +.RE +.PP +The +\fBreplace\fR +program is used by +\fBmsql2mysql\fR. See +\fBmsql2mysql\fR(1). +.PP +\fBreplace\fR +supports the following options: +.TP 3n +\(bu +\fB\-?\fR, +\fB\-I\fR +.sp +Display a help message and exit. +.TP 3n +\(bu +\fB\-#\fR\fB\fIdebug_options\fR\fR +.sp +Enable debugging. +.TP 3n +\(bu +\fB\-s\fR +.sp +Silent mode. Print less information what the program does. +.TP 3n +\(bu +\fB\-v\fR +.sp +Verbose mode. Print more information about what the program does. +.TP 3n +\(bu +\fB\-V\fR +.sp +Display version information and exit. +.SH "COPYRIGHT" +.PP +Copyright 2007\-2008 MySQL AB, 2009 Sun Microsystems, Inc. +.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/. +.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 +MySQL AB (http://www.mysql.com/). diff --git a/man/resolve_stack_dump.1 b/man/resolve_stack_dump.1 new file mode 100644 index 00000000000..7cf8179d940 --- /dev/null +++ b/man/resolve_stack_dump.1 @@ -0,0 +1,78 @@ +.\" Title: \fBresolve_stack_dump\fR +.\" Author: +.\" Generator: DocBook XSL Stylesheets v1.70.1 <http://docbook.sf.net/> +.\" Date: 03/31/2009 +.\" Manual: MySQL Database System +.\" Source: MySQL 5.1 +.\" +.TH "\fBRESOLVE_STACK_DUM" "1" "03/31/2009" "MySQL 5.1" "MySQL Database System" +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.SH "NAME" +resolve_stack_dump \- resolve numeric stack trace dump to symbols +.SH "SYNOPSIS" +.HP 62 +\fBresolve_stack_dump [\fR\fB\fIoptions\fR\fR\fB] \fR\fB\fIsymbols_file\fR\fR\fB [\fR\fB\fInumeric_dump_file\fR\fR\fB]\fR +.SH "DESCRIPTION" +.PP +\fBresolve_stack_dump\fR +resolves a numeric stack dump to symbols. +.PP +Invoke +\fBresolve_stack_dump\fR +like this: +.sp +.RS 3n +.nf +shell> \fBresolve_stack_dump [\fR\fB\fIoptions\fR\fR\fB] \fR\fB\fIsymbols_file\fR\fR\fB [\fR\fB\fInumeric_dump_file\fR\fR\fB]\fR +.fi +.RE +.PP +The symbols file should include the output from the +\fBnm \-\-numeric\-sort mysqld\fR +command. The numeric dump file should contain a numeric stack track from +\fBmysqld\fR. If no numeric dump file is named on the command line, the stack trace is read from the standard input. +.PP +\fBresolve_stack_dump\fR +understands the options described in the following list. +.TP 3n +\(bu +\fB\-\-help\fR, +\fB\-h\fR +.sp +Display a help message and exit. +.TP 3n +\(bu +\fB\-\-numeric\-dump\-file=\fR\fB\fIfile_name\fR\fR, +\fB\-n \fR\fB\fIfile_name\fR\fR +.sp +Read the stack trace from the given file. +.TP 3n +\(bu +\fB\-\-symbols\-file=\fR\fB\fIfile_name\fR\fR, +\fB\-s \fR\fB\fIfile_name\fR\fR +.sp +Use the given symbols file. +.TP 3n +\(bu +\fB\-\-version\fR, +\fB\-V\fR +.sp +Display version information and exit. +.SH "COPYRIGHT" +.PP +Copyright 2007\-2008 MySQL AB, 2009 Sun Microsystems, Inc. +.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/. +.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 +MySQL AB (http://www.mysql.com/). diff --git a/man/resolveip.1 b/man/resolveip.1 new file mode 100644 index 00000000000..2b501a98602 --- /dev/null +++ b/man/resolveip.1 @@ -0,0 +1,70 @@ +.\" Title: \fBresolveip\fR +.\" Author: +.\" Generator: DocBook XSL Stylesheets v1.70.1 <http://docbook.sf.net/> +.\" Date: 03/31/2009 +.\" Manual: MySQL Database System +.\" Source: MySQL 5.1 +.\" +.TH "\fBRESOLVEIP\fR" "1" "03/31/2009" "MySQL 5.1" "MySQL Database System" +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.SH "NAME" +resolveip \- resolve host name to IP address or vice versa +.SH "SYNOPSIS" +.HP 44 +\fBresolveip [\fR\fB\fIoptions\fR\fR\fB] {\fR\fB\fIhost_name\fR\fR\fB|\fR\fB\fIip\-addr\fR\fR\fB} ...\fR +.SH "DESCRIPTION" +.PP +The +\fBresolveip\fR +utility resolves host names to IP addresses and vice versa. +.PP +Invoke +\fBresolveip\fR +like this: +.sp +.RS 3n +.nf +shell> \fBresolveip [\fR\fB\fIoptions\fR\fR\fB] {\fR\fB\fIhost_name\fR\fR\fB|\fR\fB\fIip\-addr\fR\fR\fB} ...\fR +.fi +.RE +.PP +\fBresolveip\fR +understands the options described in the following list. +.TP 3n +\(bu +\fB\-\-help\fR, +\fB\-\-info\fR, +\fB\-?\fR, +\fB\-I\fR +.sp +Display a help message and exit. +.TP 3n +\(bu +\fB\-\-silent\fR, +\fB\-s\fR +.sp +Silent mode. Produce less output. +.TP 3n +\(bu +\fB\-\-version\fR, +\fB\-V\fR +.sp +Display version information and exit. +.SH "COPYRIGHT" +.PP +Copyright 2007\-2008 MySQL AB, 2009 Sun Microsystems, Inc. +.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/. +.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 +MySQL AB (http://www.mysql.com/). |