mirror/mariadb
1
0
Fork 0
mirror of https://github.com/MariaDB/server.git synced 2025-01-15 19:42:28 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

Imported freely distributable documentation from upstream MySQL 5.1.34 source tarball.

Browse source
This commit is contained in:
unknown 2009-05-25 11:59:47 +02:00
parent d7ae55e704
commit cc5e283d15
56 changed files with 27699 additions and 24 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

193
Docs/INSTALL-BINARY
View file

@ -1,8 +1,191 @@
You can find information about how to install binary distributions at
2.9. Installing MySQL from tar.gz Packages on Other Unix-Like Systems
http://dev.mysql.com/doc/refman/5.1/en/quick-standard-installation.html
This section covers the installation of MySQL binary distributions
that are provided for various platforms in the form of compressed
tar files (files with a .tar.gz extension). See Section 2.1.2.4,
"MySQL Binaries Compiled by Sun Microsystems, Inc.," for a
detailed list.
The MySQL Reference Manual is also available in various formats on
http://dev.mysql.com/doc; if you're interested in the DocBook XML
sources go to http://svn.mysql.com.
To obtain MySQL, see Section 2.1.3, "How to Get MySQL."
MySQL tar file binary distributions have names of the form
mysql-VERSION-OS.tar.gz, where VERSION is a number (for example,
5.1.35), and OS indicates the type of operating system for which
the distribution is intended (for example, pc-linux-i686).
In addition to these generic packages, we also offer binaries in
platform-specific package formats for selected platforms. See
Section 2.2, "Standard MySQL Installation Using a Binary
Distribution," for more information on how to install these.
You need the following tools to install a MySQL tar file binary
distribution:
* GNU gunzip to uncompress the distribution.
* A reasonable tar to unpack the distribution. GNU tar is known
to work. Some operating systems come with a preinstalled
version of tar that is known to have problems. For example,
the tar provided with early versions of Mac OS X, SunOS 4.x
and Solaris 8 and earlier are known to have problems with long
file names. On Mac OS X, you can use the preinstalled gnutar
program. On other systems with a deficient tar, you should
install GNU tar first.
If you run into problems and need to file a bug report, please use
the instructions in Section 1.6, "How to Report Bugs or Problems."
The basic commands that you must execute to install and use a
MySQL binary distribution are:
shell> groupadd mysql
shell> useradd -g mysql mysql
shell> cd /usr/local
shell> gunzip < /path/to/mysql-VERSION-OS.tar.gz | tar xvf -
shell> ln -s full-path-to-mysql-VERSION-OS mysql
shell> cd mysql
shell> chown -R mysql .
shell> chgrp -R mysql .
shell> scripts/mysql_install_db --user=mysql
shell> chown -R root .
shell> chown -R mysql data
shell> bin/mysqld_safe --user=mysql &
Note
This procedure does not set up any passwords for MySQL accounts.
After following the procedure, proceed to Section 2.11,
"Post-Installation Setup and Testing."
A more detailed version of the preceding description for
installing a binary distribution follows:
1. Add a login user and group for mysqld to run as:
shell> groupadd mysql
shell> useradd -g mysql mysql
These commands add the mysql group and the mysql user. The
syntax for useradd and groupadd may differ slightly on
different versions of Unix, or they may have different names
such as adduser and addgroup.
You might want to call the user and group something else
instead of mysql. If so, substitute the appropriate name in
the following steps.
2. Pick the directory under which you want to unpack the
distribution and change location into it. In the following
example, we unpack the distribution under /usr/local. (The
instructions, therefore, assume that you have permission to
create files and directories in /usr/local. If that directory
is protected, you must perform the installation as root.)
shell> cd /usr/local
3. Obtain a distribution file using the instructions in Section
2.1.3, "How to Get MySQL." For a given release, binary
distributions for all platforms are built from the same MySQL
source distribution.
4. Unpack the distribution, which creates the installation
directory. Then create a symbolic link to that directory:
shell> gunzip < /path/to/mysql-VERSION-OS.tar.gz | tar xvf -
shell> ln -s full-path-to-mysql-VERSION-OS mysql
The tar command creates a directory named mysql-VERSION-OS.
The ln command makes a symbolic link to that directory. This
lets you refer more easily to the installation directory as
/usr/local/mysql.
With GNU tar, no separate invocation of gunzip is necessary.
You can replace the first line with the following alternative
command to uncompress and extract the distribution:
shell> tar zxvf /path/to/mysql-VERSION-OS.tar.gz
5. Change location into the installation directory:
shell> cd mysql
You will find several files and subdirectories in the mysql
directory. The most important for installation purposes are
the bin and scripts subdirectories:
+ The bin directory contains client programs and the
server. You should add the full path name of this
directory to your PATH environment variable so that your
shell finds the MySQL programs properly. See Section
2.14, "Environment Variables."
+ The scripts directory contains the mysql_install_db
script used to initialize the mysql database containing
the grant tables that store the server access
permissions.
6. Ensure that the distribution contents are accessible to mysql.
If you unpacked the distribution as mysql, no further action
is required. If you unpacked the distribution as root, its
contents will be owned by root. Change its ownership to mysql
by executing the following commands as root in the
installation directory:
shell> chown -R mysql .
shell> chgrp -R mysql .
The first command changes the owner attribute of the files to
the mysql user. The second changes the group attribute to the
mysql group.
7. If you have not installed MySQL before, you must create the
MySQL data directory and initialize the grant tables:
shell> scripts/mysql_install_db --user=mysql
If you run the command as root, include the --user option as
shown. If you run the command while logged in as that user,
you can omit the --user option.
The command should create the data directory and its contents
with mysql as the owner.
After creating or updating the grant tables, you need to
restart the server manually.
8. Most of the MySQL installation can be owned by root if you
like. The exception is that the data directory must be owned
by mysql. To accomplish this, run the following commands as
root in the installation directory:
shell> chown -R root .
shell> chown -R mysql data
9. If you want MySQL to start automatically when you boot your
machine, you can copy support-files/mysql.server to the
location where your system has its startup files. More
information can be found in the support-files/mysql.server
script itself and in Section 2.11.2.2, "Starting and Stopping
MySQL Automatically."
10. You can set up new accounts using the bin/mysql_setpermission
script if you install the DBI and DBD::mysql Perl modules. See
Section 4.6.14, "mysql_setpermission --- Interactively Set
Permissions in Grant Tables." For Perl module installation
instructions, see Section 2.15, "Perl Installation Notes."
11. If you would like to use mysqlaccess and have the MySQL
distribution in some non-standard location, you must change
the location where mysqlaccess expects to find the mysql
client. Edit the bin/mysqlaccess script at approximately line
18. Search for a line that looks like this:
$MYSQL = '/usr/local/bin/mysql'; # path to mysql executable
Change the path to reflect the location where mysql actually
is stored on your system. If you do not do this, a Broken pipe
error will occur when you run mysqlaccess.
After everything has been unpacked and installed, you should test
your distribution. To start the MySQL server, use the following
command:
shell> bin/mysqld_safe --user=mysql &
If you run the command as root, you must use the --user option as
shown. The value of the option is the name of the login account
that you created in the first step to use for running the server.
If you run the command while logged in as mysql, you can omit the
--user option.
If the command fails immediately and prints mysqld ended, you can
find some information in the host_name.err file in the data
directory.
More information about mysqld_safe is given in Section 4.3.2,
"mysqld_safe --- MySQL Server Startup Script."
Note
The accounts that are listed in the MySQL grant tables initially
have no passwords. After starting the server, you should set up
passwords for them using the instructions in Section 2.11,
"Post-Installation Setup and Testing."

9580
INSTALL-SOURCE
View file

File diff suppressed because it is too large Load diff

271
INSTALL-WIN-SOURCE
View file

@ -1,9 +1,268 @@
You can find information about how to install from a Windows source
distributions at
2.10.6. Installing MySQL from Source on Windows
http://dev.mysql.com/doc/refman/5.1/en/windows-source-build.html
These instructions describe how to build binaries from source for
MySQL 5.1 on Windows. Instructions are provided for building
binaries from a standard source distribution or from the Bazaar
tree that contains the latest development source.
The MySQL Reference Manual is also available in various formats on
http://dev.mysql.com/doc; if you're interested in the DocBook XML
sources go to http://svn.mysql.com.
Note
The instructions here are strictly for users who want to test
MySQL on Microsoft Windows from the latest source distribution or
from the Bazaar tree. For production use, we do not advise using a
MySQL server built by yourself from source. Normally, it is best
to use precompiled binary distributions of MySQL that are built
specifically for optimal performance on Windows by Sun
Microsystems, Inc. Instructions for installing binary
distributions are available in Section 2.3, "Installing MySQL on
Windows."
To build MySQL on Windows from source, you must satisfy the
following system, compiler, and resource requirements:
* Windows 2000, Windows XP, or newer version.
Windows Vista is supported when using Visual Studio 2005
provided you have installed the following updates:
+ Microsoft Visual Studio 2005 Professional Edition - ENU
Service Pack 1 (KB926601)
(http://support.microsoft.com/?kbid=926601)
+ Security Update for Microsoft Visual Studio 2005
Professional Edition - ENU (KB937061)
(http://support.microsoft.com/?kbid=937061)
+ Update for Microsoft Visual Studio 2005 Professional
Edition - ENU (KB932232)
(http://support.microsoft.com/?kbid=932232)
* CMake, which can be downloaded from http://www.cmake.org.
After installing, modify your path to include the cmake
binary.
* Microsoft Visual C++ 2005 Express Edition, Visual Studio .Net
2003 (7.1), or Visual Studio 2005 (8.0) compiler system.
* If you are using Visual C++ 2005 Express Edition, you must
also install an appropriate Platform SDK. More information and
links to downloads for various Windows platforms is available
from
http://www.microsoft.com/downloads/details.aspx?familyid=0baf2
b35-c656-4969-ace8-e4c0c0716adb.
* If you are compiling from a Bazaar tree or making changes to
the parser, you need bison for Windows, which can be
downloaded from
http://gnuwin32.sourceforge.net/packages/bison.htm. Download
the package labeled "Complete package, excluding sources".
After installing the package, modify your path to include the
bison binary and ensure that this binary is accessible from
Visual Studio.
* Cygwin might be necessary if you want to run the test script
or package the compiled binaries and support files into a Zip
archive. (Cygwin is needed only to test or package the
distribution, not to build it.) Cygwin is available from
http://cygwin.com.
* 3GB to 5GB of disk space.
The exact system requirements can be found here:
http://msdn.microsoft.com/vstudio/Previous/2003/sysreqs/default.as
px and
http://msdn.microsoft.com/vstudio/products/sysreqs/default.aspx
You also need a MySQL source distribution for Windows, which can
be obtained two ways:
* Obtain a source distribution packaged by Sun Microsystems,
Inc. These are available from http://dev.mysql.com/downloads/.
* Package a source distribution yourself from the latest Bazaar
developer source tree. For instructions on pulling the latest
source files, see Section 2.10.3, "Installing from the
Development Source Tree."
If you find something not working as expected, or you have
suggestions about ways to improve the current build process on
Windows, please send a message to the win32 mailing list. See
Section 1.5.1, "MySQL Mailing Lists."
2.10.6.1. Building MySQL from Source Using CMake and Visual Studio
You can build MySQL on Windows by using a combination of cmake and
Microsoft Visual Studio .NET 2003 (7.1), Microsoft Visual Studio
2005 (8.0) or Microsoft Visual C++ 2005 Express Edition. You must
have the appropriate Microsoft Platform SDK installed.
Note
To compile from the source code on Windows you must use the
standard source distribution (for example, mysql-5.0.45.tar.gz).
You build from the same distribution as used to build MySQL on
Unix, Linux and other platforms. Do not use the Windows Source
distributions as they do not contain the necessary configuration
script and other files.
Follow this procedure to build MySQL:
1. If you are installing from a packaged source distribution,
create a work directory (for example, C:\workdir), and unpack
the source distribution there using WinZip or another Windows
tool that can read .zip files. This directory is the work
directory in the following instructions.
2. Using a command shell, navigate to the work directory and run
the following command:
C:\workdir>win\configure.js options
If you have associated the .js file extension with an
application such as a text editor, then you may need to use
the following command to force configure.js to be executed as
a script:
C:\workdir>cscript win\configure.js options
These options are available for configure.js:
+ WITH_INNOBASE_STORAGE_ENGINE: Enable the InnoDB storage
engine.
+ WITH_PARTITION_STORAGE_ENGINE: Enable user-defined
partitioning.
+ WITH_ARCHIVE_STORAGE_ENGINE: Enable the ARCHIVE storage
engine.
+ WITH_BLACKHOLE_STORAGE_ENGINE: Enable the BLACKHOLE
storage engine.
+ WITH_EXAMPLE_STORAGE_ENGINE: Enable the EXAMPLE storage
engine.
+ WITH_FEDERATED_STORAGE_ENGINE: Enable the FEDERATED
storage engine.
+ WITH_NDBCLUSTER_STORAGE_ENGINE (experimental): Enable the
NDBCLUSTER storage engine in the MySQL server; cause
binaries for the MySQL Cluster management and data node,
management client, and other programs to be built.
This option is supported only in MySQL Cluster NDB 7.0
(NDBCLUSTER storage engine versions 6.4.0 and later)
using the MySQL Cluster sources. It cannot be used to
enable clustering support in other MySQL source trees or
distributions.
+ MYSQL_SERVER_SUFFIX=suffix: Server suffix, default none.
+ COMPILATION_COMMENT=comment: Server comment, default
"Source distribution".
+ MYSQL_TCP_PORT=port: Server port, default 3306.
+ DISABLE_GRANT_OPTIONS: Disables the --bootstrap,
--skip-grant-tables, and --init-file options for mysqld.
This option is available as of MySQL 5.1.15.
For example (type the command on one line):
C:\workdir>win\configure.js WITH_INNOBASE_STORAGE_ENGINE
WITH_PARTITION_STORAGE_ENGINE MYSQL_SERVER_SUFFIX=-pro
3. From the work directory, execute the win\build-vs8.bat or
win\build-vs71.bat file, depending on the version of Visual
Studio you have installed. The script invokes CMake, which
generates the mysql.sln solution file.
You can also use win\build-vs8_x64.bat to build the 64-bit
version of MySQL. However, you cannot build the 64-bit version
with Visual Studio Express Edition. You must use Visual Studio
2005 (8.0) or higher.
4. From the work directory, open the generated mysql.sln file
with Visual Studio and select the proper configuration using
the Configuration menu. The menu provides Debug, Release,
RelwithDebInfo, MinRelInfo options. Then select Solution >
Build to build the solution.
Remember the configuration that you use in this step. It is
important later when you run the test script because that
script needs to know which configuration you used.
5. Test the server. The server built using the preceding
instructions expects that the MySQL base directory and data
directory are C:\mysql and C:\mysql\data by default. If you
want to test your server using the source tree root directory
and its data directory as the base directory and data
directory, you need to tell the server their path names. You
can either do this on the command line with the --basedir and
--datadir options, or by placing appropriate options in an
option file. (See Section 4.2.3.2, "Using Option Files.") If
you have an existing data directory elsewhere that you want to
use, you can specify its path name instead.
When the server is running in standalone fashion or as a
service based on your configuration, try to connect to it from
the mysql interactive command-line utility.
You can also run the standard test script, mysql-test-run.pl.
This script is written in Perl, so 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 mysql-test directory under the work
directory, set the MTR_VS_CONFIG environment variable to the
configuration you selected earlier (or use the --vs-config
option), and invoke mysql-test-run.pl. For example (using
Cygwin and the bash shell):
shell> cd mysql-test
shell> export MTS_VS_CONFIG=debug
shell> ./mysql-test-run.pl --force --timer
shell> ./mysql-test-run.pl --force --timer --ps-protocol
When you are satisfied that the programs you have built are
working correctly, stop the server. Now you can install the
distribution. One way to do this is to use the make_win_bin_dist
script in the scripts directory of the MySQL source distribution
(see Section 4.4.2, "make_win_bin_dist --- Package MySQL
Distribution as ZIP Archive"). This is a shell script, so you must
have Cygwin installed if you want to use it. It creates a Zip
archive of the built executables and support files that you can
unpack in the location at which you want to install MySQL.
It is also possible to install MySQL by copying directories and
files directly:
1. Create the directories where you want to install MySQL. For
example, to install into C:\mysql, use these commands:
C:\> mkdir C:\mysql
C:\> mkdir C:\mysql\bin
C:\> mkdir C:\mysql\data
C:\> mkdir C:\mysql\share
C:\> mkdir C:\mysql\scripts
If you want to compile other clients and link them to MySQL,
you should also create several additional directories:
C:\> mkdir C:\mysql\include
C:\> mkdir C:\mysql\lib
C:\> mkdir C:\mysql\lib\debug
C:\> mkdir C:\mysql\lib\opt
If you want to benchmark MySQL, create this directory:
C:\> mkdir C:\mysql\sql-bench
Benchmarking requires Perl support. See Section 2.15, "Perl
Installation Notes."
2. From the work directory, copy into the C:\mysql directory the
following directories:
C:\> cd \workdir
C:\workdir> copy client_release\*.exe C:\mysql\bin
C:\workdir> copy client_debug\mysqld.exe C:\mysql\bin\mysqld-debug.ex
e
C:\workdir> xcopy scripts\*.* C:\mysql\scripts /E
C:\workdir> xcopy share\*.* C:\mysql\share /E
If you want to compile other clients and link them to MySQL,
you should also copy several libraries and header files:
C:\workdir> copy lib_debug\mysqlclient.lib C:\mysql\lib\debug
C:\workdir> copy lib_debug\libmysql.* C:\mysql\lib\debug
C:\workdir> copy lib_debug\zlib.* C:\mysql\lib\debug
C:\workdir> copy lib_release\mysqlclient.lib C:\mysql\lib\opt
C:\workdir> copy lib_release\libmysql.* C:\mysql\lib\opt
C:\workdir> copy lib_release\zlib.* C:\mysql\lib\opt
C:\workdir> copy include\*.h C:\mysql\include
C:\workdir> copy libmysql\libmysql.def C:\mysql\include
If you want to benchmark MySQL, you should also do this:
C:\workdir> xcopy sql-bench\*.* C:\mysql\bench /E
After installation, set up and start the server in the same way as
for binary Windows distributions. See Section 2.3, "Installing
MySQL on Windows."

137
man/comp_err.1 Normal file
View file

@ -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/).

81
man/innochecksum.1 Normal file
View file

@ -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/).

106
man/make_win_bin_dist.1 Normal file
View file

@ -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/).

61
man/msql2mysql.1 Normal file
View file

@ -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/).

111
man/my_print_defaults.1 Normal file
View file

@ -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/).

151
man/myisam_ftdump.1 Normal file
View file

@ -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/).

841
man/myisamchk.1 Normal file
View file

@ -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/).

129
man/myisamlog.1 Normal file
View file

@ -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/).

523
man/myisampack.1 Normal file
View file

@ -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/).

234
man/mysql-stress-test.pl.1 Normal file
View file

@ -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/).

1145
man/mysql-test-run.pl.1 Normal file
View file

File diff suppressed because it is too large Load diff

1699
man/mysql.1 Normal file
View file

File diff suppressed because it is too large Load diff

111
man/mysql.server.1 Normal file
View file

@ -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/).

166
man/mysql_client_test.1 Normal file
View file

@ -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/).

1
man/mysql_client_test_embedded.1 Normal file
View file

@ -0,0 +1 @@
.so man1/mysql_client_test.1

131
man/mysql_config.1 Normal file
View file

@ -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/).

117
man/mysql_convert_table_format.1 Normal file
View file

@ -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/).

98
man/mysql_find_rows.1 Normal file
View file

@ -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/).

62
man/mysql_fix_extensions.1 Normal file
View file

@ -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/).

123
man/mysql_fix_privilege_tables.1 Normal file
View file

@ -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/).

153
man/mysql_install_db.1 Normal file
View file

@ -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/).

67
man/mysql_secure_installation.1 Normal file
View file

@ -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/).

104
man/mysql_setpermission.1 Normal file
View file

@ -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/).

101
man/mysql_tzinfo_to_sql.1 Normal file
View file

@ -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/).

190
man/mysql_upgrade.1 Normal file
View file

@ -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/).

91
man/mysql_waitpid.1 Normal file
View file

@ -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/).

93
man/mysql_zap.1 Normal file
View file

@ -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/).

218
man/mysqlaccess.1 Normal file
View file

@ -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/).

510
man/mysqladmin.1 Normal file
View file

@ -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/).

1230
man/mysqlbinlog.1 Normal file
View file

File diff suppressed because it is too large Load diff

63
man/mysqlbug.1 Normal file
View file

@ -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/).

411
man/mysqlcheck.1 Normal file
View file

@ -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/).

53
man/mysqld.8 Normal file
View file

@ -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/).

457
man/mysqld_multi.1 Normal file
View file

@ -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/).

506
man/mysqld_safe.1 Normal file
View file

@ -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/).

1250
man/mysqldump.1 Normal file
View file

File diff suppressed because it is too large Load diff

176
man/mysqldumpslow.1 Normal file
View file

@ -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/).

265
man/mysqlhotcopy.1 Normal file
View file

@ -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/).

320
man/mysqlimport.1 Normal file
View file

@ -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/).

1216
man/mysqlmanager.8 Normal file
View file

File diff suppressed because it is too large Load diff

237
man/mysqlshow.1 Normal file
View file

@ -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/).

454
man/mysqlslap.1 Normal file
View file

@ -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/).

383
man/mysqltest.1 Normal file
View file

@ -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/).

1
man/mysqltest_embedded.1 Normal file
View file

@ -0,0 +1 @@
.so man1/mysqltest.1

174
man/ndbd.8 Normal file
View file

@ -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/).

85
man/ndbd_redo_log_reader.1 Normal file
View file

@ -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/).

285
man/ndbmtd.8 Normal file
View file

@ -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/).

117
man/perror.1 Normal file
View file

@ -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/).

116
man/replace.1 Normal file
View file

@ -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/).

78
man/resolve_stack_dump.1 Normal file
View file

@ -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/).

70
man/resolveip.1 Normal file
View file

@ -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/).

2013
scripts/fill_help_tables.sql
View file

File diff suppressed because one or more lines are too long

165
support-files/MacOSX/ReadMe.txt
View file

@ -1,8 +1,163 @@
You can find information about how to install on Mac OS X at
2.5. Installing MySQL on Mac OS X
http://dev.mysql.com/doc/refman/5.1/en/mac-os-x-installation.html
You can install MySQL on Mac OS X 10.3.x ("Panther") or newer
using a Mac OS X binary package in PKG format instead of the
binary tarball distribution. Please note that older versions of
Mac OS X (for example, 10.1.x or 10.2.x) are not supported by this
package.
The MySQL Reference Manual is also available in various formats on
http://dev.mysql.com/doc; if you're interested in the DocBook XML
sources go to http://svn.mysql.com.
The package is located inside a disk image (.dmg) file that you
first need to mount by double-clicking its icon in the Finder. It
should then mount the image and display its contents.
To obtain MySQL, see Section 2.1.3, "How to Get MySQL."
Note
Before proceeding with the installation, be sure to shut down all
running MySQL server instances by either using the MySQL Manager
Application (on Mac OS X Server) or via mysqladmin shutdown on the
command line.
To actually install the MySQL PKG file, double-click on the
package icon. This launches the Mac OS X Package Installer, which
guides you through the installation of MySQL.
Due to a bug in the Mac OS X package installer, you may see this
error message in the destination disk selection dialog:
You cannot install this software on this disk. (null)
If this error occurs, simply click the Go Back button once to
return to the previous screen. Then click Continue to advance to
the destination disk selection again, and you should be able to
choose the destination disk correctly. We have reported this bug
to Apple and it is investigating this problem.
The Mac OS X PKG of MySQL installs itself into
/usr/local/mysql-VERSION and also installs a symbolic link,
/usr/local/mysql, that points to the new location. If a directory
named /usr/local/mysql exists, it is renamed to
/usr/local/mysql.bak first. Additionally, the installer creates
the grant tables in the mysql database by executing
mysql_install_db.
The installation layout is similar to that of a tar file binary
distribution; all MySQL binaries are located in the directory
/usr/local/mysql/bin. The MySQL socket file is created as
/tmp/mysql.sock by default. See Section 2.1.5, "Installation
Layouts."
MySQL installation requires a Mac OS X user account named mysql. A
user account with this name should exist by default on Mac OS X
10.2 and up.
If you are running Mac OS X Server, a version of MySQL should
already be installed. The following table shows the versions of
MySQL that ship with Mac OS X Server versions.
Mac OS X Server Version MySQL Version
10.2-10.2.2 3.23.51
10.2.3-10.2.6 3.23.53
10.3 4.0.14
10.3.2 4.0.16
10.4.0 4.1.10a
This manual section covers the installation of the official MySQL
Mac OS X PKG only. Make sure to read Apple's help information
about installing MySQL: Run the "Help View" application, select
"Mac OS X Server" help, do a search for "MySQL," and read the item
entitled "Installing MySQL."
If you previously used Marc Liyanage's MySQL packages for Mac OS X
from http://www.entropy.ch, you can simply follow the update
instructions for packages using the binary installation layout as
given on his pages.
If you are upgrading from Marc's 3.23.x versions or from the Mac
OS X Server version of MySQL to the official MySQL PKG, you also
need to convert the existing MySQL privilege tables to the current
format, because some new security privileges have been added. See
Section 4.4.8, "mysql_upgrade --- Check Tables for MySQL Upgrade."
If you want MySQL to start automatically during system startup,
you also need to install the MySQL Startup Item. It is part of the
Mac OS X installation disk images as a separate installation
package. Simply double-click the MySQLStartupItem.pkg icon and
follow the instructions to install it. The Startup Item need be
installed only once. There is no need to install it each time you
upgrade the MySQL package later.
The Startup Item for MySQL is installed into
/Library/StartupItems/MySQLCOM. (Before MySQL 4.1.2, the location
was /Library/StartupItems/MySQL, but that collided with the MySQL
Startup Item installed by Mac OS X Server.) Startup Item
installation adds a variable MYSQLCOM=-YES- to the system
configuration file /etc/hostconfig. If you want to disable the
automatic startup of MySQL, simply change this variable to
MYSQLCOM=-NO-.
On Mac OS X Server, the default MySQL installation uses the
variable MYSQL in the /etc/hostconfig file. The MySQL Startup Item
installer disables this variable by setting it to MYSQL=-NO-. This
avoids boot time conflicts with the MYSQLCOM variable used by the
MySQL Startup Item. However, it does not shut down a running MySQL
server. You should do that yourself.
After the installation, you can start up MySQL by running the
following commands in a terminal window. You must have
administrator privileges to perform this task.
If you have installed the Startup Item, use this command:
shell> sudo /Library/StartupItems/MySQLCOM/MySQLCOM start
(Enter your password, if necessary)
(Press Control-D or enter "exit" to exit the shell)
If you don't use the Startup Item, enter the following command
sequence:
shell> cd /usr/local/mysql
shell> sudo ./bin/mysqld_safe
(Enter your password, if necessary)
(Press Control-Z)
shell> bg
(Press Control-D or enter "exit" to exit the shell)
You should be able to connect to the MySQL server, for example, by
running /usr/local/mysql/bin/mysql.
Note
The accounts that are listed in the MySQL grant tables initially
have no passwords. After starting the server, you should set up
passwords for them using the instructions in Section 2.11,
"Post-Installation Setup and Testing."
You might want to add aliases to your shell's resource file to
make it easier to access commonly used programs such as mysql and
mysqladmin from the command line. The syntax for bash is:
alias mysql=/usr/local/mysql/bin/mysql
alias mysqladmin=/usr/local/mysql/bin/mysqladmin
For tcsh, use:
alias mysql /usr/local/mysql/bin/mysql
alias mysqladmin /usr/local/mysql/bin/mysqladmin
Even better, add /usr/local/mysql/bin to your PATH environment
variable. You can do this by modifying the appropriate startup
file for your shell. For more information, see Section 4.2.1,
"Invoking MySQL Programs."
If you are upgrading an existing installation, note that
installing a new MySQL PKG does not remove the directory of an
older installation. Unfortunately, the Mac OS X Installer does not
yet offer the functionality required to properly upgrade
previously installed packages.
To use your existing databases with the new installation, you'll
need to copy the contents of the old data directory to the new
data directory. Make sure that neither the old server nor the new
one is running when you do this. After you have copied over the
MySQL database files from the previous installation and have
successfully started the new server, you should consider removing
the old installation files to save disk space. Additionally, you
should also remove older versions of the Package Receipt
directories located in /Library/Receipts/mysql-VERSION.pkg.