developers

Download

developers@lists.mariadb.org

May 2009

24 participants
74 discussions

Re: [Maria-developers] [Merge] lp:~maria-captains/maria/maria-xtradb into lp:maria
by Kristian Nielsen 10 Jul '09

10 Jul '09

Percona <launchpad(a)percona.com> writes: > Percona has proposed merging lp:~maria-captains/maria/maria-xtradb into lp:maria. > > Requested reviews: > Maria-captains (maria-captains) > > Proposal to merge replacement InnoDB->XtraDB Thanks a lot for your efforts in this! I branched the tree and took a look. There are a couple of issues that I think need to be resolved before we can merge it into MariaDB. I have some questions below, but please don't hesitate to ask me for any kind of help needed to move this forward. > === modified file 'storage/innobase/include/sync0rw.h' > --- storage/innobase/include/sync0rw.h 2008-02-19 16:44:09 +0000 > +++ storage/innobase/include/sync0rw.h 2009-03-31 04:19:17 +0000 > +#ifndef INNODB_RW_LOCKS_USE_ATOMICS > +#error INNODB_RW_LOCKS_USE_ATOMICS is not defined. Do you use enough new GCC or compatibles? > +#error Or do you use exact options for CFLAGS? > +#error e.g. (for x86_32): "-m32 -march=i586 -mtune=i686" > +#error e.g. (for Sparc_64): "-m64 -mcpu=v9" > +#error Otherwise, this build may be slower than normal version. > +#endif > + My attempt to build (BUILD/compile-pentium64-max) failed with this error. There were also other build errors (I assume places where the atomics-using code has not been extended with a part that works without the availability of atomics). The reason is that in the MariaDB tree, HAVE_GCC_ATOMIC_BUILTINS is disabled, which caused XtraDB to disable INNODB_RW_LOCKS_USE_ATOMICS, which triggers the above error. I think I understand why this makes sense for Percona, after all using these better synchronisation primitives is part of the reason for using the Percona server in the first place. Can you tell me if Percona has decided not to maintain XtraDB working without the availability of atomic operations? Or if it is just an oversight? I need to discuss with other MariaDB people whether XtraDB for MariaDB should be maintained working without the atomic operations (if so, we should of course be willing to do the work/effort required). So, any thoughts about the best way to deal with this? Should the above #error be removed and XtraDB extended to work without atomics in the MariaDB tree? And is this something Percona wants to do, or should I look into it? Also, Sergei Golubchik told me that HAVE_GCC_ATOMIC_BUILTINS is for my_atomic_ops, and InnoDB/XtraDB shouldn't really be using it. But I need to look more into the code to understand what the problem is, if any. > === added directory 'storage/innobase/mysql-test' > === added directory 'storage/innobase/mysql-test/patches' When I ran the test suite, I got test failures in test main.innodb. I see that the patch contains patches for main MySQL test cases in mysql-test/t/*.test, and also seems to add separate test cases in the storage/innobase/mysql-test/ directory. Do you know what the status is of these test suite modifications? Do the patches need to be applied to the existing test suite, and/or should the extra test cases be used to add to/overwrite the existing tests? We would need to get the test suite to run without problems before merging. Does Percona run the test suite with no failures? Can you suggest which directions I should work in to solve the test failures? Ie. I'm unsure to what extent the extra test cases/patches have already been applied in main MySQL sources, and whether failures are expected or are just due to not being adapted for current MariaDB source changes. Any help with the above would be great. I plan to continue working with you on this so we can get it merged without unnecessary delays. - Kristian.

3 17

[Maria-developers] how to speed up Maria record loading?
by Giuseppe Maxia 07 Jun '09

07 Jun '09

Hi, I am doing some tests with Maria. Out of the box, without any tuning, the load of records (with multiple record INSERT statements) is 5 times slower than MyISAM, 4 times slower than InnoDB. What can I do to make the loading faster? Thanks Giuseppe -- The Data Charmer http://datacharmer.org/

4 4

[Maria-developers] Query cache test failure in Buildbot for mariadb 5.1
by Kristian Nielsen 07 Jun '09

07 Jun '09

Hi, There is a query cache related failure seen in Buildbot: https://askmonty.org/buildbot/builders/hardy-amd64-dbg/builds/35/steps/test… main.query_cache_28249 [ fail ] Test ended at 2009-05-21 09:13:10 CURRENT_TEST: main.query_cache_28249 --- /home/archivist/archivist-amd64/archivist-amd64/build/mysql-test/r/query_cache_28249.result 2009-05-21 09:30:15.000000000 +0300 +++ /home/archivist/archivist-amd64/archivist-amd64/build/mysql-test/r/query_cache_28249.reject 2009-05-21 11:13:10.000000000 +0300 @@ -46,7 +46,6 @@ 1 0 2 0 3 0 -4 0 RESET QUERY CACHE; SELECT *, (SELECT COUNT(*) FROM t2) FROM t1; a (SELECT COUNT(*) FROM t2) mysqltest: Result length mismatch - saving '/home/archivist/archivist-amd64/archivist-amd64/build/mysql-test/var/1/log/main.query_cache_28249/' to '/home/archivist/archivist-amd64/archivist-amd64/build/mysql-test/var/log/main.query_cache_28249/' Retrying test, attempt(2/3)... main.query_cache_28249 [ retry-pass ] 509 Retrying test, attempt(3/3)... main.query_cache_28249 [ retry-pass ] 404 I checked the bug: http://bugs.mysql.com/bug.php?id=28249 It is about a race condition in query cache and MyISAM (and re-test in Buildbot shows that it is not 100% reproducible). I am thinking that perhaps the bug was re-introduced with Maria, or in any case that someone more familiar with the MyISAM or Maria code would be better at looking into it. Any takers? - Kristian.

2 2

[Maria-developers] Patches to consider to include
by Vadim Tkachenko 07 Jun '09

07 Jun '09

Hello, What do you think about including patches global_trx_ids, binlog event checksums and fixes to crash-proof slaves from https://code.launchpad.net/~jtolmer/mysql-server/global-trx-ids into tree ? -- Vadim Tkachenko, CTO Percona Inc. ICQ: 369-510-335, Skype: vadimtk153, Phone +1-888-401-3403 MySQL Performance Blog - http://www.mysqlperformanceblog.com MySQL Consulting http://www.percona.com/

6 9

[Maria-developers] Buildbot Idea
by Adam M. Dutko 06 Jun '09

06 Jun '09

Kristian, Maybe Linode.com or Slicehost.com would be interested in donating a few VPS boxes to Maria? I use Linode.com for a few things and they have a large selection of "distros." -Adam

2 1

[Maria-developers] microslow-innodb ported to 5.1
by Vadim Tkachenko 06 Jun '09

06 Jun '09

Hi, We already ported patch http://www.percona.com/mysql/5.0.77-b13/patches/microslow_innodb.patch (from list http://askmonty.org/wiki/index.php/MariaDB_versus_MySQL#What_kind_of_patche… ) to 5.1, so it will be easy to include it into MariaDB. I will propose merge soon, so let's do not duplicate work if you are going to look into this patch also. -- Vadim Tkachenko, CTO Percona Inc. ICQ: 369-510-335, Skype: vadimtk153, Phone +1-888-401-3403 MySQL Performance Blog - http://www.mysqlperformanceblog.com MySQL Consulting http://www.percona.com/

5 11

[Maria-developers] bzr commit into MariaDB 5.1, with Maria 1.5:maria branch (knielsen:2706)
by knielsen＠knielsen-hq.org 02 Jun '09

02 Jun '09

#At lp:maria 2706 knielsen(a)knielsen-hq.org 2009-05-25 Imported freely distributable documentation from upstream MySQL 5.1.34 source tarball. added: man/comp_err.1 man/innochecksum.1 man/make_win_bin_dist.1 man/msql2mysql.1 man/my_print_defaults.1 man/myisam_ftdump.1 man/myisamchk.1 man/myisamlog.1 man/myisampack.1 man/mysql-stress-test.pl.1 man/mysql-test-run.pl.1 man/mysql.1 man/mysql.server.1 man/mysql_client_test.1 man/mysql_client_test_embedded.1 man/mysql_config.1 man/mysql_convert_table_format.1 man/mysql_find_rows.1 man/mysql_fix_extensions.1 man/mysql_fix_privilege_tables.1 man/mysql_install_db.1 man/mysql_secure_installation.1 man/mysql_setpermission.1 man/mysql_tzinfo_to_sql.1 man/mysql_upgrade.1 man/mysql_waitpid.1 man/mysql_zap.1 man/mysqlaccess.1 man/mysqladmin.1 man/mysqlbinlog.1 man/mysqlbug.1 man/mysqlcheck.1 man/mysqld.8 man/mysqld_multi.1 man/mysqld_safe.1 man/mysqldump.1 man/mysqldumpslow.1 man/mysqlhotcopy.1 man/mysqlimport.1 man/mysqlmanager.8 man/mysqlshow.1 man/mysqlslap.1 man/mysqltest.1 man/mysqltest_embedded.1 man/ndbd.8 man/ndbd_redo_log_reader.1 man/ndbmtd.8 man/perror.1 man/replace.1 man/resolve_stack_dump.1 man/resolveip.1 modified: Docs/INSTALL-BINARY INSTALL-SOURCE INSTALL-WIN-SOURCE scripts/fill_help_tables.sql support-files/MacOSX/ReadMe.txt === modified file 'Docs/INSTALL-BINARY' --- a/Docs/INSTALL-BINARY 2007-11-23 09:15:55 +0000 +++ b/Docs/INSTALL-BINARY 2009-05-25 09:59:47 +0000 @@ -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." === modified file 'INSTALL-SOURCE' --- a/INSTALL-SOURCE 2007-11-23 09:15:55 +0000 +++ b/INSTALL-SOURCE 2009-05-25 09:59:47 +0000 @@ -1,8 +1,9578 @@ -You can find information about how to install from a source distributions at +Chapter 2. Installing and Upgrading MySQL - http://dev.mysql.com/doc/refman/5.1/en/installing-source.html + This chapter describes how to obtain and install MySQL. A summary + of the procedure follows and later sections provide the details. + If you plan to upgrade an existing version of MySQL to a newer + version rather than install MySQL for the first time, see Section + 2.12.1, "Upgrading MySQL," for information about upgrade + procedures and about issues that you should consider before + upgrading. -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. + If you are interested in migrating to MySQL from another database + system, you may wish to read Section A.8, "MySQL 5.1 FAQ --- + Migration," which contains answers to some common questions + concerning migration issues. + + 1. Determine whether MySQL runs and is supported on your + platform. Please note that not all platforms are equally + suitable for running MySQL, and that not all platforms on + which MySQL is known to run are officially supported by Sun + Microsystems, Inc.: + + + For MySQL Enterprise Server, the officially supported + platforms are listed at + http://www.mysql.com/support/supportedplatforms.html. + + + MySQL Community Server runs on the platforms listed at + Section 2.1.1, "Operating Systems Supported by MySQL + Community Server." + + 2. Choose which distribution to install. Several versions of + MySQL are available, and most are available in several + distribution formats. You can choose from pre-packaged + distributions containing binary (precompiled) programs or + source code. When in doubt, use a binary distribution. We also + provide public access to our current source tree for those who + want to see our most recent developments and help us test new + code. To determine which version and type of distribution you + should use, see Section 2.1.2, "Choosing Which MySQL + Distribution to Install." + + 3. Download the distribution that you want to install. For + instructions, see Section 2.1.3, "How to Get MySQL." To verify + the integrity of the distribution, use the instructions in + Section 2.1.4, "Verifying Package Integrity Using MD5 + Checksums or GnuPG." + + 4. Install the distribution. To install MySQL from a binary + distribution, use the instructions in Section 2.2, "Standard + MySQL Installation Using a Binary Distribution." To install + MySQL from a source distribution or from the current + development source tree, use the instructions in Section 2.10, + "MySQL Installation Using a Source Distribution." + If you encounter installation difficulties, see Section 2.13, + "Operating System-Specific Notes," for information on solving + problems for particular platforms. + + 5. Perform any necessary post-installation setup. After + installing MySQL, read Section 2.11, "Post-Installation Setup + and Testing." This section contains important information + about making sure the MySQL server is working properly. It + also describes how to secure the initial MySQL user accounts, + which have no passwords until you assign passwords. The + section applies whether you install MySQL using a binary or + source distribution. + + 6. If you want to run the MySQL benchmark scripts, Perl support + for MySQL must be available. See Section 2.15, "Perl + Installation Notes." + +2.1. General Installation Issues + + The MySQL installation procedure depends on whether you will + install MySQL Enterprise Server or MySQL Community Server. The set + of applicable platforms depends on which distribution you will + install: + + * For MySQL Enterprise Server, the officially supported + platforms are listed at + http://www.mysql.com/support/supportedplatforms.html. + + * MySQL Community Server runs on the platforms listed at Section + 2.1.1, "Operating Systems Supported by MySQL Community + Server." + + For MySQL Enterprise Server, install the main distribution plus + any service packs or hotfixes that you wish to apply using the + Enterprise Installer. For platforms that do not yet have an + Enterprise Installer, use the Community Server instructions. + + For MySQL Community Server, install the main distribution plus any + hotfixes and updates: + + * Download a binary release, or download a source release and + build MySQL yourself from the source code. + + * Retrieve MySQL from the Bazaar tree and build it from source. + The Bazaar tree contains the latest developer code. + + The immediately following sections contain the information + necessary to choose, download, and verify your distribution. The + instructions in later sections of the chapter describe how to + install the distribution that you choose. For binary + distributions, see the instructions at Section 2.2, "Standard + MySQL Installation Using a Binary Distribution." To build MySQL + from source, use the instructions at Section 2.10, "MySQL + Installation Using a Source Distribution." + +2.1.1. Operating Systems Supported by MySQL Community Server + + This section lists the operating systems on which MySQL Community + Server is known to run. + +Important + + Sun Microsystems, Inc. does not necessarily provide official + support for all the platforms listed in this section. For + information about those platforms that are officially supported, + see MySQL Server Supported Platforms + (http://www.mysql.com/support/supportedplatforms.html) on the + MySQL Web site. + + We use GNU Autoconf, so it is possible to port MySQL to all modern + systems that have a C++ compiler and a working implementation of + POSIX threads. (Thread support is needed for the server. To + compile only the client code, the only requirement is a C++ + compiler.) + + MySQL has been reported to compile successfully on the following + combinations of operating system and thread package. + + * AIX 4.x, 5.x with native threads. See Section 2.13.5.3, + "IBM-AIX notes." + + * Amiga. + + * FreeBSD 5.x and up with native threads. + + * HP-UX 11.x with the native threads. See Section 2.13.5.2, + "HP-UX Version 11.x Notes." + + * Linux, builds on all fairly recent Linux distributions with + glibc 2.3. See Section 2.13.1, "Linux Notes." + + * Mac OS X. See Section 2.13.2, "Mac OS X Notes." + + * NetBSD 1.3/1.4 Intel and NetBSD 1.3 Alpha. See Section + 2.13.4.2, "NetBSD Notes." + + * Novell NetWare 6.0 and 6.5. See Section 2.8, "Installing MySQL + on NetWare." + + * OpenBSD 2.5 and with native threads. OpenBSD earlier than 2.5 + with the MIT-pthreads package. See Section 2.13.4.3, "OpenBSD + 2.5 Notes." + + * SCO OpenServer 5.0.X with a recent port of the FSU Pthreads + package. See Section 2.13.5.8, "SCO UNIX and OpenServer 5.0.x + Notes." + + * SCO Openserver 6.0.x. See Section 2.13.5.9, "SCO OpenServer + 6.0.x Notes." + + * SCO UnixWare 7.1.x. See Section 2.13.5.10, "SCO UnixWare 7.1.x + and OpenUNIX 8.0.0 Notes." + + * SGI Irix 6.x with native threads. See Section 2.13.5.7, "SGI + Irix Notes." + + * Solaris 2.5 and above with native threads on SPARC and x86. + See Section 2.13.3, "Solaris Notes." + + * Tru64 Unix. See Section 2.13.5.5, "Alpha-DEC-UNIX Notes + (Tru64)." + + * Windows 2000, Windows XP, Windows Vista, Windows Server 2003, + and Windows Server 2008. See Section 2.3, "Installing MySQL on + Windows." + + MySQL has also been known to run on other systems in the past. See + Section 2.13, "Operating System-Specific Notes." Some porting + effort might be required for current versions of MySQL on these + systems. + + Not all platforms are equally well-suited for running MySQL. How + well a certain platform is suited for a high-load mission-critical + MySQL server is determined by the following factors: + + * General stability of the thread library. A platform may have + an excellent reputation otherwise, but MySQL is only as stable + as the thread library it calls, even if everything else is + perfect. + + * The capability of the kernel and the thread library to take + advantage of symmetric multi-processor (SMP) systems. In other + words, when a process creates a thread, it should be possible + for that thread to run on a CPU different from the original + process. + + * The capability of the kernel and the thread library to run + many threads that acquire and release a mutex over a short + critical region frequently without excessive context switches. + If the implementation of pthread_mutex_lock() is too anxious + to yield CPU time, this hurts MySQL tremendously. If this + issue is not taken care of, adding extra CPUs actually makes + MySQL slower. + + * General file system stability and performance. + + * If your tables are large, performance is affected by the + ability of the file system to deal with large files at all and + to deal with them efficiently. + + * Our level of expertise here at Sun Microsystems, Inc. with the + platform. If we know a platform well, we enable + platform-specific optimizations and fixes at compile time. We + can also provide advice on configuring your system optimally + for MySQL. + + * The amount of testing we have done internally for similar + configurations. + + * The number of users that have run MySQL successfully on the + platform in similar configurations. If this number is high, + the likelihood of encountering platform-specific surprises is + much smaller. + +2.1.2. Choosing Which MySQL Distribution to Install + + When preparing to install MySQL, you should decide which version + to use. MySQL development occurs in several release series, and + you can pick the one that best fits your needs. After deciding + which version to install, you can choose a distribution format. + Releases are available in binary or source format. + +2.1.2.1. Choosing Which Version of MySQL to Install + + The first decision to make is whether you want to use a production + (stable) release or a development release. In the MySQL + development process, multiple release series co-exist, each at a + different stage of maturity: + + * MySQL 6.0 is the current development release series. + + * MySQL 5.1 is the current General Availability (Production) + release series. New releases are issued for bugfixes only; no + new features are being added that could affect stability. + + * MySQL 5.0 is the previous stable (production-quality) release + series. + + * MySQL 4.1, 4.0, and 3.23 are old stable (production-quality) + release series. MySQL 4.1 is now at the end of the product + lifecycle. Active development and support for these versions + has ended. Extended support for MySQL 4.1 and 4.0 is + available. According to the MySQL Lifecycle Policy (see + http://www.mysql.com/company/legal/lifecycle/#policy), only + Security and Severity Level 1 issues will still be fixed for + MySQL 4.0 and 4.1. + + We do not believe in a complete code freeze because this prevents + us from making bugfixes and other fixes that must be done. By + "somewhat frozen" we mean that we may add small things that should + not affect anything that currently works in a production release. + Naturally, relevant bugfixes from an earlier series propagate to + later series. + + Normally, if you are beginning to use MySQL for the first time or + trying to port it to some system for which there is no binary + distribution, we recommend going with the General Availability + release series. Currently, this is MySQL 5.1. All MySQL releases, + even those from development series, are checked with the MySQL + benchmarks and an extensive test suite before being issued. + + If you are running an older system and want to upgrade, but do not + want to take the chance of having a non-seamless upgrade, you + should upgrade to the latest version in the same release series + you are using (where only the last part of the version number is + newer than yours). We have tried to fix only fatal bugs and make + only small, relatively "safe" changes to that version. + + If you want to use new features not present in the production + release series, you can use a version from a development series. + Note that development releases are not as stable as production + releases. + + If you want to use the very latest sources containing all current + patches and bugfixes, you can use one of our Bazaar repositories. + These are not "releases" as such, but are available as previews of + the code on which future releases are to be based. + + The MySQL naming scheme uses release names that consist of three + numbers and a suffix; for example, mysql-5.0.12-beta. The numbers + within the release name are interpreted as follows: + + * The first number (5) is the major version and describes the + file format. All MySQL 5 releases have the same file format. + + * The second number (0) is the release level. Taken together, + the major version and release level constitute the release + series number. + + * The third number (12) is the version number within the release + series. This is incremented for each new release. Usually you + want the latest version for the series you have chosen. + + For each minor update, the last number in the version string is + incremented. When there are major new features or minor + incompatibilities with previous versions, the second number in the + version string is incremented. When the file format changes, the + first number is increased. + + Release names also include a suffix to indicates the stability + level of the release. Releases within a series progress through a + set of suffixes to indicate how the stability level improves. The + possible suffixes are: + + * alpha indicates that the release is for preview purposes only. + Known bugs should be documented in the News section (see + Appendix C, "MySQL Change History"). Most alpha releases + implement new commands and extensions. Active development that + may involve major code changes can occur in an alpha release. + However, we do conduct testing before issuing a release. + + * beta indicates that the release is appropriate for use with + new development. Within beta releases, the features and + compatibility should remain consistent. However, beta releases + may contain numerous and major unaddressed bugs. + All APIs, externally visible structures, and columns for SQL + statements will not change during future beta, release + candidate, or production releases. + + * rc indicates a Release Candidate. Release candidates are + believed to be stable, having passed all of MySQL's internal + testing, and with all known fatal runtime bugs fixed. However, + the release has not been in widespread use long enough to know + for sure that all bugs have been identified. Only minor fixes + are added. (A release candidate is what formerly was known as + a gamma release.) + + * If there is no suffix, it indicates that the release is a + General Availability (GA) or Production release. GA releases + are stable, having successfully passed through all earlier + release stages and are believed to be reliable, free of + serious bugs, and suitable for use in production systems. Only + critical bugfixes are applied to the release. + + MySQL uses a naming scheme that is slightly different from most + other products. In general, it is usually safe to use any version + that has been out for a couple of weeks without being replaced by + a new version within the same release series. + + All releases of MySQL are run through our standard tests and + benchmarks to ensure that they are relatively safe to use. Because + the standard tests are extended over time to check for all + previously found bugs, the test suite keeps getting better. + + All releases have been tested at least with these tools: + + * An internal test suite + The mysql-test directory contains an extensive set of test + cases. We run these tests for every server binary. See Section + 22.1.2, "MySQL Test Suite," for more information about this + test suite. + + * The MySQL benchmark suite + This suite runs a range of common queries. It is also a test + to determine whether the latest batch of optimizations + actually made the code faster. See Section 7.1.4, "The MySQL + Benchmark Suite." + + * The crash-me test + This test tries to determine what features the database + supports and what its capabilities and limitations are. See + Section 7.1.4, "The MySQL Benchmark Suite." + + We also test the newest MySQL version in our internal production + environment, on at least one machine. We have more than 100GB of + data to work with. + +2.1.2.2. Choosing a Distribution Format + + After choosing which version of MySQL to install, you should + decide whether to use a binary distribution or a source + distribution. In most cases, you should probably use a binary + distribution, if one exists for your platform. Binary + distributions are available in native format for many platforms, + such as RPM files for Linux or PKG package installers for Mac OS X + or Solaris. Distributions also are available as Zip archives or + compressed tar files. + + Reasons to choose a binary distribution include the following: + + * Binary distributions generally are easier to install than + source distributions. + + * To satisfy different user requirements, we provide several + servers in binary distributions. mysqld is an optimized server + that is a smaller, faster binary. mysqld-debug is compiled + with debugging support. + Each of these servers is compiled from the same source + distribution, though with different configuration options. All + native MySQL clients can connect to servers from either MySQL + version. + + Under some circumstances, you may be better off installing MySQL + from a source distribution: + + * You want to install MySQL at some explicit location. The + standard binary distributions are ready to run at any + installation location, but you might require even more + flexibility to place MySQL components where you want. + + * You want to configure mysqld to ensure that features are + available that might not be included in the standard binary + distributions. Here is a list of the most common extra options + that you may want to use to ensure feature availability: + + + --with-libwrap + + + --with-named-z-libs (this is done for some of the + binaries) + + + --with-debug[=full] + + * You want to configure mysqld without some features that are + included in the standard binary distributions. For example, + distributions normally are compiled with support for all + character sets. If you want a smaller MySQL server, you can + recompile it with support for only the character sets you + need. + + * You have a special compiler (such as pgcc) or want to use + compiler options that are better optimized for your processor. + Binary distributions are compiled with options that should + work on a variety of processors from the same processor + family. + + * You want to use the latest sources from one of the Bazaar + repositories to have access to all current bugfixes. For + example, if you have found a bug and reported it to the MySQL + development team, the bugfix is committed to the source + repository and you can access it there. The bugfix does not + appear in a release until a release actually is issued. + + * You want to read (or modify) the C and C++ code that makes up + MySQL. For this purpose, you should get a source distribution, + because the source code is always the ultimate manual. + + * Source distributions contain more tests and examples than + binary distributions. + +2.1.2.3. How and When Updates Are Released + + MySQL is evolving quite rapidly and we want to share new + developments with other MySQL users. We try to produce a new + release whenever we have new and useful features that others also + seem to have a need for. + + We also try to help users who request features that are easy to + implement. We take note of what our licensed users want, and we + especially take note of what our support customers want and try to + help them in this regard. + + No one is required to download a new release. The News section + helps you determine whether the new release has something you + really want. See Appendix C, "MySQL Change History." + + We use the following policy when updating MySQL: + + * Enterprise Server releases are meant to appear every 18 + months, supplemented by quarterly service packs and monthly + rapid updates. Community Server releases are meant to appear + 2-3 times per year. + + * Releases are issued within each series. Enterprise Server + releases are numbered using even numbers (for example, + 5.1.20). Community Server releases are numbered using odd + numbers (for example, 5.1.21). + + * Binary distributions for some platforms are made by us for + major releases. Other people may make binary distributions for + other systems, but probably less frequently. + + * We make fixes available as soon as we have identified and + corrected small or non-critical but annoying bugs. The fixes + are available in source form immediately from our public + Bazaar repositories, and are included in the next release. + + * If by any chance a security vulnerability or critical bug is + found in a release, our policy is to fix it in a new release + as soon as possible. (We would like other companies to do + this, too!) + +2.1.2.4. MySQL Binaries Compiled by Sun Microsystems, Inc. + + As a service of Sun Microsystems, Inc., we provide a set of binary + distributions of MySQL that are compiled on systems at our site or + on systems where supporters of MySQL kindly have given us access + to their machines. + + In addition to the binaries provided in platform-specific package + formats, we offer binary distributions for a number of platforms + in the form of compressed tar files (.tar.gz files). See Section + 2.2, "Standard MySQL Installation Using a Binary Distribution." + + The RPM distributions for MySQL 5.1 releases that we make + available through our Web site are generated by MySQL AB. + + For Windows distributions, see Section 2.3, "Installing MySQL on + Windows." + + These distributions are generated using the script + Build-tools/Do-compile, which compiles the source code and creates + the binary tar.gz archive using scripts/make_binary_distribution. + + These binaries are configured and built with the following + compilers and options. This information can also be obtained by + looking at the variables COMP_ENV_INFO and CONFIGURE_LINE inside + the script bin/mysqlbug of every binary tar file distribution. + + Anyone who has more optimal options for any of the following + configure commands can mail them to the MySQL internals mailing + list. See Section 1.5.1, "MySQL Mailing Lists." + + If you want to compile a debug version of MySQL, you should add + --with-debug or --with-debug=full to the following configure + commands and remove any -fomit-frame-pointer options. + + The following binaries are built on our own development systems: + + * Linux 2.4.xx x86 with gcc 2.95.3: +CFLAGS="-O2 -mcpu=pentiumpro" CXX=gcc CXXFLAGS="-O2 -mcpu=pentiumpro +-felide-constructors" ./configure --prefix=/usr/local/mysql +--with-extra-charsets=complex --enable-thread-safe-client +--enable-local-infile --enable-assembler --disable-shared +--with-client-ldflags=-all-static --with-mysqld-ldflags=-all-static + + * Linux 2.4.x x86 with icc (Intel C++ Compiler 8.1 or later + releases): +CC=icc CXX=icpc CFLAGS="-O3 -unroll2 -ip -mp -no-gcc -restrict" +CXXFLAGS="-O3 -unroll2 -ip -mp -no-gcc -restrict" ./configure +--prefix=/usr/local/mysql --localstatedir=/usr/local/mysql/data +--libexecdir=/usr/local/mysql/bin --with-extra-charsets=complex +--enable-thread-safe-client --enable-local-infile --enable-assembler +--disable-shared --with-client-ldflags=-all-static +--with-mysqld-ldflags=-all-static --with-embedded-server --with-innod +b + Note that versions 8.1 and newer of the Intel compiler have + separate drivers for 'pure' C (icc) and C++ (icpc); if you use + icc version 8.0 or older for building MySQL, you will need to + set CXX=icc. + + * Linux 2.4.xx Intel Itanium 2 with ecc (Intel C++ Itanium + Compiler 7.0): +CC=ecc CFLAGS="-O2 -tpp2 -ip -nolib_inline" CXX=ecc CXXFLAGS="-O2 +-tpp2 -ip -nolib_inline" ./configure --prefix=/usr/local/mysql +--with-extra-charsets=complex --enable-thread-safe-client +--enable-local-infile + + * Linux 2.4.xx Intel Itanium with ecc (Intel C++ Itanium + Compiler 7.0): +CC=ecc CFLAGS=-tpp1 CXX=ecc CXXFLAGS=-tpp1 ./configure +--prefix=/usr/local/mysql --with-extra-charsets=complex +--enable-thread-safe-client --enable-local-infile + + * Linux 2.4.xx alpha with ccc (Compaq C V6.2-505 / Compaq C++ + V6.3-006): +CC=ccc CFLAGS="-fast -arch generic" CXX=cxx CXXFLAGS="-fast -arch +generic -noexceptions -nortti" ./configure --prefix=/usr/local/mysql +--with-extra-charsets=complex --enable-thread-safe-client +--enable-local-infile --with-mysqld-ldflags=-non_shared +--with-client-ldflags=-non_shared --disable-shared + + * Linux 2.x.xx ppc with gcc 2.95.4: +CC=gcc CFLAGS="-O3 -fno-omit-frame-pointer" CXX=gcc CXXFLAGS="-O3 +-fno-omit-frame-pointer -felide-constructors -fno-exceptions +-fno-rtti" ./configure --prefix=/usr/local/mysql +--localstatedir=/usr/local/mysql/data --libexecdir=/usr/local/mysql/b +in +--with-extra-charsets=complex --enable-thread-safe-client +--enable-local-infile --disable-shared --with-embedded-server +--with-innodb + + * Linux 2.4.xx s390 with gcc 2.95.3: +CFLAGS="-O2" CXX=gcc CXXFLAGS="-O2 -felide-constructors" ./configure +--prefix=/usr/local/mysql --with-extra-charsets=complex +--enable-thread-safe-client --enable-local-infile --disable-shared +--with-client-ldflags=-all-static --with-mysqld-ldflags=-all-static + + * Linux 2.4.xx x86_64 (AMD64) with gcc 3.2.1: +CXX=gcc ./configure --prefix=/usr/local/mysql +--with-extra-charsets=complex --enable-thread-safe-client +--enable-local-infile --disable-shared + + * Sun Solaris 8 x86 with gcc 3.2.3: +CC=gcc CFLAGS="-O3 -fno-omit-frame-pointer" CXX=gcc CXXFLAGS="-O3 +-fno-omit-frame-pointer -felide-constructors -fno-exceptions +-fno-rtti" ./configure --prefix=/usr/local/mysql +--localstatedir=/usr/local/mysql/data --libexecdir=/usr/local/mysql/b +in +--with-extra-charsets=complex --enable-thread-safe-client +--enable-local-infile --disable-shared --with-innodb + + * Sun Solaris 8 SPARC with gcc 3.2: +CC=gcc CFLAGS="-O3 -fno-omit-frame-pointer" CXX=gcc CXXFLAGS="-O3 +-fno-omit-frame-pointer -felide-constructors -fno-exceptions +-fno-rtti" ./configure --prefix=/usr/local/mysql +--with-extra-charsets=complex --enable-thread-safe-client +--enable-local-infile --enable-assembler --with-named-z-libs=no +--with-named-curses-libs=-lcurses --disable-shared + + * Sun Solaris 8 SPARC 64-bit with gcc 3.2: +CC=gcc CFLAGS="-O3 -m64 -fno-omit-frame-pointer" CXX=gcc CXXFLAGS="-O +3 +-m64 -fno-omit-frame-pointer -felide-constructors -fno-exceptions +-fno-rtti" ./configure --prefix=/usr/local/mysql +--with-extra-charsets=complex --enable-thread-safe-client +--enable-local-infile --with-named-z-libs=no +--with-named-curses-libs=-lcurses --disable-shared + + * Sun Solaris 9 SPARC with gcc 2.95.3: +CC=gcc CFLAGS="-O3 -fno-omit-frame-pointer" CXX=gcc CXXFLAGS="-O3 +-fno-omit-frame-pointer -felide-constructors -fno-exceptions +-fno-rtti" ./configure --prefix=/usr/local/mysql +--with-extra-charsets=complex --enable-thread-safe-client +--enable-local-infile --enable-assembler --with-named-curses-libs=-lc +urses +--disable-shared + + * Sun Solaris 9 SPARC with cc-5.0 (Sun Forte 5.0): +CC=cc-5.0 CXX=CC ASFLAGS="-xarch=v9" CFLAGS="-Xa -xstrconst -mt +-D_FORTEC_ -xarch=v9" CXXFLAGS="-noex -mt -D_FORTEC_ -xarch=v9" +./configure --prefix=/usr/local/mysql --with-extra-charsets=complex +--enable-thread-safe-client --enable-local-infile --enable-assembler +--with-named-z-libs=no --enable-thread-safe-client --disable-shared + + * IBM AIX 4.3.2 ppc with gcc 3.2.3: +CFLAGS="-O2 -mcpu=powerpc -Wa,-many " CXX=gcc CXXFLAGS="-O2 +-mcpu=powerpc -Wa,-many -felide-constructors -fno-exceptions +-fno-rtti" ./configure --prefix=/usr/local/mysql +--with-extra-charsets=complex --enable-thread-safe-client +--enable-local-infile --with-named-z-libs=no --disable-shared + + * IBM AIX 4.3.3 ppc with xlC_r (IBM Visual Age C/C++ 6.0): +CC=xlc_r CFLAGS="-ma -O2 -qstrict -qoptimize=2 -qmaxmem=8192" +CXX=xlC_r CXXFLAGS ="-ma -O2 -qstrict -qoptimize=2 -qmaxmem=8192" +./configure --prefix=/usr/local/mysql --localstatedir=/usr/local/mysq +l/data +--libexecdir=/usr/local/mysql/bin --with-extra-charsets=complex +--enable-thread-safe-client --enable-local-infile --with-named-z-libs +=no +--disable-shared --with-innodb + + * IBM AIX 5.1.0 ppc with gcc 3.3: +CFLAGS="-O2 -mcpu=powerpc -Wa,-many" CXX=gcc CXXFLAGS="-O2 -mcpu=powe +rpc +-Wa,-many -felide-constructors -fno-exceptions -fno-rtti" ./configure +--prefix=/usr/local/mysql --with-extra-charsets=complex +--enable-thread-safe-client --enable-local-infile --with-named-z-libs +=no +--disable-shared + + * IBM AIX 5.2.0 ppc with xlC_r (IBM Visual Age C/C++ 6.0): +CC=xlc_r CFLAGS="-ma -O2 -qstrict -qoptimize=2 -qmaxmem=8192" +CXX=xlC_r CXXFLAGS="-ma -O2 -qstrict -qoptimize=2 -qmaxmem=8192" +./configure --prefix=/usr/local/mysql --localstatedir=/usr/local/mysq +l/data +--libexecdir=/usr/local/mysql/bin --with-extra-charsets=complex +--enable-thread-safe-client --enable-local-infile --with-named-z-libs +=no +--disable-shared --with-embedded-server --with-innodb + + * HP-UX 10.20 pa-risc1.1 with gcc 3.1: +CFLAGS="-DHPUX -I/opt/dce/include -O3 -fPIC" CXX=gcc CXXFLAGS="-DHPUX +-I/opt/dce /include -felide-constructors -fno-exceptions -fno-rtti +-O3 -fPIC" ./configure --prefix=/usr/local/mysql +--with-extra-charsets=complex --enable-thread-safe-client +--enable-local-infile --with-pthread --with-named-thread-libs=-ldce +--with-lib-ccflags=-fPIC --disable-shared + + * HP-UX 11.00 pa-risc with aCC (HP ANSI C++ B3910B A.03.50): +CC=cc CXX=aCC CFLAGS=+DAportable CXXFLAGS=+DAportable ./configure +--prefix=/usr/local/mysql --localstatedir=/usr/local/mysql/data +--libexecdir=/usr/local/mysql/bin --with-extra-charsets=complex +--enable-thread-safe-client --enable-local-infile --disable-shared +--with-embedded-server --with-innodb + + * HP-UX 11.11 pa-risc2.0 64bit with aCC (HP ANSI C++ B3910B + A.03.33): +CC=cc CXX=aCC CFLAGS=+DD64 CXXFLAGS=+DD64 ./configure +--prefix=/usr/local/mysql --with-extra-charsets=complex +--enable-thread-safe-client --enable-local-infile --disable-shared + + * HP-UX 11.11 pa-risc2.0 32bit with aCC (HP ANSI C++ B3910B + A.03.33): +CC=cc CXX=aCC CFLAGS="+DAportable" CXXFLAGS="+DAportable" ./configure +--prefix=/usr/local/mysql --localstatedir=/usr/local/mysql/data +--libexecdir=/usr/local/mysql/bin --with-extra-charsets=complex +--enable-thread-safe-client --enable-local-infile --disable-shared +--with-innodb + + * HP-UX 11.22 ia64 64bit with aCC (HP aC++/ANSI C B3910B + A.05.50): +CC=cc CXX=aCC CFLAGS="+DD64 +DSitanium2" CXXFLAGS="+DD64 +DSitanium2" +./configure --prefix=/usr/local/mysql --localstatedir=/usr/local/mysq +l/data +--libexecdir=/usr/local/mysql/bin --with-extra-charsets=complex +--enable-thread-safe-client --enable-local-infile --disable-shared +--with-embedded-server --with-innodb + + * Apple Mac OS X 10.2 powerpc with gcc 3.1: +CC=gcc CFLAGS="-O3 -fno-omit-frame-pointer" CXX=gcc CXXFLAGS="-O3 +-fno-omit-frame-pointer -felide-constructors -fno-exceptions +-fno-rtti" ./configure --prefix=/usr/local/mysql +--with-extra-charsets=complex --enable-thread-safe-client +--enable-local-infile --disable-shared + + * FreeBSD 4.7 i386 with gcc 2.95.4: +CFLAGS=-DHAVE_BROKEN_REALPATH ./configure --prefix=/usr/local/mysql +--with-extra-charsets=complex --enable-thread-safe-client +--enable-local-infile --enable-assembler --with-named-z-libs=not-used +--disable-shared + + * FreeBSD 4.7 i386 using LinuxThreads with gcc 2.95.4: +CFLAGS="-DHAVE_BROKEN_REALPATH -D__USE_UNIX98 -D_REENTRANT +-D_THREAD_SAFE -I/usr/local/include/pthread/linuxthreads" +CXXFLAGS="-DHAVE_BROKEN_REALPATH -D__USE_UNIX98 -D_REENTRANT +-D_THREAD_SAFE -I/usr/local/include/pthread/linuxthreads" ./configure +--prefix=/usr/local/mysql --localstatedir=/usr/local/mysql/data +--libexecdir=/usr/local/mysql/bin --enable-thread-safe-client +--enable-local-infile --enable-assembler +--with-named-thread-libs="-DHAVE_GLIBC2_STYLE_GETHOSTBYNAME_R +-D_THREAD_SAFE -I /usr/local/include/pthread/linuxthreads +-L/usr/local/lib -llthread -llgcc_r" --disable-shared +--with-embedded-server --with-innodb + + * QNX Neutrino 6.2.1 i386 with gcc 2.95.3qnx-nto 20010315: +CC=gcc CFLAGS="-O3 -fno-omit-frame-pointer" CXX=gcc CXXFLAGS="-O3 +-fno-omit-frame-pointer -felide-constructors -fno-exceptions +-fno-rtti" ./configure --prefix=/usr/local/mysql +--with-extra-charsets=complex --enable-thread-safe-client +--enable-local-infile --disable-shared + + The following binaries are built on third-party systems kindly + provided to Sun Microsystems, Inc. by other users. These are + provided only as a courtesy; we do not have full control over + these systems, so we can provide only limited support for the + binaries built on them. + + * SCO Unix 3.2v5.0.7 i386 with gcc 2.95.3: +CFLAGS="-O3 -mpentium" LDFLAGS=-static CXX=gcc CXXFLAGS="-O3 -mpentiu +m +-felide-constructors" ./configure --prefix=/usr/local/mysql +--with-extra-charsets=complex --enable-thread-safe-client +--enable-local-infile --with-named-z-libs=no --enable-thread-safe-cli +ent +--disable-shared + + * SCO UnixWare 7.1.4 i386 with CC 3.2: +CC=cc CFLAGS="-O" CXX=CC ./configure --prefix=/usr/local/mysql +--with-extra-charsets=complex --enable-thread-safe-client +--enable-local-infile --with-named-z-libs=no --enable-thread-safe-cli +ent +--disable-shared --with-readline + + * SCO OpenServer 6.0.0 i386 with CC 3.2: +CC=cc CFLAGS="-O" CXX=CC ./configure --prefix=/usr/local/mysql +--with-extra-charsets=complex --enable-thread-safe-client +--enable-local-infile --with-named-z-libs=no --enable-thread-safe-cli +ent +--disable-shared --with-readline + + * Compaq Tru64 OSF/1 V5.1 732 alpha with cc/cxx (Compaq C + V6.3-029i / DIGITAL C++ V6.1-027): +CC="cc -pthread" CFLAGS="-O4 -ansi_alias -ansi_args -fast -inline +speed -speculate all" CXX="cxx -pthread" CXXFLAGS="-O4 -ansi_alias +-fast -inline speed -speculate all -noexceptions -nortti" ./configure +--prefix=/usr/local/mysql --with-extra-charsets=complex +--enable-thread-safe-client --enable-local-infile +--with-named-thread-libs="-lpthread -lmach -lexc -lc" --disable-share +d +--with-mysqld-ldflags=-all-static + + * SGI Irix 6.5 IP32 with gcc 3.0.1: +CC=gcc CFLAGS="-O3 -fno-omit-frame-pointer" CXXFLAGS="-O3 +-fno-omit-frame-pointer -felide-constructors -fno-exceptions +-fno-rtti" ./configure --prefix=/usr/local/mysql +--with-extra-charsets=complex --enable-thread-safe-client +--enable-local-infile --disable-shared + + * FreeBSD/sparc64 5.0 with gcc 3.2.1: +CFLAGS=-DHAVE_BROKEN_REALPATH ./configure --prefix=/usr/local/mysql +--localstatedir=/usr/local/mysql/data --libexecdir=/usr/local/mysql/b +in +--with-extra-charsets=complex --enable-thread-safe-client +--enable-local-infile --disable-shared --with-innodb + + The following compile options have been used for binary packages + that we have provided in the past. These binaries no longer are + being updated, but the compile options are listed here for + reference purposes. + + * Linux 2.2.xx SPARC with egcs 1.1.2: +CC=gcc CFLAGS="-O3 -fno-omit-frame-pointer" CXX=gcc CXXFLAGS="-O3 +-fno-omit-frame-pointer -felide-constructors -fno-exceptions +-fno-rtti" ./configure --prefix=/usr/local/mysql +--with-extra-charsets=complex --enable-thread-safe-client +--enable-local-infile --enable-assembler --disable-shared + + * Linux 2.2.x with x686 with gcc 2.95.2: +CFLAGS="-O3 -mpentiumpro" CXX=gcc CXXFLAGS="-O3 -mpentiumpro +-felide-constructors -fno-exceptions -fno-rtti" ./configure +--prefix=/usr/local/mysql --enable-assembler +--with-mysqld-ldflags=-all-static --disable-shared +--with-extra-charsets=complex + + * SunOS 4.1.4 2 sun4c with gcc 2.7.2.1: +CC=gcc CXX=gcc CXXFLAGS="-O3 -felide-constructors" ./configure +--prefix=/usr/local/mysql --disable-shared --with-extra-charsets=comp +lex +--enable-assembler + + * SunOS 5.5.1 (and above) sun4u with egcs 1.0.3a or 2.90.27 or + gcc 2.95.2 and newer: +CC=gcc CFLAGS="-O3" CXX=gcc CXXFLAGS="-O3 -felide-constructors +-fno-exceptions -fno-rtti" ./configure --prefix=/usr/local/mysql +--with-low-memory --with-extra-charsets=complex --enable-assembler + + * SunOS 5.6 i86pc with gcc 2.8.1: +CC=gcc CXX=gcc CXXFLAGS=-O3 ./configure --prefix=/usr/local/mysql +--with-low-memory --with-extra-charsets=complex + + * BSDI BSD/OS 3.1 i386 with gcc 2.7.2.1: +CC=gcc CXX=gcc CXXFLAGS=-O ./configure --prefix=/usr/local/mysql +--with-extra-charsets=complex + + * BSDI BSD/OS 2.1 i386 with gcc 2.7.2: +CC=gcc CXX=gcc CXXFLAGS=-O3 ./configure --prefix=/usr/local/mysql +--with-extra-charsets=complex + + * AIX 4.2 with gcc 2.7.2.2: +CC=gcc CXX=gcc CXXFLAGS=-O3 ./configure --prefix=/usr/local/mysql +--with-extra-charsets=complex + +2.1.3. How to Get MySQL + + Check our downloads page at http://dev.mysql.com/downloads/ for + information about the current version of MySQL and for downloading + instructions. For a complete up-to-date list of MySQL download + mirror sites, see http://dev.mysql.com/downloads/mirrors.html. You + can also find information there about becoming a MySQL mirror site + and how to report a bad or out-of-date mirror. + + Our main mirror is located at http://mirrors.sunsite.dk/mysql/. + +2.1.4. Verifying Package Integrity Using MD5 Checksums or GnuPG + + After you have downloaded the MySQL package that suits your needs + and before you attempt to install it, you should make sure that it + is intact and has not been tampered with. There are three means of + integrity checking: + + * MD5 checksums + + * Cryptographic signatures using GnuPG, the GNU Privacy Guard + + * For RPM packages, the built-in RPM integrity verification + mechanism + + The following sections describe how to use these methods. + + If you notice that the MD5 checksum or GPG signatures do not + match, first try to download the respective package one more time, + perhaps from another mirror site. If you repeatedly cannot + successfully verify the integrity of the package, please notify us + about such incidents, including the full package name and the + download site you have been using, at webmaster(a)mysql.com or + build(a)mysql.com. Do not report downloading problems using the + bug-reporting system. + +2.1.4.1. Verifying the MD5 Checksum + + After you have downloaded a MySQL package, you should make sure + that its MD5 checksum matches the one provided on the MySQL + download pages. Each package has an individual checksum that you + can verify with the following command, where package_name is the + name of the package you downloaded: +shell> md5sum package_name + + Example: +shell> md5sum mysql-standard-5.1.35-linux-i686.tar.gz +aaab65abbec64d5e907dcd41b8699945 mysql-standard-5.1.35-linux-i686.ta +r.gz + + You should verify that the resulting checksum (the string of + hexadecimal digits) matches the one displayed on the download page + immediately below the respective package. + +Note + + Make sure to verify the checksum of the archive file (for example, + the .zip or .tar.gz file) and not of the files that are contained + inside of the archive. + + Note that not all operating systems support the md5sum command. On + some, it is simply called md5, and others do not ship it at all. + On Linux, it is part of the GNU Text Utilities package, which is + available for a wide range of platforms. You can download the + source code from http://www.gnu.org/software/textutils/ as well. + If you have OpenSSL installed, you can use the command openssl md5 + package_name instead. A Windows implementation of the md5 command + line utility is available from http://www.fourmilab.ch/md5/. + winMd5Sum is a graphical MD5 checking tool that can be obtained + from http://www.nullriver.com/index/products/winmd5sum. + +2.1.4.2. Signature Checking Using GnuPG + + Another method of verifying the integrity and authenticity of a + package is to use cryptographic signatures. This is more reliable + than using MD5 checksums, but requires more work. + + We sign MySQL downloadable packages with GnuPG (GNU Privacy + Guard). GnuPG is an Open Source alternative to the well-known + Pretty Good Privacy (PGP) by Phil Zimmermann. See + http://www.gnupg.org/ for more information about GnuPG and how to + obtain and install it on your system. Most Linux distributions + ship with GnuPG installed by default. For more information about + GnuPG, see http://www.openpgp.org/. + + To verify the signature for a specific package, you first need to + obtain a copy of our public GPG build key, which you can download + from http://keyserver.pgp.com/. The key that you want to obtain is + named build(a)mysql.com. Alternatively, you can cut and paste the + key directly from the following text: +-----BEGIN PGP PUBLIC KEY BLOCK----- +Version: GnuPG v1.0.6 (GNU/Linux) +Comment: For info see http://www.gnupg.org + +mQGiBD4+owwRBAC14GIfUfCyEDSIePvEW3SAFUdJBtoQHH/nJKZyQT7h9bPlUWC3 +RODjQReyCITRrdwyrKUGku2FmeVGwn2u2WmDMNABLnpprWPkBdCk96+OmSLN9brZ +fw2vOUgCmYv2hW0hyDHuvYlQA/BThQoADgj8AW6/0Lo7V1W9/8VuHP0gQwCgvzV3 +BqOxRznNCRCRxAuAuVztHRcEAJooQK1+iSiunZMYD1WufeXfshc57S/+yeJkegNW +hxwR9pRWVArNYJdDRT+rf2RUe3vpquKNQU/hnEIUHJRQqYHo8gTxvxXNQc7fJYLV +K2HtkrPbP72vwsEKMYhhr0eKCbtLGfls9krjJ6sBgACyP/Vb7hiPwxh6rDZ7ITnE +kYpXBACmWpP8NJTkamEnPCia2ZoOHODANwpUkP43I7jsDmgtobZX9qnrAXw+uNDI +QJEXM6FSbi0LLtZciNlYsafwAPEOMDKpMqAK6IyisNtPvaLd8lH0bPAnWqcyefep +rv0sxxqUEMcM3o7wwgfN83POkDasDbs3pjwPhxvhz6//62zQJ7Q7TXlTUUwgUGFj +a2FnZSBzaWduaW5nIGtleSAod3d3Lm15c3FsLmNvbSkgPGJ1aWxkQG15c3FsLmNv +bT6IXQQTEQIAHQUCR6yUtAUJDTBYqAULBwoDBAMVAwIDFgIBAheAAAoJEIxxjTtQ +cuH1rpIAn38+BlBI815Dou9VXMIAsQEk4G3tAJ9+Cz69Y/Xwm611lzteJrCAA32+ +aYhMBBMRAgAMBQI+PqPRBYMJZgC7AAoJEElQ4SqycpHyJOEAn1mxHijft00bKXvu +cSo/pECUmppiAJ41M9MRVj5VcdH/KN/KjRtW6tHFPYhMBBMRAgAMBQI+QoIDBYMJ +YiKJAAoJELb1zU3GuiQ/lpEAoIhpp6BozKI8p6eaabzF5MlJH58pAKCu/ROofK8J +Eg2aLos+5zEYrB/LsohGBBARAgAGBQI/rOOvAAoJEK/FI0h4g3QP9pYAoNtSISDD +AAU2HafyAYlLD/yUC4hKAJ0czMsBLbo0M/xPaJ6Ox9Q5Hmw2uIhGBBARAgAGBQI/ +tEN3AAoJEIWWr6swc05mxsMAnRag9X61Ygu1kbfBiqDku4czTd9pAJ4q5W8KZ0+2 +ujTrEPN55NdWtnXj4YhGBBARAgAGBQJDW7PqAAoJEIvYLm8wuUtcf3QAnRCyqF0C +pMCTdIGc7bDO5I7CIMhTAJ0UTGx0O1d/VwvdDiKWj45N2tNbYIhGBBMRAgAGBQJE +8TMmAAoJEPZJxPRgk1MMCnEAoIm2pP0sIcVh9Yo0YYGAqORrTOL3AJwIbcy+e8HM +NSoNV5u51RnrVKie34hMBBARAgAMBQJBgcsBBYMGItmLAAoJEBhZ0B9ne6HsQo0A +nA/LCTQ3P5kvJvDhg1DsfVTFnJxpAJ49WFjg/kIcaN5iP1JfaBAITZI3H4hMBBAR +AgAMBQJBgcs0BYMGItlYAAoJEIHC9+viE7aSIiMAnRVTVVAfMXvJhV6D5uHfWeeD +046TAJ4kjwP2bHyd6DjCymq+BdEDz63axohMBBARAgAMBQJBgctiBYMGItkqAAoJ +EGtw7Nldw/RzCaoAmwWM6+Rj1zl4D/PIys5nW48Hql3hAJ0bLOBthv96g+7oUy9U +j09Uh41lF4hMBBARAgAMBQJB0JMkBYMF1BFoAAoJEH0lygrBKafCYlUAoIb1r5D6 +qMLMPMO1krHk3MNbX5b5AJ4vryx5fw6iJctC5GWJ+Y8ytXab34hMBBARAgAMBQJC +K1u6BYMFeUjSAAoJEOYbpIkV67mr8xMAoJMy+UJC0sqXMPSxh3BUsdcmtFS+AJ9+ +Z15LpoOnAidTT/K9iODXGViK6ohMBBIRAgAMBQJAKlk6BYMHektSAAoJEDyhHzSU ++vhhJlwAnA/gOdwOThjO8O+dFtdbpKuImfXJAJ0TL53QKp92EzscZSz49lD2YkoE +qohMBBIRAgAMBQJAPfq6BYMHZqnSAAoJEPLXXGPjnGWcst8AoLQ3MJWqttMNHDbl +xSyzXhFGhRU8AJ4ukRzfNJqElQHQ00ZM2WnCVNzOUIhMBBIRAgAMBQJBDgqEBYMG +lpoIAAoJEDnKK/Q9aopf/N0AniE2fcCKO1wDIwusuGVlC+JvnnWbAKDDoUSEYuNn +5qzRbrzWW5zBno/Nb4hMBBIRAgAMBQJCgKU0BYMFI/9YAAoJEAQNwIV8g5+o4yQA +nA9QOFLV5POCddyUMqB/fnctuO9eAJ4sJbLKP/Z3SAiTpKrNo+XZRxauqIhMBBMR +AgAMBQI+TU2EBYMJV1cIAAoJEC27dr+t1MkzBQwAoJU+RuTVSn+TI+uWxUpT82/d +s5NkAJ9bnNodffyMMK7GyMiv/TzifiTD+4hMBBMRAgAMBQJB14B2BYMFzSQWAAoJ +EGbv28jNgv0+P7wAn13uu8YkhwfNMJJhWdpK2/qM/4AQAJ40drnKW2qJ5EEIJwtx +pwapgrzWiYhMBBMRAgAMBQJCGIEOBYMFjCN+AAoJEHbBAxyiMW6hoO4An0Ith3Kx +5/sixbjZR9aEjoePGTNKAJ94SldLiESaYaJx2lGIlD9bbVoHQYhdBBMRAgAdBQJH +rJTPBQkNMFioBQsHCgMEAxUDAgMWAgECF4AACgkQjHGNO1By4fV0KgCgsLpG2wP0 +rc3s07Fync9g7MfairMAoIUefSNKrGTsTxvLeyH4DLzJW/QFiHsEMBECADsFAkJ3 +NfU0HQBPb3BzLi4uIHNob3VsZCBoYXZlIGJlZW4gbG9jYWwhIEknbSAqc28qIHN0 +dXBpZC4uLgAKCRA5yiv0PWqKX+9HAJ0WjTx/rqgouK4QCrOV/2IOU+jMQQCfYSC8 +JgsIIeN8aiyuStTdYrk0VWCIjwQwEQIATwUCRW8Av0gdAFNob3VsZCBoYXZlIGJl +ZW4gYSBsb2NhbCBzaWduYXR1cmUsIG9yIHNvbWV0aGluZyAtIFdURiB3YXMgSSB0 +aGlua2luZz8ACgkQOcor9D1qil+g+wCfcFWoo5qUl4XTE9K8tH3Q+xGWeYYAnjii +KxjtOXc0ls+BlqXxbfZ9uqBsiQIiBBABAgAMBQJBgcuFBYMGItkHAAoJEKrj5s5m +oURoqC8QAIISudocbJRhrTAROOPoMsReyp46Jdp3iL1oFDGcPfkZSBwWh8L+cJjh +dycIwwSeZ1D2h9S5Tc4EnoE0khsS6wBpuAuih5s//coRqIIiLKEdhTmNqulkCH5m +imCzc5zXWZDW0hpLr2InGsZMuh2QCwAkB4RTBM+r18cUXMLV4YHKyjIVaDhsiPP/ +MKUj6rJNsUDmDq1GiJdOjySjtCFjYADlQYSD7zcd1vpqQLThnZBESvEoCqumEfOP +xemNU6xAB0CL+pUpB40pE6Un6Krr5h6yZxYZ/N5vzt0Y3B5UUMkgYDSpjbulNvaU +TFiOxEU3gJvXc1+h0BsxM7FwBZnuMA8LEA+UdQb76YcyuFBcROhmcEUTiducLu84 +E2BZ2NSBdymRQKSinhvXsEWlH6Txm1gtJLynYsvPi4B4JxKbb+awnFPusL8W+gfz +jbygeKdyqzYgKj3M79R3geaY7Q75Kxl1UogiOKcbI5VZvg47OQCWeeERnejqEAdx +EQiwGA/ARhVOP/1l0LQA7jg2P1xTtrBqqC2ufDB+v+jhXaCXxstKSW1lTbv/b0d6 +454UaOUV7RisN39pE2zFvJvY7bwfiwbUJVmYLm4rWJAEOJLIDtDRtt2h8JahDObm +3CWkpadjw57S5v1c/mn+xV9yTgVx5YUfC/788L1HNKXfeVDq8zbAiQIiBBMBAgAM +BQJCnwocBYMFBZpwAAoJENjCCglaJFfPIT4P/25zvPp8ixqV85igs3rRqMBtBsj+ +5EoEW6DJnlGhoi26yf1nasC2frVasWG7i4JIm0U3WfLZERGDjR/nqlOCEqsP5gS3 +43N7r4UpDkBsYh0WxH/ZtST5llFK3zd7XgtxvqKL98l/OSgijH2W2SJ9DGpjtO+T +iegq7igtJzw7Vax9z/LQH2xhRQKZR9yernwMSYaJ72i9SyWbK3k0+e95fGnlR5pF +zlGq320rYHgD7v9yoQ2t1klsAxK6e3b7Z+RiJG6cAU8o8F0kGxjWzF4v8D1op7S+ +IoRdB0Bap01ko0KLyt3+g4/33/2UxsW50BtfqcvYNJvU4bZns1YSqAgDOOanBhg8 +Ip5XPlDxH6J/3997n5JNj/nk5ojfd8nYfe/5TjflWNiput6tZ7frEki1wl6pTNbv +V9C1eLUJMSXfDZyHtUXmiP9DKNpsucCUeBKWRKLqnsHLkLYydsIeUJ8+ciKc+EWh +FxEY+Ml72cXAaz5BuW9L8KHNzZZfez/ZJabiARQpFfjOwAnmhzJ9r++TEKRLEr96 +taUI9/8nVPvT6LnBpcM38Td6dJ639YvuH3ilAqmPPw50YvglIEe4BUYD5r52Seqc +8XQowouGOuBX4vs7zgWFuYA/s9ebfGaIw+uJd/56Xl9ll6q5CghqB/yt1EceFEnF +CAjQc2SeRo6qzx22uQINBD4+ox0QCADv4Yl/Fsx1jjCyU+eMf2sXg3ap9awQ3+XF +pmglhzdrozTZYKceXpqFPb+0ErbDVAjhgW15HjuAK+2Bvo7Ukd986jYd8uZENGJG +N3UNMIep7JfsIeFyCGP901GVbZnSXlAURyZX1TRWGndoV9YLhSN+zctT6GQBbMTv +NoPlwf0nvK//rG5lXDjXXHSHhSqxNxYy7SIzUHMQupfUNjsvCg8Rv871GRt/h+Yt +7XUTMhoJrg+oBFdBlzh2FKKcy3ordfgGtGwpN+jMG7vgXjsPwiVt/m9Jgdu4Tmn/ +WggPOeSD+nyRb7cXG5avJxyKoVNw3PbXnLJff0tcWeUvMpRv8XkbAAMFB/4vCqpr +wIatF+w4AnGKbrcId+3LmZRzmtRKdOyUZgQg4JHUF5Bq7I9ls8OwMP0xnVlpJp9q +cW/AUbouXH3GRTu3Or68ouhaSbi7nF/e+fnlWOdJ3VpD15CdRxeIvhycEahNs5Yj +f0RzLOCyXMF0L74w+NxBNwDunolRWw/qgAHcVBaDni25SjQRzxuwzxvcS/jYua5B +Pk10ocbAexdM+2XSSWThtCTg5qMeyLLUExqGlPbuNaMmUyIlz4hYnSaCGQoe33bq +z/KZ91/keR1DVzK+zPm2vJUjcXHvxd5Jh9C+67CqnYfXf2lcYSSDSfop1Q5611la +F7vRgY0/DXKNYlPUiEwEGBECAAwFAkeslPwFCQ0wWN8ACgkQjHGNO1By4fWlzgCf +Qj3rkfcljYZOuLOn50J7PFuF7FoAnjwWGhwVi9+Fm2B5RZvpo++BBkdP +=Xquv +-----END PGP PUBLIC KEY BLOCK----- + + To import the build key into your personal public GPG keyring, use + gpg --import. For example, if you have saved the key in a file + named mysql_pubkey.asc, the import command looks like this: +shell> gpg --import mysql_pubkey.asc +gpg: key 5072E1F5: public key "MySQL Package signing key (www.mysql.c +om) <build(a)mysql.com>" imported +gpg: Total number processed: 1 +gpg: imported: 1 +gpg: no ultimately trusted keys found + + You can also download the key from the public keyserver using the + public key id, 5072E1F5: +shell> gpg --recv-keys 5072E1F5 +gpg: requesting key 5072E1F5 from hkp server subkeys.pgp.net +gpg: key 5072E1F5: "MySQL Package signing key (www.mysql.com) <build@ +mysql.com>" 2 new signatures +gpg: no ultimately trusted keys found +gpg: Total number processed: 1 +gpg: new signatures: 2 + + If you want to import the key into your RPM configuration to + validate RPM install packages, you should be able to import the + key directly: +shell> rpm --import mysql_pubkey.asc + + If you experience problems, try exporting the key from gpg and + importing: +shell> gpg --export -a 5072e1f5 > 5072e1f5.asc +shell> rpm --import 5072e1f5.asc + + Alternatively, rpm also supports loading the key directly from a + URL, and you cas use this manual page: +shell> rpm --import http://dev.mysql.com/doc/refman/5.1/en/checking-g +pg-signature.html + + After you have downloaded and imported the public build key, + download your desired MySQL package and the corresponding + signature, which also is available from the download page. The + signature file has the same name as the distribution file with an + .asc extension, as shown by the examples in the following table. + Distribution file mysql-standard-5.1.35-linux-i686.tar.gz + Signature file mysql-standard-5.1.35-linux-i686.tar.gz.asc + + Make sure that both files are stored in the same directory and + then run the following command to verify the signature for the + distribution file: +shell> gpg --verify package_name.asc + + Example: +shell> gpg --verify mysql-standard-5.1.35-linux-i686.tar.gz.asc +gpg: Signature made Tue 12 Jul 2005 23:35:41 EST using DSA key ID 507 +2E1F5 +gpg: Good signature from "MySQL Package signing key (www.mysql.com) < +build(a)mysql.com>" + + The Good signature message indicates that everything is all right. + You can ignore any insecure memory warning you might obtain. + + See the GPG documentation for more information on how to work with + public keys. + +2.1.4.3. Signature Checking Using RPM + + For RPM packages, there is no separate signature. RPM packages + have a built-in GPG signature and MD5 checksum. You can verify a + package by running the following command: +shell> rpm --checksig package_name.rpm + + Example: +shell> rpm --checksig MySQL-server-5.1.35-0.glibc23.i386.rpm +MySQL-server-5.1.35-0.glibc23.i386.rpm: md5 gpg OK + +Note + + If you are using RPM 4.1 and it complains about (GPG) NOT OK + (MISSING KEYS: GPG#5072e1f5), even though you have imported the + MySQL public build key into your own GPG keyring, you need to + import the key into the RPM keyring first. RPM 4.1 no longer uses + your personal GPG keyring (or GPG itself). Rather, it maintains + its own keyring because it is a system-wide application and a + user's GPG public keyring is a user-specific file. To import the + MySQL public key into the RPM keyring, first obtain the key as + described in Section 2.1.4.2, "Signature Checking Using GnuPG." + Then use rpm --import to import the key. For example, if you have + saved the public key in a file named mysql_pubkey.asc, import it + using this command: +shell> rpm --import mysql_pubkey.asc + + If you need to obtain the MySQL public key, see Section 2.1.4.2, + "Signature Checking Using GnuPG." + +2.1.5. Installation Layouts + + This section describes the default layout of the directories + created by installing binary or source distributions provided by + Sun Microsystems, Inc. A distribution provided by another vendor + might use a layout different from those shown here. + + For MySQL 5.1 on Windows, the default installation directory is + C:\Program Files\MySQL\MySQL Server 5.1. (Some Windows users + prefer to install in C:\mysql, the directory that formerly was + used as the default. However, the layout of the subdirectories + remains the same.) The installation directory has the following + subdirectories. + Directory Contents of Directory + bin Client programs and the mysqld server + data Log files, databases + Docs Manual in CHM format + examples Example programs and scripts + include Include (header) files + lib Libraries + scripts Utility scripts + share Error message files + + Installations created from our Linux RPM distributions result in + files under the following system directories. + Directory Contents of Directory + /usr/bin Client programs and scripts + /usr/sbin The mysqld server + /var/lib/mysql Log files, databases + /usr/share/info Manual in Info format + /usr/share/man Unix manual pages + /usr/include/mysql Include (header) files + /usr/lib/mysql Libraries + /usr/share/mysql Error message and character set files + /usr/share/sql-bench Benchmarks + + On Unix, a tar file binary distribution is installed by unpacking + it at the installation location you choose (typically + /usr/local/mysql) and creates the following directories in that + location. + Directory Contents of Directory + bin Client programs and the mysqld server + data Log files, databases + docs Manual in Info format + man Unix manual pages + include Include (header) files + lib Libraries + scripts mysql_install_db + share/mysql Error message files + sql-bench Benchmarks + + A source distribution is installed after you configure and compile + it. By default, the installation step installs files under + /usr/local, in the following subdirectories. + Directory Contents of Directory + bin Client programs and scripts + include/mysql Include (header) files + Docs Manual in Info, CHM formats + man Unix manual pages + lib/mysql Libraries + libexec The mysqld server + share/mysql Error message files + sql-bench Benchmarks and crash-me test + var Databases and log files + + Within its installation directory, the layout of a source + installation differs from that of a binary installation in the + following ways: + + * The mysqld server is installed in the libexec directory rather + than in the bin directory. + + * The data directory is var rather than data. + + * mysql_install_db is installed in the bin directory rather than + in the scripts directory. + + * The header file and library directories are include/mysql and + lib/mysql rather than include and lib. + + You can create your own binary installation from a compiled source + distribution by executing the scripts/make_binary_distribution + script from the top directory of the source distribution. + +2.2. Standard MySQL Installation Using a Binary Distribution + + The next several sections cover the installation of MySQL on + platforms where we offer packages using the native packaging + format of the respective platform. (This is also known as + performing a "binary install.") However, binary distributions of + MySQL are available for many other platforms as well. See Section + 2.9, "Installing MySQL from tar.gz Packages on Other Unix-Like + Systems," for generic installation instructions for these packages + that apply to all platforms. + + See Section 2.1, "General Installation Issues," for more + information on what other binary distributions are available and + how to obtain them. + +2.3. Installing MySQL on Windows + + A native Windows distribution of MySQL has been available since + version 3.21 and represents a sizable percentage of the daily + downloads of MySQL. This section describes the process for + installing MySQL on Windows. + +Note + + If you are upgrading MySQL from an existing installation older + than MySQL 4.1.5, you must first perform the procedure described + in Section 2.3.14, "Upgrading MySQL on Windows." + + To run MySQL on Windows, you need the following: + + * A Windows operating system such as Windows 2000, Windows XP, + Windows Vista, Windows Server 2003, or Windows Server 2008. + A Windows operating system permits you to run the MySQL server + as a service. See Section 2.3.11, "Starting MySQL as a Windows + Service." + Generally, you should install MySQL on Windows using an + account that has administrator rights. Otherwise, you may + encounter problems with certain operations such as editing the + PATH environment variable or accessing the Service Control + Manager. Once installed, MySQL does not need to be executed + using a user with Administrator privileges. + + * TCP/IP protocol support. + + * Enough space on the hard drive to unpack, install, and create + the databases in accordance with your requirements (generally + a minimum of 200 megabytes is recommended.) + + For a list of limitations within the Windows version of MySQL, see + Section D.7.3, "Windows Platform Limitations." + + There may also be other requirements, depending on how you plan to + use MySQL: + + * If you plan to connect to the MySQL server via ODBC, you need + a Connector/ODBC driver. See Section 21.1, "MySQL + Connector/ODBC." + + * If you plan to use MySQL server with ADO.NET applications, you + need the Connector/NET driver. See Section 21.2, "MySQL + Connector/NET." + + * If you need tables with a size larger than 4GB, install MySQL + on an NTFS or newer file system. Don't forget to use MAX_ROWS + and AVG_ROW_LENGTH when you create tables. See Section + 12.1.17, "CREATE TABLE Syntax." + + MySQL for Windows is available in several distribution formats: + + * Binary distributions are available that contain a setup + program that installs everything you need so that you can + start the server immediately. Another binary distribution + format contains an archive that you simply unpack in the + installation location and then configure yourself. For + details, see Section 2.3.1, "Choosing An Installation + Package." + + * The source distribution contains all the code and support + files for building the executables using the Visual Studio + compiler system. + + Generally speaking, you should use a binary distribution that + includes an installer. It is simpler to use than the others, and + you need no additional tools to get MySQL up and running. The + installer for the Windows version of MySQL, combined with a GUI + Configuration Wizard, automatically installs MySQL, creates an + option file, starts the server, and secures the default user + accounts. + +Caution + + Using virus scanning software such as Norton/Symantec Anti-Virus + on directories containing MySQL data and temporary tables can + cause issues, both in terms of the performance of MySQL and the + virus-scanning software mis-identifying the contents of the files + as containing spam. This is because of the fingerprinting + mechanism used by the virus scanning software, and the way in + which MySQL rapidly updates different files, which may be + identified as a potential security risk. + + After installing MySQL Server, it is recommended that you disable + virus scanning on the main directory (datadir) being used to store + your MySQL table data. There is usually a system built into the + virus scanning software to allow certain directories to be + specifically ignored during virus scanning. + + In addition, by default, MySQL creates temporary files in the + standard Windows temporary directory. To prevent the temporary + files also being scanned, you should configure a separate + temporary directory for MySQL temporary files and add this to the + virus scanning exclusion list. To do this, add a configuration + option for the tmpdir parameter to your my.ini configuration file. + For more information, see Section 2.3.7, "Creating an Option + File." + + The following section describes how to install MySQL on Windows + using a binary distribution. To use an installation package that + does not include an installer, follow the procedure described in + Section 2.3.5, "Installing MySQL from a Noinstall Zip Archive." To + install using a source distribution, see Section 2.10.6, + "Installing MySQL from Source on Windows." + + MySQL distributions for Windows can be downloaded from + http://dev.mysql.com/downloads/. See Section 2.1.3, "How to Get + MySQL." + +2.3.1. Choosing An Installation Package + + For MySQL 5.1, there are three installation packages to choose + from when installing MySQL on Windows: + + * The Essentials Package: This package has a file name similar + to mysql-essential-5.1.35-win32.msi and contains the minimum + set of files needed to install MySQL on Windows, including the + Configuration Wizard. This package does not include optional + components such as the embedded server and benchmark suite. + + * The Complete Package: This package has a file name similar to + mysql-5.1.35-win32.zip and contains all files needed for a + complete Windows installation, including the Configuration + Wizard. This package includes optional components such as the + embedded server and benchmark suite. + + * The Noinstall Archive: This package has a file name similar to + mysql-noinstall-5.1.35-win32.zip and contains all the files + found in the Complete install package, with the exception of + the Configuration Wizard. This package does not include an + automated installer, and must be manually installed and + configured. + + The Essentials package is recommended for most users. It is + provided as an .msi file for use with the Windows Installer. The + Complete and Noinstall distributions are packaged as Zip archives. + To use them, you must have a tool that can unpack .zip files. + + Your choice of install package affects the installation process + you must follow. If you choose to install either the Essentials or + Complete install packages, see Section 2.3.2, "Installing MySQL + with the Automated Installer." If you choose to install MySQL from + the Noinstall archive, see Section 2.3.5, "Installing MySQL from a + Noinstall Zip Archive." + +2.3.2. Installing MySQL with the Automated Installer + + New MySQL users can use the MySQL Installation Wizard and MySQL + Configuration Wizard to install MySQL on Windows. These are + designed to install and configure MySQL in such a way that new + users can immediately get started using MySQL. + + The MySQL Installation Wizard and MySQL Configuration Wizard are + available in the Essentials and Complete install packages. They + are recommended for most standard MySQL installations. Exceptions + include users who need to install multiple instances of MySQL on a + single server host and advanced users who want complete control of + server configuration. + +2.3.3. Using the MySQL Installation Wizard + + MySQL Installation Wizard is an installer for the MySQL server + that uses the latest installer technologies for Microsoft Windows. + The MySQL Installation Wizard, in combination with the MySQL + Configuration Wizard, allows a user to install and configure a + MySQL server that is ready for use immediately after installation. + + The MySQL Installation Wizard is the standard installer for all + MySQL server distributions, version 4.1.5 and higher. Users of + previous versions of MySQL need to shut down and remove their + existing MySQL installations manually before installing MySQL with + the MySQL Installation Wizard. See Section 2.3.3.6, "Upgrading + MySQL with the Installation Wizard," for more information on + upgrading from a previous version. + + Microsoft has included an improved version of their Microsoft + Windows Installer (MSI) in the recent versions of Windows. MSI has + become the de-facto standard for application installations on + Windows 2000, Windows XP, and Windows Server 2003. The MySQL + Installation Wizard makes use of this technology to provide a + smoother and more flexible installation process. + + The Microsoft Windows Installer Engine was updated with the + release of Windows XP; those using a previous version of Windows + can reference this Microsoft Knowledge Base article + (http://support.microsoft.com/default.aspx?scid=kb;EN-US;292539) + for information on upgrading to the latest version of the Windows + Installer Engine. + + In addition, Microsoft has introduced the WiX (Windows Installer + XML) toolkit recently. This is the first highly acknowledged Open + Source project from Microsoft. We have switched to WiX because it + is an Open Source project and it allows us to handle the complete + Windows installation process in a flexible manner using scripts. + + Improving the MySQL Installation Wizard depends on the support and + feedback of users like you. If you find that the MySQL + Installation Wizard is lacking some feature important to you, or + if you discover a bug, please report it in our bugs database using + the instructions given in Section 1.6, "How to Report Bugs or + Problems." + +2.3.3.1. Downloading and Starting the MySQL Installation Wizard + + The MySQL installation packages can be downloaded from + http://dev.mysql.com/downloads/. If the package you download is + contained within a Zip archive, you need to extract the archive + first. + +Note + + If you are installing on Windows Vista it is best to open a + network port before beginning the installation. To do this, first + ensure that you are logged in as an Administrator, go to the + Control Panel, and double click the Windows Firewall icon. Choose + the Allow a program through Windows Firewall option and click the + Add port button. Enter MySQL into the Name text box and 3306 (or + the port of your choice) into the Port number text box. Also + ensure that the TCP protocol radio button is selected. If you + wish, you can also limit access to the MySQL server by choosing + the Change scope button. Confirm your choices by clicking the OK + button. If you do not open a port prior to installation, you + cannot configure the MySQL server immediately after installation. + Additionally, when running the MySQL Installation Wizard on + Windows Vista, ensure that you are logged in as a user with + administrative rights. + + The process for starting the wizard depends on the contents of the + installation package you download. If there is a setup.exe file + present, double-click it to start the installation process. If + there is an .msi file present, double-click it to start the + installation process. + +2.3.3.2. Choosing an Install Type + + There are three installation types available: Typical, Complete, + and Custom. + + The Typical installation type installs the MySQL server, the mysql + command-line client, and the command-line utilities. The + command-line clients and utilities include mysqldump, myisamchk, + and several other tools to help you manage the MySQL server. + + The Complete installation type installs all components included in + the installation package. The full installation package includes + components such as the embedded server library, the benchmark + suite, support scripts, and documentation. + + The Custom installation type gives you complete control over which + packages you wish to install and the installation path that is + used. See Section 2.3.3.3, "The Custom Install Dialog," for more + information on performing a custom install. + + If you choose the Typical or Complete installation types and click + the Next button, you advance to the confirmation screen to verify + your choices and begin the installation. If you choose the Custom + installation type and click the Next button, you advance to the + custom installation dialog, described in Section 2.3.3.3, "The + Custom Install Dialog." + +2.3.3.3. The Custom Install Dialog + + If you wish to change the installation path or the specific + components that are installed by the MySQL Installation Wizard, + choose the Custom installation type. + + A tree view on the left side of the custom install dialog lists + all available components. Components that are not installed have a + red X icon; components that are installed have a gray icon. To + change whether a component is installed, click on that component's + icon and choose a new option from the drop-down list that appears. + + You can change the default installation path by clicking the + Change... button to the right of the displayed installation path. + + After choosing your installation components and installation path, + click the Next button to advance to the confirmation dialog. + +2.3.3.4. The Confirmation Dialog + + Once you choose an installation type and optionally choose your + installation components, you advance to the confirmation dialog. + Your installation type and installation path are displayed for you + to review. + + To install MySQL if you are satisfied with your settings, click + the Install button. To change your settings, click the Back + button. To exit the MySQL Installation Wizard without installing + MySQL, click the Cancel button. + + After installation is complete, you have the option of registering + with the MySQL web site. Registration gives you access to post in + the MySQL forums at forums.mysql.com (http://forums.mysql.com), + along with the ability to report bugs at bugs.mysql.com + (http://bugs.mysql.com) and to subscribe to our newsletter. The + final screen of the installer provides a summary of the + installation and gives you the option to launch the MySQL + Configuration Wizard, which you can use to create a configuration + file, install the MySQL service, and configure security settings. + +2.3.3.5. Changes Made by MySQL Installation Wizard + + Once you click the Install button, the MySQL Installation Wizard + begins the installation process and makes certain changes to your + system which are described in the sections that follow. + + Changes to the Registry + + The MySQL Installation Wizard creates one Windows registry key in + a typical install situation, located in + HKEY_LOCAL_MACHINE\SOFTWARE\MySQL AB. + + The MySQL Installation Wizard creates a key named after the major + version of the server that is being installed, such as MySQL + Server 5.1. It contains two string values, Location and Version. + The Location string contains the path to the installation + directory. In a default installation it contains C:\Program + Files\MySQL\MySQL Server 5.1\. The Version string contains the + release number. For example, for an installation of MySQL Server + 5.1.35, the key contains a value of 5.1.35. + + These registry keys are used to help external tools identify the + installed location of the MySQL server, preventing a complete scan + of the hard-disk to determine the installation path of the MySQL + server. The registry keys are not required to run the server, and + if you install MySQL using the noinstall Zip archive, the registry + keys are not created. + + Changes to the Start Menu + + The MySQL Installation Wizard creates a new entry in the Windows + Start menu under a common MySQL menu heading named after the major + version of MySQL that you have installed. For example, if you + install MySQL 5.1, the MySQL Installation Wizard creates a MySQL + Server 5.1 section in the Start menu. + + The following entries are created within the new Start menu + section: + + * MySQL Command Line Client: This is a shortcut to the mysql + command-line client and is configured to connect as the root + user. The shortcut prompts for a root user password when you + connect. + + * MySQL Server Instance Config Wizard: This is a shortcut to the + MySQL Configuration Wizard. Use this shortcut to configure a + newly installed server, or to reconfigure an existing server. + + * MySQL Documentation: This is a link to the MySQL server + documentation that is stored locally in the MySQL server + installation directory. This option is not available when the + MySQL server is installed using the Essentials installation + package. + + Changes to the File System + + The MySQL Installation Wizard by default installs the MySQL 5.1 + server to C:\Program Files\MySQL\MySQL Server 5.1, where Program + Files is the default location for applications in your system, and + 5.1 is the major version of your MySQL server. This is the + recommended location for the MySQL server, replacing the former + default location C:\mysql. + + By default, all MySQL applications are stored in a common + directory at C:\Program Files\MySQL, where Program Files is the + default location for applications in your Windows installation. A + typical MySQL installation on a developer machine might look like + this: +C:\Program Files\MySQL\MySQL Server 5.1 +C:\Program Files\MySQL\MySQL Administrator 1.0 +C:\Program Files\MySQL\MySQL Query Browser 1.0 + + This approach makes it easier to manage and maintain all MySQL + applications installed on a particular system. + + In MySQL 5.1.23 and earlier, the default location for the data + files used by MySQL is located within the corresponding MySQL + Server installation directory. For MySQL 5.1.24 and later, the + default location of the data directory is the AppData directory + configured for the user that installed the MySQL application. + +2.3.3.6. Upgrading MySQL with the Installation Wizard + + The MySQL Installation Wizard can perform server upgrades + automatically using the upgrade capabilities of MSI. That means + you do not need to remove a previous installation manually before + installing a new release. The installer automatically shuts down + and removes the previous MySQL service before installing the new + version. + + Automatic upgrades are available only when upgrading between + installations that have the same major and minor version numbers. + For example, you can upgrade automatically from MySQL 4.1.5 to + MySQL 4.1.6, but not from MySQL 5.0 to MySQL 5.1. + + See Section 2.3.14, "Upgrading MySQL on Windows." + +2.3.4. MySQL Server Instance Configuration Wizard + + The MySQL Server Instance Configuration Wizard helps automate the + process of configuring your server. It creates a custom MySQL + configuration file (my.ini or my.cnf) by asking you a series of + questions and then applying your responses to a template to + generate the configuration file that is tuned to your + installation. + + The MySQL Server Instance Configuration Wizard is included with + the MySQL 5.1 server. The MySQL Server Instance Configuration + Wizard is only available for Windows. + +2.3.4.1. Starting the MySQL Server Instance Configuration Wizard + + The MySQL Server Instance Configuration Wizard is normally started + as part of the installation process. You should only need to run + the MySQL Server Instance Configuration Wizard again when you need + to change the configuration parameters of your server. + + If you chose not to open a port prior to installing MySQL on + Windows Vista, you can choose to use the MySQL Server + Configuration Wizard after installation. However, you must open a + port in the Windows Firewall. To do this see the instructions + given in Section 2.3.3.1, "Downloading and Starting the MySQL + Installation Wizard." Rather than opening a port, you also have + the option of adding MySQL as a program that bypasses the Windows + Firewall. One or the other option is sufficient --- you need not + do both. Additionally, when running the MySQL Server Configuration + Wizard on Windows Vista ensure that you are logged in as a user + with administrative rights. + MySQL Server Instance Configuration Wizard + + You can launch the MySQL Configuration Wizard by clicking the + MySQL Server Instance Config Wizard entry in the MySQL section of + the Windows Start menu. + + Alternatively, you can navigate to the bin directory of your MySQL + installation and launch the MySQLInstanceConfig.exe file directly. + + The MySQL Server Instance Configuration Wizard places the my.ini + file in the installation directory for the MySQL server. This + helps associate configuration files with particular server + instances. + + To ensure that the MySQL server knows where to look for the my.ini + file, an argument similar to this is passed to the MySQL server as + part of the service installation: +--defaults-file="C:\Program Files\MySQL\MySQL Server 5.1\my.ini" + + Here, C:\Program Files\MySQL\MySQL Server 5.1 is replaced with the + installation path to the MySQL Server. The --defaults-file option + instructs the MySQL server to read the specified file for + configuration options when it starts. + + Apart from making changes to the my.ini file by running the MySQL + Server Instance Configuration Wizard again, you can modify it by + opening it with a text editor and making any necessary changes. + You can also modify the server configuration with the MySQL + Administrator (http://www.mysql.com/products/administrator/) + utility. For more information about server configuration, see + Section 5.1.2, "Server Command Options." + + MySQL clients and utilities such as the mysql and mysqldump + command-line clients are not able to locate the my.ini file + located in the server installation directory. To configure the + client and utility applications, create a new my.ini file in the + Windows installation directory (for example, C:\WINDOWS). + + Under Windows Server 2003, Windows Server 2000, Windows XP, and + Windows Vista MySQL Server Instance Configuration Wizard will + configure MySQL to work as a Windows service. To start and stop + MySQL you use the Services application that is supplied as part of + the Windows Administrator Tools. + +2.3.4.2. Choosing a Maintenance Option + + If the MySQL Server Instance Configuration Wizard detects an + existing configuration file, you have the option of either + reconfiguring your existing server, or removing the server + instance by deleting the configuration file and stopping and + removing the MySQL service. + + To reconfigure an existing server, choose the Re-configure + Instance option and click the Next button. Any existing + configuration file is not overwritten, but renamed (within the + same directory) using a timestamp (Windows) or sequential number + (Linux). To remove the existing server instance, choose the Remove + Instance option and click the Next button. + + If you choose the Remove Instance option, you advance to a + confirmation window. Click the Execute button. The MySQL Server + Configuration Wizard stops and removes the MySQL service, and then + deletes the configuration file. The server installation and its + data folder are not removed. + + If you choose the Re-configure Instance option, you advance to the + Configuration Type dialog where you can choose the type of + installation that you wish to configure. + +2.3.4.3. Choosing a Configuration Type + + When you start the MySQL Server Instance Configuration Wizard for + a new MySQL installation, or choose the Re-configure Instance + option for an existing installation, you advance to the + Configuration Type dialog. + MySQL Server Instance Configuration Wizard: Configuration Type + + There are two configuration types available: Detailed + Configuration and Standard Configuration. The Standard + Configuration option is intended for new users who want to get + started with MySQL quickly without having to make many decisions + about server configuration. The Detailed Configuration option is + intended for advanced users who want more fine-grained control + over server configuration. + + If you are new to MySQL and need a server configured as a + single-user developer machine, the Standard Configuration should + suit your needs. Choosing the Standard Configuration option causes + the MySQL Configuration Wizard to set all configuration options + automatically with the exception of Service Options and Security + Options. + + The Standard Configuration sets options that may be incompatible + with systems where there are existing MySQL installations. If you + have an existing MySQL installation on your system in addition to + the installation you wish to configure, the Detailed Configuration + option is recommended. + + To complete the Standard Configuration, please refer to the + sections on Service Options and Security Options in Section + 2.3.4.10, "The Service Options Dialog," and Section 2.3.4.11, "The + Security Options Dialog," respectively. + +2.3.4.4. The Server Type Dialog + + There are three different server types available to choose from. + The server type that you choose affects the decisions that the + MySQL Server Instance Configuration Wizard makes with regard to + memory, disk, and processor usage. + MySQL Server Instance Configuration Wizard: Server Type + + * Developer Machine: Choose this option for a typical desktop + workstation where MySQL is intended only for personal use. It + is assumed that many other desktop applications are running. + The MySQL server is configured to use minimal system + resources. + + * Server Machine: Choose this option for a server machine where + the MySQL server is running alongside other server + applications such as FTP, email, and Web servers. The MySQL + server is configured to use a moderate portion of the system + resources. + + * Dedicated MySQL Server Machine: Choose this option for a + server machine that is intended to run only the MySQL server. + It is assumed that no other applications are running. The + MySQL server is configured to use all available system + resources. + +Note + + By selecting one of the preconfigured configurations, the values + and settings of various options in your my.cnf or my.ini will be + altered accordingly. The default values and options as described + in the reference manual may therefore be different to the options + and values that were created during the execution of the + configuration wizard. + +2.3.4.5. The Database Usage Dialog + + The Database Usage dialog allows you to indicate the storage + engines that you expect to use when creating MySQL tables. The + option you choose determines whether the InnoDB storage engine is + available and what percentage of the server resources are + available to InnoDB. + MySQL Server Instance Configuration Wizard: Usage Dialog + + * Multifunctional Database: This option enables both the InnoDB + and MyISAM storage engines and divides resources evenly + between the two. This option is recommended for users who use + both storage engines on a regular basis. + + * Transactional Database Only: This option enables both the + InnoDB and MyISAM storage engines, but dedicates most server + resources to the InnoDB storage engine. This option is + recommended for users who use InnoDB almost exclusively and + make only minimal use of MyISAM. + + * Non-Transactional Database Only: This option disables the + InnoDB storage engine completely and dedicates all server + resources to the MyISAM storage engine. This option is + recommended for users who do not use InnoDB. + + The Configuration Wizard uses a template to generate the server + configuration file. The Database Usage dialog sets one of the + following option strings: +Multifunctional Database: MIXED +Transactional Database Only: INNODB +Non-Transactional Database Only: MYISAM + + When these options are processed through the default template + (my-template.ini) the result is: +Multifunctional Database: +default-storage-engine=InnoDB +_myisam_pct=50 + +Transactional Database Only: +default-storage-engine=InnoDB +_myisam_pct=5 + +Non-Transactional Database Only: +default-storage-engine=MyISAM +_myisam_pct=100 +skip-innodb + + The _myisam_pct value is used to calculate the percentage of + resources dedicated to MyISAM. The remaining resources are + allocated to InnoDB. + +2.3.4.6. The InnoDB Tablespace Dialog + + Some users may want to locate the InnoDB tablespace files in a + different location than the MySQL server data directory. Placing + the tablespace files in a separate location can be desirable if + your system has a higher capacity or higher performance storage + device available, such as a RAID storage system. + MySQL Server Instance Configuration Wizard: InnoDB Data Tablespace + + To change the default location for the InnoDB tablespace files, + choose a new drive from the drop-down list of drive letters and + choose a new path from the drop-down list of paths. To create a + custom path, click the ... button. + + If you are modifying the configuration of an existing server, you + must click the Modify button before you change the path. In this + situation you must move the existing tablespace files to the new + location manually before starting the server. + +2.3.4.7. The Concurrent Connections Dialog + + To prevent the server from running out of resources, it is + important to limit the number of concurrent connections to the + MySQL server that can be established. The Concurrent Connections + dialog allows you to choose the expected usage of your server, and + sets the limit for concurrent connections accordingly. It is also + possible to set the concurrent connection limit manually. + MySQL Server Instance Configuration Wizard: Connections + + * Decision Support (DSS)/OLAP: Choose this option if your server + does not require a large number of concurrent connections. The + maximum number of connections is set at 100, with an average + of 20 concurrent connections assumed. + + * Online Transaction Processing (OLTP): Choose this option if + your server requires a large number of concurrent connections. + The maximum number of connections is set at 500. + + * Manual Setting: Choose this option to set the maximum number + of concurrent connections to the server manually. Choose the + number of concurrent connections from the drop-down box + provided, or enter the maximum number of connections into the + drop-down box if the number you desire is not listed. + +2.3.4.8. The Networking and Strict Mode Options Dialog + + Use the Networking Options dialog to enable or disable TCP/IP + networking and to configure the port number that is used to + connect to the MySQL server. + MySQL Server Instance Configuration Wizard: Network Configuration + + TCP/IP networking is enabled by default. To disable TCP/IP + networking, uncheck the box next to the Enable TCP/IP Networking + option. + + Port 3306 is used by default. To change the port used to access + MySQL, choose a new port number from the drop-down box or type a + new port number directly into the drop-down box. If the port + number you choose is in use, you are prompted to confirm your + choice of port number. + + Set the Server SQL Mode to either enable or disable strict mode. + Enabling strict mode (default) makes MySQL behave more like other + database management systems. If you run applications that rely on + MySQL's old "forgiving" behavior, make sure to either adapt those + applications or to disable strict mode. For more information about + strict mode, see Section 5.1.7, "Server SQL Modes." + +2.3.4.9. The Character Set Dialog + + The MySQL server supports multiple character sets and it is + possible to set a default server character set that is applied to + all tables, columns, and databases unless overridden. Use the + Character Set dialog to change the default character set of the + MySQL server. + MySQL Server Instance Configuration Wizard: Character Set + + * Standard Character Set: Choose this option if you want to use + latin1 as the default server character set. latin1 is used for + English and many Western European languages. + + * Best Support For Multilingualism: Choose this option if you + want to use utf8 as the default server character set. This is + a Unicode character set that can store characters from many + different languages. + + * Manual Selected Default Character Set / Collation: Choose this + option if you want to pick the server's default character set + manually. Choose the desired character set from the provided + drop-down list. + +2.3.4.10. The Service Options Dialog + + On Windows platforms, the MySQL server can be installed as a + Windows service. When installed this way, the MySQL server can be + started automatically during system startup, and even restarted + automatically by Windows in the event of a service failure. + + The MySQL Server Instance Configuration Wizard installs the MySQL + server as a service by default, using the service name MySQL. If + you do not wish to install the service, uncheck the box next to + the Install As Windows Service option. You can change the service + name by picking a new service name from the drop-down box provided + or by entering a new service name into the drop-down box. + +Note + + Service names can include any legal character except forward (/) + or backward (\) slashes, and must be less than 256 characters + long. + +Warning + + If you are installing multiple versions of MySQL onto the same + machine, you must choose a different service name for each version + that you install. If you do not choose a different service for + each installed version then the service manager information will + be inconsistent and this will cause problems when you try to + uninstall a previous version. + + If you have already installed multiple versions using the same + service name, you must manually edit the contents of the + HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services parameters + within the Windows registry to update the association of the + service name with the correct server version. + + Typically, when installing multiple versions you create a service + name based on the version information. For example, you might + install MySQL 5.x as mysql5, or specific versions such as MySQL + 5.1.30 as mysql5130. + + To install the MySQL server as a service but not have it started + automatically at startup, uncheck the box next to the Launch the + MySQL Server Automatically option. + +2.3.4.11. The Security Options Dialog + + It is strongly recommended that you set a root password for your + MySQL server, and the MySQL Server Instance Configuration Wizard + requires by default that you do so. If you do not wish to set a + root password, uncheck the box next to the Modify Security + Settings option. + MySQL Server Instance Configuration Wizard: Security + + To set the root password, enter the desired password into both the + New root password and Confirm boxes. If you are reconfiguring an + existing server, you need to enter the existing root password into + the Current root password box. + + To prevent root logins from across the network, check the box next + to the Root may only connect from localhost option. This increases + the security of your root account. + + To create an anonymous user account, check the box next to the + Create An Anonymous Account option. Creating an anonymous account + can decrease server security and cause login and permission + difficulties. For this reason, it is not recommended. + +2.3.4.12. The Confirmation Dialog + + The final dialog in the MySQL Server Instance Configuration Wizard + is the Confirmation Dialog. To start the configuration process, + click the Execute button. To return to a previous dialog, click + the Back button. To exit the MySQL Server Instance Configuration + Wizard without configuring the server, click the Cancel button. + MySQL Server Instance Configuration Wizard: Confirmation + + After you click the Execute button, the MySQL Server Instance + Configuration Wizard performs a series of tasks and displays the + progress onscreen as the tasks are performed. + + The MySQL Server Instance Configuration Wizard first determines + configuration file options based on your choices using a template + prepared by MySQL developers and engineers. This template is named + my-template.ini and is located in your server installation + directory. + + The MySQL Configuration Wizard then writes these options to the + corresponding configuration file. + + If you chose to create a service for the MySQL server, the MySQL + Server Instance Configuration Wizard creates and starts the + service. If you are reconfiguring an existing service, the MySQL + Server Instance Configuration Wizard restarts the service to apply + your configuration changes. + + If you chose to set a root password, the MySQL Configuration + Wizard connects to the server, sets your new root password, and + applies any other security settings you may have selected. + + After the MySQL Server Instance Configuration Wizard has completed + its tasks, it displays a summary. Click the Finish button to exit + the MySQL Server Configuration Wizard. + +2.3.5. Installing MySQL from a Noinstall Zip Archive + + Users who are installing from the Noinstall package can use the + instructions in this section to manually install MySQL. The + process for installing MySQL from a Zip archive is as follows: + + 1. Extract the archive to the desired install directory + + 2. Create an option file + + 3. Choose a MySQL server type + + 4. Start the MySQL server + + 5. Secure the default user accounts + + This process is described in the sections that follow. + +2.3.6. Extracting the Install Archive + + To install MySQL manually, do the following: + + 1. If you are upgrading from a previous version please refer to + Section 2.3.14, "Upgrading MySQL on Windows," before beginning + the upgrade process. + + 2. Make sure that you are logged in as a user with administrator + privileges. + + 3. Choose an installation location. Traditionally, the MySQL + server is installed in C:\mysql. The MySQL Installation Wizard + installs MySQL under C:\Program Files\MySQL. If you do not + install MySQL at C:\mysql, you must specify the path to the + install directory during startup or in an option file. See + Section 2.3.7, "Creating an Option File." + + 4. Extract the install archive to the chosen installation + location using your preferred Zip archive tool. Some tools may + extract the archive to a folder within your chosen + installation location. If this occurs, you can move the + contents of the subfolder into the chosen installation + location. + +2.3.7. Creating an Option File + + If you need to specify startup options when you run the server, + you can indicate them on the command line or place them in an + option file. For options that are used every time the server + starts, you may find it most convenient to use an option file to + specify your MySQL configuration. This is particularly true under + the following circumstances: + + * The installation or data directory locations are different + from the default locations (C:\Program Files\MySQL\MySQL + Server 5.1 and C:\Program Files\MySQL\MySQL Server 5.1\data). + + * You need to tune the server settings, such as memory, cache, + or InnoDB configuration information. + + When the MySQL server starts on Windows, it looks for options in + two files: the my.ini file in the Windows directory, and the + C:\my.cnf file. The Windows directory typically is named something + like C:\WINDOWS. You can determine its exact location from the + value of the WINDIR environment variable using the following + command: +C:\> echo %WINDIR% + + MySQL looks for options first in the my.ini file, and then in the + my.cnf file. However, to avoid confusion, it is best if you use + only one file. If your PC uses a boot loader where C: is not the + boot drive, your only option is to use the my.ini file. Whichever + option file you use, it must be a plain text file. + + You can also make use of the example option files included with + your MySQL distribution; see Section 4.2.3.2.2, "Preconfigured + Option Files." + + An option file can be created and modified with any text editor, + such as Notepad. For example, if MySQL is installed in E:\mysql + and the data directory is in E:\mydata\data, you can create an + option file containing a [mysqld] section to specify values for + the basedir and datadir options: +[mysqld] +# set basedir to your installation path +basedir=E:/mysql +# set datadir to the location of your data directory +datadir=E:/mydata/data + + Note that Windows path names are specified in option files using + (forward) slashes rather than backslashes. If you do use + backslashes, you must double them: +[mysqld] +# set basedir to your installation path +basedir=E:\\mysql +# set datadir to the location of your data directory +datadir=E:\\mydata\\data + + MySQL Enterprise For expert advice on the start-up options + appropriate to your circumstances, subscribe to the MySQL + Enterprise Monitor. For more information, see + http://www.mysql.com/products/enterprise/advisors.html. + + In MySQL 5.1.23 and earlier, the MySQL installer places the data + directory directly under the directory where you install MySQL. On + MySQL 5.1.24 and later, the data directory is located within the + AppData directory for the user running MySQL. + + If you would like to use a data directory in a different location, + you should copy the entire contents of the data directory to the + new location. For example, if you want to use E:\mydata as the + data directory instead, you must do two things: + + 1. Move the entire data directory and all of its contents from + the default location (for example C:\Program Files\MySQL\MySQL + Server 5.1\data) to E:\mydata. + + 2. Use a --datadir option to specify the new data directory + location each time you start the server. + +2.3.8. Selecting a MySQL Server Type + + The following table shows the available servers for Windows in + MySQL 5.1.20 and earlier. + Binary Description + mysqld-nt Optimized binary with named-pipe support + mysqld Optimized binary without named-pipe support + mysqld-debug Like mysqld-nt, but compiled with full debugging and + automatic memory allocation checking + + The following table shows the available servers for Windows in + MySQL 5.1.21 and later. + Binary Description + mysqld Optimized binary with named-pipe support + mysqld-debug Like mysqld, but compiled with full debugging and + automatic memory allocation checking + + All of the preceding binaries are optimized for modern Intel + processors, but should work on any Intel i386-class or higher + processor. + + Each of the servers in a distribution support the same set of + storage engines. The SHOW ENGINES statement displays which engines + a given server supports. + + All Windows MySQL 5.1 servers have support for symbolic linking of + database directories. + + MySQL supports TCP/IP on all Windows platforms. MySQL servers on + Windows support named pipes as indicated in the following list. + However, the default is to use TCP/IP regardless of platform. + (Named pipes are slower than TCP/IP in many Windows + configurations.) + + Use of named pipes is subject to these conditions: + + * Named pipes are enabled only if you start the server with the + --enable-named-pipe option. It is necessary to use this option + explicitly because some users have experienced problems with + shutting down the MySQL server when named pipes were used. + + * For MySQL 5.1.20 and earlier, named-pipe connections are + allowed only by the mysqld-nt and mysqld-debug servers. For + MySQL 5.1.21 and later, the mysqld and mysqld-debug servers + both contain support for named-pipe connections. + +Note + + Most of the examples in this manual use mysqld as the server name. + If you choose to use a different server, such as mysqld-nt or + mysqld-debug, make the appropriate substitutions in the commands + that are shown in the examples. + +2.3.9. Starting the Server for the First Time + + This section gives a general overview of starting the MySQL + server. The following sections provide more specific information + for starting the MySQL server from the command line or as a + Windows service. + + The information here applies primarily if you installed MySQL + using the Noinstall version, or if you wish to configure and test + MySQL manually rather than with the GUI tools. + + The examples in these sections assume that MySQL is installed + under the default location of C:\Program Files\MySQL\MySQL Server + 5.1. Adjust the path names shown in the examples if you have MySQL + installed in a different location. + + Clients have two options. They can use TCP/IP, or they can use a + named pipe if the server supports named-pipe connections. + + MySQL for Windows also supports shared-memory connections if the + server is started with the --shared-memory option. Clients can + connect through shared memory by using the --protocol=MEMORY + option. + + For information about which server binary to run, see Section + 2.3.8, "Selecting a MySQL Server Type." + + Testing is best done from a command prompt in a console window (or + "DOS window"). In this way you can have the server display status + messages in the window where they are easy to see. If something is + wrong with your configuration, these messages make it easier for + you to identify and fix any problems. + + To start the server, enter this command: +C:\> "C:\Program Files\MySQL\MySQL Server 5.1\bin\mysqld" --console + + For a server that includes InnoDB support, you should see the + messages similar to those following as it starts (the path names + and sizes may differ): +InnoDB: The first specified datafile c:\ibdata\ibdata1 did not exist: +InnoDB: a new database to be created! +InnoDB: Setting file c:\ibdata\ibdata1 size to 209715200 +InnoDB: Database physically writes the file full: wait... +InnoDB: Log file c:\iblogs\ib_logfile0 did not exist: new to be creat +ed +InnoDB: Setting log file c:\iblogs\ib_logfile0 size to 31457280 +InnoDB: Log file c:\iblogs\ib_logfile1 did not exist: new to be creat +ed +InnoDB: Setting log file c:\iblogs\ib_logfile1 size to 31457280 +InnoDB: Log file c:\iblogs\ib_logfile2 did not exist: new to be creat +ed +InnoDB: Setting log file c:\iblogs\ib_logfile2 size to 31457280 +InnoDB: Doublewrite buffer not found: creating new +InnoDB: Doublewrite buffer created +InnoDB: creating foreign key constraint system tables +InnoDB: foreign key constraint system tables created +011024 10:58:25 InnoDB: Started + + When the server finishes its startup sequence, you should see + something like this, which indicates that the server is ready to + service client connections: +mysqld: ready for connections +Version: '5.1.35' socket: '' port: 3306 + + The server continues to write to the console any further + diagnostic output it produces. You can open a new console window + in which to run client programs. + + If you omit the --console option, the server writes diagnostic + output to the error log in the data directory (C:\Program + Files\MySQL\MySQL Server 5.1\data by default). The error log is + the file with the .err extension. + +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." + +2.3.10. Starting MySQL from the Windows Command Line + + The MySQL server can be started manually from the command line. + This can be done on any version of Windows. + + To start the mysqld server from the command line, you should start + a console window (or "DOS window") and enter this command: +C:\> "C:\Program Files\MySQL\MySQL Server 5.1\bin\mysqld" + + The path to mysqld may vary depending on the install location of + MySQL on your system. + + You can stop the MySQL server by executing this command: +C:\> "C:\Program Files\MySQL\MySQL Server 5.1\bin\mysqladmin" -u root + shutdown + +Note + + If the MySQL root user account has a password, you need to invoke + mysqladmin with the -p option and supply the password when + prompted. + + This command invokes the MySQL administrative utility mysqladmin + to connect to the server and tell it to shut down. The command + connects as the MySQL root user, which is the default + administrative account in the MySQL grant system. Note that users + in the MySQL grant system are wholly independent from any login + users under Windows. + + If mysqld doesn't start, check the error log to see whether the + server wrote any messages there to indicate the cause of the + problem. The error log is located in the C:\Program + Files\MySQL\MySQL Server 5.1\data directory. It is the file with a + suffix of .err. You can also try to start the server as mysqld + --console; in this case, you may get some useful information on + the screen that may help solve the problem. + + The last option is to start mysqld with the --standalone and + --debug options. In this case, mysqld writes a log file + C:\mysqld.trace that should contain the reason why mysqld doesn't + start. See MySQL Internals: Porting + (http://forge.mysql.com/wiki/MySQL_Internals_Porting). + + Use mysqld --verbose --help to display all the options that mysqld + understands. + +2.3.11. Starting MySQL as a Windows Service + + On Windows, the recommended way to run MySQL is to install it as a + Windows service, whereby MySQL starts and stops automatically when + Windows starts and stops. A MySQL server installed as a service + can also be controlled from the command line using NET commands, + or with the graphical Services utility. Generally, to install + MySQL as a Windows service you should be logged in using an + account that has administrator rights. + + The Services utility (the Windows Service Control Manager) can be + found in the Windows Control Panel (under Administrative Tools on + Windows 2000, XP, Vista and Server 2003). To avoid conflicts, it + is advisable to close the Services utility while performing server + installation or removal operations from the command line. + + Before installing MySQL as a Windows service, you should first + stop the current server if it is running by using the following + command: +C:\> "C:\Program Files\MySQL\MySQL Server 5.1\bin\mysqladmin" + -u root shutdown + +Note + + If the MySQL root user account has a password, you need to invoke + mysqladmin with the -p option and supply the password when + prompted. + + This command invokes the MySQL administrative utility mysqladmin + to connect to the server and tell it to shut down. The command + connects as the MySQL root user, which is the default + administrative account in the MySQL grant system. Note that users + in the MySQL grant system are wholly independent from any login + users under Windows. + + Install the server as a service using this command: +C:\> "C:\Program Files\MySQL\MySQL Server 5.1\bin\mysqld" --install + + The service-installation command does not start the server. + Instructions for that are given later in this section. + + To make it easier to invoke MySQL programs, you can add the path + name of the MySQL bin directory to your Windows system PATH + environment variable: + + * On the Windows desktop, right-click on the My Computer icon, + and select Properties. + + * Next select the Advanced tab from the System Properties menu + that appears, and click the Environment Variables button. + + * Under System Variables, select Path, and then click the Edit + button. The Edit System Variable dialogue should appear. + + * Place your cursor at the end of the text appearing in the + space marked Variable Value. (Use the End key to ensure that + your cursor is positioned at the very end of the text in this + space.) Then enter the complete path name of your MySQL bin + directory (for example, C:\Program Files\MySQL\MySQL Server + 5.1\bin), Note that there should be a semicolon separating + this path from any values present in this field. Dismiss this + dialogue, and each dialogue in turn, by clicking OK until all + of the dialogues that were opened have been dismissed. You + should now be able to invoke any MySQL executable program by + typing its name at the DOS prompt from any directory on the + system, without having to supply the path. This includes the + servers, the mysql client, and all MySQL command-line + utilities such as mysqladmin and mysqldump. + You should not add the MySQL bin directory to your Windows + PATH if you are running multiple MySQL servers on the same + machine. + +Warning + + You must exercise great care when editing your system PATH by + hand; accidental deletion or modification of any portion of the + existing PATH value can leave you with a malfunctioning or even + unusable system. + + The following additional arguments can be used in MySQL 5.1 when + installing the service: + + * You can specify a service name immediately following the + --install option. The default service name is MySQL. + + * If a service name is given, it can be followed by a single + option. By convention, this should be + --defaults-file=file_name to specify the name of an option + file from which the server should read options when it starts. + The use of a single option other than --defaults-file is + possible but discouraged. --defaults-file is more flexible + because it enables you to specify multiple startup options for + the server by placing them in the named option file. + + * You can also specify a --local-service option following the + service name. This causes the server to run using the + LocalService Windows account that has limited system + privileges. This account is available only for Windows XP or + newer. If both --defaults-file and --local-service are given + following the service name, they can be in any order. + + For a MySQL server that is installed as a Windows service, the + following rules determine the service name and option files that + the server uses: + + * If the service-installation command specifies no service name + or the default service name (MySQL) following the --install + option, the server uses the a service name of MySQL and reads + options from the [mysqld] group in the standard option files. + + * If the service-installation command specifies a service name + other than MySQL following the --install option, the server + uses that service name. It reads options from the [mysqld] + group and the group that has the same name as the service in + the standard option files. This allows you to use the [mysqld] + group for options that should be used by all MySQL services, + and an option group with the service name for use by the + server installed with that service name. + + * If the service-installation command specifies a + --defaults-file option after the service name, the server + reads options only from the [mysqld] group of the named file + and ignores the standard option files. + + As a more complex example, consider the following command: +C:\> "C:\Program Files\MySQL\MySQL Server 5.1\bin\mysqld" + --install MySQL --defaults-file=C:\my-opts.cnf + + Here, the default service name (MySQL) is given after the + --install option. If no --defaults-file option had been given, + this command would have the effect of causing the server to read + the [mysqld] group from the standard option files. However, + because the --defaults-file option is present, the server reads + options from the [mysqld] option group, and only from the named + file. + + You can also specify options as Start parameters in the Windows + Services utility before you start the MySQL service. + + Once a MySQL server has been installed as a service, Windows + starts the service automatically whenever Windows starts. The + service also can be started immediately from the Services utility, + or by using a NET START MySQL command. The NET command is not case + sensitive. + + When run as a service, mysqld has no access to a console window, + so no messages can be seen there. If mysqld does not start, check + the error log to see whether the server wrote any messages there + to indicate the cause of the problem. The error log is located in + the MySQL data directory (for example, C:\Program + Files\MySQL\MySQL Server 5.1\data). It is the file with a suffix + of .err. + + When a MySQL server has been installed as a service, and the + service is running, Windows stops the service automatically when + Windows shuts down. The server also can be stopped manually by + using the Services utility, the NET STOP MySQL command, or the + mysqladmin shutdown command. + + You also have the choice of installing the server as a manual + service if you do not wish for the service to be started + automatically during the boot process. To do this, use the + --install-manual option rather than the --install option: +C:\> "C:\Program Files\MySQL\MySQL Server 5.1\bin\mysqld" --install-m +anual + + To remove a server that is installed as a service, first stop it + if it is running by executing NET STOP MySQL. Then use the + --remove option to remove it: +C:\> "C:\Program Files\MySQL\MySQL Server 5.1\bin\mysqld" --remove + + If mysqld is not running as a service, you can start it from the + command line. For instructions, see Section 2.3.10, "Starting + MySQL from the Windows Command Line." + + Please see Section 2.3.13, "Troubleshooting a MySQL Installation + Under Windows," if you encounter difficulties during installation. + +2.3.12. Testing The MySQL Installation + + You can test whether the MySQL server is working by executing any + of the following commands: +C:\> "C:\Program Files\MySQL\MySQL Server 5.1\bin\mysqlshow" +C:\> "C:\Program Files\MySQL\MySQL Server 5.1\bin\mysqlshow" -u root +mysql +C:\> "C:\Program Files\MySQL\MySQL Server 5.1\bin\mysqladmin" version + status proc +C:\> "C:\Program Files\MySQL\MySQL Server 5.1\bin\mysql" test + + If mysqld is slow to respond to TCP/IP connections from client + programs, there is probably a problem with your DNS. In this case, + start mysqld with the --skip-name-resolve option and use only + localhost and IP numbers in the Host column of the MySQL grant + tables. + + You can force a MySQL client to use a named-pipe connection rather + than TCP/IP by specifying the --pipe or --protocol=PIPE option, or + by specifying . (period) as the host name. Use the --socket option + to specify the name of the pipe if you do not want to use the + default pipe name. + + Note that if you have set a password for the root account, deleted + the anonymous account, or created a new user account, then you + must use the appropriate -u and -p options with the commands shown + above in order to connect with the MySQL Server. See Section + 4.2.2, "Connecting to the MySQL Server." + + For more information about mysqlshow, see Section 4.5.6, + "mysqlshow --- Display Database, Table, and Column Information." + +2.3.13. Troubleshooting a MySQL Installation Under Windows + + When installing and running MySQL for the first time, you may + encounter certain errors that prevent the MySQL server from + starting. The purpose of this section is to help you diagnose and + correct some of these errors. + + Your first resource when troubleshooting server issues is the + error log. The MySQL server uses the error log to record + information relevant to the error that prevents the server from + starting. The error log is located in the data directory specified + in your my.ini file. The default data directory location is + C:\Program Files\MySQL\MySQL Server 5.1\data. See Section 5.2.2, + "The Error Log." + + Another source of information regarding possible errors is the + console messages displayed when the MySQL service is starting. Use + the NET START MySQL command from the command line after installing + mysqld as a service to see any error messages regarding the + starting of the MySQL server as a service. See Section 2.3.11, + "Starting MySQL as a Windows Service." + + The following examples show other common error messages you may + encounter when installing MySQL and starting the server for the + first time: + + * If the MySQL server cannot find the mysql privileges database + or other critical files, you may see these messages: +System error 1067 has occurred. +Fatal error: Can't open privilege tables: Table 'mysql.host' doesn't +exist + These messages often occur when the MySQL base or data + directories are installed in different locations than the + default locations (C:\Program Files\MySQL\MySQL Server 5.1 and + C:\Program Files\MySQL\MySQL Server 5.1\data, respectively). + This situation may occur when MySQL is upgraded and installed + to a new location, but the configuration file is not updated + to reflect the new location. In addition, there may be old and + new configuration files that conflict. Be sure to delete or + rename any old configuration files when upgrading MySQL. + If you have installed MySQL to a directory other than + C:\Program Files\MySQL\MySQL Server 5.1, you need to ensure + that the MySQL server is aware of this through the use of a + configuration (my.ini) file. The my.ini file needs to be + located in your Windows directory, typically C:\WINDOWS. You + can determine its exact location from the value of the WINDIR + environment variable by issuing the following command from the + command prompt: +C:\> echo %WINDIR% + An option file can be created and modified with any text + editor, such as Notepad. For example, if MySQL is installed in + E:\mysql and the data directory is D:\MySQLdata, you can + create the option file and set up a [mysqld] section to + specify values for the basedir and datadir options: +[mysqld] +# set basedir to your installation path +basedir=E:/mysql +# set datadir to the location of your data directory +datadir=D:/MySQLdata + Note that Windows path names are specified in option files + using (forward) slashes rather than backslashes. If you do use + backslashes, you must double them: +[mysqld] +# set basedir to your installation path +basedir=C:\\Program Files\\MySQL\\MySQL Server 5.1 +# set datadir to the location of your data directory +datadir=D:\\MySQLdata + If you change the datadir value in your MySQL configuration + file, you must move the contents of the existing MySQL data + directory before restarting the MySQL server. + See Section 2.3.7, "Creating an Option File." + + * If you reinstall or upgrade MySQL without first stopping and + removing the existing MySQL service and install MySQL using + the MySQL Configuration Wizard, you may see this error: +Error: Cannot create Windows service for MySql. Error: 0 + This occurs when the Configuration Wizard tries to install the + service and finds an existing service with the same name. + One solution to this problem is to choose a service name other + than mysql when using the configuration wizard. This allows + the new service to be installed correctly, but leaves the + outdated service in place. Although this is harmless, it is + best to remove old services that are no longer in use. + To permanently remove the old mysql service, execute the + following command as a user with administrative privileges, on + the command-line: +C:\> sc delete mysql +[SC] DeleteService SUCCESS + If the sc utility is not available for your version of + Windows, download the delsrv utility from + http://www.microsoft.com/windows2000/techinfo/reskit/tools/exi + sting/delsrv-o.asp and use the delsrv mysql syntax. + +2.3.14. Upgrading MySQL on Windows + + This section lists some of the steps you should take when + upgrading MySQL on Windows. + + 1. Review Section 2.12.1, "Upgrading MySQL," for additional + information on upgrading MySQL that is not specific to + Windows. + + 2. You should always back up your current MySQL installation + before performing an upgrade. See Section 6.1, "Database + Backups." + + 3. Download the latest Windows distribution of MySQL from + http://dev.mysql.com/downloads/. + + 4. Before upgrading MySQL, you must stop the server. If the + server is installed as a service, stop the service with the + following command from the command prompt: +C:\> NET STOP MySQL + If you are not running the MySQL server as a service, use the + following command to stop it: +C:\> "C:\Program Files\MySQL\MySQL Server 5.1\bin\mysqladmin" -u root + shutdown + +Note + If the MySQL root user account has a password, you need to + invoke mysqladmin with the -p option and supply the password + when prompted. + + 5. When upgrading to MySQL 5.1 from a version previous to 4.1.5, + or when upgrading from a version of MySQL installed from a Zip + archive to a version of MySQL installed with the MySQL + Installation Wizard, you must manually remove the previous + installation and MySQL service (if the server is installed as + a service). + To remove the MySQL service, use the following command: +C:\> C:\mysql\bin\mysqld --remove + If you do not remove the existing service, the MySQL + Installation Wizard may fail to properly install the new MySQL + service. + + 6. When upgrading from MySQL 5.1.23 to MySQL 5.1.24, the change + in the default location of the data directory from a directory + within the MySQL installation to the AppData folder means that + you must manually copy the data files from your old + installation to the new location. + + 7. If you are using the MySQL Installation Wizard, start the + wizard as described in Section 2.3.3, "Using the MySQL + Installation Wizard." + + 8. If you are installing MySQL from a Zip archive, extract the + archive. You may either overwrite your existing MySQL + installation (usually located at C:\mysql), or install it into + a different directory, such as C:\mysql5. Overwriting the + existing installation is recommended. + + 9. If you were running MySQL as a Windows service and you had to + remove the service earlier in this procedure, reinstall the + service. (See Section 2.3.11, "Starting MySQL as a Windows + Service.") + 10. Restart the server. For example, use NET START MySQL if you + run MySQL as a service, or invoke mysqld directly otherwise. + 11. If you encounter errors, see Section 2.3.13, "Troubleshooting + a MySQL Installation Under Windows." + +2.3.15. MySQL on Windows Compared to MySQL on Unix + + MySQL for Windows has proven itself to be very stable. The Windows + version of MySQL has the same features as the corresponding Unix + version, with the following exceptions: + + * Limited number of ports + Windows systems have about 4,000 ports available for client + connections, and after a connection on a port closes, it takes + two to four minutes before the port can be reused. In + situations where clients connect to and disconnect from the + server at a high rate, it is possible for all available ports + to be used up before closed ports become available again. If + this happens, the MySQL server appears to be unresponsive even + though it is running. Note that ports may be used by other + applications running on the machine as well, in which case the + number of ports available to MySQL is lower. + For more information about this problem, see + http://support.microsoft.com/default.aspx?scid=kb;en-us;196271 + . + + * Concurrent reads + MySQL depends on the pread() and pwrite() system calls to be + able to mix INSERT and SELECT. Currently, we use mutexes to + emulate pread() and pwrite(). We intend to replace the file + level interface with a virtual interface in the future so that + we can use the readfile()/writefile() interface to get more + speed. The current implementation limits the number of open + files that MySQL 5.1 can use to 2,048, which means that you + cannot run as many concurrent threads on Windows as on Unix. + + * Blocking read + MySQL uses a blocking read for each connection. That has the + following implications if named-pipe connections are enabled: + + + A connection is not disconnected automatically after + eight hours, as happens with the Unix version of MySQL. + + + If a connection hangs, it is not possible to break it + without killing MySQL. + + + mysqladmin kill does not work on a sleeping connection. + + + mysqladmin shutdown cannot abort as long as there are + sleeping connections. + We plan to fix this problem in the future. + + * ALTER TABLE + While you are executing an ALTER TABLE statement, the table is + locked from being used by other threads. This has to do with + the fact that on Windows, you can't delete a file that is in + use by another thread. In the future, we may find some way to + work around this problem. + + * DROP TABLE + DROP TABLE on a table that is in use by a MERGE table does not + work on Windows because the MERGE handler does the table + mapping hidden from the upper layer of MySQL. Because Windows + does not allow dropping files that are open, you first must + flush all MERGE tables (with FLUSH TABLES) or drop the MERGE + table before dropping the table. + + * DATA DIRECTORY and INDEX DIRECTORY + The DATA DIRECTORY and INDEX DIRECTORY options for CREATE + TABLE are ignored on Windows, because Windows doesn't support + symbolic links. These options also are ignored on systems that + have a non-functional realpath() call. + + * DROP DATABASE + You cannot drop a database that is in use by some thread. + + * Case-insensitive names + File names are not case sensitive on Windows, so MySQL + database and table names are also not case sensitive on + Windows. The only restriction is that database and table names + must be specified using the same case throughout a given + statement. See Section 8.2.2, "Identifier Case Sensitivity." + + * The "\" path name separator character + Path name components in Windows are separated by the "\" + character, which is also the escape character in MySQL. If you + are using LOAD DATA INFILE or SELECT ... INTO OUTFILE, use + Unix-style file names with "/" characters: +mysql> LOAD DATA INFILE 'C:/tmp/skr.txt' INTO TABLE skr; +mysql> SELECT * INTO OUTFILE 'C:/tmp/skr.txt' FROM skr; + Alternatively, you must double the "\" character: +mysql> LOAD DATA INFILE 'C:\\tmp\\skr.txt' INTO TABLE skr; +mysql> SELECT * INTO OUTFILE 'C:\\tmp\\skr.txt' FROM skr; + + * Problems with pipes + Pipes do not work reliably from the Windows command-line + prompt. If the pipe includes the character ^Z / CHAR(24), + Windows thinks that it has encountered end-of-file and aborts + the program. + This is mainly a problem when you try to apply a binary log as + follows: +C:\> mysqlbinlog binary_log_file | mysql --user=root + If you have a problem applying the log and suspect that it is + because of a ^Z / CHAR(24) character, you can use the + following workaround: +C:\> mysqlbinlog binary_log_file --result-file=/tmp/bin.sql +C:\> mysql --user=root --execute "source /tmp/bin.sql" + The latter command also can be used to reliably read in any + SQL file that may contain binary data. + + * Access denied for user error + If MySQL cannot resolve your host name properly, you may get + the following error when you attempt to run a MySQL client + program to connect to a server running on the same machine: +Access denied for user 'some_user'@'unknown' +to database 'mysql' + To fix this problem, you should create a file named + \windows\hosts containing the following information: +127.0.0.1 localhost + + Here are some open issues for anyone who might want to help us + improve MySQL on Windows: + + * Add macros to use the faster thread-safe increment/decrement + methods provided by Windows. + +2.4. Installing MySQL from RPM Packages on Linux + + The recommended way to install MySQL on RPM-based Linux + distributions is by using the RPM packages. The RPMs that we + provide to the community should work on all versions of Linux that + support RPM packages and use glibc 2.3. To obtain RPM packages, + see Section 2.1.3, "How to Get MySQL." + + For non-RPM Linux distributions, you can install MySQL using a + .tar.gz package. See Section 2.9, "Installing MySQL from tar.gz + Packages on Other Unix-Like Systems." + + We do provide some platform-specific RPMs; the difference between + a platform-specific RPM and a generic RPM is that a + platform-specific RPM is built on the targeted platform and is + linked dynamically whereas a generic RPM is linked statically with + LinuxThreads. + +Note + + RPM distributions of MySQL often are provided by other vendors. Be + aware that they may differ in features and capabilities from those + built by us, and that the instructions in this manual do not + necessarily apply to installing them. The vendor's instructions + should be consulted instead. + + If you have problems with an RPM file (for example, if you receive + the error Sorry, the host 'xxxx' could not be looked up), see + Section 2.13.1.2, "Linux Binary Distribution Notes." + + In most cases, you need to install only the MySQL-server and + MySQL-client packages to get a functional MySQL installation. The + other packages are not required for a standard installation. + + RPMs for MySQL Cluster. Beginning with MySQL 5.1.24, standard + MySQL server RPMs built by MySQL no longer provide support for the + NDBCLUSTER storage engine. MySQL Cluster users wanting to upgrade + MySQL 5.1.23 or earlier installations from RPMs built by MySQL + should upgrade to MySQL Cluster NDB 6.2 or MySQL Cluster NDB 6.3; + RPMs that should work with most Linux distributions are available + for both of these release series. + +Important + + When upgrading a MySQL Cluster RPM installation, you must upgrade + all installed RPMs, including the Server and Client RPMs. + + For more information about installing MySQL Cluster from RPMs, see + Section 17.2.2, "MySQL Cluster Multi-Computer Installation." + + For upgrades, if your installation was originally produced by + installing multiple RPM packages, it is best to upgrade all the + packages, not just some. For example, if you previously installed + the server and client RPMs, do not upgrade just the server RPM. + + If you get a dependency failure when trying to install MySQL + packages (for example, error: removing these packages would break + dependencies: libmysqlclient.so.10 is needed by ...), you should + also install the MySQL-shared-compat package, which includes both + the shared libraries for backward compatibility + (libmysqlclient.so.12 for MySQL 4.0 and libmysqlclient.so.10 for + MySQL 3.23). + + Some Linux distributions still ship with MySQL 3.23 and they + usually link applications dynamically to save disk space. If these + shared libraries are in a separate package (for example, + MySQL-shared), it is sufficient to simply leave this package + installed and just upgrade the MySQL server and client packages + (which are statically linked and do not depend on the shared + libraries). For distributions that include the shared libraries in + the same package as the MySQL server (for example, Red Hat Linux), + you could either install our 3.23 MySQL-shared RPM, or use the + MySQL-shared-compat package instead. (Do not install both.) + + The RPM packages shown in the following list are available. The + names shown here use a suffix of .glibc23.i386.rpm, but particular + packages can have different suffixes, as described later. + + * MySQL-server-VERSION.glibc23.i386.rpm + The MySQL server. You need this unless you only want to + connect to a MySQL server running on another machine. + + * MySQL-client-VERSION.glibc23.i386.rpm + The standard MySQL client programs. You probably always want + to install this package. + + * MySQL-devel-VERSION.glibc23.i386.rpm + The libraries and include files that are needed if you want to + compile other MySQL clients, such as the Perl modules. + + * MySQL-debuginfo-VERSION.glibc23.i386.rpm + This package contains debugging information. debuginfo RPMs + are never needed to use MySQL software; this is true both for + the server and for client programs. However, they contain + additional information that might be needed by a debugger to + analyze a crash. + + * MySQL-shared-VERSION.glibc23.i386.rpm + This package contains the shared libraries + (libmysqlclient.so*) that certain languages and applications + need to dynamically load and use MySQL. It contains + single-threaded and thread-safe libraries. If you install this + package, do not install the MySQL-shared-compat package. + + * MySQL-shared-compat-VERSION.glibc23.i386.rpm + This package includes the shared libraries for MySQL 3.23, + 4.0, 4.1, and 5.1. It contains single-threaded and thread-safe + libraries. Install this package instead of MySQL-shared if you + have applications installed that are dynamically linked + against older versions of MySQL but you want to upgrade to the + current version without breaking the library dependencies. + + * MySQL-embedded-VERSION.glibc23.i386.rpm + The embedded MySQL server library. + + * MySQL-ndb-management-VERSION.glibc23.i386.rpm, + MySQL-ndb-storage-VERSION.glibc23.i386.rpm, + MySQL-ndb-tools-VERSION.glibc23.i386.rpm, + MySQL-ndb-extra-VERSION.glibc23.i386.rpm + Packages that contain additional files for MySQL Cluster + installations. + +Note + The MySQL-ndb-tools RPM requires a working installation of + perl. Prior to MySQL 5.1.18, the DBI and HTML::Template + packages were also required. See Section 2.15, "Perl + Installation Notes," and Section 17.9.15, "ndb_size.pl --- + NDBCLUSTER Size Requirement Estimator," for more information. + + * MySQL-test-VERSION.glibc23.i386.rpm + This package includes the MySQL test suite. + + * MySQL-VERSION.src.rpm + This contains the source code for all of the previous + packages. It can also be used to rebuild the RPMs on other + architectures (for example, Alpha or SPARC). + + The suffix of RPM package names (following the VERSION value) has + the following syntax: +.PLATFORM.CPU.rpm + + The PLATFORM and CPU values indicate the type of system for which + the package is built. PLATFORM indicates the platform and CPU + indicates the processor type or family. + + All packages are dynamically linked against glibc 2.3. The + PLATFORM value indicates whether the package is platform + independent or intended for a specific platform, as shown in the + following table. + glibc23 Platform independent, should run on any Linux distribution + that supports glibc 2.3 + rhel3, rhel4 Red Hat Enterprise Linux 3 or 4 + sles9, sles10 SuSE Linux Enterprise Server 9 or 10 + + In MySQL 5.1, only glibc23 packages are available currently. + + The CPU value indicates the processor type or family for which the + package is built. + i386 x86 processor, 386 and up + i586 x86 processor, Pentium and up + x86_64 64-bit x86 processor + ia64 Itanium (IA-64) processor + + To see all files in an RPM package (for example, a MySQL-server + RPM), run a command like this: +shell> rpm -qpl MySQL-server-VERSION.glibc23.i386.rpm + + To perform a standard minimal installation, install the server and + client RPMs: +shell> rpm -i MySQL-server-VERSION.glibc23.i386.rpm +shell> rpm -i MySQL-client-VERSION.glibc23.i386.rpm + + To install only the client programs, install just the client RPM: +shell> rpm -i MySQL-client-VERSION.glibc23.i386.rpm + + RPM provides a feature to verify the integrity and authenticity of + packages before installing them. If you would like to learn more + about this feature, see Section 2.1.4, "Verifying Package + Integrity Using MD5 Checksums or GnuPG." + + The server RPM places data under the /var/lib/mysql directory. The + RPM also creates a login account for a user named mysql (if one + does not exist) to use for running the MySQL server, and creates + the appropriate entries in /etc/init.d/ to start the server + automatically at boot time. (This means that if you have performed + a previous installation and have made changes to its startup + script, you may want to make a copy of the script so that you + don't lose it when you install a newer RPM.) See Section 2.11.2.2, + "Starting and Stopping MySQL Automatically," for more information + on how MySQL can be started automatically on system startup. + + If you want to install the MySQL RPM on older Linux distributions + that do not support initialization scripts in /etc/init.d + (directly or via a symlink), you should create a symbolic link + that points to the location where your initialization scripts + actually are installed. For example, if that location is + /etc/rc.d/init.d, use these commands before installing the RPM to + create /etc/init.d as a symbolic link that points there: +shell> cd /etc +shell> ln -s rc.d/init.d . + + However, all current major Linux distributions should support the + new directory layout that uses /etc/init.d, because it is required + for LSB (Linux Standard Base) compliance. + + If the RPM files that you install include MySQL-server, the mysqld + server should be up and running after installation. You should be + able to start using MySQL. + + If something goes wrong, you can find more information in the + binary installation section. See Section 2.9, "Installing MySQL + from tar.gz Packages on Other Unix-Like Systems." + +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." + + During RPM installation, a user named mysql and a group named + mysql are created on the system. This is done using the useradd, + groupadd, and usermod commands. Those commands require appropriate + administrative privileges, which is ensured for locally managed + users and groups (as listed in the /etc/passwd and /etc/group + files) by the RPM installation process being run by root. + + For non-local user management (LDAP, NIS, and so forth), the + administrative tools may require additional authentication (such + as a password), and will fail if the installing user does not + provide this authentication. Even if they fail, the RPM + installation will not abort but succeed, and this is intentional. + If they failed, some of the intended transfer of ownership may be + missing, and it is recommended that the system administrator then + manually ensures some appropriate user andgroup exists and + manually transfers ownership following the actions in the RPM spec + file. + +2.5. Installing MySQL on Mac OS X + + 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 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. + +2.6. Installing MySQL on Solaris + + If you install MySQL using a binary tarball distribution on + Solaris, you may run into trouble even before you get the MySQL + distribution unpacked, as the Solaris tar cannot handle long file + names. This means that you may see errors when you try to unpack + MySQL. + + If this occurs, you must use GNU tar (gtar) to unpack the + distribution. You can find a precompiled copy for Solaris at + http://dev.mysql.com/downloads/os-solaris.html. + + You can install MySQL on Solaris using a binary package in PKG + format instead of the binary tarball distribution. Before + installing using the binary PKG format, you should create the + mysql user and group, for example: +groupadd mysql +useradd -g mysql mysql + + Some basic PKG-handling commands follow: + + * To add a package: +pkgadd -d package_name.pkg + + * To remove a package: +pkgrm package_name + + * To get a full list of installed packages: +pkginfo + + * To get detailed information for a package: +pkginfo -l package_name + + * To list the files belonging to a package: +pkgchk -v package_name + + * To get packaging information for an arbitrary file: +pkgchk -l -p file_name + + For additional information about installing MySQL on Solaris, see + Section 2.13.3, "Solaris Notes." + +2.7. Installing MySQL on i5/OS + + The i5/OS POWER MySQL package was created in cooperation with IBM. + MySQL works within the Portable Application Solution Environment + (PASE) on the System i series of hardware and will also provide + database services for the Zend Core for i5/OS. + + MySQL for i5/OS is provided as a save file (.savf) package that + can be downloaded and installed directly without any additional + installation steps required. + + MySQL is only supported on i5/OS V5R4 or later releases. The i5/OS + PASE must be installed for MySQL to operate. You must be able to + login as a user in *SECOFR class. + + You should the installation notes and tips for i5/OS before + starting installation. See i5/OS Installation Notes. + +Note + + The installation package will use an existing configuration if you + have previously installed MySQL (which is identified by looking + for the file /etc/my.cnf). The values for the data directory + (DATADIR) and owner of the MySQL files (USRPRF) specified during + the installation will be ignored, and the values determined from + the /etc/my.cnf will be used instead. + + If you want to change these parameters during a new install, you + should temporarily rename /etc/my.cnf, install MySQL using the new + parameters you want to use, and then merge your previous + /etc/my.cnf configuration settings with the new /etc/my.cnf file + that is created during installation. + + To install MySQL on i5/OS, follow these steps: + + 1. Create a user profile MYSQL. The MYSQL user profile will own + all the MySQL files and databases and be the active user used + when the MySQL server is running. The profile should be + disabled so that you cannot log in as the MySQL user. To + create a user profile, use CRTUSRPRF: +CRTUSRPRF USRPRF(MYSQL) STATUS(*DISABLED) TEXT('MySQL user id') + + 2. On the System i machine, create a save file that will be used + to receive the downloaded installation save file. The file + should be located within the General Purpose Library (QGPL): +CRTSAVF FILE(QGPL/MYSQLINST) + + 3. Download the MySQL installation save file in 32-bit + (mysql-5.0.42-i5os-power-32bit.savf) or 64-bit + (mysql-5.0.42-i5os-power-64bit.savf) from MySQL Downloads + (http://dev.mysql.com/downloads). + + 4. You need to FTP the downloaded .savf file directly into the + QGPL/MYSQLINST file on the System i server. You can do this + through FTP using the following steps after logging in to the + System i machine: +ftp> bin +ftp> cd qgpl +ftp> put mysql-5.0.42-i5os-power.savf mysqlinst + + 5. Log into the System i server using a user in the *SECOFR + class, such as the QSECOFR user ID. + + 6. You need to restore the installation library stored in the + .savf save file: +RSTLIB MYSQLINST DEV(*SAVF) SAVF(QGPL/MYSQLINST) + + 7. You need to execute the installation command, + MYSQLINST/INSMYSQL. You can specify three parameter settings + during installation: + + + DIR('/opt/mysql') sets the installation location for the + MySQL files. The directory will be created if it does not + already exist. + + + DATADIR('/QOpenSys/mysal/data') sets the location of the + directory that will be used to store the database files + and binary logs. The default setting is + /QOpenSys/mysql/data. Note that if the installer detects + an existing installation (due to the existence of + /etc/my.cnf), then this parameter will be ignored. + + + USRPRF(MYSQL) sets the user profile that will own the + files that are installed. The profile will be created if + it does not already exist. + MySQL can be installed anywhere, for this example we will + assume MySQL has been installed into /opt/mysql. The MYSQL + user profile that was created earlier in this sequence should + be used for the profile: +MYSQLINST/INSMYSQL DIR('/opt/mysql') DATADIR('/opt/mysqldata') USRPRF +(MYSQL) + If you are updating an installation over an existing MySQL + installation, you should use the same parameter values that + were used when MySQL was originally installed. + The installation copies all the necessary files into a + directory matching the package version (for example + mysql-5.0.42-i5os-power-32bit), sets the ownership on those + files, sets up the MySQL environment and creates the MySQL + configuration file (in /etc/my.cnf) completing all the steps + in a typical binary installation process automatically. If + this is a new installation of MySQL, or if the installer + detects that this is a new version (because the /etc/my.cnf + file does not exist), then the initial core MySQL databases + will also be created during installation. + + 8. Once the installation has completed, you can delete the + installation file: +DLTLIB LIB(MYSQLINST) + + To start MySQL: + + 1. Log into the System i server using a user within the *SECOFR + class, such as the QSECOFR user ID. + +Note + You should start mysqld_safe using a user that in the PASE + environment has the id=0 (the equivalent of the standard Unix + root user). If you do not use a user with this ID then the + system will be unable to change the user when executing mysqld + as set using --user option. If this happens, mysqld may be + unable to read the files located within the MySQL data + directory and the execution will fail. + + 2. Enter the PASE environment using call qp2term. + + 3. Start the MySQL server by changing to the installation + directory and running mysqld_safe, specifying the user name + used to install the server. The installer conveniently + installs a symbolic link to the installation directory + (mysql-5.0.42-i5os-power-32bit) as /opt/mysql/mysql: +> cd /opt/mysql/mysql +> bin/mysqld_safe --user=mysql & + You should see a message similar to the following: +Starting mysqld daemon with databases » + from /opt/mysql/mysql-enterprise-5.0.42-i5os-power-32bit/data + + If you are having problems starting MySQL server, see Section + 2.11.2.3, "Starting and Troubleshooting the MySQL Server." + + To stop MySQL: + + 1. Log into the System i server using the *SECOFR class, such as + the QSECOFR user ID. + + 2. Enter the PASE environment using call qp2term. + + 3. Stop the MySQL server by changing into the installation + directory and running mysqladmin, specifying the user name + used to install the server: +> cd /opt/mysql/mysql +> bin/mysqladmin -u root shutdown + If the session that you started and stopped MySQL are the + same, you may get the log output from mysqld: + STOPPING server from pid file » + /opt/mysql/mysql-enterprise-5.0.42-i5os-power-32bit/data/I5DBX.R +CHLAND.IBM.COM.pid + 070718 10:34:20 mysqld ended + If the sessions used to start and stop MySQL are different, + you will not receive any confirmation of the shutdown. + + Note and tips + + * A problem has been identified with the installation process on + DBCS systems. If you are having problems install MySQL on a + DBCS system, you need to change your job's coded character set + identifier (CSSID) to 37 (EBCDIC) before executing the install + command, INSMYSQL. To do this, determine your existing CSSID + (using DSPJOB and selecting option 2), execute CHGJOB + CSSID(37), run INSMYSQL to install MySQL and then execute + CHGJOB again with your original CSSID. + + * If you want to use the Perl scripts that are included with + MySQL, you need to download the iSeries Tools for Developers + (5799-PTL). See + http://www-03.ibm.com/servers/enable/site/porting/tools/. + +2.8. Installing MySQL on NetWare + + Porting MySQL to NetWare was an effort spearheaded by Novell. + Novell customers should be pleased to note that NetWare 6.5 ships + with bundled MySQL binaries, complete with an automatic commercial + use license for all servers running that version of NetWare. + + MySQL for NetWare is compiled using a combination of Metrowerks + CodeWarrior for NetWare and special cross-compilation versions of + the GNU autotools. + + The latest binary packages for NetWare can be obtained at + http://dev.mysql.com/downloads/. See Section 2.1.3, "How to Get + MySQL." + + To host MySQL, the NetWare server must meet these requirements: + + * The latest Support Pack of NetWare 6.5 + (http://support.novell.com/filefinder/18197/index.html) must + be installed. + + * The system must meet Novell's minimum requirements to run the + respective version of NetWare. + + * MySQL data and the program binaries must be installed on an + NSS volume; traditional volumes are not supported. + + To install MySQL for NetWare, use the following procedure: + + 1. If you are upgrading from a prior installation, stop the MySQL + server. This is done from the server console, using the + following command: +SERVER: mysqladmin -u root shutdown + +Note + If the MySQL root user account has a password, you need to + invoke mysqladmin with the -p option and supply the password + when prompted. + + 2. Log on to the target server from a client machine with access + to the location where you are installing MySQL. + + 3. Extract the binary package Zip file onto the server. Be sure + to allow the paths in the Zip file to be used. It is safe to + simply extract the file to SYS:\. + If you are upgrading from a prior installation, you may need + to copy the data directory (for example, SYS:MYSQL\DATA), as + well as my.cnf, if you have customized it. You can then delete + the old copy of MySQL. + + 4. You might want to rename the directory to something more + consistent and easy to use. The examples in this manual use + SYS:MYSQL to refer to the installation directory. + Note that MySQL installation on NetWare does not detect if a + version of MySQL is already installed outside the NetWare + release. Therefore, if you have installed the latest MySQL + version from the Web (for example, MySQL 4.1 or later) in + SYS:\MYSQL, you must rename the folder before upgrading the + NetWare server; otherwise, files in SYS:\MySQL are overwritten + by the MySQL version present in NetWare Support Pack. + + 5. At the server console, add a search path for the directory + containing the MySQL NLMs. For example: +SERVER: SEARCH ADD SYS:MYSQL\BIN + + 6. Initialize the data directory and the grant tables, if + necessary, by executing mysql_install_db at the server + console. + + 7. Start the MySQL server using mysqld_safe at the server + console. + + 8. To finish the installation, you should also add the following + commands to autoexec.ncf. For example, if your MySQL + installation is in SYS:MYSQL and you want MySQL to start + automatically, you could add these lines: +#Starts the MySQL 5.1.x database server +SEARCH ADD SYS:MYSQL\BIN +MYSQLD_SAFE + If you are running MySQL on NetWare 6.0, we strongly suggest + that you use the --skip-external-locking option on the command + line: +#Starts the MySQL 5.1.x database server +SEARCH ADD SYS:MYSQL\BIN +MYSQLD_SAFE --skip-external-locking + It is also necessary to use CHECK TABLE and REPAIR TABLE + instead of myisamchk, because myisamchk makes use of external + locking. External locking is known to have problems on NetWare + 6.0; the problem has been eliminated in NetWare 6.5. Note that + the use of MySQL on Netware 6.0 is not officially supported. + mysqld_safe on NetWare provides a screen presence. When you + unload (shut down) the mysqld_safe NLM, the screen does not go + away by default. Instead, it prompts for user input: +*<NLM has terminated; Press any key to close the screen>* + If you want NetWare to close the screen automatically instead, + use the --autoclose option to mysqld_safe. For example: +#Starts the MySQL 5.1.x database server +SEARCH ADD SYS:MYSQL\BIN +MYSQLD_SAFE --autoclose + The behavior of mysqld_safe on NetWare is described further in + Section 4.3.2, "mysqld_safe --- MySQL Server Startup Script." + + 9. When installing MySQL, either for the first time or upgrading + from a previous version, download and install the latest and + appropriate Perl module and PHP extensions for NetWare: + + + Perl: + http://forge.novell.com/modules/xfcontent/downloads.php/p + erl/Modules/ + + + PHP: + http://forge.novell.com/modules/xfcontent/downloads.php/p + hp/Modules/ + + If there was an existing installation of MySQL on the NetWare + server, be sure to check for existing MySQL startup commands in + autoexec.ncf, and edit or delete them as necessary. + +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." + +2.9. Installing MySQL from tar.gz Packages on Other Unix-Like Systems + + 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. + + 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." + +2.10. MySQL Installation Using a Source Distribution + + Before you proceed with an installation from source, first check + whether our binary is available for your platform and whether it + works for you. We put a great deal of effort into ensuring that + our binaries are built with the best possible options. + + To obtain a source distribution for MySQL, Section 2.1.3, "How to + Get MySQL." If you want to build MySQL from source on Windows, see + Section 2.10.6, "Installing MySQL from Source on Windows." + + MySQL source distributions are provided as compressed tar archives + and have names of the form mysql-VERSION.tar.gz, where VERSION is + a number like 5.1.35. + + You need the following tools to build and install MySQL from + source: + + * 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. + + * A working ANSI C++ compiler. gcc 2.95.2 or later, SGI C++, and + SunPro C++ are some of the compilers that are known to work. + libg++ is not needed when using gcc. gcc 2.7.x has a bug that + makes it impossible to compile some perfectly legal C++ files, + such as sql/sql_base.cc. If you have only gcc 2.7.x, you must + upgrade your gcc to be able to compile MySQL. gcc 2.8.1 is + also known to have problems on some platforms, so it should be + avoided if a newer compiler exists for the platform. gcc + 2.95.2 or later is recommended. + + * A good make program. GNU make is always recommended and is + sometimes required. (BSD make fails, and vendor-provided make + implementations may fail as well.) If you have problems, we + recommend GNU make 3.75 or newer. + + * libtool 1.5.24 or later is also recommended. + + If you are using a version of gcc recent enough to understand the + -fno-exceptions option, it is very important that you use this + option. Otherwise, you may compile a binary that crashes randomly. + We also recommend that you use -felide-constructors and -fno-rtti + along with -fno-exceptions. When in doubt, do the following: +CFLAGS="-O3" CXX=gcc CXXFLAGS="-O3 -felide-constructors \ + -fno-exceptions -fno-rtti" ./configure \ + --prefix=/usr/local/mysql --enable-assembler \ + --with-mysqld-ldflags=-all-static + + On most systems, this gives you a fast and stable binary. + + 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." + +2.10.1. Source Installation Overview + + The basic commands that you must execute to install a MySQL source + distribution are: +shell> groupadd mysql +shell> useradd -g mysql mysql +shell> gunzip < mysql-VERSION.tar.gz | tar -xvf - +shell> cd mysql-VERSION +shell> ./configure --prefix=/usr/local/mysql +shell> make +shell> make install +shell> cp support-files/my-medium.cnf /etc/my.cnf +shell> cd /usr/local/mysql +shell> chown -R mysql . +shell> chgrp -R mysql . +shell> bin/mysql_install_db --user=mysql +shell> chown -R root . +shell> chown -R mysql var +shell> bin/mysqld_safe --user=mysql & + + If you start from a source RPM, do the following: +shell> rpmbuild --rebuild --clean MySQL-VERSION.src.rpm + + This makes a binary RPM that you can install. For older versions + of RPM, you may have to replace the command rpmbuild with rpm + instead. + +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," for post-installation setup + and testing. + + A more detailed version of the preceding description for + installing MySQL from a source 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. Perform the following steps as the mysql user, except as + noted. + + 3. Pick the directory under which you want to unpack the + distribution and change location into it. + + 4. Obtain a distribution file using the instructions in Section + 2.1.3, "How to Get MySQL." + + 5. Unpack the distribution into the current directory: +shell> gunzip < /path/to/mysql-VERSION.tar.gz | tar xvf - + This command creates a directory named mysql-VERSION. + With GNU tar, no separate invocation of gunzip is necessary. + You can use the following alternative command to uncompress + and extract the distribution: +shell> tar zxvf /path/to/mysql-VERSION-OS.tar.gz + + 6. Change location into the top-level directory of the unpacked + distribution: +shell> cd mysql-VERSION + Note that currently you must configure and build MySQL from + this top-level directory. You cannot build it in a different + directory. + + 7. Configure the release and compile everything: +shell> ./configure --prefix=/usr/local/mysql +shell> make + When you run configure, you might want to specify other + options. Run ./configure --help for a list of options. Section + 2.10.2, "Typical configure Options," discusses some of the + more useful options. + If configure fails and you are going to send mail to a MySQL + mailing list to ask for assistance, please include any lines + from config.log that you think can help solve the problem. + Also include the last couple of lines of output from + configure. To file a bug report, please use the instructions + in Section 1.6, "How to Report Bugs or Problems." + If the compile fails, see Section 2.10.4, "Dealing with + Problems Compiling MySQL," for help. + + 8. Install the distribution: +shell> make install + You might need to run this command as root. + If you want to set up an option file, use one of those present + in the support-files directory as a template. For example: +shell> cp support-files/my-medium.cnf /etc/my.cnf + You might need to run this command as root. + If you want to configure support for InnoDB tables, you should + edit the /etc/my.cnf file, remove the # character before the + option lines that start with innodb_..., and modify the option + values to be what you want. See Section 4.2.3.2, "Using Option + Files," and Section 13.6.2, "InnoDB Configuration." + + 9. Change location into the installation directory: +shell> cd /usr/local/mysql + 10. If you ran the make install command as root, the installed + files will be owned by root. Ensure that the installation is + accessible 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. + 11. If you have not installed MySQL before, you must create the + MySQL data directory and initialize the grant tables: +shell> bin/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 mysql, you + can omit the --user option. + The command should create the data directory and its contents + with mysql as the owner. + After using mysql_install_db to create the grant tables for + MySQL, you must restart the server manually. The mysqld_safe + command to do this is shown in a later step. + 12. 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 var + 13. 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; see also Section 2.11.2.2, "Starting and + Stopping MySQL Automatically." + 14. 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." + + After everything has been installed, you should test your + distribution. To start the MySQL server, use the following + command: +shell> /usr/local/mysql/bin/mysqld_safe --user=mysql & + + If you run the command as root, you should 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 that user, 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." + +2.10.2. Typical configure Options + + The configure script gives you a great deal of control over how + you configure a MySQL source distribution. Typically you do this + using options on the configure command line. You can also affect + configure using certain environment variables. See Section 2.14, + "Environment Variables." For a full list of options supported by + configure, run this command: +shell> ./configure --help + + A list of the available configure options is provided in the table + below. + + Table 2.1. Build (configure) Reference + Formats Description Default Introduced Removed + --bindir=DIR User executables EPREFIX/bin + --build=BUILD Configure for building on BUILD guessed + --cache-file=FILE Cache test results in FILE disabled + -C Alias for `--cache-file=config.cache' + --config-cache + --datadir=DIR Read-only architecture-independent data PREFIX/share + + --disable-FEATURE Do not include FEATURE + --disable-dependency-tracking Disable dependency tracking + --disable-grant-options Disable GRANT options + --disable-largefile Omit support for large files + --disable-libtool-lock Disable libtool lock + --disable-thread-safe-client Compile the client without threads + 5.1.7 + --enable-FEATURE Enable FEATURE + --enable-assembler Use assembler versions of some string functions + if available + --enable-dependency-tracking Do not reject slow dependency + extractors + --enable-fast-install Optimize for fast installation yes + --enable-local-infile Enable LOAD DATA LOCAL INFILE disabled + --enable-shared Build shared libraries yes + --enable-static Build static libraries yes + --enable-thread-safe-client Compile the client with threads + --exec-prefix=EPREFIX Install architecture-dependent files in + EPREFIX + -h Display this help and exit + --help + --help=short Display options specific to this package + --help=recursive Display the short help of all the included + packages + --host=HOST Cross-compile to build programs to run on HOST + --includedir=DIR C header files PREFIX/include + --infodir=DIR Info documentation PREFIX/info + --libdir=DIR Object code libraries EPREFIX/lib + --libexecdir=DIR Program executables EPREFIX/libexec + --localstatedir=DIR Modifiable single-machine data PREFIX/var + --mandir=DIR man documentation PREFIX/man + -n Do not create output files + --no-create + --oldincludedir=DIR C header files for non-gcc /usr/include + --prefix=PREFIX Install architecture-independent files in PREFIX + + --program-prefix=PREFIX Prepend PREFIX to installed program names + + --program-suffix=SUFFIX Append SUFFIX to installed program names + + --program-transform-name=PROGRAM run sed PROGRAM on installed + program names + -q Do not print `checking...' messages + --quiet + --sbindir=DIR System admin executables EPREFIX/sbin + --sharedstatedir=DIR Modifiable architecture-independent data + PREFIX/com + --srcdir=DIR Find the sources in DIR configure directory or .. + --sysconfdir=DIR Read-only single-machine data PREFIX/etc + --target=TARGET Configure for building compilers for TARGET + -V Display version information and exit + --version + --with-PACKAGE Use PACKAGE + --with-archive-storage-engine Enable the Archive Storage Engine no + + --with-atomic-ops Implement atomic operations using pthread + rwlocks or atomic CPU instructions for multi-processor 5.1.12 + --with-berkeley-db Use BerkeleyDB located in DIR no + --with-berkeley-db-includes Find Berkeley DB headers in DIR + --with-berkeley-db-libs Find Berkeley DB libraries in DIR + --with-big-tables Support tables with more than 4 G rows even on + 32 bit platforms + --with-blackhole-storage-engine Enable the Blackhole Storage + Engine no + --with-charset Default character set + --with-client-ldflags Extra linking arguments for clients + --with-collation Default collation + --with-comment Comment about compilation environment + --with-csv-storage-engine Enable the CSV Storage Engine yes + --with-darwin-mwcc Use Metrowerks CodeWarrior wrappers on OS + X/Darwin + --with-debug Add debug code 5.1.7 + --with-debug=full Add debug code (adds memory checker, very slow) + + --with-embedded-privilege-control Build parts to check user's + privileges (only affects embedded library) + --with-embedded-server Build the embedded server + --with-error-inject Enable error injection in MySQL Server + 5.1.11 + --with-example-storage-engine Enable the Example Storage Engine no + + --with-extra-charsets Use charsets in addition to default + --with-fast-mutexes Compile with fast mutexes enabled 5.1.5 + --with-federated-storage-engine Enable federated storage engine no + 5.1.3 5.1.9 + --with-gnu-ld Assume the C compiler uses GNU ld no + --with-innodb Enable innobase storage engine no 5.1.3 5.1.9 + --with-lib-ccflags Extra CC options for libraries + --with-libwrap=DIR Compile in libwrap (tcp_wrappers) support + --with-low-memory Try to use less memory to compile to avoid + memory limitations + --with-machine-type Set the machine type, like "powerpc" + --with-max-indexes=N Sets the maximum number of indexes per table + 64 + --with-mysqld-ldflags Extra linking arguments for mysqld + --with-mysqld-libs Extra libraries to link with for mysqld + --with-mysqld-user What user the mysqld daemon shall be run as + + --with-mysqlmanager Build the mysqlmanager binary Build if server + is built + --with-named-curses-libs Use specified curses libraries + --with-named-thread-libs Use specified thread libraries + --with-ndb-ccflags Extra CC options for ndb compile + --with-ndb-docs Include the NDB Cluster ndbapi and mgmapi + documentation + --with-ndb-port Port for NDB Cluster management server + --with-ndb-port-base Port for NDB Cluster management server + --with-ndb-sci=DIR Provide MySQL with a custom location of sci + library + --with-ndb-test Include the NDB Cluster ndbapi test programs + --with-ndbcluster Include the NDB Cluster table handler no + --with-openssl=DIR Include the OpenSSL support + --with-openssl-includes Find OpenSSL headers in DIR + --with-openssl-libs Find OpenSSL libraries in DIR + --with-other-libc=DIR Link against libc and other standard + libraries installed in the specified non-standard location + --with-pic Try to use only PIC/non-PIC objects Use both + --with-plugin-PLUGIN Forces the named plugin to be linked into + mysqld statically 5.1.11 + --with-plugins Plugins to include in mysqld none 5.1.11 + --with-pstack Use the pstack backtrace library + --with-pthread Force use of pthread library + --with-row-based-replication Include row-based replication 5.1.5 + 5.1.6 + --with-server-suffix Append value to the version string + --with-ssl=DIR Include SSL support 5.1.11 + --with-system-type Set the system type, like "sun-solaris10" + --with-tags Include additional configurations automatic + --with-tcp-port Which port to use for MySQL services 3306 + --with-unix-socket-path Where to put the unix-domain socket + --with-yassl Include the yaSSL support + --with-zlib-dir=no|bundled|DIR Provide MySQL with a custom + location of compression library + --without-PACKAGE Do not use PACKAGE + --without-bench Skip building of the benchmark suite + --without-debug Build a production version without debugging code + + --without-docs Skip building of the documentation + --without-extra-tools Skip building utilities in the tools + directory + --without-geometry Do not build geometry-related parts + --without-libedit Use system libedit instead of bundled copy + --without-man Skip building of the man pages + --without-ndb-binlog Disable ndb binlog 5.1.6 + --without-ndb-debug Disable special ndb debug features + --without-plugin-PLUGIN Exclude PLUGIN 5.1.11 + --without-query-cache Do not build query cache + --without-readline Use system readline instead of bundled copy + + --without-row-based-replication Don't include row-based + replication 5.1.7 5.1.14 + --without-server Only build the client + --without-uca Skip building of the national Unicode collations + + Some of the configure options available are described here. For + options that may be of use if you have difficulties building + MySQL, see Section 2.10.4, "Dealing with Problems Compiling + MySQL." + + * To compile just the MySQL client libraries and client programs + and not the server, use the --without-server option: +shell> ./configure --without-server + If you have no C++ compiler, some client programs such as + mysql cannot be compiled because they require C++.. In this + case, you can remove the code in configure that tests for the + C++ compiler and then run ./configure with the + --without-server option. The compile step should still try to + build all clients, but you can ignore any warnings about files + such as mysql.cc. (If make stops, try make -k to tell it to + continue with the rest of the build even if errors occur.) + + * If you want to build the embedded MySQL library (libmysqld.a), + use the --with-embedded-server option. + + * If you don't want your log files and database directories + located under /usr/local/var, use a configure command + something like one of these: +shell> ./configure --prefix=/usr/local/mysql +shell> ./configure --prefix=/usr/local \ + --localstatedir=/usr/local/mysql/data + The first command changes the installation prefix so that + everything is installed under /usr/local/mysql rather than the + default of /usr/local. The second command preserves the + default installation prefix, but overrides the default + location for database directories (normally /usr/local/var) + and changes it to /usr/local/mysql/data. + You can also specify the installation directory and data + directory locations at server startup time by using the + --basedir and --datadir options. These can be given on the + command line or in an MySQL option file, although it is more + common to use an option file. See Section 4.2.3.2, "Using + Option Files." + + * If you are using Unix and you want the MySQL socket file + location to be somewhere other than the default location + (normally in the directory /tmp or /var/run), use a configure + command like this: +shell> ./configure \ + --with-unix-socket-path=/usr/local/mysql/tmp/mysql.sock + The socket file name must be an absolute path name. You can + also change the location of mysql.sock at server startup by + using a MySQL option file. See Section B.1.4.5, "How to + Protect or Change the MySQL Unix Socket File." + + * If you want to compile statically linked programs (for + example, to make a binary distribution, to get better + performance, or to work around problems with some Red Hat + Linux distributions), run configure like this: +shell> ./configure --with-client-ldflags=-all-static \ + --with-mysqld-ldflags=-all-static + + * If you are using gcc and don't have libg++ or libstdc++ + installed, you can tell configure to use gcc as your C++ + compiler: +shell> CC=gcc CXX=gcc ./configure + When you use gcc as your C++ compiler, it does not attempt to + link in libg++ or libstdc++. This may be a good thing to do + even if you have those libraries installed. Some versions of + them have caused strange problems for MySQL users in the past. + The following list indicates some compilers and environment + variable settings that are commonly used with each one. + + + gcc 2.7.2: +CC=gcc CXX=gcc CXXFLAGS="-O3 -felide-constructors" + + + gcc 2.95.2: +CFLAGS="-O3 -mpentiumpro" CXX=gcc CXXFLAGS="-O3 -mpentiumpro \ +-felide-constructors -fno-exceptions -fno-rtti" + + + pgcc 2.90.29 or newer: +CFLAGS="-O3 -mpentiumpro -mstack-align-double" CXX=gcc \ +CXXFLAGS="-O3 -mpentiumpro -mstack-align-double \ +-felide-constructors -fno-exceptions -fno-rtti" + In most cases, you can get a reasonably optimized MySQL binary + by using the options from the preceding list and adding the + following options to the configure line: +--prefix=/usr/local/mysql --enable-assembler \ +--with-mysqld-ldflags=-all-static + The full configure line would, in other words, be something + like the following for all recent gcc versions: +CFLAGS="-O3 -mpentiumpro" CXX=gcc CXXFLAGS="-O3 -mpentiumpro \ +-felide-constructors -fno-exceptions -fno-rtti" ./configure \ +--prefix=/usr/local/mysql --enable-assembler \ +--with-mysqld-ldflags=-all-static + The binaries we provide on the MySQL Web site at + http://dev.mysql.com/downloads/ are all compiled with full + optimization and should be perfect for most users. See Section + 2.1.2.4, "MySQL Binaries Compiled by Sun Microsystems, Inc.." + There are some configuration settings you can tweak to build + an even faster binary, but these are only for advanced users. + See Section 7.5.6, "How Compiling and Linking Affects the + Speed of MySQL." + If the build fails and produces errors about your compiler or + linker not being able to create the shared library + libmysqlclient.so.N (where N is a version number), you can + work around this problem by giving the --disable-shared option + to configure. In this case, configure does not build a shared + libmysqlclient.so.N library. + + * By default, MySQL uses the latin1 (cp1252 West European) + character set. To change the default set, use the + --with-charset option: +shell> ./configure --with-charset=CHARSET + CHARSET may be one of binary, armscii8, ascii, big5, cp1250, + cp1251, cp1256, cp1257, cp850, cp852, cp866, cp932, dec8, + eucjpms, euckr, gb2312, gbk, geostd8, greek, hebrew, hp8, + keybcs2, koi8r, koi8u, latin1, latin2, latin5, latin7, macce, + macroman, sjis, swe7, tis620, ucs2, ujis, utf8. See Section + 9.2, "The Character Set Used for Data and Sorting." + (Additional character sets might be available. Check the + output from ./configure --help for the current list.) + The default collation may also be specified. MySQL uses the + latin1_swedish_ci collation by default. To change this, use + the --with-collation option: +shell> ./configure --with-collation=COLLATION + To change both the character set and the collation, use both + the --with-charset and --with-collation options. The collation + must be a legal collation for the character set. (Use the SHOW + COLLATION statement to determine which collations are + available for each character set.) + +Warning + If you change character sets after having created any tables, + you must run myisamchk -r -q --set-collation=collation_name on + every MyISAM table. Your indexes may be sorted incorrectly + otherwise. This can happen if you install MySQL, create some + tables, and then reconfigure MySQL to use a different + character set and reinstall it. + With the configure option --with-extra-charsets=LIST, you can + define which additional character sets should be compiled into + the server. LIST is one of the following: + + + A list of character set names separated by spaces + + + complex to include all character sets that can't be + dynamically loaded + + + all to include all character sets into the binaries + Clients that want to convert characters between the server and + the client should use the SET NAMES statement. See Section + 5.1.4, "Session System Variables," and Section 9.1.4, + "Connection Character Sets and Collations." + + * To configure MySQL with debugging code, use the --with-debug + option: +shell> ./configure --with-debug + This causes a safe memory allocator to be included that can + find some errors and that provides output about what is + happening. See MySQL Internals: Porting + (http://forge.mysql.com/wiki/MySQL_Internals_Porting). + As of MySQL 5.1.12, using --with-debug to configure MySQL with + debugging support enables you to use the + --debug="d,parser_debug" option when you start the server. + This causes the Bison parser that is used to process SQL + statements to dump a parser trace to the server's standard + error output. Typically, this output is written to the error + log. + + * If your client programs are using threads, you must compile a + thread-safe version of the MySQL client library with the + --enable-thread-safe-client configure option. This creates a + libmysqlclient_r library with which you should link your + threaded applications. See Section 21.10.17, "How to Make a + Threaded Client." + + * Some features require that the server be built with + compression library support, such as the COMPRESS() and + UNCOMPRESS() functions, and compression of the client/server + protocol. The --with-zlib-dir=no|bundled|DIR option provides + control for compression library support. The value no + explicitly disables compression support. bundled causes the + zlib library bundled in the MySQL sources to be used. A DIR + path name specifies where to find the compression library + sources. + + * It is possible to build MySQL with large table support using + the --with-big-tables option. + This option causes the variables that store table row counts + to be declared as unsigned long long rather than unsigned + long. This enables tables to hold up to approximately + 1.844E+19 ((2^32)^2) rows rather than 2^32 (~4.295E+09) rows. + Previously it was necessary to pass -DBIG_TABLES to the + compiler manually in order to enable this feature. + + * Run configure with the --disable-grant-options option to cause + the --bootstrap, --skip-grant-tables, and --init-file options + for mysqld to be disabled. For Windows, the configure.js + script recognizes the DISABLE_GRANT_OPTIONS flag, which has + the same effect. The capability is available as of MySQL + 5.1.15. + + * This option allows MySQL Community Server features to be + enabled. Additional options may be required for individual + features, such as --enable-profiling to enable statement + profiling. This option was added in MySQL 5.1.24. It is + enabled by default as of MySQL 5.1.28; to disable it, use + --disable-community-features. + + * When given with --enable-community-features, the + --enable-profiling option enables the statement profiling + capability exposed by the SHOW PROFILE and SHOW PROFILES + statements. (See Section 12.5.5.33, "SHOW PROFILES Syntax.") + This option was added in MySQL 5.1.24. It is enabled by + default as of MySQL 5.1.28; to disable it, use + --disable-profiling. + + * See Section 2.13, "Operating System-Specific Notes," for + options that pertain to particular operating systems. + + * See Section 5.5.7.2, "Using SSL Connections," for options that + pertain to configuring MySQL to support secure (encrypted) + connections. + + * Several configure options apply to plugin selection and + building: +--with-plugins=PLUGIN[,PLUGIN]... +--with-plugins=GROUP +--with-plugin-PLUGIN +--without-plugin-PLUGIN + PLUGIN is an individual plugin name such as csv or archive. + As shorthand, GROUP is a configuration group name such as none + (select no plugins) or all (select all plugins). + You can build a plugin as static (compiled into the server) or + dynamic (built as a dynamic library that must be installed + using the INSTALL PLUGIN statement before it can be used). + Some plugins might not support static or dynamic build. + configure --help shows the following information pertaining to + plugins: + + + The plugin-related options + + + The names of all available plugins + + + For each plugin, a description of its purpose, which + build types it supports (static or dynamic), and which + plugin groups it is a part of. + --with-plugins can take a list of one or more plugin names + separated by commas, or a plugin group name. The named plugins + are configured to be built as static plugins. + --with-plugin-PLUGIN configures the given plugin to be built + as a static plugin. + --without-plugin-PLUGIN disables the given plugin from being + built. + If a plugin is named both with a --with and --without option, + the result is undefined. + For any plugin that is not explicitly selected or disabled, it + is selected to be built dynamically if it supports dynamic + build, and not built if it does not support dynamic build. + (Thus, in the case that no plugin options are given, all + plugins that support dynamic build are selected to be built as + dynamic plugins. Plugins that do not support dynamic build are + not built.) + +2.10.3. Installing from the Development Source Tree + +Caution + + You should read this section only if you are interested in helping + us test our new code. If you just want to get MySQL up and running + on your system, you should use a standard release distribution + (either a binary or source distribution). + + To obtain the most recent development source tree, you first need + to download and install Bazaar. You can obtain Bazaar from the + Bazaar VCS Website (http://bazaar-vcs.org). Bazaar is supported by + any platform that supports Python, and is therefore compatible + with any Linux, Unix, Windows or Mac OS X host. Instructions for + downloading and installing Bazaar on the different platforms are + available on the Bazaar website. + + All MySQL projects are hosted on Launchpad + (http://launchpad.net/). MySQL projects, including MySQL server, + MySQL Workbench and others are available from the Sun/MySQL + Engineering (http://launchpad.net/~mysql) page. For the + repositories related only to MySQL server, see the MySQL Server + (http://launchpad.net/mysql-server) page. + + To build under Unix/Linux, you must have the following tools + installed: + + * GNU make, available from http://www.gnu.org/software/make/. + Although some platforms come with their own make + implementations, it is highly recommended that you use GNU + make. It may already be available on your system as gmake. + + * autoconf 2.58 (or newer), available from + http://www.gnu.org/software/autoconf/. + + * automake 1.8.1, available from + http://www.gnu.org/software/automake/. + + * libtool 1.5, available from + http://www.gnu.org/software/libtool/. + + * m4, available from http://www.gnu.org/software/m4/. + + * bison, available from http://www.gnu.org/software/bison/. You + should use the latest version of bison where possible. Version + 1.75 and version 2.1 are known to work. There have been + reported problems with bison 1.875. If you experience + problems, upgrade to a later, rather than earlier, version. + Versions of bison older than 1.75 may report this error: +sql_yacc.yy:#####: fatal error: maximum table size (32767) exceeded + The maximum table size is not actually exceeded; the error is + caused by bugs in older versions of bison. + + To build under Windows you will need a copy of Microsoft Visual + C++ 2005 Express Edition, Visual Studio .Net 2003 (7.1), or Visual + Studio 2005 (8.0) compiler system. + + Once you have the necessary tools installed, you first need to + create a local branch of the MySQL source code on your machine: + + 1. To obtain a copy of the MySQL source code, you must create a + new Bazaar branch. If you do not already have a Bazaar + repository directory set up, you need to initialize a new + directory: +shell> mkdir mysql-server +shell> bzr init-repo --trees mysql-server + Once you have an initialized directory, you can branch from + the public MySQL server repositories. To create a branch of a + specific version: +shell> cd mysql-server +shell> bzr branch lp:mysql-server/5.1 mysql-5.1 + The initial download will take some time to complete, + depending on the speed of your connection. Please be patient. + Once you have downloaded the first tree, additional trees + should take significantly less time to download. + When building from the Bazaar branch, you may want to create a + copy of your active branch so that you can make configuration + and other changes without affecting the original branch + contents. You can achieve this by branching from the original + branch: +shell> bzr branch mysql-5.1 mysql-5.1-build + + Once you have the local branch, you can start to build MySQL + server from the source code. On Windows, the build process is + different from Unix/Linux. To continue building MySQL on Windows, + see Section 2.10.6, "Installing MySQL from Source on Windows." + + On Unix/Linux you need to use the autoconf system to create the + configure script so that you can configure the build environment + before building. + + 1. The following example shows the typical commands required to + configure a source tree. The first cd command changes location + into the top-level directory of the tree; replace mysql-5.1 + with the appropriate directory name. + +Note + For MySQL 5.1.12 and earlier, you must separately configure + the INNODB storage engine. You can do this by running the + following command from the main source directory: +shell> (cd storage/innobase; autoreconf --force --install) +shell> cd mysql-5.1 +shell> autoreconf --force --install +shell> ./configure # Add your favorite options here +shell> make + Or you can use BUILD/autorun.sh as a shortcut for the + following sequence of commands: +shell> aclocal; autoheader +shell> libtoolize --automake --force +shell> automake --force --add-missing; autoconf + The command line that changes directory into the + storage/innobase directory is used to configure the InnoDB + storage engine. You can omit this lines if you do not require + InnoDB support. + +Note + Beginning with MySQL 5.1, code specific to storage engines has + been moved under a storage directory. For example, InnoDB code + is now found in storage/innobase and NDBCLUSTER code is in + storage/ndb. + If you get some strange errors during this stage, verify that + you have the correct version of the libtool installed. + A collection of our standard configuration scripts is located + in the BUILD/ subdirectory. For example, you may find it more + convenient to use the BUILD/compile-pentium-debug script than + the preceding set of shell commands. To compile on a different + architecture, modify the script by removing flags that are + Pentium-specific, or use another script that may be more + appropriate. These scripts are provided on an "as-is" basis. + They are not officially maintained and their contents may + change from release to release. + + 2. When the build is done, run make install. Be careful with this + on a production machine; the command may overwrite your live + release installation. If you have another installation of + MySQL, we recommend that you run ./configure with different + values for the --prefix, --with-tcp-port, and + --with-unix-socket-path options than those used for your + production server. + + 3. Play hard with your new installation and try to make the new + features crash. Start by running make test. See Section + 22.1.2, "MySQL Test Suite." + + 4. If you have gotten to the make stage, but the distribution + does not compile, please enter the problem into our bugs + database using the instructions given in Section 1.6, "How to + Report Bugs or Problems." If you have installed the latest + versions of the required GNU tools, and they crash trying to + process our configuration files, please report that also. + However, if you execute aclocal and get a command not found + error or a similar problem, do not report it. Instead, make + sure that all the necessary tools are installed and that your + PATH variable is set correctly so that your shell can find + them. + + 5. After initially copying the repository with bzr to obtain the + source tree, you should use pull option to periodically update + your local copy. To do this any time after you have set up the + repository, use this command: +shell> bzr pull + + 6. You can examine the changeset comments for the tree by using + the log option to bzr: +shell> bzr log + You can also browse changesets, comments, and source code + online. To browse this information for MySQL 5.1, go to + http://launchpad.net/mysql-server/. + If you see diffs or code that you have a question about, do + not hesitate to send email to the MySQL internals mailing + list. See Section 1.5.1, "MySQL Mailing Lists." Also, if you + think you have a better idea on how to do something, send an + email message to the list with a patch. + +2.10.4. Dealing with Problems Compiling MySQL + + All MySQL programs compile cleanly for us with no warnings on + Solaris or Linux using gcc. On other systems, warnings may occur + due to differences in system include files. See Section 2.10.5, + "MIT-pthreads Notes," for warnings that may occur when using + MIT-pthreads. For other problems, check the following list. + + The solution to many problems involves reconfiguring. If you do + need to reconfigure, take note of the following: + + * If configure is run after it has previously been run, it may + use information that was gathered during its previous + invocation. This information is stored in config.cache. When + configure starts up, it looks for that file and reads its + contents if it exists, on the assumption that the information + is still correct. That assumption is invalid when you + reconfigure. + + * Each time you run configure, you must run make again to + recompile. However, you may want to remove old object files + from previous builds first because they were compiled using + different configuration options. + + To prevent old configuration information or object files from + being used, run these commands before re-running configure: +shell> rm config.cache +shell> make clean + + Alternatively, you can run make distclean. + + The following list describes some of the problems when compiling + MySQL that have been found to occur most often: + + * If you get errors such as the ones shown here when compiling + sql_yacc.cc, you probably have run out of memory or swap + space: +Internal compiler error: program cc1plus got fatal signal 11 +Out of virtual memory +Virtual memory exhausted + The problem is that gcc requires a huge amount of memory to + compile sql_yacc.cc with inline functions. Try running + configure with the --with-low-memory option: +shell> ./configure --with-low-memory + This option causes -fno-inline to be added to the compile line + if you are using gcc and -O0 if you are using something else. + You should try the --with-low-memory option even if you have + so much memory and swap space that you think you can't + possibly have run out. This problem has been observed to occur + even on systems with generous hardware configurations, and the + --with-low-memory option usually fixes it. + + * By default, configure picks c++ as the compiler name and GNU + c++ links with -lg++. If you are using gcc, that behavior can + cause problems during configuration such as this: +configure: error: installation or configuration problem: +C++ compiler cannot create executables. + You might also observe problems during compilation related to + g++, libg++, or libstdc++. + One cause of these problems is that you may not have g++, or + you may have g++ but not libg++, or libstdc++. Take a look at + the config.log file. It should contain the exact reason why + your C++ compiler didn't work. To work around these problems, + you can use gcc as your C++ compiler. Try setting the + environment variable CXX to "gcc -O3". For example: +shell> CXX="gcc -O3" ./configure + This works because gcc compiles C++ source files as well as + g++ does, but does not link in libg++ or libstdc++ by default. + Another way to fix these problems is to install g++, libg++, + and libstdc++. However, we recommend that you not use libg++ + or libstdc++ with MySQL because this only increases the binary + size of mysqld without providing any benefits. Some versions + of these libraries have also caused strange problems for MySQL + users in the past. + + * If your compile fails with errors such as any of the + following, you must upgrade your version of make to GNU make: +making all in mit-pthreads +make: Fatal error in reader: Makefile, line 18: +Badly formed macro assignment + Or: +make: file `Makefile' line 18: Must be a separator (: + Or: +pthread.h: No such file or directory + Solaris and FreeBSD are known to have troublesome make + programs. + GNU make 3.75 is known to work. + + * If you want to define flags to be used by your C or C++ + compilers, do so by adding the flags to the CFLAGS and + CXXFLAGS environment variables. You can also specify the + compiler names this way using CC and CXX. For example: +shell> CC=gcc +shell> CFLAGS=-O3 +shell> CXX=gcc +shell> CXXFLAGS=-O3 +shell> export CC CFLAGS CXX CXXFLAGS + See Section 2.1.2.4, "MySQL Binaries Compiled by Sun + Microsystems, Inc.," for a list of flag definitions that have + been found to be useful on various systems. + + * If you get errors such as those shown here when compiling + mysqld, configure did not correctly detect the type of the + last argument to accept(), getsockname(), or getpeername(): +cxx: Error: mysqld.cc, line 645: In this statement, the referenced + type of the pointer value ''length'' is ''unsigned long'', + which is not compatible with ''int''. +new_sock = accept(sock, (struct sockaddr *)&cAddr, &length); + To fix this, edit the config.h file (which is generated by + configure). Look for these lines: +/* Define as the base type of the last arg to accept */ +#define SOCKET_SIZE_TYPE XXX + Change XXX to size_t or int, depending on your operating + system. (You must do this each time you run configure because + configure regenerates config.h.) + + * The sql_yacc.cc file is generated from sql_yacc.yy. Normally, + the build process does not need to create sql_yacc.cc because + MySQL comes with a pre-generated copy. However, if you do need + to re-create it, you might encounter this error: +"sql_yacc.yy", line xxx fatal: default action causes potential... + This is a sign that your version of yacc is deficient. You + probably need to install bison (the GNU version of yacc) and + use that instead. + + * On Debian Linux 3.0, you need to install gawk instead of the + default mawk. + + * If you need to debug mysqld or a MySQL client, run configure + with the --with-debug option, and then recompile and link your + clients with the new client library. See MySQL Internals: + Porting (http://forge.mysql.com/wiki/MySQL_Internals_Porting). + + * If you get a compilation error on Linux (for example, SuSE + Linux 8.1 or Red Hat Linux 7.3) similar to the following one, + you probably do not have g++ installed: +libmysql.c:1329: warning: passing arg 5 of `gethostbyname_r' from +incompatible pointer type +libmysql.c:1329: too few arguments to function `gethostbyname_r' +libmysql.c:1329: warning: assignment makes pointer from integer +without a cast +make[2]: *** [libmysql.lo] Error 1 + By default, the configure script attempts to determine the + correct number of arguments by using g++ (the GNU C++ + compiler). This test yields incorrect results if g++ is not + installed. There are two ways to work around this problem: + + + Make sure that the GNU C++ g++ is installed. On some + Linux distributions, the required package is called gpp; + on others, it is named gcc-c++. + + + Use gcc as your C++ compiler by setting the CXX + environment variable to gcc: +export CXX="gcc" + You must run configure again after making either of those + changes. + +2.10.5. MIT-pthreads Notes + + This section describes some of the issues involved in using + MIT-pthreads. + + On Linux, you should not use MIT-pthreads. Use the installed + LinuxThreads implementation instead. See Section 2.13.1, "Linux + Notes." + + If your system does not provide native thread support, you should + build MySQL using the MIT-pthreads package. This includes older + FreeBSD systems, SunOS 4.x, Solaris 2.4 and earlier, and some + others. See Section 2.1.1, "Operating Systems Supported by MySQL + Community Server." + + MIT-pthreads is not part of the MySQL 5.1 source distribution. If + you require this package, you need to download it separately from + http://dev.mysql.com/Downloads/Contrib/pthreads-1_60_beta6-mysql.t + ar.gz + + After downloading, extract this source archive into the top level + of the MySQL source directory. It creates a new subdirectory named + mit-pthreads. + + * On most systems, you can force MIT-pthreads to be used by + running configure with the --with-mit-threads option: +shell> ./configure --with-mit-threads + Building in a non-source directory is not supported when using + MIT-pthreads because we want to minimize our changes to this + code. + + * The checks that determine whether to use MIT-pthreads occur + only during the part of the configuration process that deals + with the server code. If you have configured the distribution + using --without-server to build only the client code, clients + do not know whether MIT-pthreads is being used and use Unix + socket file connections by default. Because Unix socket files + do not work under MIT-pthreads on some platforms, this means + you need to use -h or --host with a value other than localhost + when you run client programs. + + * When MySQL is compiled using MIT-pthreads, system locking is + disabled by default for performance reasons. You can tell the + server to use system locking with the --external-locking + option. This is needed only if you want to be able to run two + MySQL servers against the same data files, but that is not + recommended, anyway. + + * Sometimes the pthread bind() command fails to bind to a socket + without any error message (at least on Solaris). The result is + that all connections to the server fail. For example: +shell> mysqladmin version +mysqladmin: connect to server at '' failed; +error: 'Can't connect to mysql server on localhost (146)' + The solution to this problem is to kill the mysqld server and + restart it. This has happened to us only when we have forcibly + stopped the server and restarted it immediately. + + * With MIT-pthreads, the sleep() system call isn't interruptible + with SIGINT (break). This is noticeable only when you run + mysqladmin --sleep. You must wait for the sleep() call to + terminate before the interrupt is served and the process + stops. + + * When linking, you might receive warning messages like these + (at least on Solaris); they can be ignored: +ld: warning: symbol `_iob' has differing sizes: + (file /my/local/pthreads/lib/libpthread.a(findfp.o) value=0x4; +file /usr/lib/libc.so value=0x140); + /my/local/pthreads/lib/libpthread.a(findfp.o) definition taken +ld: warning: symbol `__iob' has differing sizes: + (file /my/local/pthreads/lib/libpthread.a(findfp.o) value=0x4; +file /usr/lib/libc.so value=0x140); + /my/local/pthreads/lib/libpthread.a(findfp.o) definition taken + + * Some other warnings also can be ignored: +implicit declaration of function `int strtoll(...)' +implicit declaration of function `int strtoul(...)' + + * We have not been able to make readline work with MIT-pthreads. + (This is not necessary, but may be of interest to some.) + +2.10.6. Installing MySQL from Source on Windows + + 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. + +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." + +2.10.7. Compiling MySQL Clients on Windows + + In your source files, you should include my_global.h before + mysql.h: +#include <my_global.h> +#include <mysql.h> + + my_global.h includes any other files needed for Windows + compatibility (such as windows.h) if you compile your program on + Windows. + + You can either link your code with the dynamic libmysql.lib + library, which is just a wrapper to load in libmysql.dll on + demand, or link with the static mysqlclient.lib library. + + The MySQL client libraries are compiled as threaded libraries, so + you should also compile your code to be multi-threaded. + +2.11. Post-Installation Setup and Testing + + After installing MySQL, there are some issues that you should + address. For example, on Unix, you should initialize the data + directory and create the MySQL grant tables. On all platforms, an + important security concern is that the initial accounts in the + grant tables have no passwords. You should assign passwords to + prevent unauthorized access to the MySQL server. Optionally, you + can create time zone tables to enable recognition of named time + zones. + + The following sections include post-installation procedures that + are specific to Windows systems and to Unix systems. Another + section, Section 2.11.2.3, "Starting and Troubleshooting the MySQL + Server," applies to all platforms; it describes what to do if you + have trouble getting the server to start. Section 2.11.3, + "Securing the Initial MySQL Accounts," also applies to all + platforms. You should follow its instructions to make sure that + you have properly protected your MySQL accounts by assigning + passwords to them. + + When you are ready to create additional user accounts, you can + find information on the MySQL access control system and account + management in Section 5.4, "The MySQL Access Privilege System," + and Section 5.5, "MySQL User Account Management." + +2.11.1. Windows Post-Installation Procedures + + On Windows, the data directory and the grant tables do not have to + be created. MySQL Windows distributions include the grant tables + with a set of preinitialized accounts in the mysql database under + the data directory. It is unnecessary to run the mysql_install_db + script that is used on Unix. Regarding passwords, if you installed + MySQL using the Windows Installation Wizard, you may have already + assigned passwords to the accounts. (See Section 2.3.3, "Using the + MySQL Installation Wizard.") Otherwise, use the + password-assignment procedure given in Section 2.11.3, "Securing + the Initial MySQL Accounts." + + Before setting up passwords, you might want to try running some + client programs to make sure that you can connect to the server + and that it is operating properly. Make sure that the server is + running (see Section 2.3.9, "Starting the Server for the First + Time"), and then issue the following commands to verify that you + can retrieve information from the server. The output should be + similar to what is shown here: +C:\> C:\mysql\bin\mysqlshow ++--------------------+ +| Databases | ++--------------------+ +| information_schema | +| mysql | +| test | ++--------------------+ + +C:\> C:\mysql\bin\mysqlshow mysql +Database: mysql ++---------------------------+ +| Tables | ++---------------------------+ +| columns_priv | +| db | +| event | +| func | +| general_log | +| help_category | +| help_keyword | +| help_relation | +| help_topic | +| host | +| plugin | +| proc | +| procs_priv | +| servers | +| slow_log | +| tables_priv | +| time_zone | +| time_zone_leap_second | +| time_zone_name | +| time_zone_transition | +| time_zone_transition_type | +| user | ++---------------------------+ + + +C:\> C:\mysql\bin\mysql -e "SELECT Host,Db,User FROM db" mysql ++------+-------+------+ +| host | db | user | ++------+-------+------+ +| % | test% | | ++------+-------+------+ + + You may need to specify a different directory from the one shown; + if you used the Windows Installation Wizard, then the default + directory is C:\Program Files\MySQL\MySQL Server 5.1, and the + mysql and mysqlshow client programs are in C:\Program + Files\MySQL\MySQL Server 5.1\bin. See Section 2.3.3, "Using the + MySQL Installation Wizard," for more information. + + If you have already secured the initial MySQL accounts, you may + need to use the -u and -p options to supply a user name and + password to the mysqlshow and mysql client programs; otherwise the + programs may fail with an error, or you may not be able to view + all databases. For example, if you have assigned the password + "secretpass" to the MySQL root account, then you can invoke + mysqlshow and mysql as shown here: +C:\> C:\mysql\bin\mysqlshow -uroot -psecretpass ++--------------------+ +| Databases | ++--------------------+ +| information_schema | +| mysql | +| test | ++--------------------+ + +C:\> C:\mysql\bin\mysqlshow -uroot -psecretpass mysql +Database: mysql ++---------------------------+ +| Tables | ++---------------------------+ +| columns_priv | +| db | +| event | +| func | +| general_log | +| help_category | +| help_keyword | +| help_relation | +| help_topic | +| host | +| plugin | +| proc | +| procs_priv | +| servers | +| slow_log | +| tables_priv | +| time_zone | +| time_zone_leap_second | +| time_zone_name | +| time_zone_transition | +| time_zone_transition_type | +| user | ++---------------------------+ + + +C:\> C:\mysql\bin\mysql -uroot -psecretpass -e "SELECT Host,Db,User F +ROM db" mysql ++------+-------+------+ +| host | db | user | ++------+-------+------+ +| % | test% | | ++------+-------+------+ + + For more information about these programs, see Section 4.5.6, + "mysqlshow --- Display Database, Table, and Column Information," + and Section 4.5.1, "mysql --- The MySQL Command-Line Tool." + + If you are running a version of Windows that supports services and + you want the MySQL server to run automatically when Windows + starts, see Section 2.3.11, "Starting MySQL as a Windows Service." + +2.11.2. Unix Post-Installation Procedures + + After installing MySQL on Unix, you need to initialize the grant + tables, start the server, and make sure that the server works + satisfactorily. You may also wish to arrange for the server to be + started and stopped automatically when your system starts and + stops. You should also assign passwords to the accounts in the + grant tables. + + On Unix, the grant tables are set up by the mysql_install_db + program. For some installation methods, this program is run for + you automatically: + + * If you install MySQL on Linux using RPM distributions, the + server RPM runs mysql_install_db. + + * If you install MySQL on Mac OS X using a PKG distribution, the + installer runs mysql_install_db. + + Otherwise, you'll need to run mysql_install_db yourself. + + The following procedure describes how to initialize the grant + tables (if that has not previously been done) and then start the + server. It also suggests some commands that you can use to test + whether the server is accessible and working properly. For + information about starting and stopping the server automatically, + see Section 2.11.2.2, "Starting and Stopping MySQL Automatically." + + After you complete the procedure and have the server running, you + should assign passwords to the accounts created by + mysql_install_db. Instructions for doing so are given in Section + 2.11.3, "Securing the Initial MySQL Accounts." + + In the examples shown here, the server runs under the user ID of + the mysql login account. This assumes that such an account exists. + Either create the account if it does not exist, or substitute the + name of a different existing login account that you plan to use + for running the server. + + 1. Change location into the top-level directory of your MySQL + installation, represented here by BASEDIR: +shell> cd BASEDIR + BASEDIR is likely to be something like /usr/local/mysql or + /usr/local. The following steps assume that you are located in + this directory. + + 2. If necessary, run the mysql_install_db program to set up the + initial MySQL grant tables containing the privileges that + determine how users are allowed to connect to the server. + You'll need to do this if you used a distribution type for + which the installation procedure doesn't run the program for + you. + Typically, mysql_install_db needs to be run only the first + time you install MySQL, so you can skip this step if you are + upgrading an existing installation, However, mysql_install_db + does not overwrite any existing privilege tables, so it should + be safe to run in any circumstances. + To initialize the grant tables, use one of the following + commands, depending on whether mysql_install_db is located in + the bin or scripts directory: +shell> bin/mysql_install_db --user=mysql +shell> scripts/mysql_install_db --user=mysql + It might be necessary to specify other options such as + --basedir or --datadir if mysql_install_db does not use the + correct locations for the installation directory or data + directory. For example: +shell> bin/mysql_install_db --user=mysql \ + --basedir=/opt/mysql/mysql \ + --datadir=/opt/mysql/mysql/data + The mysql_install_db script creates the server's data + directory. Under the data directory, it creates directories + for the mysql database that holds all database privileges and + the test database that you can use to test MySQL. The script + also creates privilege table entries for root and + anonymous-user accounts. The accounts have no passwords + initially. A description of their initial privileges is given + in Section 2.11.3, "Securing the Initial MySQL Accounts." + Briefly, these privileges allow the MySQL root user to do + anything, and allow anybody to create or use databases with a + name of test or starting with test_. + It is important to make sure that the database directories and + files are owned by the mysql login account so that the server + has read and write access to them when you run it later. To + ensure this, the --user option should be used as shown if you + run mysql_install_db as root. Otherwise, you should execute + the script while logged in as mysql, in which case you can + omit the --user option from the command. + mysql_install_db creates several tables in the mysql database, + including user, db, host, tables_priv, columns_priv, func, and + others. See Section 5.4, "The MySQL Access Privilege System," + for a complete listing and description of these tables. + If you don't want to have the test database, you can remove it + with mysqladmin -u root drop test after starting the server. + If you have trouble with mysql_install_db at this point, see + Section 2.11.2.1, "Problems Running mysql_install_db." + + 3. Start the MySQL server: +shell> bin/mysqld_safe --user=mysql & + It is important that the MySQL server be run using an + unprivileged (non-root) login account. To ensure this, the + --user option should be used as shown if you run mysqld_safe + as system root. Otherwise, you should execute the script while + logged in to the system as mysql, in which case you can omit + the --user option from the command. + Further instructions for running MySQL as an unprivileged user + are given in Section 5.3.5, "How to Run MySQL as a Normal + User." + If you neglected to create the grant tables before proceeding + to this step, the following message appears in the error log + file when you start the server: +mysqld: Can't find file: 'host.frm' + If you have other problems starting the server, see Section + 2.11.2.3, "Starting and Troubleshooting the MySQL Server." + + 4. Use mysqladmin to verify that the server is running. The + following commands provide simple tests to check whether the + server is up and responding to connections: +shell> bin/mysqladmin version +shell> bin/mysqladmin variables + The output from mysqladmin version varies slightly depending + on your platform and version of MySQL, but should be similar + to that shown here: +shell> bin/mysqladmin version +mysqladmin Ver 14.12 Distrib 5.1.35, for pc-linux-gnu on i686 +... + +Server version 5.1.35 +Protocol version 10 +Connection Localhost via UNIX socket +UNIX socket /var/lib/mysql/mysql.sock +Uptime: 14 days 5 hours 5 min 21 sec + +Threads: 1 Questions: 366 Slow queries: 0 +Opens: 0 Flush tables: 1 Open tables: 19 +Queries per second avg: 0.000 + To see what else you can do with mysqladmin, invoke it with + the --help option. + + 5. Verify that you can shut down the server: +shell> bin/mysqladmin -u root shutdown + + 6. Verify that you can start the server again. Do this by using + mysqld_safe or by invoking mysqld directly. For example: +shell> bin/mysqld_safe --user=mysql --log & + If mysqld_safe fails, see Section 2.11.2.3, "Starting and + Troubleshooting the MySQL Server." + + 7. Run some simple tests to verify that you can retrieve + information from the server. The output should be similar to + what is shown here: +shell> bin/mysqlshow ++-----------+ +| Databases | ++-----------+ +| mysql | +| test | ++-----------+ + +shell> bin/mysqlshow mysql +Database: mysql ++---------------------------+ +| Tables | ++---------------------------+ +| columns_priv | +| db | +| func | +| help_category | +| help_keyword | +| help_relation | +| help_topic | +| host | +| proc | +| procs_priv | +| tables_priv | +| time_zone | +| time_zone_leap_second | +| time_zone_name | +| time_zone_transition | +| time_zone_transition_type | +| user | ++---------------------------+ + +shell> bin/mysql -e "SELECT Host,Db,User FROM db" mysql ++------+--------+------+ +| host | db | user | ++------+--------+------+ +| % | test | | +| % | test_% | | ++------+--------+------+ + + 8. There is a benchmark suite in the sql-bench directory (under + the MySQL installation directory) that you can use to compare + how MySQL performs on different platforms. The benchmark suite + is written in Perl. It requires the Perl DBI module that + provides a database-independent interface to the various + databases, and some other additional Perl modules: +DBI +DBD::mysql +Data::Dumper +Data::ShowTable + These modules can be obtained from CPAN + (http://www.cpan.org/). See also Section 2.15.1, "Installing + Perl on Unix." + The sql-bench/Results directory contains the results from many + runs against different databases and platforms. To run all + tests, execute these commands: +shell> cd sql-bench +shell> perl run-all-tests + If you don't have the sql-bench directory, you probably + installed MySQL using RPM files other than the source RPM. + (The source RPM includes the sql-bench benchmark directory.) + In this case, you must first install the benchmark suite + before you can use it. There are separate benchmark RPM files + named mysql-bench-VERSION.i386.rpm that contain benchmark code + and data. + If you have a source distribution, there are also tests in its + tests subdirectory that you can run. For example, to run + auto_increment.tst, execute this command from the top-level + directory of your source distribution: +shell> mysql -vvf test < ./tests/auto_increment.tst + The expected result of the test can be found in the + ./tests/auto_increment.res file. + + 9. At this point, you should have the server running. However, + none of the initial MySQL accounts have a password, so you + should assign passwords using the instructions found in + Section 2.11.3, "Securing the Initial MySQL Accounts." + + The MySQL 5.1 installation procedure creates time zone tables in + the mysql database. However, you must populate the tables manually + using the instructions in Section 9.7, "MySQL Server Time Zone + Support." + +2.11.2.1. Problems Running mysql_install_db + + The purpose of the mysql_install_db script is to generate new + MySQL privilege tables. It does not overwrite existing MySQL + privilege tables, and it does not affect any other data. + + If you want to re-create your privilege tables, first stop the + mysqld server if it is running. Then rename the mysql directory + under the data directory to save it, and then run + mysql_install_db. Suppose that your current directory is the MySQL + installation directory and that mysql_install_db is located in the + bin directory and the data directory is named data. To rename the + mysql database and re-run mysql_install_db, use these commands. +shell> mv data/mysql data/mysql.old +shell> bin/mysql_install_db --user=mysql + + When you run mysql_install_db, you might encounter the following + problems: + + * mysql_install_db fails to install the grant tables + You may find that mysql_install_db fails to install the grant + tables and terminates after displaying the following messages: +Starting mysqld daemon with databases from XXXXXX +mysqld ended + In this case, you should examine the error log file very + carefully. The log should be located in the directory XXXXXX + named by the error message and should indicate why mysqld + didn't start. If you do not understand what happened, include + the log when you post a bug report. See Section 1.6, "How to + Report Bugs or Problems." + + * There is a mysqld process running + This indicates that the server is running, in which case the + grant tables have probably been created already. If so, there + is no need to run mysql_install_db at all because it needs to + be run only once (when you install MySQL the first time). + + * Installing a second mysqld server does not work when one + server is running + This can happen when you have an existing MySQL installation, + but want to put a new installation in a different location. + For example, you might have a production installation, but you + want to create a second installation for testing purposes. + Generally the problem that occurs when you try to run a second + server is that it tries to use a network interface that is in + use by the first server. In this case, you should see one of + the following error messages: +Can't start server: Bind on TCP/IP port: +Address already in use +Can't start server: Bind on unix socket... + For instructions on setting up multiple servers, see Section + 5.6, "Running Multiple MySQL Servers on the Same Machine." + + * You do not have write access to the /tmp directory + If you do not have write access to create temporary files or a + Unix socket file in the default location (the /tmp directory), + an error occurs when you run mysql_install_db or the mysqld + server. + You can specify different locations for the temporary + directory and Unix socket file by executing these commands + prior to starting mysql_install_db or mysqld, where + some_tmp_dir is the full path name to some directory for which + you have write permission: +shell> TMPDIR=/some_tmp_dir/ +shell> MYSQL_UNIX_PORT=/some_tmp_dir/mysql.sock +shell> export TMPDIR MYSQL_UNIX_PORT + Then you should be able to run mysql_install_db and start the + server with these commands: +shell> bin/mysql_install_db --user=mysql +shell> bin/mysqld_safe --user=mysql & + If mysql_install_db is located in the scripts directory, + modify the first command to scripts/mysql_install_db. + See Section B.1.4.5, "How to Protect or Change the MySQL Unix + Socket File," and Section 2.14, "Environment Variables." + + There are some alternatives to running the mysql_install_db script + provided in the MySQL distribution: + + * If you want the initial privileges to be different from the + standard defaults, you can modify mysql_install_db before you + run it. However, it is preferable to use GRANT and REVOKE to + change the privileges after the grant tables have been set up. + In other words, you can run mysql_install_db, and then use + mysql -u root mysql to connect to the server as the MySQL root + user so that you can issue the necessary GRANT and REVOKE + statements. + If you want to install MySQL on several machines with the same + privileges, you can put the GRANT and REVOKE statements in a + file and execute the file as a script using mysql after + running mysql_install_db. For example: +shell> bin/mysql_install_db --user=mysql +shell> bin/mysql -u root < your_script_file + By doing this, you can avoid having to issue the statements + manually on each machine. + + * It is possible to re-create the grant tables completely after + they have previously been created. You might want to do this + if you're just learning how to use GRANT and REVOKE and have + made so many modifications after running mysql_install_db that + you want to wipe out the tables and start over. + To re-create the grant tables, remove all the .frm, .MYI, and + .MYD files in the mysql database directory. Then run the + mysql_install_db script again. + + * You can start mysqld manually using the --skip-grant-tables + option and add the privilege information yourself using mysql: +shell> bin/mysqld_safe --user=mysql --skip-grant-tables & +shell> bin/mysql mysql + From mysql, manually execute the SQL commands contained in + mysql_install_db. Make sure that you run mysqladmin + flush-privileges or mysqladmin reload afterward to tell the + server to reload the grant tables. + Note that by not using mysql_install_db, you not only have to + populate the grant tables manually, you also have to create + them first. + +2.11.2.2. Starting and Stopping MySQL Automatically + + Generally, you start the mysqld server in one of these ways: + + * By invoking mysqld directly. This works on any platform. + + * By running the MySQL server as a Windows service. The service + can be set to start the server automatically when Windows + starts, or as a manual service that you start on request. For + instructions, see Section 2.3.11, "Starting MySQL as a Windows + Service." + + * By invoking mysqld_safe, which tries to determine the proper + options for mysqld and then runs it with those options. This + script is used on Unix and Unix-like systems. See Section + 4.3.2, "mysqld_safe --- MySQL Server Startup Script." + + * By invoking mysql.server. This script is used primarily at + system startup and shutdown on systems that use System V-style + run directories, where it usually is installed under the name + mysql. The mysql.server script starts the server by invoking + mysqld_safe. See Section 4.3.3, "mysql.server --- MySQL Server + Startup Script." + + * On Mac OS X, you can install a separate MySQL Startup Item + package to enable the automatic startup of MySQL on system + startup. The Startup Item starts the server by invoking + mysql.server. See Section 2.5, "Installing MySQL on Mac OS X," + for details. + + The mysqld_safe and mysql.server scripts and the Mac OS X Startup + Item can be used to start the server manually, or automatically at + system startup time. mysql.server and the Startup Item also can be + used to stop the server. + + To start or stop the server manually using the mysql.server + script, invoke it with start or stop arguments: +shell> mysql.server start +shell> mysql.server stop + + Before mysql.server starts the server, it changes location to the + MySQL installation directory, and then invokes mysqld_safe. If you + want the server to run as some specific user, add an appropriate + user option to the [mysqld] group of the /etc/my.cnf option file, + as shown later in this section. (It is possible that you will need + to edit mysql.server if you've installed a binary distribution of + MySQL in a non-standard location. Modify it to cd into the proper + directory before it runs mysqld_safe. If you do this, your + modified version of mysql.server may be overwritten if you upgrade + MySQL in the future, so you should make a copy of your edited + version that you can reinstall.) + + mysql.server stop stops the server by sending a signal to it. You + can also stop the server manually by executing mysqladmin + shutdown. + + To start and stop MySQL automatically on your server, you need to + add start and stop commands to the appropriate places in your + /etc/rc* files. + + If you use the Linux server RPM package + (MySQL-server-VERSION.rpm), the mysql.server script is installed + in the /etc/init.d directory with the name mysql. You need not + install it manually. See Section 2.4, "Installing MySQL from RPM + Packages on Linux," for more information on the Linux RPM + packages. + + Some vendors provide RPM packages that install a startup script + under a different name such as mysqld. + + If you install MySQL from a source distribution or using a binary + distribution format that does not install mysql.server + automatically, you can install it manually. The script can be + found in the support-files directory under the MySQL installation + directory or in a MySQL source tree. + + To install mysql.server manually, copy it to the /etc/init.d + directory with the name mysql, and then make it executable. Do + this by changing location into the appropriate directory where + mysql.server is located and executing these commands: +shell> cp mysql.server /etc/init.d/mysql +shell> chmod +x /etc/init.d/mysql + + Older Red Hat systems use the /etc/rc.d/init.d directory rather + than /etc/init.d. Adjust the preceding commands accordingly. + Alternatively, first create /etc/init.d as a symbolic link that + points to /etc/rc.d/init.d: +shell> cd /etc +shell> ln -s rc.d/init.d . + + After installing the script, the commands needed to activate it to + run at system startup depend on your operating system. On Linux, + you can use chkconfig: +shell> chkconfig --add mysql + + On some Linux systems, the following command also seems to be + necessary to fully enable the mysql script: +shell> chkconfig --level 345 mysql on + + On FreeBSD, startup scripts generally should go in + /usr/local/etc/rc.d/. The rc(8) manual page states that scripts in + this directory are executed only if their basename matches the + *.sh shell file name pattern. Any other files or directories + present within the directory are silently ignored. In other words, + on FreeBSD, you should install the mysql.server script as + /usr/local/etc/rc.d/mysql.server.sh to enable automatic startup. + + As an alternative to the preceding setup, some operating systems + also use /etc/rc.local or /etc/init.d/boot.local to start + additional services on startup. To start up MySQL using this + method, you could append a command like the one following to the + appropriate startup file: +/bin/sh -c 'cd /usr/local/mysql; ./bin/mysqld_safe --user=mysql &' + + For other systems, consult your operating system documentation to + see how to install startup scripts. + + You can add options for mysql.server in a global /etc/my.cnf file. + A typical /etc/my.cnf file might look like this: +[mysqld] +datadir=/usr/local/mysql/var +socket=/var/tmp/mysql.sock +port=3306 +user=mysql + +[mysql.server] +basedir=/usr/local/mysql + + The mysql.server script understands the following options: + basedir, datadir, and pid-file. If specified, they must be placed + in an option file, not on the command line. mysql.server + understands only start and stop as command-line arguments. + + The following table shows which option groups the server and each + startup script read from option files. + Script Option Groups + mysqld [mysqld], [server], [mysqld-major_version] + mysqld_safe [mysqld], [server], [mysqld_safe] + mysql.server [mysqld], [mysql.server], [server] + + [mysqld-major_version] means that groups with names like + [mysqld-5.0] and [mysqld-5.1] are read by servers having versions + 5.0.x, 5.1.x, and so forth. This feature can be used to specify + options that can be read only by servers within a given release + series. + + For backward compatibility, mysql.server also reads the + [mysql_server] group and mysqld_safe also reads the [safe_mysqld] + group. However, you should update your option files to use the + [mysql.server] and [mysqld_safe] groups instead when using MySQL + 5.1. + + See Section 4.2.3.2, "Using Option Files." + +2.11.2.3. Starting and Troubleshooting the MySQL Server + + This section provides troubleshooting suggestions for problems + starting the server on Unix. If you are using Windows, see Section + 2.3.13, "Troubleshooting a MySQL Installation Under Windows." + + If you have problems starting the server, here are some things to + try: + + * Check the error log to see why the server does not start. + + * Specify any special options needed by the storage engines you + are using. + + * Make sure that the server knows where to find the data + directory. + + * Make sure that the server can access the data directory. The + ownership and permissions of the data directory and its + contents must be set such that the server can read and modify + them. + + * Verify that the network interfaces the server wants to use are + available. + + Some storage engines have options that control their behavior. You + can create a my.cnf file and specify startup options for the + engines that you plan to use. If you are going to use storage + engines that support transactional tables (InnoDB, NDB), be sure + that you have them configured the way you want before starting the + server: + + MySQL Enterprise For expert advice on start-up options appropriate + to your circumstances, subscribe to The MySQL Enterprise Monitor. + For more information, see + http://www.mysql.com/products/enterprise/advisors.html. + + * If you are using InnoDB tables, see Section 13.6.2, "InnoDB + Configuration." + + * If you are using MySQL Cluster, see Section 17.3, "MySQL + Cluster Configuration." + + Storage engines will use default option values if you specify + none, but it is recommended that you review the available options + and specify explicit values for those for which the defaults are + not appropriate for your installation. + + When the mysqld server starts, it changes location to the data + directory. This is where it expects to find databases and where it + expects to write log files. The server also writes the pid + (process ID) file in the data directory. + + The data directory location is hardwired in when the server is + compiled. This is where the server looks for the data directory by + default. If the data directory is located somewhere else on your + system, the server will not work properly. You can determine what + the default path settings are by invoking mysqld with the + --verbose and --help options. + + If the default locations don't match the MySQL installation layout + on your system, you can override them by specifying options to + mysqld or mysqld_safe on the command line or in an option file. + + To specify the location of the data directory explicitly, use the + --datadir option. However, normally you can tell mysqld the + location of the base directory under which MySQL is installed and + it looks for the data directory there. You can do this with the + --basedir option. + + To check the effect of specifying path options, invoke mysqld with + those options followed by the --verbose and --help options. For + example, if you change location into the directory where mysqld is + installed and then run the following command, it shows the effect + of starting the server with a base directory of /usr/local: +shell> ./mysqld --basedir=/usr/local --verbose --help + + You can specify other options such as --datadir as well, but + --verbose and --help must be the last options. + + Once you determine the path settings you want, start the server + without --verbose and --help. + + If mysqld is currently running, you can find out what path + settings it is using by executing this command: +shell> mysqladmin variables + + Or: +shell> mysqladmin -h host_name variables + + host_name is the name of the MySQL server host. + + If you get Errcode 13 (which means Permission denied) when + starting mysqld, this means that the privileges of the data + directory or its contents do not allow the server access. In this + case, you change the permissions for the involved files and + directories so that the server has the right to use them. You can + also start the server as root, but this raises security issues and + should be avoided. + + On Unix, change location into the data directory and check the + ownership of the data directory and its contents to make sure the + server has access. For example, if the data directory is + /usr/local/mysql/var, use this command: +shell> ls -la /usr/local/mysql/var + + If the data directory or its files or subdirectories are not owned + by the login account that you use for running the server, change + their ownership to that account. If the account is named mysql, + use these commands: +shell> chown -R mysql /usr/local/mysql/var +shell> chgrp -R mysql /usr/local/mysql/var + + If the server fails to start up correctly, check the error log. + Log files are located in the data directory (typically C:\Program + Files\MySQL\MySQL Server 5.1\data on Windows, + /usr/local/mysql/data for a Unix binary distribution, and + /usr/local/var for a Unix source distribution). Look in the data + directory for files with names of the form host_name.err and + host_name.log, where host_name is the name of your server host. + Then examine the last few lines of these files. On Unix, you can + use tail to display them: +shell> tail host_name.err +shell> tail host_name.log + + The error log should contain information that indicates why the + server couldn't start. + + If either of the following errors occur, it means that some other + program (perhaps another mysqld server) is using the TCP/IP port + or Unix socket file that mysqld is trying to use: +Can't start server: Bind on TCP/IP port: Address already in use +Can't start server: Bind on unix socket... + + Use ps to determine whether you have another mysqld server + running. If so, shut down the server before starting mysqld again. + (If another server is running, and you really want to run multiple + servers, you can find information about how to do so in Section + 5.6, "Running Multiple MySQL Servers on the Same Machine.") + + If no other server is running, try to execute the command telnet + your_host_name tcp_ip_port_number. (The default MySQL port number + is 3306.) Then press Enter a couple of times. If you don't get an + error message like telnet: Unable to connect to remote host: + Connection refused, some other program is using the TCP/IP port + that mysqld is trying to use. You'll need to track down what + program this is and disable it, or else tell mysqld to listen to a + different port with the --port option. In this case, you'll also + need to specify the port number for client programs when + connecting to the server via TCP/IP. + + Another reason the port might be inaccessible is that you have a + firewall running that blocks connections to it. If so, modify the + firewall settings to allow access to the port. + + If the server starts but you can't connect to it, you should make + sure that you have an entry in /etc/hosts that looks like this: +127.0.0.1 localhost + + This problem occurs only on systems that do not have a working + thread library and for which MySQL must be configured to use + MIT-pthreads. + + If you cannot get mysqld to start, you can try to make a trace + file to find the problem by using the --debug option. See MySQL + Internals: Porting + (http://forge.mysql.com/wiki/MySQL_Internals_Porting). + +2.11.3. Securing the Initial MySQL Accounts + + Part of the MySQL installation process is to set up the mysql + database that contains the grant tables: + + * Windows distributions contain preinitialized grant tables that + are installed automatically. + + * On Unix, the grant tables are populated by the + mysql_install_db program. Some installation methods run this + program for you. Others require that you execute it manually. + For details, see Section 2.11.2, "Unix Post-Installation + Procedures." + + The grant tables define the initial MySQL user accounts and their + access privileges. These accounts are set up as follows: + + * Accounts with the user name root are created. These are + superuser accounts that can do anything. The initial root + account passwords are empty, so anyone can connect to the + MySQL server as root --- without a password --- and be granted + all privileges. + + + On Windows, one root account is created; this account + allows connecting from the local host only. The Windows + installer will optionally create an account allowing for + connections from any host only if the user selects the + Enable root access from remote machines option during + installation. + + + On Unix, both root accounts are for connections from the + local host. Connections must be made from the local host + by specifying a host name of localhost for one of the + accounts, or the actual host name or IP number for the + other. + + * Two anonymous-user accounts are created, each with an empty + user name. The anonymous accounts have no password, so anyone + can use them to connect to the MySQL server. + + + On Windows, one anonymous account is for connections from + the local host. It has no global privileges. (Before + MySQL 5.1.16, it has all global privileges, just like the + root accounts.) The other is for connections from any + host and has all privileges for the test database and for + other databases with names that start with test. + + + On Unix, both anonymous accounts are for connections from + the local host. Connections must be made from the local + host by specifying a host name of localhost for one of + the accounts, or the actual host name or IP number for + the other. These accounts have all privileges for the + test database and for other databases with names that + start with test_. + + As noted, none of the initial accounts have passwords. This means + that your MySQL installation is unprotected until you do something + about it: + + * If you want to prevent clients from connecting as anonymous + users without a password, you should either assign a password + to each anonymous account or else remove the accounts. + + * You should assign a password to each MySQL root account. + + The following instructions describe how to set up passwords for + the initial MySQL accounts, first for the anonymous accounts and + then for the root accounts. Replace "newpwd" in the examples with + the actual password that you want to use. The instructions also + cover how to remove the anonymous accounts, should you prefer not + to allow anonymous access at all. + + You might want to defer setting the passwords until later, so that + you don't need to specify them while you perform additional setup + or testing. However, be sure to set them before using your + installation for production purposes. + + Anonymous Account Password Assignment + + To assign passwords to the anonymous accounts, connect to the + server as root and then use either SET PASSWORD or UPDATE. In + either case, be sure to encrypt the password using the PASSWORD() + function. + + To use SET PASSWORD on Windows, do this: +shell> mysql -u root +mysql> SET PASSWORD FOR ''@'localhost' = PASSWORD('newpwd'); +mysql> SET PASSWORD FOR ''@'%' = PASSWORD('newpwd'); + + To use SET PASSWORD on Unix, do this: +shell> mysql -u root +mysql> SET PASSWORD FOR ''@'localhost' = PASSWORD('newpwd'); +mysql> SET PASSWORD FOR ''@'host_name' = PASSWORD('newpwd'); + + In the second SET PASSWORD statement, replace host_name with the + name of the server host. This is the name that is specified in the + Host column of the non-localhost record for root in the user + table. If you don't know what host name this is, issue the + following statement before using SET PASSWORD: +mysql> SELECT Host, User FROM mysql.user; + + Look for the record that has root in the User column and something + other than localhost in the Host column. Then use that Host value + in the second SET PASSWORD statement. + + Anonymous Account Removal + + If you prefer to remove the anonymous accounts instead, do so as + follows: +shell> mysql -u root +mysql> DROP USER ''; + + The DROP statement applies both to Windows and to Unix. On + Windows, if you want to remove only the anonymous account that has + the same privileges as root, do this instead: +shell> mysql -u root +mysql> DROP USER ''@'localhost'; + + That account allows anonymous access but has full privileges, so + removing it improves security. + + root Account Password Assignment + + You can assign passwords to the root accounts in several ways. The + following discussion demonstrates three methods: + + * Use the SET PASSWORD statement + + * Use the mysqladmin command-line client program + + * Use the UPDATE statement + + To assign passwords using SET PASSWORD, connect to the server as + root and issue SET PASSWORD statements. Be sure to encrypt the + password using the PASSWORD() function. + + For Windows, do this: +shell> mysql -u root +mysql> SET PASSWORD FOR 'root'@'localhost' = PASSWORD('newpwd'); +mysql> SET PASSWORD FOR 'root'@'%' = PASSWORD('newpwd'); + + For Unix, do this: +shell> mysql -u root +mysql> SET PASSWORD FOR 'root'@'localhost' = PASSWORD('newpwd'); +mysql> SET PASSWORD FOR 'root'@'host_name' = PASSWORD('newpwd'); + + In the second SET PASSWORD statement, replace host_name with the + name of the server host. This is the same host name that you used + when you assigned the anonymous account passwords. + + If the user table contains an account with User and Host values of + 'root' and '127.0.0.1', use an additional SET PASSWORD statement + to set that account's password: +mysql> SET PASSWORD FOR 'root'@'127.0.0.1' = PASSWORD('newpwd'); + + To assign passwords to the root accounts using mysqladmin, execute + the following commands: +shell> mysqladmin -u root password "newpwd" +shell> mysqladmin -u root -h host_name password "newpwd" + + These commands apply both to Windows and to Unix. In the second + command, replace host_name with the name of the server host. The + double quotes around the password are not always necessary, but + you should use them if the password contains spaces or other + characters that are special to your command interpreter. + + The mysqladmin method of setting the root account passwords does + not set the password for the 'root'@'127.0.0.1' account. To do so, + use SET PASSWORD as shown earlier. + + You can also use UPDATE to modify the user table directly. The + following UPDATE statement assigns a password to all root + accounts: +shell> mysql -u root +mysql> UPDATE mysql.user SET Password = PASSWORD('newpwd') + -> WHERE User = 'root'; +mysql> FLUSH PRIVILEGES; + + The UPDATE statement applies both to Windows and to Unix. + + After the passwords have been set, you must supply the appropriate + password whenever you connect to the server. For example, if you + want to use mysqladmin to shut down the server, you can do so + using this command: +shell> mysqladmin -u root -p shutdown +Enter password: (enter root password here) + +Note + + If you forget your root password after setting it up, Section + B.1.4.1, "How to Reset the Root Password," covers the procedure + for resetting it. + + To set up additional accounts, you can use the GRANT statement. + For instructions, see Section 5.5.2, "Adding User Accounts." + +2.12. Upgrading or Downgrading MySQL + +2.12.1. Upgrading MySQL + + As a general rule, we recommend that when you upgrade from one + release series to another, you should go to the next series rather + than skipping a series. If you wish to upgrade from a release + series previous to MySQL 5.0, you should upgrade to each + successive release series in turn until you have reached MySQL + 5.0, and then proceed with the upgrade to MySQL 5.1. For example, + if you currently are running MySQL 4.0 and wish to upgrade to a + newer series, upgrade to MySQL 4.1 first before upgrading to 5.0, + and so forth. For information on upgrading to MySQL 5.0, see the + MySQL 5.0 Reference Manual; for earlier releases, see the MySQL + 3.23, 4.0, 4.1 Reference Manual. + + The following items form a checklist of things that you should do + whenever you perform an upgrade from MySQL 5.0 to 5.1: + + * Before any upgrade, back up your databases, including the + mysql database that contains the grant tables. + + * Read all the notes in Section 2.12.1.1, "Upgrading from MySQL + 5.0 to 5.1." These notes will enable you to identify upgrade + issues that apply to your current MySQL installation. Read + Appendix C, "MySQL Change History" as well, which provides + information about features that are new in MySQL 5.1 or differ + from those found in MySQL 5.0. + + * For any incompatibilities that require your attention before + upgrading, deal with them as described in Section 2.12.1.1, + "Upgrading from MySQL 5.0 to 5.1." + + * After you upgrade to a new version of MySQL, you should run + mysql_upgrade (see Section 4.4.8, "mysql_upgrade --- Check + Tables for MySQL Upgrade"). This program will check your + tables, and repair them if necessary. It will also update your + grant tables to make sure that they have the current structure + so that you can take advantage of any new capabilities. (Some + releases of MySQL introduce changes to the structure of the + grant tables to add new privileges or features.) + + * If you are running MySQL Server on Windows, see Section + 2.3.14, "Upgrading MySQL on Windows." + + * If you are using replication, see Section 16.3.3, "Upgrading a + Replication Setup," for information on upgrading your + replication setup. + + * If you are upgrading an installation originally produced by + installing multiple RPM packages, it is best to upgrade all + the packages, not just some. For example, if you previously + installed the server and client RPMs, do not upgrade just the + server RPM. + + * As of MySQL 5.1.9, the mysqld-max server is included in binary + distributions. There is no separate MySQL-Max distribution. As + of MySQL 5.1.12, binary distributions contain a server that + includes the features previously included in mysqld-max. + + * If you have created a user-defined function (UDF) with a given + name and upgrade MySQL to a version that implements a new + built-in function with the same name, the UDF becomes + inaccessible. To correct this, use DROP FUNCTION to drop the + UDF, and then use CREATE FUNCTION to re-create the UDF with a + different non-conflicting name. The same is true if the new + version of MySQL implements a built-in function with the same + name as an existing stored function. See Section 8.2.4, + "Function Name Parsing and Resolution," for the rules + describing how the server interprets references to different + kinds of functions. + + You can always move the MySQL format files and data files between + different versions on the same architecture as long as you stay + within versions for the same release series of MySQL. + + If you are cautious about using new versions, you can always + rename your old mysqld before installing a newer one. For example, + if you are using MySQL 5.0.13 and want to upgrade to 5.1.10, + rename your current server from mysqld to mysqld-5.0.13. If your + new mysqld then does something unexpected, you can simply shut it + down and restart with your old mysqld. + + If, after an upgrade, you experience problems with recompiled + client programs, such as Commands out of sync or unexpected core + dumps, you probably have used old header or library files when + compiling your programs. In this case, you should check the date + for your mysql.h file and libmysqlclient.a library to verify that + they are from the new MySQL distribution. If not, recompile your + programs with the new headers and libraries. + + If problems occur, such as that the new mysqld server does not + start or that you cannot connect without a password, verify that + you do not have an old my.cnf file from your previous + installation. You can check this with the --print-defaults option + (for example, mysqld --print-defaults). If this command displays + anything other than the program name, you have an active my.cnf + file that affects server or client operation. + + It is a good idea to rebuild and reinstall the Perl DBD::mysql + module whenever you install a new release of MySQL. The same + applies to other MySQL interfaces as well, such as the PHP mysql + extension and the Python MySQLdb module. + +2.12.1.1. Upgrading from MySQL 5.0 to 5.1 + + After upgrading a 5.0 installation to 5.0.10 or above, it is + necessary to upgrade your grant tables. Otherwise, creating stored + procedures and functions might not work. The procedure for doing + this is described in Section 4.4.8, "mysql_upgrade --- Check + Tables for MySQL Upgrade." + +Note + + It is good practice to back up your data before installing any new + version of software. Although MySQL works very hard to ensure a + high level of quality, you should protect your data by making a + backup. MySQL recommends that you dump and reload your tables from + any previous version to upgrade to 5.1. + + In general, you should do the following when upgrading from MySQL + 5.0 to 5.1: + + * Read all the items in the following sections to see whether + any of them might affect your applications: + + + Section 2.12.1, "Upgrading MySQL," has general update + information. + + + The items in the change lists found later in this section + enable you to identify upgrade issues that apply to your + current MySQL installation. + + + The MySQL 5.1 change history describes significant new + features you can use in 5.1 or that differ from those + found in MySQL 5.0. Some of these changes may result in + incompatibilities. See Section C.1, "Changes in release + 5.1.x (Production)." + + * Note particularly any changes that are marked Known issue or + Incompatible change. These incompatibilities with earlier + versions of MySQL may require your attention before you + upgrade. + Our aim is to avoid these changes, but occasionally they are + necessary to correct problems that would be worse than an + incompatibility between releases. If any upgrade issue + applicable to your installation involves an incompatibility + that requires special handling, follow the instructions given + in the incompatibility description. Often this will involve a + dump and reload, or use of a statement such as CHECK TABLE or + REPAIR TABLE. + For dump and reload instructions, see Section 2.12.4, + "Rebuilding Tables or Table Indexes." Any procedure that + involves REPAIR TABLE with the USE_FRM option must be done + before upgrading. Use of this statement with a version of + MySQL different from the one used to create the table (that + is, using it after upgrading) may damage the table. See + Section 12.5.2.6, "REPAIR TABLE Syntax." + + * After you upgrade to a new version of MySQL, run mysql_upgrade + (see Section 4.4.8, "mysql_upgrade --- Check Tables for MySQL + Upgrade"). This program will check your tables, and repair + them if necessary. It will also update your grant tables to + make sure that they have the current structure so that you can + take advantage of any new capabilities. (Some releases of + MySQL introduce changes to the structure of the grant tables + to add new privileges or features.) + + * Check Section 2.12.3, "Checking Whether Table Indexes Must Be + Rebuilt," to see whether changes to character sets or + collations were made that affect your table indexes. If so, + you will need to rebuild the affected indexes using the + instructions in Section 2.12.4, "Rebuilding Tables or Table + Indexes." + + * If you are running MySQL Server on Windows, see Section + 2.3.14, "Upgrading MySQL on Windows." + + * If you are using replication, see Section 16.3.3, "Upgrading a + Replication Setup," for information on upgrading your + replication setup. + + The following lists describe changes that may affect applications + and that you should watch out for when upgrading to MySQL 5.1. + + Configuration Changes: + + * Before MySQL 5.1.11, to build MySQL from source with SSL + support enabled, you would invoke configure with either the + --with-openssl or --with-yassl option. In MySQL 5.1.11, those + options both have been replaced by the --with-ssl option. By + default, --with-ssl causes the bundled yaSSL library to be + used. To select OpenSSL instead, give the option as + --with-ssl=path, where path is the directory where the OpenSSL + header files and libraries are located. + + Server Changes: + + * Known issue: Before MySQL 5.1.30, the CHECK TABLE ... FOR + UPGRADE statement did not check for incompatible collation + changes made in MySQL 5.1.24. (This also affects mysqlcheck + and mysql_upgrade, which cause that statement to be executed.) + Prior to the fix made in 5.1.30, a binary upgrade (performed + without dumping tables with mysqldump before the upgrade and + reloading the dump file after the upgrade) would corrupt + tables. After the fix, CHECK TABLE ... FOR UPGRADE properly + detects the problem and warns about tables that need repair. + However, the fix is not backward compatible and can result in + a downgrading problem under these circumstances: + + 1. Perform a binary upgrade to a version of MySQL that + includes the fix. + + 2. Run CHECK TABLE ... FOR UPGRADE (or mysqlcheck or + mysql_upgrade) to upgrade tables. + + 3. Perform a binary downgrade to a version of MySQL that + does not include the fix. + The solution is to dump tables with mysqldump before the + downgrade and reload the dump file after the downgrade. + Alternatively, drop and recreate affected indexes. + + * Known issue: MySQL introduces encoding for table names that + have non-ASCII characters (see Section 8.2.3, "Mapping of + Identifiers to File Names"). After a live upgrade from MySQL + 5.0 to 5.1 or higher, the server recognizes names that have + non-ASCII characters and adds a #mysql50# prefix to them. + Running mysqlcheck --all-databases --check-upgrade + --fix-db-names --fix-table-names later upgrades these names by + encoding them with the new format and removes the #mysql50# + prefix. + However, although this is done for tables, it is not done for + views prior to MySQL 5.1.23. To work around this problem, drop + each affected view and recreate it. This problem is fixed as + of MySQL 5.1.23. + To check and repair tables and to upgrade the system tables, + mysql_upgrade executes the following commands: +mysqlcheck --check-upgrade --all-databases --auto-repair +mysql_fix_privilege_tables +mysqlcheck --all-databases --check-upgrade --fix-db-names --fix-table +-names + However, prior to MySQL 5.1.31, mysql_upgrade 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.) If + you have such database or table names, execute the third + command manually after executing mysql_upgrade. This problem + is fixed as of MySQL 5.1.31. + + * Known issue: When upgrading from MySQL 5.0 to 5.1, running + mysqlcheck (or mysql_upgrade, which runs mysqlcheck) to + upgrade tables fails for names that must be written as quoted + identifiers. To work around this problem, rename each affected + table to a name that does not require quoting: +RENAME TABLE `tab``le_a` TO table_a; +RENAME TABLE `table b` TO table_b; + After renaming the tables, run the mysql_upgrade program. Then + rename the tables back to their original names: +RENAME TABLE table_a TO `tab``le_a`; +RENAME TABLE table_b TO `table b`; + This problem is fixed as of MySQL 5.1.23. + + * Known issue: In connection with view creation, the server + created arc directories inside database directories and + maintained useless copies of .frm files there. Creation and + renaming procedures of those copies as well as creation of arc + directories has been discontinued in MySQL 5.1.29. + This change does cause a problem when downgrading to older + server versions which manifests itself under these + circumstances: + + 1. Create a view v_orig in MySQL 5.1.29 or higher. + + 2. Rename the view to v_new and then back to v_orig. + + 3. Downgrade to an older 5.1.x server and run mysql_upgrade. + + 4. Try to rename v_orig to v_new again. This operation + fails. + As a workaround to avoid this problem, use either of these + approaches: + + + Dump your data using mysqldump before downgrading and + reload the dump file after downgrading. + + + Instead of renaming a view after the downgrade, drop it + and recreate it. + + * Known issue: Dumps performed by using mysqldump to generate a + dump file before the upgrade and reloading the file after + upgrading are subject to the following problem: + Before MySQL 5.0.40, mysqldump displays SPATIAL index + definitions using prefix lengths for the indexed columns. + These prefix lengths are accepted in MySQL 5.0, but not as of + MySQL 5.1. If you use mysqldump from versions of MySQL older + than 5.0.40, any table containing SPATIAL indexes will cause + an error when the dump file is reloaded into MySQL 5.1 or + higher. + For example, a table definition might look like this when + dumped in MySQL 5.0: +CREATE TABLE `t` ( + `g` geometry NOT NULL, + SPATIAL KEY `g` (`g`(32)) +) ENGINE=MyISAM DEFAULT CHARSET=latin1 + The SPATIAL index definition will not be accepted in MySQL + 5.1. To work around this, edit the dump file to remove the + prefix: +CREATE TABLE `t` ( + `g` geometry NOT NULL, + SPATIAL KEY `g` (`g`) +) ENGINE=MyISAM DEFAULT CHARSET=latin1 + Dump files can be large, so it may be preferable to dump table + definitions and data separately to make it easier to edit the + definitions: +shell> mysqldump --no-data other_args > definitions.sql +shell> mysqldump --no-create-info other_args > data.sql + Then edit definitions.sql before reloading definitions.sql and + data.sql, in that order. + + * Incompatible change: From MySQL 5.1.24 to 5.1.31, the UPDATE + statement was changed such that assigning NULL to a NOT NULL + column caused an error even when strict SQL mode was not + enabled. The original behavior before MySQL 5.1.24 was that + such assignments caused an error only in strict SQL mode, and + otherwise set the column to the the implicit default value for + the column data type and generated a warning. (For information + about implicit default values, see Section 10.1.4, "Data Type + Default Values.") + The change caused compatibility problems for applications that + relied on the original behavior. It also caused replication + problems between servers that had the original behavior and + those that did not, for applications that assigned NULL to NOT + NULL columns in UPDATE statements without strict SQL mode + enabled. The change was reverted in MySQL 5.1.32 so that + UPDATE again had the original behavior. Problems can still + occur if you replicate between servers that have the modified + UPDATE behavior and those that do not. + + * Incompatible change: Character set or collation changes were + made in MySQL 5.1.21, 5.1.23, and 5.1.24 that may require + table indexes to be rebuilt. For details, see Section 2.12.3, + "Checking Whether Table Indexes Must Be Rebuilt." + + * Incompatible change: As of MySQL 5.1.29, the default binary + logging mode has been changed from MIXED to STATEMENT for + compatibility with MySQL 5.0. + + * Incompatible change: In MySQL 5.1.25, a change was made to the + way that the server handles prepared statements. This affects + prepared statements processed at the SQL level (using the + PREPARE statement) and those processed using the binary + client-server protocol (using the mysql_stmt_prepare() C API + function). + Previously, changes to metadata of tables or views referred to + in a prepared statement could cause a server crash when the + statement was next executed, or perhaps an error at execute + time with a crash occurring later. For example, this could + happen after dropping a table and recreating it with a + different definition. + Now metadata changes to tables or views referred to by + prepared statements are detected and cause automatic + repreparation of the statement when it is next executed. + Metadata changes occur for DDL statements such as those that + create, drop, alter, rename, or truncate tables, or that + analyze, optimize, or repair tables. Repreparation also occurs + after referenced tables or views are flushed from the table + definition cache, either implicitly to make room for new + entries in the cache, or explicitly due to FLUSH TABLES. + Repreparation is automatic, but to the extent that it occurs, + performance of prepared statements is diminished. + Table content changes (for example, with INSERT or UPDATE) do + not cause repreparation, nor do SELECT statements. + An incompatibility with previous versions of MySQL is that a + prepared statement may now return a different set of columns + or different column types from one execution to the next. For + example, if the prepared statement is SELECT * FROM t1, + altering t1 to contain a different number of columns causes + the next execution to return a number of columns different + from the previous execution. + Older versions of the client library cannot handle this change + in behavior. For applications that use prepared statements + with the new server, an upgrade to the new client library is + strongly recommended. + Along with this change to statement repreparation, the default + value of the table_definition_cache system variable has been + increased from 128 to 256. The purpose of this increase is to + lessen the chance that prepared statements will need + repreparation due to referred-to tables/views having been + flushed from the cache to make room for new entries. + A new status variable, Com_stmt_reprepare, has been introduced + to track the number of repreparations. + + * Incompatible change: As of MySQL 5.1.23, within a stored + routine, it is no longer allowable to declare a cursor for a + SHOW or DESCRIBE statement. This happened to work in some + instances, but is no longer supported. In many cases, a + workaround for this change is to use the cursor with a SELECT + query to read from an INFORMATION_SCHEMA table that provides + the same information as the SHOW statement. + + * Incompatible change: MySQL 5.1 implements support for a plugin + API that allows the loading and unloading of components at + runtime, without restarting the server. Section 22.2, "The + MySQL Plugin Interface." The plugin API requires the + mysql.plugin table. After upgrading from an older version of + MySQL, you should run the mysql_upgrade command to create this + table. See Section 4.4.8, "mysql_upgrade --- Check Tables for + MySQL Upgrade." + Plugins are installed in the directory named by the plugin_dir + system variable. This variable also controls the location from + which the server loads user-defined functions (UDFs), which is + a change from earlier versions of MySQL. That is, all UDF + library files now must be installed in the plugin directory. + When upgrading from an older version of MySQL, you must + migrate your UDF files to the plugin directory. + + * Incompatible change: The table_cache system variable has been + renamed to table_open_cache. Any scripts that refer to + table_cache should be updated to use the new name. + + * Incompatible change: Several issues were identified for stored + programs (stored procedures and functions, triggers, and + events) and views containing non-ASCII symbols. These issues + involved conversion errors due to incomplete character set + information when translating these objects to and from stored + format. + To address these problems, the representation for these + objects was changed in MySQL 5.1.21. However, the fixes affect + all stored programs and views. (For example, you will see + warnings about "no creation context.") To avoid warnings from + the server about the use of old definitions from any release + prior to 5.1.21, you should dump stored programs and views + with mysqldump after upgrading to 5.1.21 or higher, and then + reload them to recreate them with new definitions. Invoke + mysqldump with a --default-character-set option that names the + non-ASCII character set that was used for the definitions when + the objects were originally defined. + + * Incompatible change: As of MySQL 5.1.20, mysqld_safe supports + error logging to syslog on systems that support the logger + command. The new --syslog and --skip-syslog options can be + used instead of the --log-error option to control logging + behavior, as described in Section 4.3.2, "mysqld_safe --- + MySQL Server Startup Script." + In 5.1.21 and up, the default is --skip-syslog, which is + compatible with the default behavior of writing an error log + file for releases prior to 5.1.20. + In 5.1.20 only, the following conditions apply: 1) The default + is to use syslog, which is not compatible with releases prior + to 5.1.20. 2) Logging to syslog may fail to operate correctly + in some cases, so we recommend that you use --skip-syslog or + --log-error. To maintain the older behavior if you were using + no error-logging option, use --skip-syslog. If you were using + --log-error, continue to use it. + + * Incompatible change: As of MySQL 5.1.15, InnoDB rolls back + only the last statement on a transaction timeout. A new + option, --innodb_rollback_on_timeout, causes InnoDB to abort + and roll back the entire transaction if a transaction timeout + occurs (the same behavior as in MySQL 4.1). + + * Incompatible change: As of MySQL 5.1.15, the following + conditions apply to enabling the read_only system variable: + + + If you attempt to enable read_only while you have any + explicit locks (acquired with LOCK TABLES or have a + pending transaction, an error will occur. + + + If other clients hold explicit table locks or have + pending transactions, the attempt to enable read_only + blocks until the locks are released and the transactions + end. While the attempt to enable read_only is pending, + requests by other clients for table locks or to begin + transactions also block until read_only has been set. + + + read_only can be enabled while you hold a global read + lock (acquired with FLUSH TABLES WITH READ LOCK) because + that does not involve table locks. + Previously, the attempt to enable read_only would return + immediately even if explicit locks or transactions were + pending, so some data changes could occur for statements + executing in the server at the same time. + + * Incompatible change: The number of function names affected by + IGNORE_SPACE was reduced significantly in MySQL 5.1.13, from + about 200 to about 30. (For details about IGNORE_SPACE, see + Section 8.2.4, "Function Name Parsing and Resolution.") This + change improves the consistency of parser operation. However, + it also introduces the possibility of incompatibility for old + SQL code that relies on the following conditions: + + + IGNORE_SPACE is disabled. + + + The presence or absence of whitespace following a + function name is used to distinguish between a built-in + function and stored function that have the same name (for + example, PI() versus PI ()). + For functions that are no longer affected by IGNORE_SPACE as + of MySQL 5.1.13, that strategy no longer works. Either of the + following approaches can be used if you have code that is + subject to the preceding incompatibility: + + + If a stored function has a name that conflicts with a + built-in function, refer to the stored function with a + schema name qualifier, regardless of whether whitespace + is present. For example, write schema_name.PI() or + schema_name.PI (). + + + Alternatively, rename the stored function to use a + non-conflicting name and change invocations of the + function to use the new name. + + * Incompatible change: For utf8 columns, the full-text parser + incorrectly considered several non-word punctuation and + whitespace characters as word characters, causing some + searches to return incorrect results. The fix involves a + change to the full-text parser in MySQL 5.1.12, so as of + 5.1.12, any tables that have FULLTEXT indexes on utf8 columns + must be repaired with REPAIR TABLE: +REPAIR TABLE tbl_name QUICK; + + * Incompatible change: Storage engines can be pluggable at + runtime, so the distinction between disabled and invalid + storage engines no longer applies. As of MySQL 5.1.12, this + affects the NO_ENGINE_SUBSTITUTION SQL mode, as described in + Section 5.1.7, "Server SQL Modes." + + * Incompatible change: The structure of FULLTEXT indexes has + been changed in MySQL 5.1.6. After upgrading to MySQL 5.1.6 or + greater, use the REPAIR TABLE ... QUICK statement for each + table that contains any FULLTEXT indexes. + + * Incompatible change: In MySQL 5.1.6, when log tables were + implemented, the default log destination for the general query + and slow query log was TABLE. As of MySQL 5.1.21, this default + has been changed to FILE, which is compatible with MySQL 5.0, + but incompatible with earlier releases of MySQL 5.1 from 5.1.6 + to 5.1.20. If you are upgrading from MySQL 5.0 to this + release, no logging option changes should be necessary. + However, if you are upgrading from 5.1.6 through 5.1.20 to + this release and were using TABLE logging, use the + --log-output=TABLE option explicitly to preserve your server's + table-logging behavior. + + * Incompatible change: For ENUM columns that had enumeration + values containing commas, the commas were mapped to 0xff + internally. However, this rendered the commas + indistinguishable from true 0xff characters in the values. + This no longer occurs. However, the fix requires that you dump + and reload any tables that have ENUM columns containing true + 0xff in their values: Dump the tables using mysqldump with the + current server before upgrading from a version of MySQL 5.1 + older than 5.1.15 to version 5.1.15 or newer. + + * As of MySQL 5.1.12, the lc_time_names system variable + specifies the locale that controls the language used to + display day and month names and abbreviations. This variable + affects the output from the DATE_FORMAT(), DAYNAME() and + MONTHNAME() functions. See Section 9.8, "MySQL Server Locale + Support." + + * As of MySQL 5.1.6, special characters in database and table + identifiers are encoded when creating the corresponding + directory names and file names. This relaxes the restrictions + on the characters that can appear in identifiers. See Section + 8.2.3, "Mapping of Identifiers to File Names." To cause + database and table names to be updated to the new format + should they contain special characters, re-encode them with + mysqlcheck. The following command updates all names to the new + encoding: +shell> mysqlcheck --check-upgrade --fix-db-names --fix-table-names -- +all-databases + mysqlcheck cannot fix names that contain literal instances of + the @ character that is used for encoding special characters. + If you have databases or tables that contain this character, + use mysqldump to dump them before upgrading to MySQL 5.1.6 or + later, and then reload the dump file after upgrading. + + * As of MySQL 5.1.9, mysqld_safe no longer implicitly invokes + mysqld-max if it exists. Instead, it invokes mysqld unless a + --mysqld or --mysqld-version option is given to specify + another server explicitly. If you previously relied on the + implicit invocation of mysqld-max, you should use an + appropriate option now. + + SQL Changes: + + * Incompatible change: Multiple-table DELETE statements + containing ambiguous aliases could have unintended side + effects such as deleting rows from the wrong table. Example: +DELETE FROM t1 AS a2 USING t1 AS a1 INNER JOIN t2 AS a2; + As of MySQL 5.1.23, alias declarations can be declared only in + the table_references part. Elsewhere in the statement, alias + references are allowed but not alias declarations. Statements + containing aliases that are no longer allowed must be + rewritten. + + * Important note: Prior to MySQL 5.1.17, the parser accepted + invalid code in SQL condition handlers, leading to server + crashes or unexpected execution behavior in stored programs. + Specifically, the parser allowed a condition handler to refer + to labels for blocks that enclose the handler declaration. + This was incorrect because block label scope does not include + the code for handlers declared within the labeled block. + As of 5.1.17, the parser rejects this invalid construct, but + if you upgrade in place (without dumping and reloading your + databases), existing handlers that contain the construct still + are invalid even if they appear to function as you expect and + should be rewritten. + To find affected handlers, use mysqldump to dump all stored + procedures and functions, triggers, and events. Then attempt + to reload them into an upgraded server. Handlers that contain + illegal label references will be rejected. + For more information about condition handlers and writing them + to avoid invalid jumps, see Section 12.8.4.2, "DECLARE for + Handlers." + + * Incompatible change: The parser accepted statements that + contained /* ... */ that were not properly closed with */, + such as SELECT 1 /* + 2. As of MySQL 5.1.23, statements that + contain unclosed /*-comments now are rejected with a syntax + error. + This fix has the potential to cause incompatibilities. Because + of Bug#26302: http://bugs.mysql.com/26302, which caused the + trailing */ to be truncated from comments in views, stored + routines, triggers, and events, it is possible that objects of + those types may have been stored with definitions that now + will be rejected as syntactically invalid. Such objects should + be dropped and re-created so that their definitions do not + contain truncated comments. + + * Incompatible change: As of MySQL 5.1.8, TYPE = engine_name is + still accepted as a synonym for the ENGINE = engine_name table + option but generates a warning. You should note that this + option is not available in MySQL 5.1.7, and is removed + altogether as of MySQL 5.2.5 and produces a syntax error. + TYPE has been deprecated since MySQL 4.0. + + * Incompatible change: The namespace for triggers has changed in + MySQL 5.0.10. Previously, trigger names had to be unique per + table. Now they must be unique within the schema (database). + An implication of this change is that DROP TRIGGER syntax now + uses a schema name instead of a table name (schema name is + optional and, if omitted, the current schema will be used). + When upgrading from a previous version of MySQL 5 to MySQL + 5.0.10 or newer, you must drop all triggers and re-create them + or DROP TRIGGER will not work after the upgrade. Here is a + suggested procedure for doing this: + + 1. Upgrade to MySQL 5.0.10 or later to be able to access + trigger information in the INFORMATION_SCHEMA.TRIGGERS + table. (It should work even for pre-5.0.10 triggers.) + + 2. Dump all trigger definitions using the following SELECT + statement: +SELECT CONCAT('CREATE TRIGGER ', t.TRIGGER_SCHEMA, '.', t.TRIGGER_NAM +E, + ' ', t.ACTION_TIMING, ' ', t.EVENT_MANIPULATION, ' ON ' +, + t.EVENT_OBJECT_SCHEMA, '.', t.EVENT_OBJECT_TABLE, + ' FOR EACH ROW ', t.ACTION_STATEMENT, '//' ) +INTO OUTFILE '/tmp/triggers.sql' +FROM INFORMATION_SCHEMA.TRIGGERS AS t; + The statement uses INTO OUTFILE, so you must have the + FILE privilege. The file will be created on the server + host; use a different file name if you like. To be 100% + safe, inspect the trigger definitions in the triggers.sql + file, and perhaps make a backup of the file. + + 3. Stop the server and drop all triggers by removing all + .TRG files in your database directories. Change location + to your data directory and issue this command: +shell> rm */*.TRG + + 4. Start the server and re-create all triggers using the + triggers.sql file: For example in my case it was: +mysql> delimiter // ; +mysql> source /tmp/triggers.sql // + + 5. Check that all triggers were successfully created using + the SHOW TRIGGERS statement. + + * Incompatible change: MySQL 5.1.6 introduces the TRIGGER + privilege. Previously, the SUPER privilege was needed to + create or drop triggers. Now those operations require the + TRIGGER privilege. This is a security improvement because you + no longer need to grant users the SUPER privilege to enable + them to create triggers. However, the requirement that the + account named in a trigger's DEFINER clause must have the + SUPER privilege has changed to a requirement for the TRIGGER + privilege. When upgrading from a previous version of MySQL 5.0 + or 5.1 to MySQL 5.1.6 or newer, be sure to update your grant + tables as described in Section 4.4.8, "mysql_upgrade --- Check + Tables for MySQL Upgrade." This process assigns the TRIGGER + privilege to all accounts that had the SUPER privilege. If you + fail to update the grant tables, triggers may fail when + activated. (After updating the grant tables, you can revoke + the SUPER privilege from those accounts that no longer + otherwise require it.) + + * Some keywords are reserved in MySQL 5.1 that were not reserved + in MySQL 5.0. See Section 8.3, "Reserved Words." + + * The LOAD DATA FROM MASTER and LOAD TABLE FROM MASTER + statements are deprecated. See Section 12.6.2.2, "LOAD DATA + FROM MASTER Syntax," for recommended alternatives. + + * The INSTALL PLUGIN and UNINSTALL PLUGIN statements that are + used for the plugin API are new. So is the WITH PARSER clause + for FULLTEXT index creation that associates a parser plugin + with a full-text index. Section 22.2, "The MySQL Plugin + Interface." + + C API Changes: + + * Incompatible change: As of MySQL 5.1.7, the + mysql_stmt_attr_get() C API function returns a boolean rather + than an unsigned int for STMT_ATTR_UPDATE_MAX_LENGTH. + (Bug#16144: http://bugs.mysql.com/16144) + +2.12.2. Downgrading MySQL + + This section describes what you should do to downgrade to an older + MySQL version in the unlikely case that the previous version + worked better than the new one. + + If you are downgrading within the same release series (for + example, from 5.0.13 to 5.0.12) the general rule is that you just + have to install the new binaries on top of the old ones. There is + no need to do anything with the databases. As always, however, it + is always a good idea to make a backup. + + The following items form a checklist of things you should do + whenever you perform a downgrade: + + * Read the upgrading section for the release series from which + you are downgrading to be sure that it does not have any + features you really need. See Section 2.12.1, "Upgrading + MySQL." + + * If there is a downgrading section for that version, you should + read that as well. + + * To see which new features were added between the version to + which you are downgrading and your current version, see the + change logs (Appendix C, "MySQL Change History"). + + * Check Section 2.12.3, "Checking Whether Table Indexes Must Be + Rebuilt," to see whether changes to character sets or + collations were made between your current version of MySQL and + the version to which you are downgrading. If so and these + changes affect your table indexes, you will need to rebuild + the affected indexes using the instructions in Section 2.12.4, + "Rebuilding Tables or Table Indexes." + + In most cases, you can move the MySQL format files and data files + between different versions on the same architecture as long as you + stay within versions for the same release series of MySQL. + + If you downgrade from one release series to another, there may be + incompatibilities in table storage formats. In this case, use + mysqldump to dump your tables before downgrading. After + downgrading, reload the dump file using mysql or mysqlimport to + re-create your tables. For examples, see Section 2.12.5, "Copying + MySQL Databases to Another Machine." + + A typical symptom of a downward-incompatible table format change + when you downgrade is that you cannot open tables. In that case, + use the following procedure: + + 1. Stop the older MySQL server that you are downgrading to. + + 2. Restart the newer MySQL server you are downgrading from. + + 3. Dump any tables that were inaccessible to the older server by + using mysqldump to create a dump file. + + 4. Stop the newer MySQL server and restart the older one. + + 5. Reload the dump file into the older server. Your tables should + be accessible. + + It might also be the case that the structure of the system tables + in the mysql database has changed and that downgrading introduces + some loss of functionality or requires some adjustments. Here are + some examples: + + * Trigger creation requires the TRIGGER privilege as of MySQL + 5.1. In MySQL 5.0, there is no TRIGGER privilege and SUPER is + required instead. If you downgrade from MySQL 5.1 to 5.0, you + will need to give the SUPER privilege to those accounts that + had the TRIGGER privilege in 5.1. + + * Triggers were added in MySQL 5.0, so if you downgrade from 5.0 + to 4.1, you cannot use triggers at all. + +2.12.2.1. Downgrading to MySQL 5.0 + + When downgrading to MySQL 5.0 from MySQL 5.1 or a later version, + you should keep in mind the following issues relating to features + found in MySQL 5.1 and later, but not in MySQL 5.0: + + * Partitioning. MySQL 5.0 does not support user-defined + partitioning. If a table was created as a partitioned table in + 5.1 (or if an table created in a previous version of MySQL was + altered to include partitions after an upgrade to 5.1), the + table is accessible after downgrade only if you do one of the + following: + + + Export the table using mysqldump and then drop it in + MySQL 5.1; import the table again following the downgrade + to MySQL 5.0. + + + Prior to the downgrade, remove the table's partitioning + using ALTER TABLE table_name REMOVE PARTITIONING. + + * Event Scheduler. MySQL 5.0 does not support scheduled events. + If your databases contain scheduled event definitions, you + should prevent them from being dumped when you use mysqldump + by using the --skip-events option. (See Section 4.5.4, + "mysqldump --- A Database Backup Program.") + + * Stored routines. MySQL 5.1.21 added a number of new columns + to the mysql.proc table in which stored routine definitions + are stored. If you are downgrading from MySQL 5.1.21 or later + to MySQL 5.0, you cannot import the MySQL 5.1 routine + definitions into MySQL 5.0.46 or earlier using the dump of + mysql.proc created by mysqldump (such as when using the + --all-databases option). Instead, you should run mysqldump + --routines prior to performing the downgrade and run the + stored routines DDL statements following the downgrade. + See Bug#11986: http://bugs.mysql.com/11986, + Bug#30029: http://bugs.mysql.com/30029, and + Bug#30660: http://bugs.mysql.com/30660, for more information. + + * Triggers. Trigger creation requires the TRIGGER privilege as + of MySQL 5.1. In MySQL 5.0, there is no TRIGGER privilege and + SUPER is required instead. If you downgrade from MySQL 5.1 to + 5.0, you will need to give the SUPER privilege to those + accounts that had the TRIGGER privilege in 5.1. + +2.12.3. Checking Whether Table Indexes Must Be Rebuilt + + A binary upgrade or downgrade is one that installs one version of + MySQL "in place" over an existing version, without dumping and + reloading tables: + + 1. Stop the server for the existing version if it is running. + + 2. Install a different version of MySQL. This is an upgrade if + the new version is higher than the original version, a + downgrade if the version is lower. + + 3. Start the server for the new version. + + In many cases, the tables from the previous version of MySQL can + be used without change by the new version. However, sometimes + modifications are made to the handling of character sets or + collations that change the character sort order, which causes the + ordering of entries in any index that uses an affected character + set or collation to be incorrect. Such changes result in several + possible problems: + + * Comparison results that differ from previous results + + * Inability to find some index values due to misordered index + entries + + * Misordered ORDER BY results + + * Tables that CHECK TABLE reports as being in need of repair + + The solution to these problems is to rebuild any indexes that use + an affected character set or collation, either by dropping and + re-creating the indexes, or by dumping and reloading the entire + table. For information about rebuilding indexes, see Section + 2.12.4, "Rebuilding Tables or Table Indexes." + + To check whether a table has indexes that must be rebuilt, consult + the following list. It indicates which versions of MySQL + introduced character set or collation changes that require indexes + to be rebuilt. Each entry indicates the version in which the + change occurred and the character sets or collations that the + change affects. If the change is associated with a particular bug + report, the bug number is given. + + The list applies both for binary upgrades and downgrades. For + example, Bug#29461: http://bugs.mysql.com/29461 was fixed in MySQL + 5.0.48, so it applies to upgrades from versions older than 5.0.48 + to 5.0.48 or newer, and also to downgrades from 5.0.48 or newer to + versions older than 5.0.58. + + If you have tables with indexes that are affected, rebuild the + indexes using the instructions given in Section 2.12.4, + "Rebuilding Tables or Table Indexes." + + In many cases, you can use CHECK TABLE ... FOR UPDATE to identify + tables for which index rebuilding is required. (It will report: + Table upgrade required. Please do "REPAIR TABLE `tbl_name`" to fix + it!) In these cases, you can also use mysqlcheck --check-upgrade + or mysql_upgrade, which execute CHECK TABLE. However, the use of + CHECK TABLE applies only after upgrades, not downgrades. Also, + CHECK TABLE is not applicable to all storage engines. For details + about which storage engines CHECK TABLE supports, see Section + 12.5.2.3, "CHECK TABLE Syntax." + + Changes that cause index rebuilding to be necessary: + + * MySQL 5.0.48 (Bug#29461: http://bugs.mysql.com/29461) + Affects indexes for columns that use any of these character + sets: eucjpms, euc_kr, gb2312, latin7, macce, ujis + Affected tables can be detected by CHECK TABLE ... FOR UPDATE + as of MySQL 5.1.29, 6.0.8 (see + Bug#39585: http://bugs.mysql.com/39585). + + * MySQL 5.0.48 (Bug#27562: http://bugs.mysql.com/27562) + Affects indexes that use the ascii_general_ci collation for + columns that contain any of these characters: '`' GRAVE + ACCENT, '[' LEFT SQUARE BRACKET, '\' REVERSE SOLIDUS, ']' + RIGHT SQUARE BRACKET, '~' TILDE + Affected tables can be detected by CHECK TABLE ... FOR UPDATE + as of MySQL 5.1.29, 6.0.8 (see + Bug#39585: http://bugs.mysql.com/39585). + + * MySQL 5.1.21 (Bug#29461: http://bugs.mysql.com/29461) + Affects indexes for columns that use any of these character + sets: eucjpms, euc_kr, gb2312, latin7, macce, ujis + Affected tables can be detected by CHECK TABLE ... FOR UPDATE + as of MySQL 5.1.29, 6.0.8 (see + Bug#39585: http://bugs.mysql.com/39585). + + * MySQL 5.1.23 (Bug#27562: http://bugs.mysql.com/27562) + Affects indexes that use the ascii_general_ci collation for + columns that contain any of these characters: '`' GRAVE + ACCENT, '[' LEFT SQUARE BRACKET, '\' REVERSE SOLIDUS, ']' + RIGHT SQUARE BRACKET, '~' TILDE + Affected tables can be detected by CHECK TABLE ... FOR UPDATE + as of MySQL 5.1.29, 6.0.8 (see + Bug#39585: http://bugs.mysql.com/39585). + + * MySQL 5.1.24 (Bug#27877: http://bugs.mysql.com/27877) + Affects indexes that use the utf8_general_ci or + ucs2_general_ci collation for columns that contain 'ß' LATIN + SMALL LETTER SHARP S (German). + Affected tables can be detected by CHECK TABLE ... FOR UPDATE + as of MySQL 5.1.30, 6.0.8 (see + Bug#40053: http://bugs.mysql.com/40053). + + * * MySQL 6.0.1 (WL#3664) + Affects indexes that use the latin2_czech_cs collation. + Affected tables can be detected by CHECK TABLE ... FOR UPDATE + as of MySQL 6.0.9 (see + Bug#40054: http://bugs.mysql.com/40054). + MySQL 6.0.5 (Bug#33452: http://bugs.mysql.com/33452) + Affects indexes that use the latin2_czech_cs collation. + Affected tables can be detected by CHECK TABLE ... FOR UPDATE + as of MySQL 6.0.9 (see + Bug#40054: http://bugs.mysql.com/40054). + + * MySQL 6.0.5 (Bug#27877: http://bugs.mysql.com/27877) + Affects indexes that use the utf8_general_ci or + ucs2_general_ci collation for columns that contain 'ß' LATIN + SMALL LETTER SHARP S (German). + Affected tables can be detected by CHECK TABLE ... FOR UPDATE + as of MySQL 6.0.8 (see + Bug#40053: http://bugs.mysql.com/40053). + + * MySQL 6.0.6 (Bug#25420: http://bugs.mysql.com/25420) + Affects indexes for columns that use the following collations, + if the columns contain the indicated characters: + big5_chinese_ci: '~' TILDE or '`' GRAVE ACCENT; + cp866_general_ci: j LATIN SMALL LETTER J; gb2312_chinese_ci: + '~' TILDE; gbk_chinese_ci: '~' TILDE + Affected tables can be detected by CHECK TABLE ... FOR UPDATE + as of MySQL 6.0.9 (see + Bug#40054: http://bugs.mysql.com/40054). + +2.12.4. Rebuilding Tables or Table Indexes + + This section describes how to rebuild a table. This can be + necessitated by changes to MySQL such as how data types are + handled or changes to character set handling. For example, an + error in a collation might have been corrected, necessitating a + table rebuild to rebuild the indexes for character columns that + use the collation. Methods for rebuilding a table include dumping + and reloading it, or using ALTER TABLE. + +Note + + If you are rebuilding tables because a different version of MySQL + will not handle them after a binary upgrade or downgrade, you must + use the dump-and-reload method. Dump the tables before upgrading + or downgrading (using your original version of MySQL), and reload + the tables after upgrading or downgrading (after installing the + new version). + + If you use the dump-and-reload method of rebuilding tables only + for the purpose of rebuilding indexes, you can perform the dump + either before or after upgrading or downgrading. Reloading still + must be done afterward. + + For the examples in this section, suppose that a table t1 is + defined like this: +CREATE TABLE t1 ( + c1 VARCHAR(10) CHARACTER SET macce, + c2 TEXT CHARACTER SET ujis, + c3 VARCHAR(20) CHARACTER SET latin1, + PRIMARY KEY (c1), + INDEX (c2(20)) +); + + To re-create a table by dumping and reloading it, use mysqldump to + create a dump file and mysql to reload the file: +shell> mysqldump db_name t1 > dump.sql +shell> mysql db_name < dump.sql + + To recreate all the tables in a single database, specify the + database name without any following table name: +shell> mysqldump db_name > dump.sql +shell> mysql db_name < dump.sql + + To recreate all tables in all databases, use the --all-databases + option: +shell> mysqldump --all-databases > dump.sql +shell> mysql < dump.sql + + To rebuild a table with ALTER TABLE, use a statement that + "changes" the table to use the storage engine that it already has. + For example, if t1 is a MyISAM table, use this statement: +mysql> ALTER TABLE t1 ENGINE = MyISAM; + + If you are not sure which storage engine is used for the table, + use SHOW CREATE TABLE to display the table definition. + +2.12.5. Copying MySQL Databases to Another Machine + + You can copy the .frm, .MYI, and .MYD files for MyISAM tables + between different architectures that support the same + floating-point format. (MySQL takes care of any byte-swapping + issues.) See Section 13.5, "The MyISAM Storage Engine." + + In cases where you need to transfer databases between different + architectures, you can use mysqldump to create a file containing + SQL statements. You can then transfer the file to the other + machine and feed it as input to the mysql client. + + Use mysqldump --help to see what options are available. + + The easiest (although not the fastest) way to move a database + between two machines is to run the following commands on the + machine on which the database is located: +shell> mysqladmin -h 'other_hostname' create db_name +shell> mysqldump db_name | mysql -h 'other_hostname' db_name + + If you want to copy a database from a remote machine over a slow + network, you can use these commands: +shell> mysqladmin create db_name +shell> mysqldump -h 'other_hostname' --compress db_name | mysql db_na +me + + You can also store the dump in a file, transfer the file to the + target machine, and then load the file into the database there. + For example, you can dump a database to a compressed file on the + source machine like this: +shell> mysqldump --quick db_name | gzip > db_name.gz + + Transfer the file containing the database contents to the target + machine and run these commands there: +shell> mysqladmin create db_name +shell> gunzip < db_name.gz | mysql db_name + + You can also use mysqldump and mysqlimport to transfer the + database. For large tables, this is much faster than simply using + mysqldump. In the following commands, DUMPDIR represents the full + path name of the directory you use to store the output from + mysqldump. + + First, create the directory for the output files and dump the + database: +shell> mkdir DUMPDIR +shell> mysqldump --tab=DUMPDIR db_name + + Then transfer the files in the DUMPDIR directory to some + corresponding directory on the target machine and load the files + into MySQL there: +shell> mysqladmin create db_name # create database +shell> cat DUMPDIR/*.sql | mysql db_name # create tables in databas +e +shell> mysqlimport db_name DUMPDIR/*.txt # load data into tables + + Do not forget to copy the mysql database because that is where the + grant tables are stored. You might have to run commands as the + MySQL root user on the new machine until you have the mysql + database in place. + + After you import the mysql database on the new machine, execute + mysqladmin flush-privileges so that the server reloads the grant + table information. + +2.13. Operating System-Specific Notes + +2.13.1. Linux Notes + + This section discusses issues that have been found to occur on + Linux. The first few subsections describe general operating + system-related issues, problems that can occur when using binary + or source distributions, and post-installation issues. The + remaining subsections discuss problems that occur with Linux on + specific platforms. + + Note that most of these problems occur on older versions of Linux. + If you are running a recent version, you may see none of them. + +2.13.1.1. Linux Operating System Notes + + MySQL needs at least Linux version 2.0. + +Warning + + We have seen some strange problems with Linux 2.2.14 and MySQL on + SMP systems. We also have reports from some MySQL users that they + have encountered serious stability problems using MySQL with + kernel 2.2.14. If you are using this kernel, you should upgrade to + 2.2.19 (or newer) or to a 2.4 kernel. If you have a multiple-CPU + box, you should seriously consider using 2.4 because it gives you + a significant speed boost. Your system should be more stable. + + When using LinuxThreads, you should see a minimum of three mysqld + processes running. These are in fact threads. There is one thread + for the LinuxThreads manager, one thread to handle connections, + and one thread to handle alarms and signals. + +2.13.1.2. Linux Binary Distribution Notes + + The Linux-Intel binary and RPM releases of MySQL are configured + for the highest possible speed. We are always trying to use the + fastest stable compiler available. + + The binary release is linked with -static, which means you do not + normally need to worry about which version of the system libraries + you have. You need not install LinuxThreads, either. A program + linked with -static is slightly larger than a dynamically linked + program, but also slightly faster (3-5%). However, one problem + with a statically linked program is that you can't use + user-defined functions (UDFs). If you are going to write or use + UDFs (this is something for C or C++ programmers only), you must + compile MySQL yourself using dynamic linking. + + A known issue with binary distributions is that on older Linux + systems that use libc (such as Red Hat 4.x or Slackware), you get + some (non-fatal) issues with host name resolution. If your system + uses libc rather than glibc2, you probably will encounter some + difficulties with host name resolution and getpwnam(). This + happens because glibc (unfortunately) depends on some external + libraries to implement host name resolution and getpwent(), even + when compiled with -static. These problems manifest themselves in + two ways: + + * You may see the following error message when you run + mysql_install_db: +Sorry, the host 'xxxx' could not be looked up + You can deal with this by executing mysql_install_db --force, + which does not execute the resolveip test in mysql_install_db. + The downside is that you cannot use host names in the grant + tables: except for localhost, you must use IP numbers instead. + If you are using an old version of MySQL that does not support + --force, you must manually remove the resolveip test in + mysql_install_db using a text editor. + + * You also may see the following error when you try to run + mysqld with the --user option: +getpwnam: No such file or directory + To work around this problem, start mysqld by using the su + command rather than by specifying the --user option. This + causes the system itself to change the user ID of the mysqld + process so that mysqld need not do so. + + Another solution, which solves both problems, is not to use a + binary distribution. Obtain a MySQL source distribution (in RPM or + tar.gz format) and install that instead. + + On some Linux 2.2 versions, you may get the error Resource + temporarily unavailable when clients make a great many new + connections to a mysqld server over TCP/IP. The problem is that + Linux has a delay between the time that you close a TCP/IP socket + and the time that the system actually frees it. There is room for + only a finite number of TCP/IP slots, so you encounter the + resource-unavailable error if clients attempt too many new TCP/IP + connections over a short period of time. For example, you may see + the error when you run the MySQL test-connect benchmark over + TCP/IP. + + We have inquired about this problem a few times on different Linux + mailing lists but have never been able to find a suitable + resolution. The only known "fix" is for clients to use persistent + connections, or, if you are running the database server and + clients on the same machine, to use Unix socket file connections + rather than TCP/IP connections. + +2.13.1.3. Linux Source Distribution Notes + + The following notes regarding glibc apply only to the situation + when you build MySQL yourself. If you are running Linux on an x86 + machine, in most cases it is much better for you to use our + binary. We link our binaries against the best patched version of + glibc we can find and with the best compiler options, in an + attempt to make it suitable for a high-load server. For a typical + user, even for setups with a lot of concurrent connections or + tables exceeding the 2GB limit, our binary is the best choice in + most cases. After reading the following text, if you are in doubt + about what to do, try our binary first to determine whether it + meets your needs. If you discover that it is not good enough, you + may want to try your own build. In that case, we would appreciate + a note about it so that we can build a better binary next time. + + MySQL uses LinuxThreads on Linux. If you are using an old Linux + version that doesn't have glibc2, you must install LinuxThreads + before trying to compile MySQL. You can obtain LinuxThreads from + http://dev.mysql.com/downloads/os-linux.html. + + Note that glibc versions before and including version 2.1.1 have a + fatal bug in pthread_mutex_timedwait() handling, which is used + when INSERT DELAYED statements are issued. We recommend that you + not use INSERT DELAYED before upgrading glibc. + + Note that Linux kernel and the LinuxThread library can by default + handle a maximum of 1,024 threads. If you plan to have more than + 1,000 concurrent connections, you need to make some changes to + LinuxThreads, as follows: + + * Increase PTHREAD_THREADS_MAX in + sysdeps/unix/sysv/linux/bits/local_lim.h to 4096 and decrease + STACK_SIZE in linuxthreads/internals.h to 256KB. The paths are + relative to the root of glibc. (Note that MySQL is not stable + with 600-1000 connections if STACK_SIZE is the default of + 2MB.) + + * Recompile LinuxThreads to produce a new libpthread.a library, + and relink MySQL against it. + + There is another issue that greatly hurts MySQL performance, + especially on SMP systems. The mutex implementation in + LinuxThreads in glibc 2.1 is very poor for programs with many + threads that hold the mutex only for a short time. This produces a + paradoxical result: If you link MySQL against an unmodified + LinuxThreads, removing processors from an SMP actually improves + MySQL performance in many cases. We have made a patch available + for glibc 2.1.3 to correct this behavior + (http://dev.mysql.com/Downloads/Linux/linuxthreads-2.1-patch). + + With glibc 2.2.2, MySQL uses the adaptive mutex, which is much + better than even the patched one in glibc 2.1.3. Be warned, + however, that under some conditions, the current mutex code in + glibc 2.2.2 overspins, which hurts MySQL performance. The + likelihood that this condition occurs can be reduced by re-nicing + the mysqld process to the highest priority. We have also been able + to correct the overspin behavior with a patch, available at + http://dev.mysql.com/Downloads/Linux/linuxthreads-2.2.2.patch. It + combines the correction of overspin, maximum number of threads, + and stack spacing all in one. You need to apply it in the + linuxthreads directory with patch -p0 + </tmp/linuxthreads-2.2.2.patch. We hope it is included in some + form in future releases of glibc 2.2. In any case, if you link + against glibc 2.2.2, you still need to correct STACK_SIZE and + PTHREAD_THREADS_MAX. We hope that the defaults is corrected to + some more acceptable values for high-load MySQL setup in the + future, so that the commands needed to produce your own build can + be reduced to ./configure; make; make install. + + We recommend that you use these patches to build a special static + version of libpthread.a and use it only for statically linking + against MySQL. We know that these patches are safe for MySQL and + significantly improve its performance, but we cannot say anything + about their effects on other applications. If you link other + applications that require LinuxThreads against the patched static + version of the library, or build a patched shared version and + install it on your system, you do so at your own risk. + + If you experience any strange problems during the installation of + MySQL, or with some common utilities hanging, it is very likely + that they are either library or compiler related. If this is the + case, using our binary resolves them. + + If you link your own MySQL client programs, you may see the + following error at runtime: +ld.so.1: fatal: libmysqlclient.so.#: +open failed: No such file or directory + + This problem can be avoided by one of the following methods: + + * Link clients with the -Wl,r/full/path/to/libmysqlclient.so + flag rather than with -Lpath). + + * Copy libmysqclient.so to /usr/lib. + + * Add the path name of the directory where libmysqlclient.so is + located to the LD_RUN_PATH environment variable before running + your client. + + If you are using the Fujitsu compiler (fcc/FCC), you may have some + problems compiling MySQL because the Linux header files are very + gcc oriented. The following configure line should work with + fcc/FCC: +CC=fcc CFLAGS="-O -K fast -K lib -K omitfp -Kpreex -D_GNU_SOURCE \ + -DCONST=const -DNO_STRTOLL_PROTO" \ +CXX=FCC CXXFLAGS="-O -K fast -K lib \ + -K omitfp -K preex --no_exceptions --no_rtti -D_GNU_SOURCE \ + -DCONST=const -Dalloca=__builtin_alloca -DNO_STRTOLL_PROTO \ + '-D_EXTERN_INLINE=static __inline'" \ +./configure \ + --prefix=/usr/local/mysql --enable-assembler \ + --with-mysqld-ldflags=-all-static --disable-shared \ + --with-low-memory + +2.13.1.4. Linux Post-Installation Notes + + mysql.server can be found in the support-files directory under the + MySQL installation directory or in a MySQL source tree. You can + install it as /etc/init.d/mysql for automatic MySQL startup and + shutdown. See Section 2.11.2.2, "Starting and Stopping MySQL + Automatically." + + If MySQL cannot open enough files or connections, it may be that + you have not configured Linux to handle enough files. + + In Linux 2.2 and onward, you can check the number of allocated + file handles as follows: +shell> cat /proc/sys/fs/file-max +shell> cat /proc/sys/fs/dquot-max +shell> cat /proc/sys/fs/super-max + + If you have more than 16MB of memory, you should add something + like the following to your init scripts (for example, + /etc/init.d/boot.local on SuSE Linux): +echo 65536 > /proc/sys/fs/file-max +echo 8192 > /proc/sys/fs/dquot-max +echo 1024 > /proc/sys/fs/super-max + + You can also run the echo commands from the command line as root, + but these settings are lost the next time your computer restarts. + + Alternatively, you can set these parameters on startup by using + the sysctl tool, which is used by many Linux distributions + (including SuSE Linux 8.0 and later). Put the following values + into a file named /etc/sysctl.conf: +# Increase some values for MySQL +fs.file-max = 65536 +fs.dquot-max = 8192 +fs.super-max = 1024 + + You should also add the following to /etc/my.cnf: +[mysqld_safe] +open-files-limit=8192 + + This should allow the server a limit of 8,192 for the combined + number of connections and open files. + + The STACK_SIZE constant in LinuxThreads controls the spacing of + thread stacks in the address space. It needs to be large enough so + that there is plenty of room for each individual thread stack, but + small enough to keep the stack of some threads from running into + the global mysqld data. Unfortunately, as we have experimentally + discovered, the Linux implementation of mmap() successfully unmaps + a mapped region if you ask it to map out an address currently in + use, zeroing out the data on the entire page instead of returning + an error. So, the safety of mysqld or any other threaded + application depends on the "gentlemanly" behavior of the code that + creates threads. The user must take measures to make sure that the + number of running threads at any given time is sufficiently low + for thread stacks to stay away from the global heap. With mysqld, + you should enforce this behavior by setting a reasonable value for + the max_connections variable. + + If you build MySQL yourself, you can patch LinuxThreads for better + stack use. See Section 2.13.1.3, "Linux Source Distribution + Notes." If you do not want to patch LinuxThreads, you should set + max_connections to a value no higher than 500. It should be even + less if you have a large key buffer, large heap tables, or some + other things that make mysqld allocate a lot of memory, or if you + are running a 2.2 kernel with a 2GB patch. If you are using our + binary or RPM version, you can safely set max_connections at 1500, + assuming no large key buffer or heap tables with lots of data. The + more you reduce STACK_SIZE in LinuxThreads the more threads you + can safely create. We recommend values between 128KB and 256KB. + + If you use a lot of concurrent connections, you may suffer from a + "feature" in the 2.2 kernel that attempts to prevent fork bomb + attacks by penalizing a process for forking or cloning a child. + This causes MySQL not to scale well as you increase the number of + concurrent clients. On single-CPU systems, we have seen this + manifest as very slow thread creation; it may take a long time to + connect to MySQL (as long as one minute), and it may take just as + long to shut it down. On multiple-CPU systems, we have observed a + gradual drop in query speed as the number of clients increases. In + the process of trying to find a solution, we have received a + kernel patch from one of our users who claimed it helped for his + site. This patch is available at + http://dev.mysql.com/Downloads/Patches/linux-fork.patch. We have + done rather extensive testing of this patch on both development + and production systems. It has significantly improved MySQL + performance without causing any problems and we recommend it to + our users who still run high-load servers on 2.2 kernels. + + This issue has been fixed in the 2.4 kernel, so if you are not + satisfied with the current performance of your system, rather than + patching your 2.2 kernel, it might be easier to upgrade to 2.4. On + SMP systems, upgrading also gives you a nice SMP boost in addition + to fixing the fairness bug. + + We have tested MySQL on the 2.4 kernel on a two-CPU machine and + found MySQL scales much better. There was virtually no slowdown on + query throughput all the way up to 1,000 clients, and the MySQL + scaling factor (computed as the ratio of maximum throughput to the + throughput for one client) was 180%. We have observed similar + results on a four-CPU system: Virtually no slowdown as the number + of clients was increased up to 1,000, and a 300% scaling factor. + Based on these results, for a high-load SMP server using a 2.2 + kernel, we definitely recommend upgrading to the 2.4 kernel at + this point. + + We have discovered that it is essential to run the mysqld process + with the highest possible priority on the 2.4 kernel to achieve + maximum performance. This can be done by adding a renice -20 $$ + command to mysqld_safe. In our testing on a four-CPU machine, + increasing the priority resulted in a 60% throughput increase with + 400 clients. + + We are currently also trying to collect more information on how + well MySQL performs with a 2.4 kernel on four-way and eight-way + systems. If you have access such a system and have done some + benchmarks, please send an email message to benchmarks(a)mysql.com + with the results. We will review them for inclusion in the manual. + + If you see a dead mysqld server process with ps, this usually + means that you have found a bug in MySQL or you have a corrupted + table. See Section B.1.4.2, "What to Do If MySQL Keeps Crashing." + + To get a core dump on Linux if mysqld dies with a SIGSEGV signal, + you can start mysqld with the --core-file option. Note that you + also probably need to raise the core file size by adding ulimit -c + 1000000 to mysqld_safe or starting mysqld_safe with + --core-file-size=1000000. See Section 4.3.2, "mysqld_safe --- + MySQL Server Startup Script." + +2.13.1.5. Linux x86 Notes + + MySQL requires libc 5.4.12 or newer. It is known to work with libc + 5.4.46. glibc 2.0.6 and later should also work. There have been + some problems with the glibc RPMs from Red Hat, so if you have + problems, check whether there are any updates. The glibc 2.0.7-19 + and 2.0.7-29 RPMs are known to work. + + If you are using Red Hat 8.0 or a new glibc 2.2.x library, you may + see mysqld die in gethostbyaddr(). This happens because the new + glibc library requires a stack size greater than 128KB for this + call. To fix the problem, start mysqld with the + --thread-stack=192K option. (Use -O thread_stack=192K before MySQL + 4.) This stack size is the default on MySQL 4.0.10 and above, so + you should not see the problem. + + If you are using gcc 3.0 and above to compile MySQL, you must + install the libstdc++v3 library before compiling MySQL; if you + don't do this, you get an error about a missing __cxa_pure_virtual + symbol during linking. + + On some older Linux distributions, configure may produce an error + like this: +Syntax error in sched.h. Change _P to __P in the +/usr/include/sched.h file. +See the Installation chapter in the Reference Manual. + + Just do what the error message says. Add an extra underscore to + the _P macro name that has only one underscore, and then try + again. + + You may get some warnings when compiling. Those shown here can be + ignored: +mysqld.cc -o objs-thread/mysqld.o +mysqld.cc: In function `void init_signals()': +mysqld.cc:315: warning: assignment of negative value `-1' to +`long unsigned int' +mysqld.cc: In function `void * signal_hand(void *)': +mysqld.cc:346: warning: assignment of negative value `-1' to +`long unsigned int' + + If mysqld always dumps core when it starts, the problem may be + that you have an old /lib/libc.a. Try renaming it, and then remove + sql/mysqld and do a new make install and try again. This problem + has been reported on some Slackware installations. + + If you get the following error when linking mysqld, it means that + your libg++.a is not installed correctly: +/usr/lib/libc.a(putc.o): In function `_IO_putc': +putc.o(.text+0x0): multiple definition of `_IO_putc' + + You can avoid using libg++.a by running configure like this: +shell> CXX=gcc ./configure + +2.13.1.6. Linux SPARC Notes + + In some implementations, readdir_r() is broken. The symptom is + that the SHOW DATABASES statement always returns an empty set. + This can be fixed by removing HAVE_READDIR_R from config.h after + configuring and before compiling. + +2.13.1.7. Linux Alpha Notes + + We have tested MySQL 5.1 on Alpha with our benchmarks and test + suite, and it appears to work well. + + We currently build the MySQL binary packages on SuSE Linux 7.0 for + AXP, kernel 2.4.4-SMP, Compaq C compiler (V6.2-505) and Compaq C++ + compiler (V6.3-006) on a Compaq DS20 machine with an Alpha EV6 + processor. + + You can find the preceding compilers at + http://www.support.compaq.com/alpha-tools/. By using these + compilers rather than gcc, we get about 9-14% better MySQL + performance. + + For MySQL on Alpha, we use the -arch generic flag to our compile + options, which ensures that the binary runs on all Alpha + processors. We also compile statically to avoid library problems. + The configure command looks like this: +CC=ccc CFLAGS="-fast -arch generic" CXX=cxx \ +CXXFLAGS="-fast -arch generic -noexceptions -nortti" \ +./configure --prefix=/usr/local/mysql --disable-shared \ + --with-extra-charsets=complex --enable-thread-safe-client \ + --with-mysqld-ldflags=-non_shared --with-client-ldflags=-non_shar +ed + + Some known problems when running MySQL on Linux-Alpha: + + * Debugging threaded applications like MySQL does not work with + gdb 4.18. You should use gdb 5.1 instead. + + * If you try linking mysqld statically when using gcc, the + resulting image dumps core at startup time. In other words, do + not use --with-mysqld-ldflags=-all-static with gcc. + +2.13.1.8. Linux PowerPC Notes + + MySQL should work on MkLinux with the newest glibc package (tested + with glibc 2.0.7). + +2.13.1.9. Linux MIPS Notes + + To get MySQL to work on Qube2 (Linux Mips), you need the newest + glibc libraries. glibc-2.0.7-29C2 is known to work. You must also + use gcc 2.95.2 or newer). + +2.13.1.10. Linux IA-64 Notes + + To get MySQL to compile on Linux IA-64, we use the following + configure command for building with gcc 2.96: +CC=gcc \ +CFLAGS="-O3 -fno-omit-frame-pointer" \ +CXX=gcc \ +CXXFLAGS="-O3 -fno-omit-frame-pointer -felide-constructors \ + -fno-exceptions -fno-rtti" \ + ./configure --prefix=/usr/local/mysql \ + "--with-comment=Official MySQL binary" \ + --with-extra-charsets=complex + + On IA-64, the MySQL client binaries use shared libraries. This + means that if you install our binary distribution at a location + other than /usr/local/mysql, you need to add the path of the + directory where you have libmysqlclient.so installed either to the + /etc/ld.so.conf file or to the value of your LD_LIBRARY_PATH + environment variable. + + See Section B.1.3.1, "Problems Linking to the MySQL Client + Library." + +2.13.1.11. SELinux Notes + + RHEL4 comes with SELinux, which supports tighter access control + for processes. If SELinux is enabled (SELINUX in + /etc/selinux/config is set to enforcing, SELINUXTYPE is set to + either targeted or strict), you might encounter problems + installing MySQL AB RPM packages. + + Red Hat has an update that solves this. It involves an update of + the "security policy" specification to handle the install + structure of the RPMs provided by MySQL AB. For further + information, see + https://bugzilla.redhat.com/bugzilla/show_bug.cgi?id=167551 and + http://rhn.redhat.com/errata/RHBA-2006-0049.html. + + The preceding discussion applies only to RHEL4. The patch is + unnecessary for RHEL5. + +2.13.2. Mac OS X Notes + + On Mac OS X, tar cannot handle long file names. If you need to + unpack a .tar.gz distribution, use gnutar instead. + +2.13.2.1. Mac OS X 10.x (Darwin) + + MySQL should work without major problems on Mac OS X 10.x + (Darwin). + + Known issues: + + * If you have problems with performance under heavy load, try + using the --skip-thread-priority option to mysqld. This runs + all threads with the same priority. On Mac OS X, this gives + better performance, at least until Apple fixes its thread + scheduler. + + * The connection times (wait_timeout, interactive_timeout and + net_read_timeout) values are not honored. + This is probably a signal handling problem in the thread + library where the signal doesn't break a pending read and we + hope that a future update to the thread libraries will fix + this. + + Our binary for Mac OS X is compiled on Darwin 6.3 with the + following configure line: +CC=gcc CFLAGS="-O3 -fno-omit-frame-pointer" CXX=gcc \ +CXXFLAGS="-O3 -fno-omit-frame-pointer -felide-constructors \ + -fno-exceptions -fno-rtti" \ + ./configure --prefix=/usr/local/mysql \ + --with-extra-charsets=complex --enable-thread-safe-client \ + --enable-local-infile --disable-shared + + See Section 2.5, "Installing MySQL on Mac OS X." + +2.13.2.2. Mac OS X Server 1.2 (Rhapsody) + + For current versions of Mac OS X Server, no operating system + changes are necessary before compiling MySQL. Compiling for the + Server platform is the same as for the client version of Mac OS X. + + For older versions (Mac OS X Server 1.2, a.k.a. Rhapsody), you + must first install a pthread package before trying to configure + MySQL. + + See Section 2.5, "Installing MySQL on Mac OS X." + +2.13.3. Solaris Notes + + For information about installing MySQL on Solaris using PKG + distributions, see Section 2.6, "Installing MySQL on Solaris." + + On Solaris, you may run into trouble even before you get the MySQL + distribution unpacked, as the Solaris tar cannot handle long file + names. This means that you may see errors when you try to unpack + MySQL. + + If this occurs, you must use GNU tar (gtar) to unpack the + distribution. You can find a precompiled copy for Solaris at + http://dev.mysql.com/downloads/os-solaris.html. + + Sun native threads work only on Solaris 2.5 and higher. For + Solaris 2.4 and earlier, MySQL automatically uses MIT-pthreads. + See Section 2.10.5, "MIT-pthreads Notes." + + If you get the following error from configure, it means that you + have something wrong with your compiler installation: +checking for restartable system calls... configure: error can not +run test programs while cross compiling + + In this case, you should upgrade your compiler to a newer version. + You may also be able to solve this problem by inserting the + following row into the config.cache file: +ac_cv_sys_restartable_syscalls=${ac_cv_sys_restartable_syscalls='no'} + + If you are using Solaris on a SPARC, the recommended compiler is + gcc 2.95.2 or 3.2. You can find this at http://gcc.gnu.org/. Note + that gcc 2.8.1 does not work reliably on SPARC. + + The recommended configure line when using gcc 2.95.2 is: +CC=gcc CFLAGS="-O3" \ +CXX=gcc CXXFLAGS="-O3 -felide-constructors -fno-exceptions -fno-rtti" + \ +./configure --prefix=/usr/local/mysql --with-low-memory \ + --enable-assembler + + If you have an UltraSPARC system, you can get 4% better + performance by adding -mcpu=v8 -Wa,-xarch=v8plusa to the CFLAGS + and CXXFLAGS environment variables. + + If you have Sun's Forte 5.0 (or newer) compiler, you can run + configure like this: +CC=cc CFLAGS="-Xa -fast -native -xstrconst -mt" \ +CXX=CC CXXFLAGS="-noex -mt" \ +./configure --prefix=/usr/local/mysql --enable-assembler + + To create a 64-bit binary with Sun's Forte compiler, use the + following configuration options: +CC=cc CFLAGS="-Xa -fast -native -xstrconst -mt -xarch=v9" \ +CXX=CC CXXFLAGS="-noex -mt -xarch=v9" ASFLAGS="-xarch=v9" \ +./configure --prefix=/usr/local/mysql --enable-assembler + + To create a 64-bit Solaris binary using gcc, add -m64 to CFLAGS + and CXXFLAGS and remove --enable-assembler from the configure + line. + + In the MySQL benchmarks, we obtained a 4% speed increase on + UltraSPARC when using Forte 5.0 in 32-bit mode, as compared to + using gcc 3.2 with the -mcpu flag. + + If you create a 64-bit mysqld binary, it is 4% slower than the + 32-bit binary, but can handle more threads and memory. + + When using Solaris 10 for x86_64, you should mount any file + systems on which you intend to store InnoDB files with the + forcedirectio option. (By default mounting is done without this + option.) Failing to do so will cause a significant drop in + performance when using the InnoDB storage engine on this platform. + + If you get a problem with fdatasync or sched_yield, you can fix + this by adding LIBS=-lrt to the configure line + + For compilers older than WorkShop 5.3, you might have to edit the + configure script. Change this line: +#if !defined(__STDC__) || __STDC__ != 1 + + To this: +#if !defined(__STDC__) + + If you turn on __STDC__ with the -Xc option, the Sun compiler + can't compile with the Solaris pthread.h header file. This is a + Sun bug (broken compiler or broken include file). + + If mysqld issues the following error message when you run it, you + have tried to compile MySQL with the Sun compiler without enabling + the -mt multi-thread option: +libc internal error: _rmutex_unlock: rmutex not held + + Add -mt to CFLAGS and CXXFLAGS and recompile. + + If you are using the SFW version of gcc (which comes with Solaris + 8), you must add /opt/sfw/lib to the environment variable + LD_LIBRARY_PATH before running configure. + + If you are using the gcc available from sunfreeware.com, you may + have many problems. To avoid this, you should recompile gcc and + GNU binutils on the machine where you are running them. + + If you get the following error when compiling MySQL with gcc, it + means that your gcc is not configured for your version of Solaris: +shell> gcc -O3 -g -O2 -DDBUG_OFF -o thr_alarm ... +./thr_alarm.c: In function `signal_hand': +./thr_alarm.c:556: too many arguments to function `sigwait' + + The proper thing to do in this case is to get the newest version + of gcc and compile it with your current gcc compiler. At least for + Solaris 2.5, almost all binary versions of gcc have old, unusable + include files that break all programs that use threads, and + possibly other programs as well. + + Solaris does not provide static versions of all system libraries + (libpthreads and libdl), so you cannot compile MySQL with + --static. If you try to do so, you get one of the following + errors: +ld: fatal: library -ldl: not found +undefined reference to `dlopen' +cannot find -lrt + + If you link your own MySQL client programs, you may see the + following error at runtime: +ld.so.1: fatal: libmysqlclient.so.#: +open failed: No such file or directory + + This problem can be avoided by one of the following methods: + + * Link clients with the -Wl,r/full/path/to/libmysqlclient.so + flag rather than with -Lpath). + + * Copy libmysqclient.so to /usr/lib. + + * Add the path name of the directory where libmysqlclient.so is + located to the LD_RUN_PATH environment variable before running + your client. + + If you have problems with configure trying to link with -lz when + you don't have zlib installed, you have two options: + + * If you want to be able to use the compressed communication + protocol, you need to get and install zlib from ftp.gnu.org. + + * Run configure with the --with-named-z-libs=no option when + building MySQL. + + If you are using gcc and have problems with loading user-defined + functions (UDFs) into MySQL, try adding -lgcc to the link line for + the UDF. + + If you would like MySQL to start automatically, you can copy + support-files/mysql.server to /etc/init.d and create a symbolic + link to it named /etc/rc3.d/S99mysql.server. + + If too many processes try to connect very rapidly to mysqld, you + should see this error in the MySQL log: +Error in accept: Protocol error + + You might try starting the server with the --back_log=50 option as + a workaround for this. (Use -O back_log=50 before MySQL 4.) + + Solaris doesn't support core files for setuid() applications, so + you can't get a core file from mysqld if you are using the --user + option. + +2.13.3.1. Solaris 2.7/2.8 Notes + + Normally, you can use a Solaris 2.6 binary on Solaris 2.7 and 2.8. + Most of the Solaris 2.6 issues also apply for Solaris 2.7 and 2.8. + + MySQL should be able to detect new versions of Solaris + automatically and enable workarounds for the following problems. + + Solaris 2.7 / 2.8 has some bugs in the include files. You may see + the following error when you use gcc: +/usr/include/widec.h:42: warning: `getwc' redefined +/usr/include/wchar.h:326: warning: this is the location of the previo +us +definition + + If this occurs, you can fix the problem by copying + /usr/include/widec.h to .../lib/gcc-lib/os/gcc-version/include and + changing line 41 from this: +#if !defined(lint) && !defined(__lint) + + To this: +#if !defined(lint) && !defined(__lint) && !defined(getwc) + + Alternatively, you can edit /usr/include/widec.h directly. Either + way, after you make the fix, you should remove config.cache and + run configure again. + + If you get the following errors when you run make, it is because + configure didn't detect the curses.h file (probably because of the + error in /usr/include/widec.h): +In file included from mysql.cc:50: +/usr/include/term.h:1060: syntax error before `,' +/usr/include/term.h:1081: syntax error before `;' + + The solution to this problem is to do one of the following: + + * Configure with CFLAGS=-DHAVE_CURSES_H CXXFLAGS=-DHAVE_CURSES_H + ./configure. + + * Edit /usr/include/widec.h as indicated in the preceding + discussion and re-run configure. + + * Remove the #define HAVE_TERM line from the config.h file and + run make again. + + If your linker cannot find -lz when linking client programs, the + problem is probably that your libz.so file is installed in + /usr/local/lib. You can fix this problem by one of the following + methods: + + * Add /usr/local/lib to LD_LIBRARY_PATH. + + * Add a link to libz.so from /lib. + + * If you are using Solaris 8, you can install the optional zlib + from your Solaris 8 CD distribution. + + * Run configure with the --with-named-z-libs=no option when + building MySQL. + +2.13.3.2. Solaris x86 Notes + + On Solaris 8 on x86, mysqld dumps core if you remove the debug + symbols using strip. + + If you are using gcc on Solaris x86 and you experience problems + with core dumps under load, you should use the following configure + command: +CC=gcc CFLAGS="-O3 -fomit-frame-pointer -DHAVE_CURSES_H" \ +CXX=gcc \ +CXXFLAGS="-O3 -fomit-frame-pointer -felide-constructors \ + -fno-exceptions -fno-rtti -DHAVE_CURSES_H" \ +./configure --prefix=/usr/local/mysql + + This avoids problems with the libstdc++ library and with C++ + exceptions. + + If this doesn't help, you should compile a debug version and run + it with a trace file or under gdb. See MySQL Internals: Porting + (http://forge.mysql.com/wiki/MySQL_Internals_Porting). + +2.13.4. BSD Notes + + This section provides information about using MySQL on variants of + BSD Unix. + +2.13.4.1. FreeBSD Notes + + FreeBSD 4.x or newer is recommended for running MySQL, because the + thread package is much more integrated. To get a secure and stable + system, you should use only FreeBSD kernels that are marked + -RELEASE. + + The easiest (and preferred) way to install MySQL is to use the + mysql-server and mysql-client ports available at + http://www.freebsd.org/. Using these ports gives you the following + benefits: + + * A working MySQL with all optimizations enabled that are known + to work on your version of FreeBSD. + + * Automatic configuration and build. + + * Startup scripts installed in /usr/local/etc/rc.d. + + * The ability to use pkg_info -L to see which files are + installed. + + * The ability to use pkg_delete to remove MySQL if you no longer + want it on your machine. + + It is recommended you use MIT-pthreads on FreeBSD 2.x, and native + threads on FreeBSD 3 and up. It is possible to run with native + threads on some late 2.2.x versions, but you may encounter + problems shutting down mysqld. + + Unfortunately, certain function calls on FreeBSD are not yet fully + thread-safe. Most notably, this includes the gethostbyname() + function, which is used by MySQL to convert host names into IP + addresses. Under certain circumstances, the mysqld process + suddenly causes 100% CPU load and is unresponsive. If you + encounter this problem, try to start MySQL using the + --skip-name-resolve option. + + Alternatively, you can link MySQL on FreeBSD 4.x against the + LinuxThreads library, which avoids a few of the problems that the + native FreeBSD thread implementation has. For a very good + comparison of LinuxThreads versus native threads, see Jeremy + Zawodny's article FreeBSD or Linux for your MySQL Server? at + http://jeremy.zawodny.com/blog/archives/000697.html. + + Known problem when using LinuxThreads on FreeBSD is: + + * The connection times (wait_timeout, interactive_timeout and + net_read_timeout) values are not honored. The symptom is that + persistent connections can hang for a very long time without + getting closed down and that a 'kill' for a thread will not + take affect until the thread does it a new command + This is probably a signal handling problem in the thread + library where the signal doesn't break a pending read. This is + supposed to be fixed in FreeBSD 5.0 + + The MySQL build process requires GNU make (gmake) to work. If GNU + make is not available, you must install it first before compiling + MySQL. + + The recommended way to compile and install MySQL on FreeBSD with + gcc (2.95.2 and up) is: +CC=gcc CFLAGS="-O2 -fno-strength-reduce" \ + CXX=gcc CXXFLAGS="-O2 -fno-rtti -fno-exceptions \ + -felide-constructors -fno-strength-reduce" \ + ./configure --prefix=/usr/local/mysql --enable-assembler +gmake +gmake install +cd /usr/local/mysql +bin/mysql_install_db --user=mysql +bin/mysqld_safe & + + If you notice that configure uses MIT-pthreads, you should read + the MIT-pthreads notes. See Section 2.10.5, "MIT-pthreads Notes." + + If you get an error from make install that it can't find + /usr/include/pthreads, configure didn't detect that you need + MIT-pthreads. To fix this problem, remove config.cache, and then + re-run configure with the --with-mit-threads option. + + Be sure that your name resolver setup is correct. Otherwise, you + may experience resolver delays or failures when connecting to + mysqld. Also make sure that the localhost entry in the /etc/hosts + file is correct. The file should start with a line similar to + this: +127.0.0.1 localhost localhost.your.domain + + FreeBSD is known to have a very low default file handle limit. See + Section B.1.2.18, "'File' Not Found and Similar Errors." Start the + server by using the --open-files-limit option for mysqld_safe, or + raise the limits for the mysqld user in /etc/login.conf and + rebuild it with cap_mkdb /etc/login.conf. Also be sure that you + set the appropriate class for this user in the password file if + you are not using the default (use chpass mysqld-user-name). See + Section 4.3.2, "mysqld_safe --- MySQL Server Startup Script." + + FreeBSD limits the size of a process to 512MB, even if you have + much more RAM available on the system. So you may get an error + such as this: +Out of memory (Needed 16391 bytes) + + In current versions of FreeBSD (at least 4.x and greater), you may + increase this limit by adding the following entries to the + /boot/loader.conf file and rebooting the machine (these are not + settings that can be changed at run time with the sysctl command): +kern.maxdsiz="1073741824" # 1GB +kern.dfldsiz="1073741824" # 1GB +kern.maxssiz="134217728" # 128MB + + For older versions of FreeBSD, you must recompile your kernel to + change the maximum data segment size for a process. In this case, + you should look at the MAXDSIZ option in the LINT config file for + more information. + + If you get problems with the current date in MySQL, setting the TZ + variable should help. See Section 2.14, "Environment Variables." + +2.13.4.2. NetBSD Notes + + To compile on NetBSD, you need GNU make. Otherwise, the build + process fails when make tries to run lint on C++ files. + +2.13.4.3. OpenBSD 2.5 Notes + + On OpenBSD 2.5, you can compile MySQL with native threads with the + following options: +CFLAGS=-pthread CXXFLAGS=-pthread ./configure --with-mit-threads=no + +2.13.4.4. BSD/OS Version 2.x Notes + + If you get the following error when compiling MySQL, your ulimit + value for virtual memory is too low: +item_func.h: In method +`Item_func_ge::Item_func_ge(const Item_func_ge &)': +item_func.h:28: virtual memory exhausted +make[2]: *** [item_func.o] Error 1 + + Try using ulimit -v 80000 and run make again. If this doesn't work + and you are using bash, try switching to csh or sh; some BSDI + users have reported problems with bash and ulimit. + + If you are using gcc, you may also use have to use the + --with-low-memory flag for configure to be able to compile + sql_yacc.cc. + + If you get problems with the current date in MySQL, setting the TZ + variable should help. See Section 2.14, "Environment Variables." + +2.13.4.5. BSD/OS Version 3.x Notes + + Upgrade to BSD/OS 3.1. If that is not possible, install BSDIpatch + M300-038. + + Use the following command when configuring MySQL: +env CXX=shlicc++ CC=shlicc2 \ +./configure \ + --prefix=/usr/local/mysql \ + --localstatedir=/var/mysql \ + --without-perl \ + --with-unix-socket-path=/var/mysql/mysql.sock + + The following is also known to work: +env CC=gcc CXX=gcc CXXFLAGS=-O3 \ +./configure \ + --prefix=/usr/local/mysql \ + --with-unix-socket-path=/var/mysql/mysql.sock + + You can change the directory locations if you wish, or just use + the defaults by not specifying any locations. + + If you have problems with performance under heavy load, try using + the --skip-thread-priority option to mysqld. This runs all threads + with the same priority. On BSDI 3.1, this gives better + performance, at least until BSDI fixes its thread scheduler. + + If you get the error virtual memory exhausted while compiling, you + should try using ulimit -v 80000 and running make again. If this + doesn't work and you are using bash, try switching to csh or sh; + some BSDI users have reported problems with bash and ulimit. + +2.13.4.6. BSD/OS Version 4.x Notes + + BSDI 4.x has some thread-related bugs. If you want to use MySQL on + this, you should install all thread-related patches. At least + M400-023 should be installed. + + On some BSDI 4.x systems, you may get problems with shared + libraries. The symptom is that you can't execute any client + programs, for example, mysqladmin. In this case, you need to + reconfigure not to use shared libraries with the --disable-shared + option to configure. + + Some customers have had problems on BSDI 4.0.1 that the mysqld + binary after a while can't open tables. This occurs because some + library/system-related bug causes mysqld to change current + directory without having asked for that to happen. + + The fix is to either upgrade MySQL to at least version 3.23.34 or, + after running configure, remove the line #define HAVE_REALPATH + from config.h before running make. + + Note that this means that you can't symbolically link a database + directories to another database directory or symbolic link a table + to another database on BSDI. (Making a symbolic link to another + disk is okay). + +2.13.5. Other Unix Notes + +2.13.5.1. HP-UX Version 10.20 Notes + + If you install MySQL using a binary tarball distribution on HP-UX, + you may run into trouble even before you get the MySQL + distribution unpacked, as the HP-UX tar cannot handle long file + names. This means that you may see errors when you try to unpack + MySQL. + + If this occurs, you must use GNU tar (gtar) to unpack the + distribution. + + There are a couple of small problems when compiling MySQL on + HP-UX. We recommend that you use gcc instead of the HP-UX native + compiler, because gcc produces better code. + + We recommend using gcc 2.95 on HP-UX. Don't use high optimization + flags (such as -O6) because they may not be safe on HP-UX. + + The following configure line should work with gcc 2.95: +CFLAGS="-I/opt/dce/include -fpic" \ +CXXFLAGS="-I/opt/dce/include -felide-constructors -fno-exceptions \ +-fno-rtti" \ +CXX=gcc \ +./configure --with-pthread \ + --with-named-thread-libs='-ldce' \ + --prefix=/usr/local/mysql --disable-shared + + The following configure line should work with gcc 3.1: +CFLAGS="-DHPUX -I/opt/dce/include -O3 -fPIC" CXX=gcc \ +CXXFLAGS="-DHPUX -I/opt/dce/include -felide-constructors \ + -fno-exceptions -fno-rtti -O3 -fPIC" \ +./configure --prefix=/usr/local/mysql \ + --with-extra-charsets=complex --enable-thread-safe-client \ + --enable-local-infile --with-pthread \ + --with-named-thread-libs=-ldce --with-lib-ccflags=-fPIC + --disable-shared + +2.13.5.2. HP-UX Version 11.x Notes + + If you install MySQL using a binary tarball distribution on HP-UX, + you may run into trouble even before you get the MySQL + distribution unpacked, as the HP-UX tar cannot handle long file + names. This means that you may see errors when you try to unpack + MySQL. + + If this occurs, you must use GNU tar (gtar) to unpack the + distribution. + + Because of some critical bugs in the standard HP-UX libraries, you + should install the following patches before trying to run MySQL on + HP-UX 11.0: +PHKL_22840 Streams cumulative +PHNE_22397 ARPA cumulative + + This solves the problem of getting EWOULDBLOCK from recv() and + EBADF from accept() in threaded applications. + + If you are using gcc 2.95.1 on an unpatched HP-UX 11.x system, you + may get the following error: +In file included from /usr/include/unistd.h:11, + from ../include/global.h:125, + from mysql_priv.h:15, + from item.cc:19: +/usr/include/sys/unistd.h:184: declaration of C function ... +/usr/include/sys/pthread.h:440: previous declaration ... +In file included from item.h:306, + from mysql_priv.h:158, + from item.cc:19: + + The problem is that HP-UX does not define pthreads_atfork() + consistently. It has conflicting prototypes in + /usr/include/sys/unistd.h:184 and /usr/include/sys/pthread.h:440. + + One solution is to copy /usr/include/sys/unistd.h into + mysql/include and edit unistd.h and change it to match the + definition in pthread.h. Look for this line: +extern int pthread_atfork(void (*prepare)(), void (*parent)(), + void (*child)()); + + Change it to look like this: +extern int pthread_atfork(void (*prepare)(void), void (*parent)(void) +, + void (*child)(void)); + + After making the change, the following configure line should work: +CFLAGS="-fomit-frame-pointer -O3 -fpic" CXX=gcc \ +CXXFLAGS="-felide-constructors -fno-exceptions -fno-rtti -O3" \ +./configure --prefix=/usr/local/mysql --disable-shared + + If you are using HP-UX compiler, you can use the following command + (which has been tested with cc B.11.11.04): +CC=cc CXX=aCC CFLAGS=+DD64 CXXFLAGS=+DD64 ./configure \ + --with-extra-character-set=complex + + You can ignore any errors of the following type: +aCC: warning 901: unknown option: `-3': use +help for online +documentation + + If you get the following error from configure, verify that you + don't have the path to the K&R compiler before the path to the + HP-UX C and C++ compiler: +checking for cc option to accept ANSI C... no +configure: error: MySQL requires an ANSI C compiler (and a C++ compil +er). +Try gcc. See the Installation chapter in the Reference Manual. + + Another reason for not being able to compile is that you didn't + define the +DD64 flags as just described. + + Another possibility for HP-UX 11 is to use the MySQL binaries + provided at http://dev.mysql.com/downloads/, which we have built + and tested ourselves. We have also received reports that the HP-UX + 10.20 binaries supplied by MySQL can be run successfully on HP-UX + 11. If you encounter problems, you should be sure to check your + HP-UX patch level. + +2.13.5.3. IBM-AIX notes + + Automatic detection of xlC is missing from Autoconf, so a number + of variables need to be set before running configure. The + following example uses the IBM compiler: +export CC="xlc_r -ma -O3 -qstrict -qoptimize=3 -qmaxmem=8192 " +export CXX="xlC_r -ma -O3 -qstrict -qoptimize=3 -qmaxmem=8192" +export CFLAGS="-I /usr/local/include" +export LDFLAGS="-L /usr/local/lib" +export CPPFLAGS=$CFLAGS +export CXXFLAGS=$CFLAGS + +./configure --prefix=/usr/local \ + --localstatedir=/var/mysql \ + --sbindir='/usr/local/bin' \ + --libexecdir='/usr/local/bin' \ + --enable-thread-safe-client \ + --enable-large-files + + The preceding options are used to compile the MySQL distribution + that can be found at http://www-frec.bull.com/. + + If you change the -O3 to -O2 in the preceding configure line, you + must also remove the -qstrict option. This is a limitation in the + IBM C compiler. + + If you are using gcc to compile MySQL, you must use the + -fno-exceptions flag, because the exception handling in gcc is not + thread-safe! There are also some known problems with IBM's + assembler that may cause it to generate bad code when used with + gcc. + + We recommend the following configure line with gcc 2.95 on AIX: +CC="gcc -pipe -mcpu=power -Wa,-many" \ +CXX="gcc -pipe -mcpu=power -Wa,-many" \ +CXXFLAGS="-felide-constructors -fno-exceptions -fno-rtti" \ +./configure --prefix=/usr/local/mysql --with-low-memory + + The -Wa,-many option is necessary for the compile to be + successful. IBM is aware of this problem but is in no hurry to fix + it because of the workaround that is available. We don't know if + the -fno-exceptions is required with gcc 2.95, but because MySQL + doesn't use exceptions and the option generates faster code, we + recommend that you should always use it with gcc. + + If you get a problem with assembler code, try changing the + -mcpu=xxx option to match your CPU. Typically power2, power, or + powerpc may need to be used. Alternatively, you might need to use + 604 or 604e. We are not positive but suspect that power would + likely be safe most of the time, even on a power2 machine. + + If you don't know what your CPU is, execute a uname -m command. It + produces a string that looks like 000514676700, with a format of + xxyyyyyymmss where xx and ss are always 00, yyyyyy is a unique + system ID and mm is the ID of the CPU Planar. A chart of these + values can be found at + http://www16.boulder.ibm.com/pseries/en_US/cmds/aixcmds5/uname.htm + . + + This gives you a machine type and a machine model you can use to + determine what type of CPU you have. + + If you have problems with signals (MySQL dies unexpectedly under + high load), you may have found an OS bug with threads and signals. + In this case, you can tell MySQL not to use signals by configuring + as follows: +CFLAGS=-DDONT_USE_THR_ALARM CXX=gcc \ +CXXFLAGS="-felide-constructors -fno-exceptions -fno-rtti \ +-DDONT_USE_THR_ALARM" \ +./configure --prefix=/usr/local/mysql --with-debug \ + --with-low-memory + + This doesn't affect the performance of MySQL, but has the side + effect that you can't kill clients that are "sleeping" on a + connection with mysqladmin kill or mysqladmin shutdown. Instead, + the client dies when it issues its next command. + + On some versions of AIX, linking with libbind.a makes + getservbyname() dump core. This is an AIX bug and should be + reported to IBM. + + For AIX 4.2.1 and gcc, you have to make the following changes. + + After configuring, edit config.h and include/my_config.h and + change the line that says this: +#define HAVE_SNPRINTF 1 + + to this: +#undef HAVE_SNPRINTF + + And finally, in mysqld.cc, you need to add a prototype for + initgroups(). +#ifdef _AIX41 +extern "C" int initgroups(const char *,int); +#endif + + For 32-bit binaries, if you need to allocate a lot of memory to + the mysqld process, it is not enough to just use ulimit -d + unlimited. You may also have to modify mysqld_safe to add a line + something like this: +export LDR_CNTRL='MAXDATA=0x80000000' + + You can find more information about using a lot of memory at + http://publib16.boulder.ibm.com/pseries/en_US/aixprggd/genprogc/lr + g_prg_support.htm. + + Users of AIX 4.3 should use gmake instead of the make utility + included with AIX. + + As of AIX 4.1, the C compiler has been unbundled from AIX as a + separate product. We recommend using gcc 3.3.2, which can be + obtained here: + ftp://ftp.software.ibm.com/aix/freeSoftware/aixtoolbox/RPMS/ppc/gc + c/ + + The steps for compiling MySQL on AIX with gcc 3.3.2 are similar to + those for using gcc 2.95 (in particular, the need to edit config.h + and my_config.h after running configure). However, before running + configure, you should also patch the curses.h file as follows: +/opt/freeware/lib/gcc-lib/powerpc-ibm-aix5.2.0.0/3.3.2/include/curses +.h.ORIG + Mon Dec 26 02:17:28 2005 +--- /opt/freeware/lib/gcc-lib/powerpc-ibm-aix5.2.0.0/3.3.2/include/cu +rses.h +Mon Dec 26 02:40:13 2005 +*************** +*** 2023,2029 **** + + + #endif /* _AIX32_CURSES */ +! #if defined(__USE_FIXED_PROTOTYPES__) || defined(__cplusplus) || de +fined +(__STRICT_ANSI__) + extern int delwin (WINDOW *); + extern int endwin (void); + extern int getcurx (WINDOW *); +--- 2023,2029 ---- + + + #endif /* _AIX32_CURSES */ +! #if 0 && (defined(__USE_FIXED_PROTOTYPES__) || defined(__cplusplus) +|| defined +(__STRICT_ANSI__)) + extern int delwin (WINDOW *); + extern int endwin (void); + extern int getcurx (WINDOW *); + +2.13.5.4. SunOS 4 Notes + + On SunOS 4, MIT-pthreads is needed to compile MySQL. This in turn + means you need GNU make. + + Some SunOS 4 systems have problems with dynamic libraries and + libtool. You can use the following configure line to avoid this + problem: +./configure --disable-shared --with-mysqld-ldflags=-all-static + + When compiling readline, you may get warnings about duplicate + defines. These can be ignored. + + When compiling mysqld, there are some implicit declaration of + function warnings. These can be ignored. + +2.13.5.5. Alpha-DEC-UNIX Notes (Tru64) + + If you are using egcs 1.1.2 on Digital Unix, you should upgrade to + gcc 2.95.2, because egcs on DEC has some serious bugs! + + When compiling threaded programs under Digital Unix, the + documentation recommends using the -pthread option for cc and cxx + and the -lmach -lexc libraries (in addition to -lpthread). You + should run configure something like this: +CC="cc -pthread" CXX="cxx -pthread -O" \ +./configure --with-named-thread-libs="-lpthread -lmach -lexc -lc" + + When compiling mysqld, you may see a couple of warnings like this: +mysqld.cc: In function void handle_connections()': +mysqld.cc:626: passing long unsigned int *' as argument 3 of +accept(int,sockadddr *, int *)' + + You can safely ignore these warnings. They occur because configure + can detect only errors, not warnings. + + If you start the server directly from the command line, you may + have problems with it dying when you log out. (When you log out, + your outstanding processes receive a SIGHUP signal.) If so, try + starting the server like this: +nohup mysqld [options] & + + nohup causes the command following it to ignore any SIGHUP signal + sent from the terminal. Alternatively, start the server by running + mysqld_safe, which invokes mysqld using nohup for you. See Section + 4.3.2, "mysqld_safe --- MySQL Server Startup Script." + + If you get a problem when compiling mysys/get_opt.c, just remove + the #define _NO_PROTO line from the start of that file. + + If you are using Compaq's CC compiler, the following configure + line should work: +CC="cc -pthread" +CFLAGS="-O4 -ansi_alias -ansi_args -fast -inline speed \ + -speculate all -arch host" +CXX="cxx -pthread" +CXXFLAGS="-O4 -ansi_alias -ansi_args -fast -inline speed \ + -speculate all -arch host -noexceptions -nortti" +export CC CFLAGS CXX CXXFLAGS +./configure \ + --prefix=/usr/local/mysql \ + --with-low-memory \ + --enable-large-files \ + --enable-shared=yes \ + --with-named-thread-libs="-lpthread -lmach -lexc -lc" +gnumake + + If you get a problem with libtool when compiling with shared + libraries as just shown, when linking mysql, you should be able to + get around this by issuing these commands: +cd mysql +/bin/sh ../libtool --mode=link cxx -pthread -O3 -DDBUG_OFF \ + -O4 -ansi_alias -ansi_args -fast -inline speed \ + -speculate all \ -arch host -DUNDEF_HAVE_GETHOSTBYNAME_R \ + -o mysql mysql.o readline.o sql_string.o completion_hash.o \ + ../readline/libreadline.a -lcurses \ + ../libmysql/.libs/libmysqlclient.so -lm +cd .. +gnumake +gnumake install +scripts/mysql_install_db + +2.13.5.6. Alpha-DEC-OSF/1 Notes + + If you have problems compiling and have DEC CC and gcc installed, + try running configure like this: +CC=cc CFLAGS=-O CXX=gcc CXXFLAGS=-O3 \ +./configure --prefix=/usr/local/mysql + + If you get problems with the c_asm.h file, you can create and use + a 'dummy' c_asm.h file with: +touch include/c_asm.h +CC=gcc CFLAGS=-I./include \ +CXX=gcc CXXFLAGS=-O3 \ +./configure --prefix=/usr/local/mysql + + Note that the following problems with the ld program can be fixed + by downloading the latest DEC (Compaq) patch kit from: + http://ftp.support.compaq.com/public/unix/. + + On OSF/1 V4.0D and compiler "DEC C V5.6-071 on Digital Unix V4.0 + (Rev. 878)," the compiler had some strange behavior (undefined asm + symbols). /bin/ld also appears to be broken (problems with _exit + undefined errors occurring while linking mysqld). On this system, + we have managed to compile MySQL with the following configure + line, after replacing /bin/ld with the version from OSF 4.0C: +CC=gcc CXX=gcc CXXFLAGS=-O3 ./configure --prefix=/usr/local/mysql + + With the Digital compiler "C++ V6.1-029," the following should + work: +CC=cc -pthread +CFLAGS=-O4 -ansi_alias -ansi_args -fast -inline speed \ + -speculate all -arch host +CXX=cxx -pthread +CXXFLAGS=-O4 -ansi_alias -ansi_args -fast -inline speed \ + -speculate all -arch host -noexceptions -nortti +export CC CFLAGS CXX CXXFLAGS +./configure --prefix=/usr/mysql/mysql \ + --with-mysqld-ldflags=-all-static --disable-shared \ + --with-named-thread-libs="-lmach -lexc -lc" + + In some versions of OSF/1, the alloca() function is broken. Fix + this by removing the line in config.h that defines 'HAVE_ALLOCA'. + + The alloca() function also may have an incorrect prototype in + /usr/include/alloca.h. This warning resulting from this can be + ignored. + + configure uses the following thread libraries automatically: + --with-named-thread-libs="-lpthread -lmach -lexc -lc". + + When using gcc, you can also try running configure like this: +CFLAGS=-D_PTHREAD_USE_D4 CXX=gcc CXXFLAGS=-O3 ./configure ... + + If you have problems with signals (MySQL dies unexpectedly under + high load), you may have found an OS bug with threads and signals. + In this case, you can tell MySQL not to use signals by configuring + with: +CFLAGS=-DDONT_USE_THR_ALARM \ +CXXFLAGS=-DDONT_USE_THR_ALARM \ +./configure ... + + This does not affect the performance of MySQL, but has the side + effect that you can't kill clients that are "sleeping" on a + connection with mysqladmin kill or mysqladmin shutdown. Instead, + the client dies when it issues its next command. + + With gcc 2.95.2, you may encounter the following compile error: +sql_acl.cc:1456: Internal compiler error in `scan_region', +at except.c:2566 +Please submit a full bug report. + + To fix this, you should change to the sql directory and do a + cut-and-paste of the last gcc line, but change -O3 to -O0 (or add + -O0 immediately after gcc if you don't have any -O option on your + compile line). After this is done, you can just change back to the + top-level directory and run make again. + +2.13.5.7. SGI Irix Notes + + As of MySQL 5.0, we don't provide binaries for Irix any more. + + If you are using Irix 6.5.3 or newer, mysqld is able to create + threads only if you run it as a user that has CAP_SCHED_MGT + privileges (such as root) or give the mysqld server this privilege + with the following shell command: +chcap "CAP_SCHED_MGT+epi" /opt/mysql/libexec/mysqld + + You may have to undefine some symbols in config.h after running + configure and before compiling. + + In some Irix implementations, the alloca() function is broken. If + the mysqld server dies on some SELECT statements, remove the lines + from config.h that define HAVE_ALLOC and HAVE_ALLOCA_H. If + mysqladmin create doesn't work, remove the line from config.h that + defines HAVE_READDIR_R. You may have to remove the HAVE_TERM_H + line as well. + + SGI recommends that you install all the patches on this page as a + set: + http://support.sgi.com/surfzone/patches/patchset/6.2_indigo.rps.ht + ml + + At the very minimum, you should install the latest kernel rollup, + the latest rld rollup, and the latest libc rollup. + + You definitely need all the POSIX patches on this page, for + pthreads support: + + http://support.sgi.com/surfzone/patches/patchset/6.2_posix.rps.htm + l + + If you get the something like the following error when compiling + mysql.cc: +"/usr/include/curses.h", line 82: error(1084): +invalid combination of type + + Type the following in the top-level directory of your MySQL source + tree: +extra/replace bool curses_bool < /usr/include/curses.h > include/curs +es.h +make + + There have also been reports of scheduling problems. If only one + thread is running, performance is slow. Avoid this by starting + another client. This may lead to a two-to-tenfold increase in + execution speed thereafter for the other thread. This is a poorly + understood problem with Irix threads; you may have to improvise to + find solutions until this can be fixed. + + If you are compiling with gcc, you can use the following configure + command: +CC=gcc CXX=gcc CXXFLAGS=-O3 \ +./configure --prefix=/usr/local/mysql --enable-thread-safe-client \ + --with-named-thread-libs=-lpthread + + On Irix 6.5.11 with native Irix C and C++ compilers ver. 7.3.1.2, + the following is reported to work +CC=cc CXX=CC CFLAGS='-O3 -n32 -TARG:platform=IP22 -I/usr/local/includ +e \ +-L/usr/local/lib' CXXFLAGS='-O3 -n32 -TARG:platform=IP22 \ +-I/usr/local/include -L/usr/local/lib' \ +./configure --prefix=/usr/local/mysql --with-innodb \ + --with-libwrap=/usr/local \ + --with-named-curses-libs=/usr/local/lib/libncurses.a + +2.13.5.8. SCO UNIX and OpenServer 5.0.x Notes + + The current port is tested only on sco3.2v5.0.5, sco3.2v5.0.6, and + sco3.2v5.0.7 systems. There has also been progress on a port to + sco3.2v4.2. Open Server 5.0.8 (Legend) has native threads and + allows files greater than 2GB. The current maximum file size is + 2GB. + + We have been able to compile MySQL with the following configure + command on OpenServer with gcc 2.95.3. +CC=gcc CFLAGS="-D_FILE_OFFSET_BITS=64 -O3" \ +CXX=gcc CXXFLAGS="-D_FILE_OFFSET_BITS=64 -O3" \ +./configure --prefix=/usr/local/mysql \ + --enable-thread-safe-client --with-innodb \ + --with-openssl --with-vio --with-extra-charsets=complex + + gcc is available at + ftp://ftp.sco.com/pub/openserver5/opensrc/gnutools-5.0.7Kj. + + This development system requires the OpenServer Execution + Environment Supplement oss646B on OpenServer 5.0.6 and oss656B and + The OpenSource libraries found in gwxlibs. All OpenSource tools + are in the opensrc directory. They are available at + ftp://ftp.sco.com/pub/openserver5/opensrc/. + + We recommend using the latest production release of MySQL. + + SCO provides operating system patches at + ftp://ftp.sco.com/pub/openserver5 for OpenServer 5.0.[0-6] and + ftp://ftp.sco.com/pub/openserverv5/507 for OpenServer 5.0.7. + + SCO provides information about security fixes at + ftp://ftp.sco.com/pub/security/OpenServer for OpenServer 5.0.x. + + The maximum file size on an OpenServer 5.0.x system is 2GB. + + The total memory which can be allocated for streams buffers, + clists, and lock records cannot exceed 60MB on OpenServer 5.0.x. + + Streams buffers are allocated in units of 4096 byte pages, clists + are 70 bytes each, and lock records are 64 bytes each, so: +(NSTRPAGES x 4096) + (NCLIST x 70) + (MAX_FLCKREC x 64) <= 62914560 + + Follow this procedure to configure the Database Services option. + If you are unsure whether an application requires this, see the + documentation provided with the application. + + 1. Log in as root. + + 2. Enable the SUDS driver by editing the /etc/conf/sdevice.d/suds + file. Change the N in the second field to a Y. + + 3. Use mkdev aio or the Hardware/Kernel Manager to enable support + for asynchronous I/O and relink the kernel. To allow users to + lock down memory for use with this type of I/O, update the + aiomemlock(F) file. This file should be updated to include the + names of users that can use AIO and the maximum amounts of + memory they can lock down. + + 4. Many applications use setuid binaries so that you need to + specify only a single user. See the documentation provided + with the application to determine whether this is the case for + your application. + + After you complete this process, reboot the system to create a new + kernel incorporating these changes. + + By default, the entries in /etc/conf/cf.d/mtune are set as + follows: +Value Default Min Max +----- ------- --- --- +NBUF 0 24 450000 +NHBUF 0 32 524288 +NMPBUF 0 12 512 +MAX_INODE 0 100 64000 +MAX_FILE 0 100 64000 +CTBUFSIZE 128 0 256 +MAX_PROC 0 50 16000 +MAX_REGION 0 500 160000 +NCLIST 170 120 16640 +MAXUP 100 15 16000 +NOFILES 110 60 11000 +NHINODE 128 64 8192 +NAUTOUP 10 0 60 +NGROUPS 8 0 128 +BDFLUSHR 30 1 300 +MAX_FLCKREC 0 50 16000 +PUTBUFSZ 8000 2000 20000 +MAXSLICE 100 25 100 +ULIMIT 4194303 2048 4194303 +* Streams Parameters +NSTREAM 64 1 32768 +NSTRPUSH 9 9 9 +NMUXLINK 192 1 4096 +STRMSGSZ 16384 4096 524288 +STRCTLSZ 1024 1024 1024 +STRMAXBLK 524288 4096 524288 +NSTRPAGES 500 0 8000 +STRSPLITFRAC 80 50 100 +NLOG 3 3 3 +NUMSP 64 1 256 +NUMTIM 16 1 8192 +NUMTRW 16 1 8192 +* Semaphore Parameters +SEMMAP 10 10 8192 +SEMMNI 10 10 8192 +SEMMNS 60 60 8192 +SEMMNU 30 10 8192 +SEMMSL 25 25 150 +SEMOPM 10 10 1024 +SEMUME 10 10 25 +SEMVMX 32767 32767 32767 +SEMAEM 16384 16384 16384 +* Shared Memory Parameters +SHMMAX 524288 131072 2147483647 +SHMMIN 1 1 1 +SHMMNI 100 100 2000 +FILE 0 100 64000 +NMOUNT 0 4 256 +NPROC 0 50 16000 +NREGION 0 500 160000 + + We recommend setting these values as follows: + + * NOFILES should be 4096 or 2048. + + * MAXUP should be 2048. + + To make changes to the kernel, use the idtune name parameter + command. idtune modifies the /etc/conf/cf.d/stune file for you. + For example, to change SEMMS to 200, execute this command as root: +# /etc/conf/bin/idtune SEMMNS 200 + + Then rebuild and reboot the kernel by issuing this command: +# /etc/conf/bin/idbuild -B && init 6 + + We recommend tuning the system, but the proper parameter values to + use depend on the number of users accessing the application or + database and size the of the database (that is, the used buffer + pool). The following kernel parameters can be set with idtune: + + * SHMMAX (recommended setting: 128MB) and SHMSEG (recommended + setting: 15). These parameters have an influence on the MySQL + database engine to create user buffer pools. + + * NOFILES and MAXUP should be set to at least 2048. + + * MAXPROC should be set to at least 3000/4000 (depends on number + of users) or more. + + * We also recommend using the following formulas to calculate + values for SEMMSL, SEMMNS, and SEMMNU: +SEMMSL = 13 + 13 is what has been found to be the best for both Progress and + MySQL. +SEMMNS = SEMMSL x number of db servers to be run on the system + Set SEMMNS to the value of SEMMSL multiplied by the number of + database servers (maximum) that you are running on the system + at one time. +SEMMNU = SEMMNS + Set the value of SEMMNU to equal the value of SEMMNS. You + could probably set this to 75% of SEMMNS, but this is a + conservative estimate. + + You need to at least install the SCO OpenServer Linker and + Application Development Libraries or the OpenServer Development + System to use gcc. You cannot use the GCC Dev system without + installing one of these. + + You should get the FSU Pthreads package and install it first. This + can be found at + http://moss.csc.ncsu.edu/~mueller/ftp/pub/PART/pthreads.tar.gz. + You can also get a precompiled package from + ftp://ftp.zenez.com/pub/zenez/prgms/FSU-threads-3.14.tar.gz. + + FSU Pthreads can be compiled with SCO Unix 4.2 with tcpip, or + using OpenServer 3.0 or Open Desktop 3.0 (OS 3.0 ODT 3.0) with the + SCO Development System installed using a good port of GCC 2.5.x. + For ODT or OS 3.0, you need a good port of GCC 2.5.x. There are a + lot of problems without a good port. The port for this product + requires the SCO Unix Development system. Without it, you are + missing the libraries and the linker that is needed. You also need + SCO-3.2v4.2-includes.tar.gz. This file contains the changes to the + SCO Development include files that are needed to get MySQL to + build. You need to replace the existing system include files with + these modified header files. They can be obtained from + ftp://ftp.zenez.com/pub/zenez/prgms/SCO-3.2v4.2-includes.tar.gz. + + To build FSU Pthreads on your system, all you should need to do is + run GNU make. The Makefile in FSU-threads-3.14.tar.gz is set up to + make FSU-threads. + + You can run ./configure in the threads/src directory and select + the SCO OpenServer option. This command copies Makefile.SCO5 to + Makefile. Then run make. + + To install in the default /usr/include directory, log in as root, + and then cd to the thread/src directory and run make install. + + Remember that you must use GNU make to build MySQL. + +Note + + If you don't start mysqld_safe as root, you should get only the + default 110 open files per process. mysqld writes a note about + this in the log file. + + With SCO 3.2V4.2, you should use FSU Pthreads version 3.14 or + newer. The following configure command should work: +CFLAGS="-D_XOPEN_XPG4" CXX=gcc CXXFLAGS="-D_XOPEN_XPG4" \ +./configure \ + --prefix=/usr/local/mysql \ + --with-named-thread-libs="-lgthreads -lsocket -lgen -lgthreads" \ + --with-named-curses-libs="-lcurses" + + You may have problems with some include files. In this case, you + can find new SCO-specific include files at + ftp://ftp.zenez.com/pub/zenez/prgms/SCO-3.2v4.2-includes.tar.gz. + + You should unpack this file in the include directory of your MySQL + source tree. + + SCO development notes: + + * MySQL should automatically detect FSU Pthreads and link mysqld + with -lgthreads -lsocket -lgthreads. + + * The SCO development libraries are re-entrant in FSU Pthreads. + SCO claims that its library functions are re-entrant, so they + must be re-entrant with FSU Pthreads. FSU Pthreads on + OpenServer tries to use the SCO scheme to make re-entrant + libraries. + + * FSU Pthreads (at least the version at ftp://ftp.zenez.com) + comes linked with GNU malloc. If you encounter problems with + memory usage, make sure that gmalloc.o is included in + libgthreads.a and libgthreads.so. + + * In FSU Pthreads, the following system calls are + pthreads-aware: read(), write(), getmsg(), connect(), + accept(), select(), and wait(). + + * The CSSA-2001-SCO.35.2 (the patch is listed in custom as + erg711905-dscr_remap security patch (version 2.0.0)) breaks + FSU threads and makes mysqld unstable. You have to remove this + one if you want to run mysqld on an OpenServer 5.0.6 machine. + + * If you use SCO OpenServer 5, you may need to recompile FSU + pthreads with -DDRAFT7 in CFLAGS. Otherwise, InnoDB may hang + at a mysqld startup. + + * SCO provides operating system patches at + ftp://ftp.sco.com/pub/openserver5 for OpenServer 5.0.x. + + * SCO provides security fixes and libsocket.so.2 at + ftp://ftp.sco.com/pub/security/OpenServer and + ftp://ftp.sco.com/pub/security/sse for OpenServer 5.0.x. + + * Pre-OSR506 security fixes. Also, the telnetd fix at + ftp://stage.caldera.com/pub/security/openserver/ or + ftp://stage.caldera.com/pub/security/openserver/CSSA-2001-SCO. + 10/ as both libsocket.so.2 and libresolv.so.1 with + instructions for installing on pre-OSR506 systems. + It is probably a good idea to install these patches before + trying to compile/use MySQL. + + Beginning with Legend/OpenServer 6.0.0, there are native threads + and no 2GB file size limit. + +2.13.5.9. SCO OpenServer 6.0.x Notes + + OpenServer 6 includes these key improvements: + + * Larger file support up to 1 TB + + * Multiprocessor support increased from 4 to 32 processors + + * Increased memory support up to 64GB + + * Extending the power of UnixWare into OpenServer 6 + + * Dramatic performance improvement + + OpenServer 6.0.0 commands are organized as follows: + + * /bin is for commands that behave exactly the same as on + OpenServer 5.0.x. + + * /u95/bin is for commands that have better standards + conformance, for example Large File System (LFS) support. + + * /udk/bin is for commands that behave the same as on UnixWare + 7.1.4. The default is for the LFS support. + + The following is a guide to setting PATH on OpenServer 6. If the + user wants the traditional OpenServer 5.0.x then PATH should be + /bin first. If the user wants LFS support, the path should be + /u95/bin:/bin. If the user wants UnixWare 7 support first, the + path would be /udk/bin:/u95/bin:/bin:. + + We recommend using the latest production release of MySQL. Should + you choose to use an older release of MySQL on OpenServer 6.0.x, + you must use a version of MySQL at least as recent as 3.22.13 to + get fixes for some portability and OS problems. + + MySQL distribution files with names of the following form are tar + archives of media are tar archives of media images suitable for + installation with the SCO Software Manager (/etc/custom) on SCO + OpenServer 6: +mysql-PRODUCT-5.1.35-sco-osr6-i686.VOLS.tar + + A distribution where PRODUCT is pro-cert is the Commercially + licensed MySQL Pro Certified server. A distribution where PRODUCT + is pro-gpl-cert is the MySQL Pro Certified server licensed under + the terms of the General Public License (GPL). + + Select whichever distribution you wish to install and, after + download, extract the tar archive into an empty directory. For + example: +shell> mkdir /tmp/mysql-pro +shell> cd /tmp/mysql-pro +shell> tar xf /tmp/mysql-pro-cert-5.1.35-sco-osr6-i686.VOLS.tar + + Prior to installation, back up your data in accordance with the + procedures outlined in Section 2.12.1, "Upgrading MySQL." + + Remove any previously installed pkgadd version of MySQL: +shell> pkginfo mysql 2>&1 > /dev/null && pkgrm mysql + + Install MySQL Pro from media images using the SCO Software + Manager: +shell> /etc/custom -p SCO:MySQL -i -z /tmp/mysql-pro + + Alternatively, the SCO Software Manager can be displayed + graphically by clicking on the Software Manager icon on the + desktop, selecting Software -> Install New, selecting the host, + selecting Media Images for the Media Device, and entering + /tmp/mysql-pro as the Image Directory. + + After installation, run mkdev mysql as the root user to configure + your newly installed MySQL Pro Certified server. + +Note + + The installation procedure for VOLS packages does not create the + mysql user and group that the package uses by default. You should + either create the mysql user and group, or else select a different + user and group using an option in mkdev mysql. + + If you wish to configure your MySQL Pro server to interface with + the Apache Web server via PHP, download and install the PHP update + from SCO at + ftp://ftp.sco.com/pub/updates/OpenServer/SCOSA-2006.17/. + + We have been able to compile MySQL with the following configure + command on OpenServer 6.0.x: +CC=cc CFLAGS="-D_FILE_OFFSET_BITS=64 -O3" \ +CXX=CC CXXFLAGS="-D_FILE_OFFSET_BITS=64 -O3" \ +./configure --prefix=/usr/local/mysql \ + --enable-thread-safe-client \ + --with-extra-charsets=complex \ + --build=i686-unknown-sysv5SCO_SV6.0.0 + + If you use gcc, you must use gcc 2.95.3 or newer. +CC=gcc CXX=g++ ... ./configure ... + + SCO provides OpenServer 6 operating system patches at + ftp://ftp.sco.com/pub/openserver6. + + SCO provides information about security fixes at + ftp://ftp.sco.com/pub/security/OpenServer. + + By default, the maximum file size on a OpenServer 6.0.0 system is + 1TB. Some operating system utilities have a limitation of 2GB. The + maximum possible file size on UnixWare 7 is 1TB with VXFS or HTFS. + + OpenServer 6 can be configured for large file support (file sizes + greater than 2GB) by tuning the UNIX kernel. + + By default, the entries in /etc/conf/cf.d/mtune are set as + follows: +Value Default Min Max +----- ------- --- --- +SVMMLIM 0x9000000 0x1000000 0x7FFFFFFF +HVMMLIM 0x9000000 0x1000000 0x7FFFFFFF + + To make changes to the kernel, use the idtune name parameter + command. idtune modifies the /etc/conf/cf.d/stune file for you. We + recommend setting the kernel values by executing the following + commands as root: +# /etc/conf/bin/idtune SDATLIM 0x7FFFFFFF +# /etc/conf/bin/idtune HDATLIM 0x7FFFFFFF +# /etc/conf/bin/idtune SVMMLIM 0x7FFFFFFF +# /etc/conf/bin/idtune HVMMLIM 0x7FFFFFFF +# /etc/conf/bin/idtune SFNOLIM 2048 +# /etc/conf/bin/idtune HFNOLIM 2048 + + Then rebuild and reboot the kernel by issuing this command: +# /etc/conf/bin/idbuild -B && init 6 + + We recommend tuning the system, but the proper parameter values to + use depend on the number of users accessing the application or + database and size the of the database (that is, the used buffer + pool). The following kernel parameters can be set with idtune: + + * SHMMAX (recommended setting: 128MB) and SHMSEG (recommended + setting: 15). These parameters have an influence on the MySQL + database engine to create user buffer pools. + + * SFNOLIM and HFNOLIM should be at maximum 2048. + + * NPROC should be set to at least 3000/4000 (depends on number + of users). + + * We also recommend using the following formulas to calculate + values for SEMMSL, SEMMNS, and SEMMNU: +SEMMSL = 13 + 13 is what has been found to be the best for both Progress and + MySQL. +SEMMNS = SEMMSL x number of db servers to be run on the system + Set SEMMNS to the value of SEMMSL multiplied by the number of + database servers (maximum) that you are running on the system + at one time. +SEMMNU = SEMMNS + Set the value of SEMMNU to equal the value of SEMMNS. You + could probably set this to 75% of SEMMNS, but this is a + conservative estimate. + +2.13.5.10. SCO UnixWare 7.1.x and OpenUNIX 8.0.0 Notes + + We recommend using the latest production release of MySQL. Should + you choose to use an older release of MySQL on UnixWare 7.1.x, you + must use a version of MySQL at least as recent as 3.22.13 to get + fixes for some portability and OS problems. + + We have been able to compile MySQL with the following configure + command on UnixWare 7.1.x: +CC="cc" CFLAGS="-I/usr/local/include" \ +CXX="CC" CXXFLAGS="-I/usr/local/include" \ +./configure --prefix=/usr/local/mysql \ + --enable-thread-safe-client \ + --with-innodb --with-openssl --with-extra-charsets=complex + + If you want to use gcc, you must use gcc 2.95.3 or newer. +CC=gcc CXX=g++ ... ./configure ... + + SCO provides operating system patches at + ftp://ftp.sco.com/pub/unixware7 for UnixWare 7.1.1, + ftp://ftp.sco.com/pub/unixware7/713/ for UnixWare 7.1.3, + ftp://ftp.sco.com/pub/unixware7/714/ for UnixWare 7.1.4, and + ftp://ftp.sco.com/pub/openunix8 for OpenUNIX 8.0.0. + + SCO provides information about security fixes at + ftp://ftp.sco.com/pub/security/OpenUNIX for OpenUNIX and + ftp://ftp.sco.com/pub/security/UnixWare for UnixWare. + + The UnixWare 7 file size limit is 1 TB with VXFS. Some OS + utilities have a limitation of 2GB. + + On UnixWare 7.1.4 you do not need to do anything to get large file + support, but to enable large file support on prior versions of + UnixWare 7.1.x, run fsadm. +# fsadm -Fvxfs -o largefiles / +# fsadm / * Note +# ulimit unlimited +# /etc/conf/bin/idtune SFSZLIM 0x7FFFFFFF ** Note +# /etc/conf/bin/idtune HFSZLIM 0x7FFFFFFF ** Note +# /etc/conf/bin/idbuild -B + +* This should report "largefiles". +** 0x7FFFFFFF represents infinity for these values. + + Reboot the system using shutdown. + + By default, the entries in /etc/conf/cf.d/mtune are set as + follows: +Value Default Min Max +----- ------- --- --- +SVMMLIM 0x9000000 0x1000000 0x7FFFFFFF +HVMMLIM 0x9000000 0x1000000 0x7FFFFFFF + + To make changes to the kernel, use the idtune name parameter + command. idtune modifies the /etc/conf/cf.d/stune file for you. We + recommend setting the kernel values by executing the following + commands as root: +# /etc/conf/bin/idtune SDATLIM 0x7FFFFFFF +# /etc/conf/bin/idtune HDATLIM 0x7FFFFFFF +# /etc/conf/bin/idtune SVMMLIM 0x7FFFFFFF +# /etc/conf/bin/idtune HVMMLIM 0x7FFFFFFF +# /etc/conf/bin/idtune SFNOLIM 2048 +# /etc/conf/bin/idtune HFNOLIM 2048 + + Then rebuild and reboot the kernel by issuing this command: +# /etc/conf/bin/idbuild -B && init 6 + + We recommend tuning the system, but the proper parameter values to + use depend on the number of users accessing the application or + database and size the of the database (that is, the used buffer + pool). The following kernel parameters can be set with idtune: + + * SHMMAX (recommended setting: 128MB) and SHMSEG (recommended + setting: 15). These parameters have an influence on the MySQL + database engine to create user buffer pools. + + * SFNOLIM and HFNOLIM should be at maximum 2048. + + * NPROC should be set to at least 3000/4000 (depends on number + of users). + + * We also recommend using the following formulas to calculate + values for SEMMSL, SEMMNS, and SEMMNU: +SEMMSL = 13 + 13 is what has been found to be the best for both Progress and + MySQL. +SEMMNS = SEMMSL x number of db servers to be run on the system + Set SEMMNS to the value of SEMMSL multiplied by the number of + database servers (maximum) that you are running on the system + at one time. +SEMMNU = SEMMNS + Set the value of SEMMNU to equal the value of SEMMNS. You + could probably set this to 75% of SEMMNS, but this is a + conservative estimate. + +2.14. Environment Variables + + This section lists all the environment variables that are used + directly or indirectly by MySQL. Most of these can also be found + in other places in this manual. + + Note that any options on the command line take precedence over + values specified in option files and environment variables, and + values in option files take precedence over values in environment + variables. + + In many cases, it is preferable to use an option file instead of + environment variables to modify the behavior of MySQL. See Section + 4.2.3.2, "Using Option Files." + Variable Description + CXX The name of your C++ compiler (for running configure). + CC The name of your C compiler (for running configure). + CFLAGS Flags for your C compiler (for running configure). + CXXFLAGS Flags for your C++ compiler (for running configure). + DBI_USER The default user name for Perl DBI. + DBI_TRACE Trace options for Perl DBI. + HOME The default path for the mysql history file is + $HOME/.mysql_history. + LD_RUN_PATH Used to specify the location of libmysqlclient.so. + MYSQL_DEBUG Debug trace options when debugging. + MYSQL_GROUP_SUFFIX Option group suffix value (like specifying + --defaults-group-suffix). + MYSQL_HISTFILE The path to the mysql history file. If this + variable is set, its value overrides the default for + $HOME/.mysql_history. + MYSQL_HOME The path to the directory in which the server-specific + my.cnf file resides (as of MySQL 5.0.3). + MYSQL_HOST The default host name used by the mysql command-line + client. + MYSQL_PS1 The command prompt to use in the mysql command-line + client. + MYSQL_PWD The default password when connecting to mysqld. Note + that using this is insecure. See Section 5.5.6.2, "End-User + Guidelines for Password Security." + MYSQL_TCP_PORT The default TCP/IP port number. + MYSQL_UNIX_PORT The default Unix socket file name; used for + connections to localhost. + PATH Used by the shell to find MySQL programs. + TMPDIR The directory where temporary files are created. + TZ This should be set to your local time zone. See Section + B.1.4.6, "Time Zone Problems." + UMASK The user-file creation mode when creating files. See note + following table. + UMASK_DIR The user-directory creation mode when creating + directories. See note following table. + USER The default user name on Windows and NetWare used when + connecting to mysqld. + + The UMASK and UMASK_DIR variables, despite their names, are used + as modes, not masks: + + * If UMASK is set, mysqld uses ($UMASK | 0600) as the mode for + file creation, so that newly created files have a mode in the + range from 0600 to 0666 (all values octal). + + * If UMASK_DIR is set, mysqld uses ($UMASK_DIR | 0700) as the + base mode for directory creation, which then is AND-ed with + ~(~$UMASK & 0666), so that newly created directories have a + mode in the range from 0700 to 0777 (all values octal). The + AND operation may remove read and write permissions from the + directory mode, but not execute permissions. + + MySQL assumes that the value for UMASK or UMASK_DIR is in octal if + it starts with a zero. + +2.15. Perl Installation Notes + + Perl support for MySQL is provided by means of the DBI/DBD client + interface. The interface requires Perl 5.6.0, and 5.6.1 or later + is preferred. DBI does not work if you have an older version of + Perl. + + If you want to use transactions with Perl DBI, you need to have + DBD::mysql 2.0900. If you are using the MySQL 4.1 or newer client + library, you must use DBD::mysql 2.9003 or newer. Support for + server-side prepared statements requires DBD::mysql 3.0009 or + newer. + + Perl support is not included with MySQL distributions. You can + obtain the necessary modules from http://search.cpan.org for Unix, + or by using the ActiveState ppm program on Windows. The following + sections describe how to do this. + + Perl support for MySQL must be installed if you want to run the + MySQL benchmark scripts; see Section 7.1.4, "The MySQL Benchmark + Suite." It is also required for the MySQL Cluster ndb_size.pl + utility; see Section 17.9.15, "ndb_size.pl --- NDBCLUSTER Size + Requirement Estimator." + +2.15.1. Installing Perl on Unix + + MySQL Perl support requires that you have installed MySQL client + programming support (libraries and header files). Most + installation methods install the necessary files. However, if you + installed MySQL from RPM files on Linux, be sure that you've + installed the developer RPM. The client programs are in the client + RPM, but client programming support is in the developer RPM. + + If you want to install Perl support, the files you need can be + obtained from the CPAN (Comprehensive Perl Archive Network) at + http://search.cpan.org. + + The easiest way to install Perl modules on Unix is to use the CPAN + module. For example: +shell> perl -MCPAN -e shell +cpan> install DBI +cpan> install DBD::mysql + + The DBD::mysql installation runs a number of tests. These tests + attempt to connect to the local MySQL server using the default + user name and password. (The default user name is your login name + on Unix, and ODBC on Windows. The default password is "no + password.") If you cannot connect to the server with those values + (for example, if your account has a password), the tests fail. You + can use force install DBD::mysql to ignore the failed tests. + + DBI requires the Data::Dumper module. It may be installed; if not, + you should install it before installing DBI. + + It is also possible to download the module distributions in the + form of compressed tar archives and build the modules manually. + For example, to unpack and build a DBI distribution, use a + procedure such as this: + + 1. Unpack the distribution into the current directory: +shell> gunzip < DBI-VERSION.tar.gz | tar xvf - + This command creates a directory named DBI-VERSION. + + 2. Change location into the top-level directory of the unpacked + distribution: +shell> cd DBI-VERSION + + 3. Build the distribution and compile everything: +shell> perl Makefile.PL +shell> make +shell> make test +shell> make install + + The make test command is important because it verifies that the + module is working. Note that when you run that command during the + DBD::mysql installation to exercise the interface code, the MySQL + server must be running or the test fails. + + It is a good idea to rebuild and reinstall the DBD::mysql + distribution whenever you install a new release of MySQL, + particularly if you notice symptoms such as that all your DBI + scripts fail after you upgrade MySQL. + + If you do not have access rights to install Perl modules in the + system directory or if you want to install local Perl modules, the + following reference may be useful: + http://servers.digitaldaze.com/extensions/perl/modules.html#module + s + + Look under the heading "Installing New Modules that Require + Locally Installed Modules." + +2.15.2. Installing ActiveState Perl on Windows + + On Windows, you should do the following to install the MySQL DBD + module with ActiveState Perl: + + 1. Get ActiveState Perl from + http://www.activestate.com/Products/ActivePerl/ and install + it. + + 2. Open a console window (a "DOS window"). + + 3. If necessary, set the HTTP_proxy variable. For example, you + might try a setting like this: +set HTTP_proxy=my.proxy.com:3128 + + 4. Start the PPM program: +C:\> C:\perl\bin\ppm.pl + + 5. If you have not previously done so, install DBI: +ppm> install DBI + + 6. If this succeeds, run the following command: +ppm> install DBD-mysql + + This procedure should work with ActiveState Perl 5.6 or newer. + + If you cannot get the procedure to work, you should install the + MyODBC driver instead and connect to the MySQL server through + ODBC: +use DBI; +$dbh= DBI->connect("DBI:ODBC:$dsn",$user,$password) || + die "Got error $DBI::errstr when connecting to $dsn\n"; + +2.15.3. Problems Using the Perl DBI/DBD Interface + + If Perl reports that it cannot find the ../mysql/mysql.so module, + the problem is probably that Perl cannot locate the + libmysqlclient.so shared library. You should be able to fix this + problem by one of the following methods: + + * Compile the DBD::mysql distribution with perl Makefile.PL + -static -config rather than perl Makefile.PL. + + * Copy libmysqlclient.so to the directory where your other + shared libraries are located (probably /usr/lib or /lib). + + * Modify the -L options used to compile DBD::mysql to reflect + the actual location of libmysqlclient.so. + + * On Linux, you can add the path name of the directory where + libmysqlclient.so is located to the /etc/ld.so.conf file. + + * Add the path name of the directory where libmysqlclient.so is + located to the LD_RUN_PATH environment variable. Some systems + use LD_LIBRARY_PATH instead. + + Note that you may also need to modify the -L options if there are + other libraries that the linker fails to find. For example, if the + linker cannot find libc because it is in /lib and the link command + specifies -L/usr/lib, change the -L option to -L/lib or add -L/lib + to the existing link command. + + If you get the following errors from DBD::mysql, you are probably + using gcc (or using an old binary compiled with gcc): +/usr/bin/perl: can't resolve symbol '__moddi3' +/usr/bin/perl: can't resolve symbol '__divdi3' + + Add -L/usr/lib/gcc-lib/... -lgcc to the link command when the + mysql.so library gets built (check the output from make for + mysql.so when you compile the Perl client). The -L option should + specify the path name of the directory where libgcc.a is located + on your system. + + Another cause of this problem may be that Perl and MySQL are not + both compiled with gcc. In this case, you can solve the mismatch + by compiling both with gcc. + + You may see the following error from DBD::mysql when you run the + tests: +t/00base............install_driver(mysql) failed: +Can't load '../blib/arch/auto/DBD/mysql/mysql.so' for module DBD::mys +ql: +../blib/arch/auto/DBD/mysql/mysql.so: undefined symbol: +uncompress at /usr/lib/perl5/5.00503/i586-linux/DynaLoader.pm line 16 +9. + + This means that you need to include the -lz compression library on + the link line. That can be done by changing the following line in + the file lib/DBD/mysql/Install.pm: +$sysliblist .= " -lm"; + + Change that line to: +$sysliblist .= " -lm -lz"; + + After this, you must run make realclean and then proceed with the + installation from the beginning. + + If you want to install DBI on SCO, you have to edit the Makefile + in DBI-xxx and each subdirectory. Note that the following assumes + gcc 2.95.2 or newer: +OLD: NEW: +CC = cc CC = gcc +CCCDLFLAGS = -KPIC -W1,-Bexport CCCDLFLAGS = -fpic +CCDLFLAGS = -wl,-Bexport CCDLFLAGS = + +LD = ld LD = gcc -G -fpic +LDDLFLAGS = -G -L/usr/local/lib LDDLFLAGS = -L/usr/local/lib +LDFLAGS = -belf -L/usr/local/lib LDFLAGS = -L/usr/local/lib + +LD = ld LD = gcc -G -fpic +OPTIMISE = -Od OPTIMISE = -O1 + +OLD: +CCCFLAGS = -belf -dy -w0 -U M_XENIX -DPERL_SCO5 -I/usr/local/include + +NEW: +CCFLAGS = -U M_XENIX -DPERL_SCO5 -I/usr/local/include + + These changes are necessary because the Perl dynaloader does not + load the DBI modules if they were compiled with icc or cc. + + If you want to use the Perl module on a system that does not + support dynamic linking (such as SCO), you can generate a static + version of Perl that includes DBI and DBD::mysql. The way this + works is that you generate a version of Perl with the DBI code + linked in and install it on top of your current Perl. Then you use + that to build a version of Perl that additionally has the DBD code + linked in, and install that. + + On SCO, you must have the following environment variables set: +LD_LIBRARY_PATH=/lib:/usr/lib:/usr/local/lib:/usr/progressive/lib + + Or: +LD_LIBRARY_PATH=/usr/lib:/lib:/usr/local/lib:/usr/ccs/lib:\ + /usr/progressive/lib:/usr/skunk/lib +LIBPATH=/usr/lib:/lib:/usr/local/lib:/usr/ccs/lib:\ + /usr/progressive/lib:/usr/skunk/lib +MANPATH=scohelp:/usr/man:/usr/local1/man:/usr/local/man:\ + /usr/skunk/man: + + First, create a Perl that includes a statically linked DBI module + by running these commands in the directory where your DBI + distribution is located: +shell> perl Makefile.PL -static -config +shell> make +shell> make install +shell> make perl + + Then you must install the new Perl. The output of make perl + indicates the exact make command you need to execute to perform + the installation. On SCO, this is make -f Makefile.aperl inst_perl + MAP_TARGET=perl. + + Next, use the just-created Perl to create another Perl that also + includes a statically linked DBD::mysql by running these commands + in the directory where your DBD::mysql distribution is located: +shell> perl Makefile.PL -static -config +shell> make +shell> make install +shell> make perl + + Finally, you should install this new Perl. Again, the output of + make perl indicates the command to use. === modified file 'INSTALL-WIN-SOURCE' --- a/INSTALL-WIN-SOURCE 2007-11-23 09:15:55 +0000 +++ b/INSTALL-WIN-SOURCE 2009-05-25 09:59:47 +0000 @@ -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." === added file 'man/comp_err.1' --- a/man/comp_err.1 1970-01-01 00:00:00 +0000 +++ b/man/comp_err.1 2009-05-25 09:59:47 +0000 @@ -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/). === added file 'man/innochecksum.1' --- a/man/innochecksum.1 1970-01-01 00:00:00 +0000 +++ b/man/innochecksum.1 2009-05-25 09:59:47 +0000 @@ -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/). === added file 'man/make_win_bin_dist.1' --- a/man/make_win_bin_dist.1 1970-01-01 00:00:00 +0000 +++ b/man/make_win_bin_dist.1 2009-05-25 09:59:47 +0000 @@ -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/). === added file 'man/msql2mysql.1' --- a/man/msql2mysql.1 1970-01-01 00:00:00 +0000 +++ b/man/msql2mysql.1 2009-05-25 09:59:47 +0000 @@ -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/). === added file 'man/my_print_defaults.1' --- a/man/my_print_defaults.1 1970-01-01 00:00:00 +0000 +++ b/man/my_print_defaults.1 2009-05-25 09:59:47 +0000 @@ -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/). === added file 'man/myisam_ftdump.1' --- a/man/myisam_ftdump.1 1970-01-01 00:00:00 +0000 +++ b/man/myisam_ftdump.1 2009-05-25 09:59:47 +0000 @@ -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/). === added file 'man/myisamchk.1' --- a/man/myisamchk.1 1970-01-01 00:00:00 +0000 +++ b/man/myisamchk.1 2009-05-25 09:59:47 +0000 @@ -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/). === added file 'man/myisamlog.1' --- a/man/myisamlog.1 1970-01-01 00:00:00 +0000 +++ b/man/myisamlog.1 2009-05-25 09:59:47 +0000 @@ -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/). === added file 'man/myisampack.1' --- a/man/myisampack.1 1970-01-01 00:00:00 +0000 +++ b/man/myisampack.1 2009-05-25 09:59:47 +0000 @@ -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/). === added file 'man/mysql-stress-test.pl.1' --- a/man/mysql-stress-test.pl.1 1970-01-01 00:00:00 +0000 +++ b/man/mysql-stress-test.pl.1 2009-05-25 09:59:47 +0000 @@ -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/). === added file 'man/mysql-test-run.pl.1' --- a/man/mysql-test-run.pl.1 1970-01-01 00:00:00 +0000 +++ b/man/mysql-test-run.pl.1 2009-05-25 09:59:47 +0000 @@ -0,0 +1,1145 @@ +.\" Title: \fBmysql\-test\-run.pl\fR +.\" Author: +.\" Generator: DocBook XSL Stylesheets v1.70.1 <http://docbook.sf.net/> +.\" Date: 03/27/2009 +.\" Manual: MySQL Database System +.\" Source: MySQL +.\" +.TH "\fBMYSQL\-TEST\-RUN.PL" "1" "03/27/2009" "MySQL" "MySQL Database System" +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.SH "NAME" +mysql\-test\-run.pl \- run MySQL test suite +.SH "SYNOPSIS" +.HP 28 +\fBmysql\-test\-run.pl [\fR\fB\fIoptions\fR\fR\fB]\fR +.SH "DESCRIPTION" +.PP +The +\fBmysql\-test\-run.pl\fR +Perl script is the main application used to run the MySQL test suite. It invokes +\fBmysqltest\fR +to run individual test cases. (Prior to MySQL 4.1, a similar shell script, +\fBmysql\-test\-run\fR, can be used instead.) +.PP +Invoke +\fBmysql\-test\-run.pl\fR +in the +\fImysql\-test\fR +directory like this: +.sp +.RS 3n +.nf +shell> \fBmysql\-test\-run.pl [\fR\fB\fIoptions\fR\fR\fB] [\fR\fB\fItest_name\fR\fR\fB] ...\fR +.fi +.RE +.PP +Each +\fItest_name\fR +argument names a test case. The test case file that corresponds to the test name is +\fIt/\fR\fI\fItest_name\fR\fR\fI.test\fR. +.PP +For each +\fItest_name\fR +argument, +\fBmysql\-test\-run.pl\fR +runs the named test case. With no +\fItest_name\fR +arguments, +\fBmysql\-test\-run.pl\fR +runs all +\fI.test\fR +files in the +\fIt\fR +subdirectory. +.PP +If no suffix is given for the test name, a suffix of +\fI.test\fR +is assumed. Any leading path name is ignored. These commands are equivalent: +.sp +.RS 3n +.nf +shell> \fBmysql\-test\-run.pl mytest\fR +shell> \fBmysql\-test\-run.pl mytest.test\fR +shell> \fBmysql\-test\-run.pl t/mytest.test\fR +.fi +.RE +.PP +As of MySQL 5.1.23, a suite name can be given as part of the test name. That is, the syntax for naming a test is: +.sp +.RS 3n +.nf +[\fIsuite_name\fR.]\fItest_name\fR[.\fIsuffix\fR] +.fi +.RE +.PP +If a suite name is given, +\fBmysql\-test\-run.pl\fR +looks in that suite for the test. With no suite name, +\fBmysql\-test\-run.pl\fR +looks in the default list of suites for a match and runs the test in any suites where it finds the test. Suppose that the default suite list is +main, +binlog, +rpl, and that a test +\fImytest.test\fR +exists in the +main +and +rpl +suites. With an argument of +mytest +or +mytest.test, +\fBmysql\-test\-run.pl\fR +will run +\fImytest.test\fR +from the +main +and +rpl +suites. +.PP +To run a family of test cases for which the names share a common prefix, use the +\fB\-\-do\-test=\fR\fB\fIprefix\fR\fR +option. For example, +\fB\-\-do\-test=rpl\fR +runs the replication tests (test cases that have names beginning with +rpl). +\fB\-\-skip\-test\fR +has the opposite effect of skipping test cases for which the names share a common prefix. +.PP +As of MySQL 5.0.54/5.1.23/6.0.5, the argument for the +\fB\-\-do\-test\fR +and +\fB\-\-skip\-test\fR +options allows more flexible specification of which tests to perform or skip. If the argument contains a pattern metacharacter other than a lone period, it is interpreted as a Perl regular expression and applies to test names that match the pattern. If the argument contains a lone period or does not contain any pattern metacharacters, it is interpreted the same way as previously and matches test names that begin with the argument value. For example, +\fB\-\-do\-test=testa\fR +matches tests that begin with +testa, +\fB\-\-do\-test=main.testa\fR +matches tests in the +main +test suite that begin with +testa, and +\fB\-\-do\-test=main.*testa\fR +matches test names that contain +main +followed by +testa +with anything in between. In the latter case, the pattern match is not anchored to the beginning of the test name, so it also matches names such as +xmainytestz. +.PP +To perform setup prior to running tests, +\fBmysql\-test\-run.pl\fR +needs to invoke +\fBmysqld\fR +with the +\fB\-\-bootstrap\fR +and +\fB\-\-skip\-grant\-tables\fR +options (see +[1]\&\fITypical \fBconfigure\fR Options\fR). If MySQL was configured with the +\fB\-\-disable\-grant\-options\fR +option, +\fB\-\-bootstrap\fR, +\fB\-\-skip\-grant\-tables\fR, and +\fB\-\-init\-file\fR +will be disabled. To handle this, set the +MYSQLD_BOOTSTRAP +environment variable to the full path name of a server that has all options enabled. +\fBmysql\-test\-run.pl\fR +will use that server to perform setup; it is not used to run the tests. +.PP +The +init_file +test will fail if +\fB\-\-init\-file\fR +is disabled. This is an expected failure that can be handled as follows: +.sp +.RS 3n +.nf +shell> \fBexport MYSQLD_BOOTSTRAP\fR +shell> \fBMYSQLD_BOOTSTRAP=/full/path/to/mysqld\fR +shell> \fBmake test force="\-\-skip\-test=init_file"\fR +.fi +.RE +.PP +To run +\fBmysql\-test\-run.pl\fR +on Windows, you'll need either Cygwin or ActiveState Perl to run it. You may also need to install the modules required by the script. To run the test script, change location into the +\fImysql\-test\fR +directory, set the +MTR_VS_CONFIG +environment variable to the configuration you selected earlier (or use the +\fB\-\-vs\-config\fR +option), and invoke +\fBmysql\-test\-run.pl\fR. For example (using Cygwin and the +\fBbash\fR +shell): +.sp +.RS 3n +.nf +shell> \fBcd mysql\-test\fR +shell> \fBexport MTS_VS_CONFIG=debug\fR +shell> \fB./mysqltest\-run.pl \-\-force \-\-timer\fR +shell> \fB./mysqltest\-run.pl \-\-force \-\-timer \-\-ps\-protocol\fR +.fi +.RE +.PP +If you have a copy of +\fBmysqld\fR +running on the machine where you want to run the test suite, you do not have to stop it, as long as it is not using ports +9306 +or +9307. If either of those ports is taken, you should set the +MTR_BUILD_THREAD +environment variable to an appropriate value, and the test suite will use a different set of ports for master, slave, NDB, and Instance Manager). For example: +.sp +.RS 3n +.nf +shell> \fBexport MTR_BUILD_THREAD=31\fR +shell> \fB./mysql\-test\-run.pl [\fR\fB\fIoptions\fR\fR\fB] [\fR\fB\fItest_name\fR\fR\fB]\fR +.fi +.RE +.PP +\fBmysql\-test\-run.pl\fR +defines several environment variables. Some of them are listed in the following table. +.TS +allbox tab(:); +l l +l l +l l +l l +l l +l l. +T{ +\fBVariable\fR +T}:T{ +\fBMeaning\fR +T} +T{ +MYSQL_TEST +T}:T{ +Path name to \fBmysqltest\fR binary +T} +T{ +MYSQLTEST_VARDIR +T}:T{ +Path name to the \fIvar\fR directory that is used for + logs, temporary files, and so forth +T} +T{ +MYSQLD_BOOTSTRAP +T}:T{ +Full path name to \fBmysqld\fR that has all options enabled +T} +T{ +MASTER_MYPORT +T}:T{ +??? +T} +T{ +MASTER_MYSOCK +T}:T{ +??? +T} +.TE +.sp +.PP +Tests sometimes rely on certain environment variables being defined. For example, certain tests assume that +MYSQL_TEST +is defined so that +\fBmysqltest\fR +can invoke itself with +exec $MYSQL_TEST. +.PP +\fBmysql\-test\-run.pl\fR +supports the options in the following list. An argument of +\fB\-\-\fR +tells +\fBmysql\-test\-run.pl\fR +not to process any following arguments as options. (A description of differences between the options supported by +\fBmysql\-test\-run.pl\fR +and +\fBmysql\-test\-run\fR +appears following the list.) +.TP 3n +\(bu +\fB\-\-help\fR, +\fB\-h\fR +.sp +Display a help message and exit. +.TP 3n +\(bu +\fB\-\-bench\fR +.sp +Run the benchmark suite. +.TP 3n +\(bu +\fB\-\-benchdir=\fR\fB\fIpath\fR\fR +.sp +The directory where the benchmark suite is located. The default path is +\fI../../mysql\-bench\fR. +.TP 3n +\(bu +\fB\-\-big\-test\fR +.sp +Pass the +\fB\-\-big\-test\fR +option to +\fBmysqltest\fR. +.TP 3n +\(bu +\fB\-\-check\-testcases\fR +.sp +Check test cases for side effects. +.TP 3n +\(bu +\fB\-\-client\-bindir\fR +.sp +The path to the directory where client binaries are located. This option was added in MySQL 5.0.66/5.1.27. +.TP 3n +\(bu +\fB\-\-client\-ddd\fR +.sp +Start +\fBmysqltest\fR +in the +\fBddd\fR +debugger. +.TP 3n +\(bu +\fB\-\-client\-debugger\fR +.sp +Start +\fBmysqltest\fR +in the named debugger. +.TP 3n +\(bu +\fB\-\-client\-gdb\fR +.sp +Start +\fBmysqltest\fR +in the +\fBgdb\fR +debugger. +.TP 3n +\(bu +\fB\-\-client\-libdir\fR +.sp +The path to the directory where client libraries are located. This option was added in MySQL 5.0.66/5.1.27. +.TP 3n +\(bu +\fB\-\-combination=\fR\fB\fIvalue\fR\fR +.sp +Extra options to pass to +\fBmysqld\fR. The value should consist of one or more comma\-separated +\fBmysqld\fR +options. This option is similar to +\fB\-\-mysqld\fR +but should be given two or more times. +\fBmysql\-test\-run.pl\fR +executes multiple test runs, using the options for each instance of +\fB\-\-combination\fR +in successive runs. If +\fB\-\-combination\fR +is given only once, it has no effect. For test runs specific to a given test suite, an alternative to the use of +\fB\-\-combination\fR +is to create a +\fIcombinations\fR +file in the suite directory. The file should contain a section of options for each test run. See +Section\ 4.9, \(lqPassing Options from \fBmysql\-test\-run.pl\fR to \fBmysqld\fR or \fBmysqltest\fR\(rq. +.sp +This option was added in MySQL 5.1.23/6.0.4. +.TP 3n +\(bu +\fB\-\-comment=\fR\fB\fIstr\fR\fR +.sp +Write +\fIstr\fR +to the output. +.TP 3n +\(bu +\fB\-\-compress\fR +.sp +Compress all information sent between the client and the server if both support compression. +.TP 3n +\(bu +\fB\-\-cursor\-protocol\fR +.sp +Pass the +\fB\-\-cursor\-protocol\fR +option to +\fBmysqltest\fR +(implies +\fB\-\-ps\-protocol\fR). +.TP 3n +\(bu +\fB\-\-ddd\fR +.sp +Start +\fBmysqld\fR +in the +\fBddd\fR +debugger. +.TP 3n +\(bu +\fB\-\-debug\fR +.sp +Dump trace output for all clients and servers. +.TP 3n +\(bu +\fB\-\-debugger\fR +.sp +Start +\fBmysqld\fR +using the named debugger. +.TP 3n +\(bu +\fB\-\-debug\-sync\-timeout=\fR\fB\fIN\fR\fR +.sp +Controls whether the Debug Sync facility for testing and debugging is enabled. The option value is a timeout in seconds. The default value is 300. A value of 0 disables Debug Sync. The value of this option also becomes the default timeout for individual synchronization points. +.sp +\fBmysql\-test\-run.pl\fR +passes +\fB\-\-loose\-debug\-sync\-timeout=\fR\fB\fIN\fR\fR +to +\fBmysqld\fR. The +\fB\-\-loose\fR +prefix is used so that +\fBmysqld\fR +does not fail if Debug Sync is not compiled in. +.sp +For information about using the Debug Sync facility for testing, see +Section\ 4.14, \(lqThread Synchronization in Test Cases\(rq. +.sp +This option was added in MySQL 6.0.6. +.TP 3n +\(bu +\fB\-\-do\-test=\fR\fB\fIprefix\fR\fR +.sp +Run all test cases having a name that begins with the given +\fIprefix\fR +value. This option provides a convenient way to run a family of similarly named tests. +.sp +As of MySQL 5.0.54/5.1.23/6.0.5, the argument for the +\fB\-\-do\-test\fR +option allows more flexible specification of which tests to perform. If the argument contains a pattern metacharacter other than a lone period, it is interpreted as a Perl regular expression and applies to test names that match the pattern. If the argument contains a lone period or does not contain any pattern metacharacters, it is interpreted the same way as previously and matches test names that begin with the argument value. For example, +\fB\-\-do\-test=testa\fR +matches tests that begin with +testa, +\fB\-\-do\-test=main.testa\fR +matches tests in the +main +test suite that begin with +testa, and +\fB\-\-do\-test=main.*testa\fR +matches test names that contain +main +followed by +testa +with anything in between. In the latter case, the pattern match is not anchored to the beginning of the test name, so it also matches names such as +xmainytestz. +.TP 3n +\(bu +\fB\-\-embedded\-server\fR +.sp +Use a version of +\fBmysqltest\fR +built with the embedded server. +.TP 3n +\(bu +\fB\-\-experimental=\fR\fB\fIfile_name\fR\fR +.sp +Specify a file that contains a list of test cases that should be displayed with the +[ exp\-fail ] +code rather than +[ fail ] +if they fail. This option was added in MySQL 5.1.33/6.0.11. +.TP 3n +\(bu +\fB\-\-extern\fR +.sp +Use an already running server. +.sp +Note: If a test case has an +\fI.opt\fR +file that requires the server to be restarted with specific options, the file will not be used. The test case likely will fail as a result. +.TP 3n +\(bu +\fB\-\-fast\fR +.sp +Do not clean up from earlier test runs. +.TP 3n +\(bu +\fB\-\-force\fR +.sp +Normally, +\fBmysql\-test\-run.pl\fR +exits if a test case fails. +\fB\-\-force\fR +causes execution to continue regardless of test case failure. +.TP 3n +\(bu +\fB\-\-gcov\fR +.sp +Run tests with the +\fBgcov\fR +test coverage tool. +.TP 3n +\(bu +\fB\-\-gdb\fR +.sp +Start +\fBmysqld\fR +in the +\fBgdb\fR +debugger. +.TP 3n +\(bu +\fB\-\-gprof\fR +.sp +Run tests with the +\fBgprof\fR +profiling tool. +.TP 3n +\(bu +\fB\-\-im\-mysqld1\-port\fR +.sp +TCP/IP port number to use for the first +\fBmysqld\fR, controlled by Instance Manager. +.TP 3n +\(bu +\fB\-\-im\-mysqld2\-port\fR +.sp +TCP/IP port number to use for the second +\fBmysqld\fR, controlled by Instance Manager. +.TP 3n +\(bu +\fB\-\-im\-port\fR +.sp +TCP/IP port number to use for +\fBmysqld\fR, controlled by Instance Manager. +.TP 3n +\(bu +\fB\-\-log\-warnings\fR +.sp +Pass the +\fB\-\-log\-warnings\fR +option to +\fBmysqld\fR. +.TP 3n +\(bu +\fB\-\-manual\-debug\fR +.sp +Use a server that has already been started by the user in a debugger. +.TP 3n +\(bu +\fB\-\-manual\-gdb\fR +.sp +Use a server that has already been started by the user in the +\fBgdb\fR +debugger. +.TP 3n +\(bu +\fB\-\-master\-binary=\fR\fB\fIpath\fR\fR +.sp +Specify the path of the +\fBmysqld\fR +binary to use for master servers. +.TP 3n +\(bu +\fB\-\-master_port=\fR\fB\fIport_num\fR\fR +.sp +Specify the TCP/IP port number for the first master server to use. Observe that the option name has an underscore and not a dash. +.TP 3n +\(bu +\fB\-\-mem\fR +.sp +Run the test suite in memory, using tmpfs or ramdisk. This can decrease test times significantly. +\fBmysql\-test\-run.pl\fR +attempts to find a suitable location using a built\-in list of standard locations for tmpfs and puts the +\fIvar\fR +directory there. This option also affects placement of temporary files, which are created in +\fIvar/tmp\fR. +.sp +The default list includes +\fI/dev/shm\fR. You can also enable this option by setting the environment variable +MTR_MEM[=\fIdir_name\fR]. If +\fIdir_name\fR +is given, it is added to the beginning of the list of locations to search, so it takes precedence over any built\-in locations. +.sp +This option was added in MySQL 4.1.22, 5.0.30, and 5.1.13. +.TP 3n +\(bu +\fB\-\-mysqld=\fR\fB\fIvalue\fR\fR +.sp +Extra options to pass to +\fBmysqld\fR. The value should consist of one or more comma\-separated +\fBmysqld\fR +options. See +Section\ 4.9, \(lqPassing Options from \fBmysql\-test\-run.pl\fR to \fBmysqld\fR or \fBmysqltest\fR\(rq. +.TP 3n +\(bu +\fB\-\-mysqltest=\fR\fB\fIvalue\fR\fR +.sp +Extra options to pass to +\fBmysqltest\fR. The value should consist of one or more comma\-separated +\fBmysqltest\fR +options. See +Section\ 4.9, \(lqPassing Options from \fBmysql\-test\-run.pl\fR to \fBmysqld\fR or \fBmysqltest\fR\(rq. This option was added in MySQL 6.0.6. +.TP 3n +\(bu +\fB\-\-ndb\-connectstring=\fR\fB\fIstr\fR\fR +.sp +Pass +\fB\-\-ndb\-connectstring=\fR\fB\fIstr\fR\fR +to the master MySQL server. This option also prevents +\fBmysql\-test\-run.pl\fR +from starting a cluster. It is assumed that there is already a cluster running to which the server can connect with the given connectstring. +.TP 3n +\(bu +\fB\-\-ndb\-connectstring\-slave=\fR\fB\fIstr\fR\fR +.sp +Pass +\fB\-\-ndb\-connectstring=\fR\fB\fIstr\fR\fR +to slave MySQL servers. This option also prevents +\fBmysql\-test\-run.pl\fR +from starting a cluster. It is assumed that there is already a cluster running to which the server can connect with the given connectstring. +.TP 3n +\(bu +\fB\-\-ndb\-extra\-test\fR +.sp +Unknown. +.TP 3n +\(bu +\fB\-\-ndbcluster\-port=\fR\fB\fIport_num\fR\fR, +\fB\-\-ndbcluster_port=\fR\fB\fIport_num\fR\fR +.sp +Specify the TCP/IP port number that NDB Cluster should use. +.TP 3n +\(bu +\fB\-\-ndbcluster\-port\-slave=\fR\fB\fIport_num\fR\fR +.sp +Specify the TCP/IP port number that the slave NDB Cluster should use. +.TP 3n +\(bu +\fB\-\-netware\fR +.sp +Run +\fBmysqld\fR +with options needed on NetWare. +.TP 3n +\(bu +\fB\-\-notimer\fR +.sp +Cause +\fBmysqltest\fR +not to generate a timing file. +.TP 3n +\(bu +\fB\-\-ps\-protocol\fR +.sp +Pass the +\fB\-\-ps\-protocol\fR +option to +\fBmysqltest\fR. +.TP 3n +\(bu +\fB\-\-record\fR +.sp +Pass the +\fB\-\-record\fR +option to +\fBmysqltest\fR. This option requires a specific test case to be named on the command line. +.TP 3n +\(bu +\fB\-\-reorder\fR +.sp +Reorder tests to minimize the number of server restarts needed. +.TP 3n +\(bu +\fB\-\-report\-features\fR +.sp +Display the output of +SHOW ENGINES +and +SHOW VARIABLES. This can be used to verify that binaries are built with all required features. +.sp +This option was added in MySQL 4.1.23, 5.0.30, and 5.1.14. +.TP 3n +\(bu +\fB\-\-script\-debug\fR +.sp +Enable debug output for +\fBmysql\-test\-run.pl\fR +itself. +.TP 3n +\(bu +\fB\-\-skip\-im\fR +.sp +Do not start Instance Manager; skip Instance Manager test cases. +.TP 3n +\(bu +\fB\-\-skip\-master\-binlog\fR +.sp +Do not enable master server binary logging. +.TP 3n +\(bu +\fB\-\-skip\-ndbcluster\fR, +\fB\-\-skip\-ndb\fR +.sp +Do not start NDB Cluster; skip Cluster test cases. +.TP 3n +\(bu +\fB\-\-skip\-ndbcluster\-slave\fR, +\fB\-\-skip\-ndb\-slave\fR +.sp +Do not start an NDB Cluster slave. +.TP 3n +\(bu +\fB\-\-skip\-rpl\fR +.sp +Skip replication test cases. +.TP 3n +\(bu +\fB\-\-skip\-slave\-binlog\fR +.sp +Do not enable master server binary logging. +.TP 3n +\(bu +\fB\-\-skip\-ssl\fR +.sp +Do not start +\fBmysqld\fR +with support for SSL connections. +.TP 3n +\(bu +\fB\-\-skip\-test=\fR\fB\fIregex\fR\fR +.sp +Specify a regular expression to be applied to test case names. Cases with names that match the expression are skipped. tests to skip. +.sp +As of MySQL 5.0.54/5.1.23/6.0.5, the argument for the +\fB\-\-skip\-test\fR +option allows more flexible specification of which tests to skip. If the argument contains a pattern metacharacter other than a lone period, it is interpreted as a Perl regular expression and applies to test names that match the pattern. See the description of the +\fB\-\-do\-test\fR +option for details. +.TP 3n +\(bu +\fB\-\-skip\-*\fR +.sp +\fB\-\-skip\-*\fR +options not otherwise recognized by +\fBmysql\-test\-run.pl\fR +are passed to the master server. +.TP 3n +\(bu +\fB\-\-slave\-binary=\fR\fB\fIpath\fR\fR +.sp +Specify the path of the +\fBmysqld\fR +binary to use for slave servers. +.TP 3n +\(bu +\fB\-\-slave_port=\fR\fB\fIport_num\fR\fR +.sp +Specify the TCP/IP port number for the first master server to use. Observe that the option name has an underscore and not a dash. +.TP 3n +\(bu +\fB\-\-sleep=\fR\fB\fIN\fR\fR +.sp +Pass +\fB\-\-sleep=\fR\fB\fIN\fR\fR +to +\fBmysqltest\fR. +.TP 3n +\(bu +\fB\-\-small\-bench\fR +.sp +Run the benchmarks with the +\fB\-\-small\-tests\fR +and +\fB\-\-small\-tables\fR +options. +.TP 3n +\(bu +\fB\-\-socket=\fR\fB\fIfile_name\fR\fR +.sp +For connections to +localhost, the Unix socket file to use, or, on Windows, the name of the named pipe to use. +.TP 3n +\(bu +\fB\-\-sp\-protocol\fR +.sp +Pass the +\fB\-\-sp\-protocol\fR +option to +\fBmysqltest\fR. +.TP 3n +\(bu +\fB\-\-ssl\fR +.sp +If +\fBmysql\-test\-run.pl\fR +is started with the +\fB\-\-ssl\fR +option, it sets up a secure conection for all test cases. In this case, if +\fBmysqld\fR +does not support SSL, +\fBmysql\-test\-run.pl\fR +exits with an error message: +Couldn't find support for SSL +.TP 3n +\(bu +\fB\-\-start\fR +.sp +Initialize and start servers with the startup settings for the first specified test case. For example: +.sp +.RS 3n +.nf +shell> \fBcd mysql\-test\fR +shell> \fB./mysql\-test\-run.pl \-\-start alias &\fR +.fi +.RE +This option was added in MySQL 5.1.32/6.0.11. +.TP 3n +\(bu +\fB\-\-start\-and\-exit\fR +.sp +Initialize and start servers with the startup settings for the specified test case or cases, if any, and then exit. You can use this option to start a server to which you can connect later. For example, after building a source distribution you can start a server and connect to it with the +\fBmysql\fR +client like this: +.sp +.RS 3n +.nf +shell> \fBcd mysql\-test\fR +shell> \fB./mysql\-test\-run.pl \-\-start\-and\-exit\fR +shell> \fB../mysql \-S ./var/tmp/master.sock \-h localhost \-u root\fR +.fi +.RE +.TP 3n +\(bu +\fB\-\-start\-dirty\fR +.sp +Start servers (without initialization) for the specified test case or cases, if any, and then exit. You can then manually run the test cases. +.TP 3n +\(bu +\fB\-\-start\-from=\fR\fB\fItest_name\fR\fR +.sp +\fBmysql\-test\-run.pl\fR +sorts the list of names of the test cases to be run, and then begins with +\fItest_name\fR. +.TP 3n +\(bu +\fB\-\-strace\-client\fR +.sp +Create +\fBstrace\fR +output for +\fBmysqltest\fR. +.TP 3n +\(bu +\fB\-\-stress\fR +.sp +Run the stress test. The other +\fB\-\-stress\-\fR\fB\fIxxx\fR\fR +options apply in this case. +.TP 3n +\(bu +\fB\-\-stress\-init\-file=\fR\fB\fIfile_name\fR\fR +.sp +\fIfile_name\fR +is the location of the file that contains the list of tests. The default file is +\fIstress_init.txt\fR +in the test suite directory. +.TP 3n +\(bu +\fB\-\-stress\-loop\-count=\fR\fB\fIN\fR\fR +.sp +In sequential stress\-test mode, the number of loops to execute before exiting. +.TP 3n +\(bu +\fB\-\-stress\-mode=\fR\fB\fImode\fR\fR +.sp +This option indicates the test order in stress\-test mode. The +\fImode\fR +value is either +random +to select tests in random order or +seq +to run tests in each thread in the order specified in the test list file. The default mode is +random. +.TP 3n +\(bu +\fB\-\-stress\-suite=\fR\fB\fIsuite_name\fR\fR +.sp +The name of the test suite to use for stress testing. The default suite name is +main +(the regular test suite located in the +\fImysql\-test\fR +directory). +.TP 3n +\(bu +\fB\-\-stress\-test\-count=\fR\fB\fIN\fR\fR +.sp +For stress testing, the number of tests to execute before exiting. +.TP 3n +\(bu +\fB\-\-stress\-test\-duration=\fR\fB\fIN\fR\fR +.sp +For stress testing, the duration of stress testing in seconds. +.TP 3n +\(bu +\fB\-\-stress\-test\-file=\fR\fB\fIfile_name\fR\fR +.sp +The file that contains the list of tests to use in stress testing. The tests should be named without the +\fI.test\fR +extension. The default file is +\fIstress_tests.txt\fR +in the test suite directory. +.TP 3n +\(bu +\fB\-\-stress\-threads=\fR\fB\fIN\fR\fR +.sp +The number of threads to use in stress testing. The default is 5. +.TP 3n +\(bu +\fB\-\-suite=\fR\fB\fIsuite_name\fR\fR +.sp +Run the named test suite. The default name is +main +(the regular test suite located in the +\fImysql\-test\fR +directory). +.TP 3n +\(bu +\fB\-\-suite\-timeout=\fR\fB\fIminutes\fR\fR +.sp +Specify the maximum test suite runtime. +.TP 3n +\(bu +\fB\-\-testcase\-timeout\fR +.sp +Specify the maximum test case runtime. +.TP 3n +\(bu +\fB\-\-timer\fR +.sp +Cause +\fBmysqltest\fR +to generate a timing file. The default file is named +\fI./var/log/timer\fR. +.TP 3n +\(bu +\fB\-\-tmpdir=\fR\fB\fIpath\fR\fR +.sp +The directory where temporary file are stored. The default location is +\fI./var/tmp\fR. +.TP 3n +\(bu +\fB\-\-unified\-diff\fR, +\fB\-\-udiff\fR +.sp +Use unified diff format when presenting differences between expected and actual test case results. +.TP 3n +\(bu +\fB\-\-use\-old\-data\fR +.sp +Do not install the test databases. (Use existing ones.) +.TP 3n +\(bu +\fB\-\-user\-test=\fR\fB\fIval\fR\fR +.sp +Unused. +.TP 3n +\(bu +\fB\-\-user=\fR\fB\fIuser_name\fR\fR +.sp +The MySQL user name to use when connecting to the server. +.TP 3n +\(bu +\fB\-\-valgrind\fR +.sp +Run +\fBmysqltest\fR +and +\fBmysqld\fR +with +\fBvalgrind\fR. +.TP 3n +\(bu +\fB\-\-valgrind\-all\fR +.sp +Like +\fB\-\-valgrind\fR, but passes the +\fB\-\-verbose\fR +and +\fB\-\-show\-reachable\fR +options to +\fBvalgrind\fR. +.TP 3n +\(bu +\fB\-\-valgrind\-mysqltest\fR +.sp +Run +\fBmysqltest\fR +with +\fBvalgrind\fR. +.TP 3n +\(bu +\fB\-\-valgrind\-mysqltest\-all\fR +.sp +Like +\fB\-\-valgrind\-mysqltest\fR, but passes the +\fB\-\-verbose\fR +and +\fB\-\-show\-reachable\fR +options to +\fBvalgrind\fR. +.TP 3n +\(bu +\fB\-\-valgrind\-options=\fR\fB\fIstr\fR\fR +.sp +Extra options to pass to +\fBvalgrind\fR. +.TP 3n +\(bu +\fB\-\-valgrind\-path=\fR\fB\fIpath\fR\fR +.sp +Specify the path name to the +\fBvalgrind\fR +executable. +.TP 3n +\(bu +\fB\-\-vardir=\fR\fB\fIpath\fR\fR +.sp +Specify the path where files generated during the test run are stored. The default location is +\fI./var\fR. +.TP 3n +\(bu +\fB\-\-view\-protocol\fR +.sp +Pass the +\fB\-\-view\-protocol\fR +option to +\fBmysqltest\fR. +.TP 3n +\(bu +\fB\-\-vs\-config=\fR\fB\fIconfig_val\fR\fR +.sp +Specify the configuration used to build MySQL (for example, +\fB\-\-vs\-config=debug\fR +\fB\-\-vs\-config=release\fR). This option is for Windows only. It is available as of MySQL 4.1.23, 5.0.30, and 5.1.14. +.TP 3n +\(bu +\fB\-\-wait\-timeout=\fR\fB\fIN\fR\fR +.sp +Unused? +.TP 3n +\(bu +\fB\-\-warnings\fR +.sp +This option is a synonym for +\fB\-\-log\-warnings\fR. +.TP 3n +\(bu +\fB\-\-with\-ndbcluster\fR +.sp +Use NDB Cluster and enable test cases that require it. +.TP 3n +\(bu +\fB\-\-with\-ndbcluster\-all\fR +.sp +Use NDB Cluster in all tests. +.TP 3n +\(bu +\fB\-\-with\-ndbcluster\-only\fR +.sp +Run only test cases that have +ndb +in their name. +.TP 3n +\(bu +\fB\-\-with\-ndbcluster\-slave\fR +.sp +Unknown. +.TP 3n +\(bu +\fB\-\-with\-openssl\fR +.sp +This option is a synonym for +\fB\-\-ssl\fR. +.sp +.RE +.sp +.it 1 an-trap +.nr an-no-space-flag 1 +.nr an-break-flag 1 +.br +\fBNote\fR +.PP +\fBmysql\-test\-run\fR +supports the following options not supported by +\fBmysql\-test\-run.pl\fR: +\fB\-\-local\fR, +\fB\-\-local\-master\fR, +\fB\-\-ndb\-verbose\fR, +\fB\-\-ndb_mgm\-extra\-opts\fR, +\fB\-\-ndb_mgmd\-extra\-opts\fR, +\fB\-\-ndbd\-extra\-opts\fR, +\fB\-\-old\-master\fR, +\fB\-\-purify\fR, +\fB\-\-use\-old\-data\fR, +\fB\-\-valgrind\-mysqltest\-all\fR. +.PP +Conversely, +\fBmysql\-test\-run.pl\fR +supports the following options not supported by +\fBmysql\-test\-run\fR: +\fB\-\-benchdir\fR, +\fB\-\-check\-testcases\fR, +\fB\-\-client\-ddd\fR, +\fB\-\-client\-debugger\fR, +\fB\-\-cursor\-protocol\fR, +\fB\-\-debugger\fR, +\fB\-\-im\-mysqld1\-port\fR, +\fB\-\-im\-mysqld2\-port\fR, +\fB\-\-im\-port\fR, +\fB\-\-manual\-debug\fR, +\fB\-\-netware\fR, +\fB\-\-notimer\fR, +\fB\-\-reorder\fR, +\fB\-\-script\-debug\fR, +\fB\-\-skip\-im\fR, +\fB\-\-skip\-ssl\fR, +\fB\-\-sp\-protocol\fR, +\fB\-\-start\-dirty\fR, +\fB\-\-suite\fR, +\fB\-\-suite\-timeout\fR, +\fB\-\-testcase\-timeout\fR, +\fB\-\-udiff\fR, +\fB\-\-unified\-diff\fR,, +\fB\-\-valgrind\-path\fR, +\fB\-\-vardir\fR, +\fB\-\-view\-protocol\fR. +.SH "COPYRIGHT" +.PP +Copyright 2007\-2008 MySQL AB, 2009 Sun Microsystems, Inc. +.PP +This documentation is free software; you can redistribute it and/or modify it only under the terms of the GNU General Public License as published by the Free Software Foundation; version 2 of the License. +.PP +This documentation is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. +.PP +You should have received a copy of the GNU General Public License along with the program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110\-1301 USA or see http://www.gnu.org/licenses/. +.SH "REFERENCES" +.TP 3 +1.\ Typical configure Options +\%http://dev.mysql.com/doc/refman/5.1/en/configure\-options.html +.SH "SEE ALSO" +For more information, please refer to the MySQL Reference Manual, +which may already be installed locally and which is also available +online at http://dev.mysql.com/doc/. +.SH AUTHOR +MySQL AB (http://www.mysql.com/). === added file 'man/mysql.1' --- a/man/mysql.1 1970-01-01 00:00:00 +0000 +++ b/man/mysql.1 2009-05-25 09:59:47 +0000 @@ -0,0 +1,1699 @@ +.\" Title: \fBmysql\fR +.\" Author: +.\" Generator: DocBook XSL Stylesheets v1.70.1 <http://docbook.sf.net/> +.\" Date: 03/31/2009 +.\" Manual: MySQL Database System +.\" Source: MySQL 5.1 +.\" +.TH "\fBMYSQL\fR" "1" "03/31/2009" "MySQL 5.1" "MySQL Database System" +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.SH "NAME" +mysql \- the MySQL command\-line tool +.SH "SYNOPSIS" +.HP 24 +\fBmysql [\fR\fB\fIoptions\fR\fR\fB] \fR\fB\fIdb_name\fR\fR +.SH "DESCRIPTION" +.PP +\fBmysql\fR +is a simple SQL shell (with GNU +readline +capabilities). It supports interactive and non\-interactive use. When used interactively, query results are presented in an ASCII\-table format. When used non\-interactively (for example, as a filter), the result is presented in tab\-separated format. The output format can be changed using command options. +.PP +If you have problems due to insufficient memory for large result sets, use the +\fB\-\-quick\fR +option. This forces +\fBmysql\fR +to retrieve results from the server a row at a time rather than retrieving the entire result set and buffering it in memory before displaying it. This is done by returning the result set using the +mysql_use_result() +C API function in the client/server library rather than +mysql_store_result(). +.PP +Using +\fBmysql\fR +is very easy. Invoke it from the prompt of your command interpreter as follows: +.sp +.RS 3n +.nf +shell> \fBmysql \fR\fB\fIdb_name\fR\fR +.fi +.RE +.PP +Or: +.sp +.RS 3n +.nf +shell> \fBmysql \-\-user=\fR\fB\fIuser_name\fR\fR\fB \-\-password=\fR\fB\fIyour_password\fR\fR\fB \fR\fB\fIdb_name\fR\fR +.fi +.RE +.PP +Then type an SQL statement, end it with +\(lq;\(rq, +\\g, or +\\G +and press Enter. +.PP +As of MySQL 5.1.10, typing Control\-C causes +\fBmysql\fR +to attempt to kill the current statement. If this cannot be done, or Control\-C is typed again before the statement is killed, +\fBmysql\fR +exits. Previously, Control\-C caused +\fBmysql\fR +to exit in all cases. +.PP +You can execute SQL statements in a script file (batch file) like this: +.sp +.RS 3n +.nf +shell> \fBmysql \fR\fB\fIdb_name\fR\fR\fB < \fR\fB\fIscript.sql\fR\fR\fB > \fR\fB\fIoutput.tab\fR\fR +.fi +.RE +.SH "\fBMYSQL\fR OPTIONS" +.PP +\fBmysql\fR +supports the following options: +.TP 3n +\(bu +\fB\-\-help\fR, +\fB\-?\fR +.sp +Display a help message and exit. +.TP 3n +\(bu +\fB\-\-auto\-rehash\fR +.sp +Enable automatic rehashing. This option is on by default, which enables database, table, and column name completion. Use +\fB\-\-disable\-auto\-rehash\fR +to disable rehashing. That causes +\fBmysql\fR +to start faster, but you must issue the +rehash +command if you want to use name completion. +.sp +To complete a name, enter the first part and press Tab. If the name is unambiguous, +\fBmysql\fR +completes it. Otherwise, you can press Tab again to see the possible names that begin with what you have typed so far. Completion does not occur if there is no default database. +.TP 3n +\(bu +\fB\-\-batch\fR, +\fB\-B\fR +.sp +Print results using tab as the column separator, with each row on a new line. With this option, +\fBmysql\fR +does not use the history file. +.sp +Batch mode results in non\-tabular output format and escaping of special characters. Escaping may be disabled by using raw mode; see the description for the +\fB\-\-raw\fR +option. +.TP 3n +\(bu +\fB\-\-character\-sets\-dir=\fR\fB\fIpath\fR\fR +.sp +The directory where character sets are installed. See +Section\ 9.2, \(lqThe Character Set Used for Data and Sorting\(rq. +.TP 3n +\(bu +\fB\-\-column\-names\fR +.sp +Write column names in results. +.TP 3n +\(bu +\fB\-\-column\-type\-info\fR, +\fB\-m\fR +.sp +Display result set metadata. This option was added in MySQL 5.1.14. (Before that, use +\fB\-\-debug\-info\fR.) The +\fB\-m\fR +short option was added in MySQL 5.1.21. +.TP 3n +\(bu +\fB\-\-comments\fR, +\fB\-c\fR +.sp +Whether to preserve comments in statements sent to the server. The default is \-\-skip\-comments (discard comments), enable with \-\-comments (preserve comments). This option was added in MySQL 5.1.23. +.TP 3n +\(bu +\fB\-\-compress\fR, +\fB\-C\fR +.sp +Compress all information sent between the client and the server if both support compression. +.TP 3n +\(bu +\fB\-\-database=\fR\fB\fIdb_name\fR\fR, +\fB\-D \fR\fB\fIdb_name\fR\fR +.sp +The database to use. This is useful primarily in an option file. +.TP 3n +\(bu +\fB\-\-debug[=\fR\fB\fIdebug_options\fR\fR\fB]\fR, +\fB\-# [\fR\fB\fIdebug_options\fR\fR\fB]\fR +.sp +Write a debugging log. The +\fIdebug_options\fR +string often is +\'d:t:o,\fIfile_name\fR'. The default is +\'d:t:o,/tmp/mysql.trace'. +.TP 3n +\(bu +\fB\-\-debug\-check\fR +.sp +Print some debugging information when the program exits. This option was added in MySQL 5.1.21. +.TP 3n +\(bu +\fB\-\-debug\-info\fR, +\fB\-T\fR +.sp +Before MySQL 5.1.14, this option prints debugging information and memory and CPU usage statistics when the program exits, and also causes display of result set metadata during execution. As of MySQL 5.1.14, use +\fB\-\-column\-type\-info\fR +to display result set metadata. +.TP 3n +\(bu +\fB\-\-default\-character\-set=\fR\fB\fIcharset_name\fR\fR +.sp +Use +\fIcharset_name\fR +as the default character set. See +Section\ 9.2, \(lqThe Character Set Used for Data and Sorting\(rq. +.TP 3n +\(bu +\fB\-\-delimiter=\fR\fB\fIstr\fR\fR +.sp +Set the statement delimiter. The default is the semicolon character (\(lq;\(rq). +.TP 3n +\(bu +\fB\-\-disable\-named\-commands\fR +.sp +Disable named commands. Use the +\\* +form only, or use named commands only at the beginning of a line ending with a semicolon (\(lq;\(rq). +\fBmysql\fR +starts with this option +\fIenabled\fR +by default. However, even with this option, long\-format commands still work from the first line. See +the section called \(lq\fBMYSQL\fR COMMANDS\(rq. +.TP 3n +\(bu +\fB\-\-execute=\fR\fB\fIstatement\fR\fR, +\fB\-e \fR\fB\fIstatement\fR\fR +.sp +Execute the statement and quit. The default output format is like that produced with +\fB\-\-batch\fR. See +Section\ 4.2.3.1, \(lqUsing Options on the Command Line\(rq, for some examples. +.TP 3n +\(bu +\fB\-\-force\fR, +\fB\-f\fR +.sp +Continue even if an SQL error occurs. +.TP 3n +\(bu +\fB\-\-host=\fR\fB\fIhost_name\fR\fR, +\fB\-h \fR\fB\fIhost_name\fR\fR +.sp +Connect to the MySQL server on the given host. +.TP 3n +\(bu +\fB\-\-html\fR, +\fB\-H\fR +.sp +Produce HTML output. +.TP 3n +\(bu +\fB\-\-ignore\-spaces\fR, +\fB\-i\fR +.sp +Ignore spaces after function names. The effect of this is described in the discussion for the +IGNORE_SPACE +SQL mode (see +Section\ 5.1.7, \(lqServer SQL Modes\(rq). +.TP 3n +\(bu +\fB\-\-line\-numbers\fR +.sp +Write line numbers for errors. Disable this with +\fB\-\-skip\-line\-numbers\fR. +.TP 3n +\(bu +\fB\-\-local\-infile[={0|1}]\fR +.sp +Enable or disable +LOCAL +capability for +LOAD DATA INFILE. With no value, the option enables +LOCAL. The option may be given as +\fB\-\-local\-infile=0\fR +or +\fB\-\-local\-infile=1\fR +to explicitly disable or enable +LOCAL. Enabling +LOCAL +has no effect if the server does not also support it. +.TP 3n +\(bu +\fB\-\-named\-commands\fR, +\fB\-G\fR +.sp +Enable named +\fBmysql\fR +commands. Long\-format commands are allowed, not just short\-format commands. For example, +quit +and +\\q +both are recognized. Use +\fB\-\-skip\-named\-commands\fR +to disable named commands. See +the section called \(lq\fBMYSQL\fR COMMANDS\(rq. +.TP 3n +\(bu +\fB\-\-no\-auto\-rehash\fR, +\fB\-A\fR +.sp +Deprecated form of +\fB\-skip\-auto\-rehash\fR. Use +\fB\-\-disable\-auto\-rehash\fR +instead. See the description for +\fB\-\-auto\-rehash\fR. +.TP 3n +\(bu +\fB\-\-no\-beep\fR, +\fB\-b\fR +.sp +Do not beep when errors occur. +.TP 3n +\(bu +\fB\-\-no\-named\-commands\fR, +\fB\-g\fR +.sp +Deprecated, use +\fB\-\-disable\-named\-commands\fR +instead. +.TP 3n +\(bu +\fB\-\-no\-pager\fR +.sp +Deprecated form of +\fB\-\-skip\-pager\fR. See the +\fB\-\-pager\fR +option. +.TP 3n +\(bu +\fB\-\-no\-tee\fR +.sp +Do not copy output to a file. +the section called \(lq\fBMYSQL\fR COMMANDS\(rq, discusses tee files further. +.TP 3n +\(bu +\fB\-\-one\-database\fR, +\fB\-o\fR +.sp +Ignore statements except those for the default database named on the command line. This is useful for skipping updates to other databases in the binary log. +.TP 3n +\(bu +\fB\-\-pager[=\fR\fB\fIcommand\fR\fR\fB]\fR +.sp +Use the given command for paging query output. If the command is omitted, the default pager is the value of your +PAGER +environment variable. Valid pagers are +\fBless\fR, +\fBmore\fR, +\fBcat [> filename]\fR, and so forth. This option works only on Unix. It does not work in batch mode. To disable paging, use +\fB\-\-skip\-pager\fR. +the section called \(lq\fBMYSQL\fR COMMANDS\(rq, discusses output paging further. +.TP 3n +\(bu +\fB\-\-password[=\fR\fB\fIpassword\fR\fR\fB]\fR, +\fB\-p[\fR\fB\fIpassword\fR\fR\fB]\fR +.sp +The password to use when connecting to the server. If you use the short option form (\fB\-p\fR), you +\fIcannot\fR +have a space between the option and the password. If you omit the +\fIpassword\fR +value following the +\fB\-\-password\fR +or +\fB\-p\fR +option on the command line, you are prompted for one. +.sp +Specifying a password on the command line should be considered insecure. See +Section\ 5.5.6.2, \(lqEnd\-User Guidelines for Password Security\(rq. +.TP 3n +\(bu +\fB\-\-pipe\fR, +\fB\-W\fR +.sp +On Windows, connect to the server via a named pipe. This option applies only for connections to a local server, and only if the server supports named\-pipe connections. +.TP 3n +\(bu +\fB\-\-port=\fR\fB\fIport_num\fR\fR, +\fB\-P \fR\fB\fIport_num\fR\fR +.sp +The TCP/IP port number to use for the connection. +.TP 3n +\(bu +\fB\-\-prompt=\fR\fB\fIformat_str\fR\fR +.sp +Set the prompt to the specified format. The default is +mysql>. The special sequences that the prompt can contain are described in +the section called \(lq\fBMYSQL\fR COMMANDS\(rq. +.TP 3n +\(bu +\fB\-\-protocol={TCP|SOCKET|PIPE|MEMORY}\fR +.sp +The connection protocol to use for connecting to the server. It is useful when the other connection parameters normally would cause a protocol to be used other than the one you want. For details on the allowable values, see +Section\ 4.2.2, \(lqConnecting to the MySQL Server\(rq. +.TP 3n +\(bu +\fB\-\-quick\fR, +\fB\-q\fR +.sp +Do not cache each query result, print each row as it is received. This may slow down the server if the output is suspended. With this option, +\fBmysql\fR +does not use the history file. +.TP 3n +\(bu +\fB\-\-raw\fR, +\fB\-r\fR +.sp +For tabular output, the +\(lqboxing\(rq +around columns enables one column value to be distinguished from another. For non\-tabular output (such as is produced in batch mode or when the +\fB\-\-batch\fR +or +\fB\-\-silent\fR +option is given), special characters are escaped in the output so they can be identified easily. Newline, tab, +NUL, and backslash are written as +\\n, +\\t, +\\0, and +\\\\. The +\fB\-\-raw\fR +option disables this character escaping. +.sp +The following example demonstrates tabular versus non\-tabular output and the use of raw mode to disable escaping: +.sp +.RS 3n +.nf +% \fBmysql\fR +mysql> SELECT CHAR(92); ++\-\-\-\-\-\-\-\-\-\-+ +| CHAR(92) | ++\-\-\-\-\-\-\-\-\-\-+ +| \\ | ++\-\-\-\-\-\-\-\-\-\-+ +% \fBmysql \-s\fR +mysql> SELECT CHAR(92); +CHAR(92) +\\\\ +% \fBmysql \-s \-r\fR +mysql> SELECT CHAR(92); +CHAR(92) +\\ +.fi +.RE +.TP 3n +\(bu +\fB\-\-reconnect\fR +.sp +If the connection to the server is lost, automatically try to reconnect. A single reconnect attempt is made each time the connection is lost. To suppress reconnection behavior, use +\fB\-\-skip\-reconnect\fR. +.TP 3n +\(bu +\fB\-\-safe\-updates\fR, +\fB\-\-i\-am\-a\-dummy\fR, +\fB\-U\fR +.sp +Allow only those +UPDATE +and +DELETE +statements that specify which rows to modify by using key values. If you have set this option in an option file, you can override it by using +\fB\-\-safe\-updates\fR +on the command line. See +the section called \(lq\fBMYSQL\fR TIPS\(rq, for more information about this option. +.TP 3n +\(bu +\fB\-\-secure\-auth\fR +.sp +Do not send passwords to the server in old (pre\-4.1.1) format. This prevents connections except for servers that use the newer password format. +.TP 3n +\(bu +\fB\-\-show\-warnings\fR +.sp +Cause warnings to be shown after each statement if there are any. This option applies to interactive and batch mode. +.TP 3n +\(bu +\fB\-\-sigint\-ignore\fR +.sp +Ignore +SIGINT +signals (typically the result of typing Control\-C). +.TP 3n +\(bu +\fB\-\-silent\fR, +\fB\-s\fR +.sp +Silent mode. Produce less output. This option can be given multiple times to produce less and less output. +.sp +This option results in non\-tabular output format and escaping of special characters. Escaping may be disabled by using raw mode; see the description for the +\fB\-\-raw\fR +option. +.TP 3n +\(bu +\fB\-\-skip\-column\-names\fR, +\fB\-N\fR +.sp +Do not write column names in results. The short format, +\fB\-N\fR +is deprecated, use the long format instead. +.TP 3n +\(bu +\fB\-\-skip\-line\-numbers\fR, +\fB\-L\fR +.sp +Do not write line numbers for errors. Useful when you want to compare result files that include error messages. The short format, +\fB\-L\fR +is deprecated, use the long format instead. +.TP 3n +\(bu +\fB\-\-socket=\fR\fB\fIpath\fR\fR, +\fB\-S \fR\fB\fIpath\fR\fR +.sp +For connections to +localhost, the Unix socket file to use, or, on Windows, the name of the named pipe to use. +.TP 3n +\(bu +\fB\-\-ssl*\fR +.sp +Options that begin with +\fB\-\-ssl\fR +specify whether to connect to the server via SSL and indicate where to find SSL keys and certificates. See +Section\ 5.5.7.3, \(lqSSL Command Options\(rq. +.TP 3n +\(bu +\fB\-\-table\fR, +\fB\-t\fR +.sp +Display output in table format. This is the default for interactive use, but can be used to produce table output in batch mode. +.TP 3n +\(bu +\fB\-\-tee=\fR\fB\fIfile_name\fR\fR +.sp +Append a copy of output to the given file. This option does not work in batch mode. +the section called \(lq\fBMYSQL\fR COMMANDS\(rq, discusses tee files further. +.TP 3n +\(bu +\fB\-\-unbuffered\fR, +\fB\-n\fR +.sp +Flush the buffer after each query. +.TP 3n +\(bu +\fB\-\-user=\fR\fB\fIuser_name\fR\fR, +\fB\-u \fR\fB\fIuser_name\fR\fR +.sp +The MySQL user name to use when connecting to the server. +.TP 3n +\(bu +\fB\-\-verbose\fR, +\fB\-v\fR +.sp +Verbose mode. Produce more output about what the program does. This option can be given multiple times to produce more and more output. (For example, +\fB\-v \-v \-v\fR +produces table output format even in batch mode.) +.TP 3n +\(bu +\fB\-\-version\fR, +\fB\-V\fR +.sp +Display version information and exit. +.TP 3n +\(bu +\fB\-\-vertical\fR, +\fB\-E\fR +.sp +Print query output rows vertically (one line per column value). Without this option, you can specify vertical output for individual statements by terminating them with +\\G. +.TP 3n +\(bu +\fB\-\-wait\fR, +\fB\-w\fR +.sp +If the connection cannot be established, wait and retry instead of aborting. +.TP 3n +\(bu +\fB\-\-xml\fR, +\fB\-X\fR +.sp +Produce XML output. +.sp +.it 1 an-trap +.nr an-no-space-flag 1 +.nr an-break-flag 1 +.br +\fBNote\fR +Prior to MySQL 5.1.12, there was no differentiation in the output when using this option between columns containing the +NULL +value and columns containing the string literal +\'NULL'; both were represented as +.sp +.RS 3n +.nf +<field name="\fIcolumn_name\fR">NULL</field> +.fi +.RE +Beginning with MySQL 5.1.12, the output when +\fB\-\-xml\fR +is used with +\fBmysql\fR +matches that of +\fBmysqldump \fR\fB\fB\-\-xml\fR\fR. See +\fBmysqldump\fR(1) +for details. +.sp +Beginning with MySQL 5.1.18, the XML output also uses an XML namespace, as shown here: +.sp +.RS 3n +.nf +shell> \fBmysql \-\-xml \-uroot \-e "SHOW VARIABLES LIKE 'version%'"\fR +<?xml version="1.0"?> +<resultset statement="SHOW VARIABLES LIKE 'version%'" xmlns:xsi="http://www.w3.org/2001/XMLSchema\-instance"> +<row> +<field name="Variable_name">version</field> +<field name="Value">5.0.40\-debug</field> +</row> +<row> +<field name="Variable_name">version_comment</field> +<field name="Value">Source distribution</field> +</row> +<row> +<field name="Variable_name">version_compile_machine</field> +<field name="Value">i686</field> +</row> +<row> +<field name="Variable_name">version_compile_os</field> +<field name="Value">suse\-linux\-gnu</field> +</row> +</resultset> +.fi +.RE +.sp +(See +[1]\&\fIBug#25946\fR.) +.sp +.RE +.PP +You can also set the following variables by using +\fB\-\-\fR\fB\fIvar_name\fR\fR\fB=\fR\fB\fIvalue\fR\fR. The +\fB\-\-set\-variable\fR +format is deprecated. +.TP 3n +\(bu +connect_timeout +.sp +The number of seconds before connection timeout. (Default value is +0.) +.TP 3n +\(bu +max_allowed_packet +.sp +The maximum packet length to send to or receive from the server. (Default value is 16MB.) +.TP 3n +\(bu +max_join_size +.sp +The automatic limit for rows in a join when using +\fB\-\-safe\-updates\fR. (Default value is 1,000,000.) +.TP 3n +\(bu +net_buffer_length +.sp +The buffer size for TCP/IP and socket communication. (Default value is 16KB.) +.TP 3n +\(bu +select_limit +.sp +The automatic limit for +SELECT +statements when using +\fB\-\-safe\-updates\fR. (Default value is 1,000.) +.sp +.RE +.PP +On Unix, the +\fBmysql\fR +client writes a record of executed statements to a history file. By default, this file is named +\fI.mysql_history\fR +and is created in your home directory. To specify a different file, set the value of the +MYSQL_HISTFILE +environment variable. +.PP +The +\fI.mysql_history\fR +should be protected with a restrictive access mode because sensitive information might be written to it, such as the text of SQL statements that contain passwords. See +Section\ 5.5.6.2, \(lqEnd\-User Guidelines for Password Security\(rq. +.PP +If you do not want to maintain a history file, first remove +\fI.mysql_history\fR +if it exists, and then use either of the following techniques: +.TP 3n +\(bu +Set the +MYSQL_HISTFILE +variable to +\fI/dev/null\fR. To cause this setting to take effect each time you log in, put the setting in one of your shell's startup files. +.TP 3n +\(bu +Create +\fI.mysql_history\fR +as a symbolic link to +\fI/dev/null\fR: +.sp +.RS 3n +.nf +shell> \fBln \-s /dev/null $HOME/.mysql_history\fR +.fi +.RE +You need do this only once. +.SH "\fBMYSQL\fR COMMANDS" +.PP +\fBmysql\fR +sends each SQL statement that you issue to the server to be executed. There is also a set of commands that +\fBmysql\fR +itself interprets. For a list of these commands, type +help +or +\\h +at the +mysql> +prompt: +.sp +.RS 3n +.nf +mysql> \fBhelp\fR +List of all MySQL commands: +Note that all text commands must be first on line and end with ';' +? (\\?) Synonym for `help'. +clear (\\c) Clear command. +connect (\\r) Reconnect to the server. Optional arguments are db and host. +delimiter (\\d) Set statement delimiter. +edit (\\e) Edit command with $EDITOR. +ego (\\G) Send command to mysql server, display result vertically. +exit (\\q) Exit mysql. Same as quit. +go (\\g) Send command to mysql server. +help (\\h) Display this help. +nopager (\\n) Disable pager, print to stdout. +notee (\\t) Don't write into outfile. +pager (\\P) Set PAGER [to_pager]. Print the query results via PAGER. +print (\\p) Print current command. +prompt (\\R) Change your mysql prompt. +quit (\\q) Quit mysql. +rehash (\\#) Rebuild completion hash. +source (\\.) Execute an SQL script file. Takes a file name as an argument. +status (\\s) Get status information from the server. +system (\\!) Execute a system shell command. +tee (\\T) Set outfile [to_outfile]. Append everything into given + outfile. +use (\\u) Use another database. Takes database name as argument. +charset (\\C) Switch to another charset. Might be needed for processing + binlog with multi\-byte charsets. +warnings (\\W) Show warnings after every statement. +nowarning (\\w) Don't show warnings after every statement. +For server side help, type 'help contents' +.fi +.RE +.PP +Each command has both a long and short form. The long form is not case sensitive; the short form is. The long form can be followed by an optional semicolon terminator, but the short form should not. +.PP +The use of short\-form commands within multi\-line +/* ... */ +comments is not supported. +.TP 3n +\(bu +\fBhelp [\fR\fB\fIarg\fR\fR\fB]\fR, +\fB\\h [\fR\fB\fIarg\fR\fR\fB]\fR, +\fB\\? [\fR\fB\fIarg\fR\fR\fB]\fR, +\fB? [\fR\fB\fIarg\fR\fR\fB]\fR +.sp +Displays a help message listing the available +\fBmysql\fR +commands. +.sp +If you provide an argument to the +help +command, +\fBmysql\fR +uses it as a search string to access server\-side help from the contents of the MySQL Reference Manual. For more information, see +the section called \(lq\fBMYSQL\fR SERVER\-SIDE HELP\(rq. +.TP 3n +\(bu +\fBcharset \fR\fB\fIcharset_name\fR\fR, +\fB\\C \fR\fB\fIcharset_name\fR\fR +.sp +The +charset +command changes the default character set and issues a +SET NAMES +statement. This enables the character set to remain synchronized on the client and server if +\fBmysql\fR +is run with auto\-reconnect enabled (which is not recommended), because the specified character set is used for reconnects. This command was added in MySQL 5.1.7. +.TP 3n +\(bu +\fBclear\fR, +\fB\\c\fR +.sp +Clears the current input. Use this if you change your mind about executing the statement that you are entering. +.TP 3n +\(bu +\fBconnect [\fR\fB\fIdb_name\fR\fR\fB \fR\fB\fIhost_name\fR\fR\fB]]\fR, +\fB\\r [\fR\fB\fIdb_name\fR\fR\fB \fR\fB\fIhost_name\fR\fR\fB]]\fR +.sp +Reconnects to the server. The optional database name and host name arguments may be given to specify the default database or the host where the server is running. If omitted, the current values are used. +.TP 3n +\(bu +\fBdelimiter \fR\fB\fIstr\fR\fR, +\fB\\d \fR\fB\fIstr\fR\fR +.sp +The +delimiter +command changes the string that +\fBmysql\fR +interprets as the separator between SQL statements. The default is the semicolon character (\(lq;\(rq). +.sp +The delimiter can be specified as an unquoted or quoted argument. Quoting can be done with either single quote (') or douple quote (") characters. To include a quote within a quoted string, either quote the string with the other quote character or escape the quote with a backslash (\(lq\\\(rq) character. Backslash should be avoided outside of quoted strings because it is the escape character for MySQL. For an unquoted argument, the delmiter is read up to the first space or end of line. For a quoted argument, the delimiter is read up to the matching quote on the line. +.sp +When the delimiter recognized by +\fBmysql\fR +is set to something other than the default of +\(lq;\(rq, instances of that character are sent to the server without interpretation. However, the server itself still interprets +\(lq;\(rq +as a statement delimiter and processes statements accordingly. This behavior on the server side comes into play for multiple\-statement execution (see +Section\ 21.10.12, \(lqC API Support for Multiple Statement Execution\(rq), and for parsing the body of stored procedures and functions, triggers, and events (see +Section\ 19.1, \(lqDefining Stored Programs\(rq). +.TP 3n +\(bu +\fBedit\fR, +\fB\\e\fR +.sp +Edits the current input statement. +\fBmysql\fR +checks the values of the +EDITOR +and +VISUAL +environment variables to determine which editor to use. The default editor is +\fBvi\fR +if neither variable is set. +.sp +The +\fBedit\fR +command works only in Unix. +.TP 3n +\(bu +\fBego\fR, +\fB\\G\fR +.sp +Sends the current statement to the server to be executed and displays the result using vertical format. +.TP 3n +\(bu +\fBexit\fR, +\fB\\q\fR +.sp +Exits +\fBmysql\fR. +.TP 3n +\(bu +\fBgo\fR, +\fB\\g\fR +.sp +Sends the current statement to the server to be executed. +.TP 3n +\(bu +\fBnopager\fR, +\fB\\n\fR +.sp +Disables output paging. See the description for +\fBpager\fR. +.sp +The +\fBnopager\fR +command works only in Unix. +.TP 3n +\(bu +\fBnotee\fR, +\fB\\t\fR +.sp +Disables output copying to the tee file. See the description for +\fBtee\fR. +.TP 3n +\(bu +\fBnowarning\fR, +\fB\\w\fR +.sp +Enables display of warnings after each statement. +.TP 3n +\(bu +\fBpager [\fR\fB\fIcommand\fR\fR\fB]\fR, +\fB\\P [\fR\fB\fIcommand\fR\fR\fB]\fR +.sp +By using the +\fB\-\-pager\fR +option when you invoke +\fBmysql\fR, it is possible to browse or search query results in interactive mode with Unix programs such as +\fBless\fR, +\fBmore\fR, or any other similar program. If you specify no value for the option, +\fBmysql\fR +checks the value of the +PAGER +environment variable and sets the pager to that. +.sp +Output paging can be enabled interactively with the +\fBpager\fR +command and disabled with +\fBnopager\fR. The command takes an optional argument; if given, the paging program is set to that. With no argument, the pager is set to the pager that was set on the command line, or +stdout +if no pager was specified. +.sp +Output paging works only in Unix because it uses the +popen() +function, which does not exist on Windows. For Windows, the +\fBtee\fR +option can be used instead to save query output, although it is not as convenient as +\fBpager\fR +for browsing output in some situations. +.TP 3n +\(bu +\fBprint\fR, +\fB\\p\fR +.sp +Prints the current input statement without executing it. +.TP 3n +\(bu +\fBprompt [\fR\fB\fIstr\fR\fR\fB]\fR, +\fB\\R [\fR\fB\fIstr\fR\fR\fB]\fR +.sp +Reconfigures the +\fBmysql\fR +prompt to the given string. The special character sequences that can be used in the prompt are described later in this section. +.sp +If you specify the +prompt +command with no argument, +\fBmysql\fR +resets the prompt to the default of +mysql>. +.TP 3n +\(bu +\fBquit\fR, +\fB\\q\fR +.sp +Exits +\fBmysql\fR. +.TP 3n +\(bu +\fBrehash\fR, +\fB\\#\fR +.sp +Rebuilds the completion hash that enables database, table, and column name completion while you are entering statements. (See the description for the +\fB\-\-auto\-rehash\fR +option.) +.TP 3n +\(bu +\fBsource \fR\fB\fIfile_name\fR\fR, +\fB\\. \fR\fB\fIfile_name\fR\fR +.sp +Reads the named file and executes the statements contained therein. On Windows, you can specify path name separators as +/ +or +\\\\. +.TP 3n +\(bu +\fBstatus\fR, +\fB\\s\fR +.sp +The +status +command provides some information about the connection and the server you are using. If you are running in +\fB\-\-safe\-updates\fR +mode, +status +also prints the values for the +\fBmysql\fR +variables that affect your queries. +.TP 3n +\(bu +\fBsystem \fR\fB\fIcommand\fR\fR, +\fB\\! \fR\fB\fIcommand\fR\fR +.sp +Executes the given command using your default command interpreter. +.sp +The +\fBsystem\fR +command works only in Unix. +.TP 3n +\(bu +\fBtee [\fR\fB\fIfile_name\fR\fR\fB]\fR, +\fB\\T [\fR\fB\fIfile_name\fR\fR\fB]\fR +.sp +By using the +\fB\-\-tee\fR +option when you invoke +\fBmysql\fR, you can log statements and their output. All the data displayed on the screen is appended into a given file. This can be very useful for debugging purposes also. +\fBmysql\fR +flushes results to the file after each statement, just before it prints its next prompt. +.sp +You can enable this feature interactively with the +\fBtee\fR +command. Without a parameter, the previous file is used. The +\fBtee\fR +file can be disabled with the +\fBnotee\fR +command. Executing +\fBtee\fR +again re\-enables logging. +.TP 3n +\(bu +\fBuse \fR\fB\fIdb_name\fR\fR, +\fB\\u \fR\fB\fIdb_name\fR\fR +.sp +Uses +\fIdb_name\fR +as the default database. +.TP 3n +\(bu +\fBwarnings\fR, +\fB\\W\fR +.sp +Enables display of warnings after each statement (if there are any). +.sp +.RE +.PP +Here are a few tips about the +\fBpager\fR +command: +.TP 3n +\(bu +You can use it to write to a file and the results go only to the file: +.sp +.RS 3n +.nf +mysql> \fBpager cat > /tmp/log.txt\fR +.fi +.RE +You can also pass any options for the program that you want to use as your pager: +.sp +.RS 3n +.nf +mysql> \fBpager less \-n \-i \-S\fR +.fi +.RE +.TP 3n +\(bu +In the preceding example, note the +\fB\-S\fR +option. You may find it very useful for browsing wide query results. Sometimes a very wide result set is difficult to read on the screen. The +\fB\-S\fR +option to +\fBless\fR +can make the result set much more readable because you can scroll it horizontally using the left\-arrow and right\-arrow keys. You can also use +\fB\-S\fR +interactively within +\fBless\fR +to switch the horizontal\-browse mode on and off. For more information, read the +\fBless\fR +manual page: +.sp +.RS 3n +.nf +shell> \fBman less\fR +.fi +.RE +.TP 3n +\(bu +The +\fB\-F\fR +and +\fB\-X\fR +options may be used with +\fBless\fR +to cause it to exit if output fits on one screen, which is convenient when no scrolling is necessary: +.sp +.RS 3n +.nf +mysql> \fBpager less \-n \-i \-S \-F \-X\fR +.fi +.RE +.TP 3n +\(bu +You can specify very complex pager commands for handling query output: +.sp +.RS 3n +.nf +mysql> \fBpager cat | tee /dr1/tmp/res.txt \\\fR + \fB| tee /dr2/tmp/res2.txt | less \-n \-i \-S\fR +.fi +.RE +In this example, the command would send query results to two files in two different directories on two different file systems mounted on +\fI/dr1\fR +and +\fI/dr2\fR, yet still display the results onscreen via +\fBless\fR. +.sp +.RE +.PP +You can also combine the +\fBtee\fR +and +\fBpager\fR +functions. Have a +\fBtee\fR +file enabled and +\fBpager\fR +set to +\fBless\fR, and you are able to browse the results using the +\fBless\fR +program and still have everything appended into a file the same time. The difference between the Unix +\fBtee\fR +used with the +\fBpager\fR +command and the +\fBmysql\fR +built\-in +\fBtee\fR +command is that the built\-in +\fBtee\fR +works even if you do not have the Unix +\fBtee\fR +available. The built\-in +\fBtee\fR +also logs everything that is printed on the screen, whereas the Unix +\fBtee\fR +used with +\fBpager\fR +does not log quite that much. Additionally, +\fBtee\fR +file logging can be turned on and off interactively from within +\fBmysql\fR. This is useful when you want to log some queries to a file, but not others. +.PP +The +\fBprompt\fR +command reconfigures the default +mysql> +prompt. The string for defining the prompt can contain the following special sequences. +.TS +allbox tab(:); +l l +l l +l l +l l +l l +l l +l l +l l +l l +l l +l l +l l +l l +l l +l l +l l +l l +l l +l l +l l +l l +l l +l l +l l +l l +l l +l l +l l +l l. +T{ +\fBOption\fR +T}:T{ +\fBDescription\fR +T} +T{ +\\o +T}:T{ +The current month in numeric format +T} +T{ +\\P +T}:T{ +am/pm +T} +T{ +\\p +T}:T{ +The current TCP/IP port or socket file +T} +T{ +\\R +T}:T{ +The current time, in 24\-hour military time (0\-23) +T} +T{ +\\r +T}:T{ +The current time, standard 12\-hour time (1\-12) +T} +T{ +\\S +T}:T{ +Semicolon +T} +T{ +\\s +T}:T{ +Seconds of the current time +T} +T{ +\\t +T}:T{ +A tab character +T} +T{ +\\U +T}:T{ +Your full + \fIuser_name\fR@\fIhost_name\fR + account name +T} +T{ +\\u +T}:T{ +Your user name +T} +T{ +\\c +T}:T{ +A counter that increments for each statement you issue +T} +T{ +\\v +T}:T{ +The server version +T} +T{ +\\w +T}:T{ +The current day of the week in three\-letter format (Mon, Tue, \&...) +T} +T{ +\\Y +T}:T{ +The current year, four digits +T} +T{ +\\y +T}:T{ +The current year, two digits +T} +T{ +\\_ +T}:T{ +A space +T} +T{ +\\\ +T}:T{ +A space (a space follows the backslash) +T} +T{ +\\' +T}:T{ +Single quote +T} +T{ +\\" +T}:T{ +Double quote +T} +T{ +\\\\ +T}:T{ +A literal \(lq\\\(rq backslash character +T} +T{ +\\\fIx\fR +T}:T{ +\fIx\fR, for any + \(lq\fIx\fR\(rq not listed + above +T} +T{ +\\D +T}:T{ +The full current date +T} +T{ +\\d +T}:T{ +The default database +T} +T{ +\\h +T}:T{ +The server host +T} +T{ +\\l +T}:T{ +The current delimiter (new in 5.1.12) +T} +T{ +\\m +T}:T{ +Minutes of the current time +T} +T{ +\\n +T}:T{ +A newline character +T} +T{ +\\O +T}:T{ +The current month in three\-letter format (Jan, Feb, \&...) +T} +.TE +.sp +.PP +You can set the prompt in several ways: +.TP 3n +\(bu +\fIUse an environment variable.\fR +You can set the +MYSQL_PS1 +environment variable to a prompt string. For example: +.sp +.RS 3n +.nf +shell> \fBexport MYSQL_PS1="(\\u@\\h) [\\d]> "\fR +.fi +.RE +.TP 3n +\(bu +\fIUse a command\-line option.\fR +You can set the +\fB\-\-prompt\fR +option on the command line to +\fBmysql\fR. For example: +.sp +.RS 3n +.nf +shell> \fBmysql \-\-prompt="(\\u@\\h) [\\d]> "\fR +(user@host) [database]> +.fi +.RE +.TP 3n +\(bu +\fIUse an option file.\fR +You can set the +prompt +option in the +[mysql] +group of any MySQL option file, such as +\fI/etc/my.cnf\fR +or the +\fI.my.cnf\fR +file in your home directory. For example: +.sp +.RS 3n +.nf +[mysql] +prompt=(\\\\u@\\\\h) [\\\\d]>\\\\_ +.fi +.RE +In this example, note that the backslashes are doubled. If you set the prompt using the +prompt +option in an option file, it is advisable to double the backslashes when using the special prompt options. There is some overlap in the set of allowable prompt options and the set of special escape sequences that are recognized in option files. (These sequences are listed in +Section\ 4.2.3.2, \(lqUsing Option Files\(rq.) The overlap may cause you problems if you use single backslashes. For example, +\\s +is interpreted as a space rather than as the current seconds value. The following example shows how to define a prompt within an option file to include the current time in +HH:MM:SS> +format: +.sp +.RS 3n +.nf +[mysql] +prompt="\\\\r:\\\\m:\\\\s> " +.fi +.RE +.TP 3n +\(bu +\fISet the prompt interactively.\fR +You can change your prompt interactively by using the +prompt +(or +\\R) command. For example: +.sp +.RS 3n +.nf +mysql> \fBprompt (\\u@\\h) [\\d]>\\_\fR +PROMPT set to '(\\u@\\h) [\\d]>\\_' +(\fIuser\fR@\fIhost\fR) [\fIdatabase\fR]> +(\fIuser\fR@\fIhost\fR) [\fIdatabase\fR]> prompt +Returning to default PROMPT of mysql> +mysql> +.fi +.RE +.SH "\fBMYSQL\fR SERVER\-SIDE HELP" +.sp +.RS 3n +.nf +mysql> \fBhelp \fR\fB\fIsearch_string\fR\fR +.fi +.RE +.PP +If you provide an argument to the +help +command, +\fBmysql\fR +uses it as a search string to access server\-side help from the contents of the MySQL Reference Manual. The proper operation of this command requires that the help tables in the +mysql +database be initialized with help topic information (see +Section\ 5.1.8, \(lqServer\-Side Help\(rq). +.PP +If there is no match for the search string, the search fails: +.sp +.RS 3n +.nf +mysql> \fBhelp me\fR +Nothing found +Please try to run 'help contents' for a list of all accessible topics +.fi +.RE +.PP +Use +\fBhelp contents\fR +to see a list of the help categories: +.sp +.RS 3n +.nf +mysql> \fBhelp contents\fR +You asked for help about help category: "Contents" +For more information, type 'help <item>', where <item> is one of the +following categories: + Account Management + Administration + Data Definition + Data Manipulation + Data Types + Functions + Functions and Modifiers for Use with GROUP BY + Geographic Features + Language Structure + Plugins + Storage Engines + Stored Routines + Table Maintenance + Transactions + Triggers +.fi +.RE +.PP +If the search string matches multiple items, +\fBmysql\fR +shows a list of matching topics: +.sp +.RS 3n +.nf +mysql> \fBhelp logs\fR +Many help items for your request exist. +To make a more specific request, please type 'help <item>', +where <item> is one of the following topics: + SHOW + SHOW BINARY LOGS + SHOW ENGINE + SHOW LOGS +.fi +.RE +.PP +Use a topic as the search string to see the help entry for that topic: +.sp +.RS 3n +.nf +mysql> \fBhelp show binary logs\fR +Name: 'SHOW BINARY LOGS' +Description: +Syntax: +SHOW BINARY LOGS +SHOW MASTER LOGS +Lists the binary log files on the server. This statement is used as +part of the procedure described in [purge\-binary\-logs], that shows how +to determine which logs can be purged. +mysql> SHOW BINARY LOGS; ++\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-\-\-+ +| Log_name | File_size | ++\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-\-\-+ +| binlog.000015 | 724935 | +| binlog.000016 | 733481 | ++\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-\-\-+ +.fi +.RE +.SH "EXECUTING SQL STATEMENTS FROM A TEXT FILE" +.PP +The +\fBmysql\fR +client typically is used interactively, like this: +.sp +.RS 3n +.nf +shell> \fBmysql \fR\fB\fIdb_name\fR\fR +.fi +.RE +.PP +However, it is also possible to put your SQL statements in a file and then tell +\fBmysql\fR +to read its input from that file. To do so, create a text file +\fItext_file\fR +that contains the statements you wish to execute. Then invoke +\fBmysql\fR +as shown here: +.sp +.RS 3n +.nf +shell> \fBmysql \fR\fB\fIdb_name\fR\fR\fB < \fR\fB\fItext_file\fR\fR +.fi +.RE +.PP +If you place a +USE \fIdb_name\fR +statement as the first statement in the file, it is unnecessary to specify the database name on the command line: +.sp +.RS 3n +.nf +shell> \fBmysql < text_file\fR +.fi +.RE +.PP +If you are already running +\fBmysql\fR, you can execute an SQL script file using the +source +command or +\\. +command: +.sp +.RS 3n +.nf +mysql> \fBsource \fR\fB\fIfile_name\fR\fR +mysql> \fB\\. \fR\fB\fIfile_name\fR\fR +.fi +.RE +.PP +Sometimes you may want your script to display progress information to the user. For this you can insert statements like this: +.sp +.RS 3n +.nf +SELECT '<info_to_display>' AS ' '; +.fi +.RE +.PP +The statement shown outputs +<info_to_display>. +.PP +As of MySQL 5.1.23, +\fBmysql\fR +ignores Unicode byte order mark (BOM) characters at the beginning of input files. Previously, it read them and sent them to the server, resulting in a syntax error. Presence of a BOM does not cause +\fBmysql\fR +to change its default character set. To do that, invoke +\fBmysql\fR +with an option such as +\fB\-\-default\-character\-set=utf8\fR. +.PP +For more information about batch mode, see +Section\ 3.5, \(lqUsing \fBmysql\fR in Batch Mode\(rq. +.SH "\fBMYSQL\fR TIPS" +.PP +This section describes some techniques that can help you use +\fBmysql\fR +more effectively. +.SS "Displaying Query Results Vertically" +.PP +Some query results are much more readable when displayed vertically, instead of in the usual horizontal table format. Queries can be displayed vertically by terminating the query with \\G instead of a semicolon. For example, longer text values that include newlines often are much easier to read with vertical output: +.sp +.RS 3n +.nf +mysql> \fBSELECT * FROM mails WHERE LENGTH(txt) < 300 LIMIT 300,1\\G\fR +*************************** 1. row *************************** + msg_nro: 3068 + date: 2000\-03\-01 23:29:50 +time_zone: +0200 +mail_from: Monty + reply: monty(a)no.spam.com + mail_to: "Thimble Smith" <tim(a)no.spam.com> + sbj: UTF\-8 + txt: >>>>> "Thimble" == Thimble Smith writes: +Thimble> Hi. I think this is a good idea. Is anyone familiar +Thimble> with UTF\-8 or Unicode? Otherwise, I'll put this on my +Thimble> TODO list and see what happens. +Yes, please do that. +Regards, +Monty + file: inbox\-jani\-1 + hash: 190402944 +1 row in set (0.09 sec) +.fi +.RE +.\" end of SS subsection "Displaying Query Results Vertically" +.SS "Using the \-\-safe\-updates Option" +.PP +For beginners, a useful startup option is +\fB\-\-safe\-updates\fR +(or +\fB\-\-i\-am\-a\-dummy\fR, which has the same effect). It is helpful for cases when you might have issued a +DELETE FROM \fItbl_name\fR +statement but forgotten the +WHERE +clause. Normally, such a statement deletes all rows from the table. With +\fB\-\-safe\-updates\fR, you can delete rows only by specifying the key values that identify them. This helps prevent accidents. +.PP +When you use the +\fB\-\-safe\-updates\fR +option, +\fBmysql\fR +issues the following statement when it connects to the MySQL server: +.sp +.RS 3n +.nf +SET sql_safe_updates=1, sql_select_limit=1000, sql_max_join_size=1000000; +.fi +.RE +.PP +See +Section\ 5.1.4, \(lqSession System Variables\(rq. +.PP +The +SET +statement has the following effects: +.TP 3n +\(bu +You are not allowed to execute an +UPDATE +or +DELETE +statement unless you specify a key constraint in the +WHERE +clause or provide a +LIMIT +clause (or both). For example: +.sp +.RS 3n +.nf +UPDATE \fItbl_name\fR SET \fInot_key_column\fR=\fIval\fR WHERE \fIkey_column\fR=\fIval\fR; +UPDATE \fItbl_name\fR SET \fInot_key_column\fR=\fIval\fR LIMIT 1; +.fi +.RE +.TP 3n +\(bu +The server limits all large +SELECT +results to 1,000 rows unless the statement includes a +LIMIT +clause. +.TP 3n +\(bu +The server aborts multiple\-table +SELECT +statements that probably need to examine more than 1,000,000 row combinations. +.sp +.RE +.PP +To specify limits different from 1,000 and 1,000,000, you can override the defaults by using the +\fB\-\-select_limit\fR +and +\fB\-\-max_join_size\fR +options: +.sp +.RS 3n +.nf +shell> \fBmysql \-\-safe\-updates \-\-select_limit=500 \-\-max_join_size=10000\fR +.fi +.RE +.\" end of SS subsection "Using the \-\-safe\-updates Option" +.SS "Disabling mysql Auto\-Reconnect" +.PP +If the +\fBmysql\fR +client loses its connection to the server while sending a statement, it immediately and automatically tries to reconnect once to the server and send the statement again. However, even if +\fBmysql\fR +succeeds in reconnecting, your first connection has ended and all your previous session objects and settings are lost: temporary tables, the autocommit mode, and user\-defined and session variables. Also, any current transaction rolls back. This behavior may be dangerous for you, as in the following example where the server was shut down and restarted between the first and second statements without you knowing it: +.sp +.RS 3n +.nf +mysql> \fBSET @a=1;\fR +Query OK, 0 rows affected (0.05 sec) +mysql> \fBINSERT INTO t VALUES(@a);\fR +ERROR 2006: MySQL server has gone away +No connection. Trying to reconnect... +Connection id: 1 +Current database: test +Query OK, 1 row affected (1.30 sec) +mysql> \fBSELECT * FROM t;\fR ++\-\-\-\-\-\-+ +| a | ++\-\-\-\-\-\-+ +| NULL | ++\-\-\-\-\-\-+ +1 row in set (0.05 sec) +.fi +.RE +.PP +The +@a +user variable has been lost with the connection, and after the reconnection it is undefined. If it is important to have +\fBmysql\fR +terminate with an error if the connection has been lost, you can start the +\fBmysql\fR +client with the +\fB\-\-skip\-reconnect\fR +option. +.PP +For more information about auto\-reconnect and its effect on state information when a reconnection occurs, see +Section\ 21.10.11, \(lqControlling Automatic Reconnection Behavior\(rq. +.\" end of SS subsection "Disabling mysql Auto\-Reconnect" +.SH "COPYRIGHT" +.PP +Copyright 2007\-2008 MySQL AB, 2009 Sun Microsystems, Inc. +.PP +This documentation is free software; you can redistribute it and/or modify it only under the terms of the GNU General Public License as published by the Free Software Foundation; version 2 of the License. +.PP +This documentation is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. +.PP +You should have received a copy of the GNU General Public License along with the program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110\-1301 USA or see http://www.gnu.org/licenses/. +.SH "REFERENCES" +.TP 3 +1.\ Bug#25946 +\%http://bugs.mysql.com/25946 +.SH "SEE ALSO" +For more information, please refer to the MySQL Reference Manual, +which may already be installed locally and which is also available +online at http://dev.mysql.com/doc/. +.SH AUTHOR +MySQL AB (http://www.mysql.com/). === added file 'man/mysql.server.1' --- a/man/mysql.server.1 1970-01-01 00:00:00 +0000 +++ b/man/mysql.server.1 2009-05-25 09:59:47 +0000 @@ -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/). === added file 'man/mysql_client_test.1' --- a/man/mysql_client_test.1 1970-01-01 00:00:00 +0000 +++ b/man/mysql_client_test.1 2009-05-25 09:59:47 +0000 @@ -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/). === added file 'man/mysql_client_test_embedded.1' --- a/man/mysql_client_test_embedded.1 1970-01-01 00:00:00 +0000 +++ b/man/mysql_client_test_embedded.1 2009-05-25 09:59:47 +0000 @@ -0,0 +1 @@ +.so man1/mysql_client_test.1 === added file 'man/mysql_config.1' --- a/man/mysql_config.1 1970-01-01 00:00:00 +0000 +++ b/man/mysql_config.1 2009-05-25 09:59:47 +0000 @@ -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/). === added file 'man/mysql_convert_table_format.1' --- a/man/mysql_convert_table_format.1 1970-01-01 00:00:00 +0000 +++ b/man/mysql_convert_table_format.1 2009-05-25 09:59:47 +0000 @@ -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/). === added file 'man/mysql_find_rows.1' --- a/man/mysql_find_rows.1 1970-01-01 00:00:00 +0000 +++ b/man/mysql_find_rows.1 2009-05-25 09:59:47 +0000 @@ -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/). === added file 'man/mysql_fix_extensions.1' --- a/man/mysql_fix_extensions.1 1970-01-01 00:00:00 +0000 +++ b/man/mysql_fix_extensions.1 2009-05-25 09:59:47 +0000 @@ -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/). === added file 'man/mysql_fix_privilege_tables.1' --- a/man/mysql_fix_privilege_tables.1 1970-01-01 00:00:00 +0000 +++ b/man/mysql_fix_privilege_tables.1 2009-05-25 09:59:47 +0000 @@ -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/). === added file 'man/mysql_install_db.1' --- a/man/mysql_install_db.1 1970-01-01 00:00:00 +0000 +++ b/man/mysql_install_db.1 2009-05-25 09:59:47 +0000 @@ -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/). === added file 'man/mysql_secure_installation.1' --- a/man/mysql_secure_installation.1 1970-01-01 00:00:00 +0000 +++ b/man/mysql_secure_installation.1 2009-05-25 09:59:47 +0000 @@ -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/). === added file 'man/mysql_setpermission.1' --- a/man/mysql_setpermission.1 1970-01-01 00:00:00 +0000 +++ b/man/mysql_setpermission.1 2009-05-25 09:59:47 +0000 @@ -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/). === added file 'man/mysql_tzinfo_to_sql.1' --- a/man/mysql_tzinfo_to_sql.1 1970-01-01 00:00:00 +0000 +++ b/man/mysql_tzinfo_to_sql.1 2009-05-25 09:59:47 +0000 @@ -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/). === added file 'man/mysql_upgrade.1' --- a/man/mysql_upgrade.1 1970-01-01 00:00:00 +0000 +++ b/man/mysql_upgrade.1 2009-05-25 09:59:47 +0000 @@ -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/). === added file 'man/mysql_waitpid.1' --- a/man/mysql_waitpid.1 1970-01-01 00:00:00 +0000 +++ b/man/mysql_waitpid.1 2009-05-25 09:59:47 +0000 @@ -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/). === added file 'man/mysql_zap.1' --- a/man/mysql_zap.1 1970-01-01 00:00:00 +0000 +++ b/man/mysql_zap.1 2009-05-25 09:59:47 +0000 @@ -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/). === added file 'man/mysqlaccess.1' --- a/man/mysqlaccess.1 1970-01-01 00:00:00 +0000 +++ b/man/mysqlaccess.1 2009-05-25 09:59:47 +0000 @@ -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/). === added file 'man/mysqladmin.1' --- a/man/mysqladmin.1 1970-01-01 00:00:00 +0000 +++ b/man/mysqladmin.1 2009-05-25 09:59:47 +0000 @@ -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/). === added file 'man/mysqlbinlog.1' --- a/man/mysqlbinlog.1 1970-01-01 00:00:00 +0000 +++ b/man/mysqlbinlog.1 2009-05-25 09:59:47 +0000 @@ -0,0 +1,1230 @@ +.\" Title: \fBmysqlbinlog\fR +.\" Author: +.\" Generator: DocBook XSL Stylesheets v1.70.1 <http://docbook.sf.net/> +.\" Date: 03/31/2009 +.\" Manual: MySQL Database System +.\" Source: MySQL 5.1 +.\" +.TH "\fBMYSQLBINLOG\fR" "1" "03/31/2009" "MySQL 5.1" "MySQL Database System" +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.SH "NAME" +mysqlbinlog \- utility for processing binary log files +.SH "SYNOPSIS" +.HP 35 +\fBmysqlbinlog [\fR\fBoptions\fR\fB] \fR\fB\fIlog_file\fR\fR\fB ...\fR +.SH "DESCRIPTION" +.PP +The server's binary log consists of files containing +\(lqevents\(rq +that describe modifications to database contents. The server writes these files in binary format. To display their contents in text format, use the +\fBmysqlbinlog\fR +utility. You can also use +\fBmysqlbinlog\fR +to display the contents of relay log files written by a slave server in a replication setup because relay logs have the same format as binary logs. The binary log and relay log are discussed further in +Section\ 5.2.4, \(lqThe Binary Log\(rq, and +Section\ 16.4.2, \(lqReplication Relay and Status Files\(rq. +.PP +Invoke +\fBmysqlbinlog\fR +like this: +.sp +.RS 3n +.nf +shell> \fBmysqlbinlog [\fR\fB\fIoptions\fR\fR\fB] \fR\fB\fIlog_file\fR\fR\fB ...\fR +.fi +.RE +.PP +For example, to display the contents of the binary log file named +\fIbinlog.000003\fR, use this command: +.sp +.RS 3n +.nf +shell> \fBmysqlbinlog binlog.0000003\fR +.fi +.RE +.PP +The output includes events contained in +\fIbinlog.000003\fR. Event information includes the statement, the ID of the server on which it was executed, the timestamp when the statement was executed, how much time it took, and so forth. +.PP +The output from +\fBmysqlbinlog\fR +can be re\-executed (for example, by using it as input to +\fBmysql\fR) to reapply the statements in the log. This is useful for recovery operations after a server crash. For other usage examples, see the discussion later in this section. +.PP +Normally, you use +\fBmysqlbinlog\fR +to read binary log files directly and apply them to the local MySQL server. It is also possible to read binary logs from a remote server by using the +\fB\-\-read\-from\-remote\-server\fR +option. When you read remote binary logs, the connection parameter options can be given to indicate how to connect to the server. These options are +\fB\-\-host\fR, +\fB\-\-password\fR, +\fB\-\-port\fR, +\fB\-\-protocol\fR, +\fB\-\-socket\fR, and +\fB\-\-user\fR; they are ignored except when you also use the +\fB\-\-read\-from\-remote\-server\fR +option. +.PP +\fBmysqlbinlog\fR +supports the following options: +.TP 3n +\(bu +\fB\-\-help\fR, +\fB\-?\fR +.sp +Display a help message and exit. +.TP 3n +\(bu +\fB\-\-base64\-output[=\fR\fB\fIvalue\fR\fR\fB]\fR +.sp +This option determines when events should be displayed encoded as base\-64 strings using +BINLOG +statements. The option has these allowable values (not case sensitive): +.RS 3n +.TP 3n +\(bu +AUTO +("automatic") or +UNSPEC +("unspecified") displays +BINLOG +statements automatically when necessary (that is, for format description events and row events). This is the default if no +\fB\-\-base64\-output\fR +option is given. +.sp +.it 1 an-trap +.nr an-no-space-flag 1 +.nr an-break-flag 1 +.br +\fBNote\fR +Automatic +BINLOG +display is the only safe behavior if you intend to use the output of +\fBmysqlbinlog\fR +to re\-execute binary log file contents. The other option values are intended only for debugging or testing purposes because they may produce output that does not include all events in executable form. +.TP 3n +\(bu +ALWAYS +displays +BINLOG +statements whenever possible. This is the implied value if the option is given as +\fB\-\-base64\-output\fR +without a value. +.TP 3n +\(bu +NEVER +causes +BINLOG +statements not to be displayed. +\fBmysqlbinlog\fR +exits with an error if a row event is found that must be displayed using +BINLOG. +.TP 3n +\(bu +DECODE\-ROWS +specifies to +\fBmysqlbinlog\fR +that you intend for row events to be decoded and displayed as commented SQL statements by also specifying the +\fB\-\-verbose\fR +option. Like +NEVER, +DECODE\-ROWS +suppresses display of +BINLOG +statements, but unlike +NEVER, it does not exit with an error if a row event is found. +.RE +.IP "" 3n +The +\fB\-\-base64\-output\fR +option was introduced in MySQL 5.1.5, to be given as +\fB\-\-base64\-output\fR +or +\fB\-\-skip\-base64\-output\fR +(with the sense of +AUTO +or +NEVER). The option values described in the preceding list may be used as of MySQL 5.1.24, with the exception of +UNSPEC +and +DECODE\-ROWS, which are available as of MySQL 5.1.28. +.sp +For examples that show the effect of +\fB\-\-base64\-output\fR +and +\fB\-\-verbose\fR +on row event output, see +the section called \(lq\fBMYSQLBINLOG\fR ROW EVENT DISPLAY\(rq. +.TP 3n +\(bu +\fB\-\-character\-sets\-dir=\fR\fB\fIpath\fR\fR +.sp +The directory where character sets are installed. See +Section\ 9.2, \(lqThe Character Set Used for Data and Sorting\(rq. +.TP 3n +\(bu +\fB\-\-database=\fR\fB\fIdb_name\fR\fR, +\fB\-d \fR\fB\fIdb_name\fR\fR +.sp +List entries for just this database (local log only). You can only specify one database with this option \- if you specify multiple +\fB\-\-database\fR +options, only the last one is used. This option forces +\fBmysqlbinlog\fR +to output entries from the binary log where the default database (that is, the one selected by +USE) is +\fIdb_name\fR. Note that this does not replicate cross\-database statements such as +UPDATE \fIsome_db.some_table\fR SET foo='bar' +while having selected a different database or no database. +.TP 3n +\(bu +\fB\-\-debug[=\fR\fB\fIdebug_options\fR\fR\fB]\fR, +\fB\-# [\fR\fB\fIdebug_options\fR\fR\fB]\fR +.sp +Write a debugging log. A typical +\fIdebug_options\fR +string is often +\'d:t:o,\fIfile_name\fR'. +.TP 3n +\(bu +\fB\-\-debug\-check\fR +.sp +Print some debugging information when the program exits. This option was added in MySQL 5.1.21. +.TP 3n +\(bu +\fB\-\-debug\-info\fR +.sp +Print debugging information and memory and CPU usage statistics when the program exits. This option was added in MySQL 5.1.21. +.TP 3n +\(bu +\fB\-\-disable\-log\-bin\fR, +\fB\-D\fR +.sp +Disable binary logging. This is useful for avoiding an endless loop if you use the +\fB\-\-to\-last\-log\fR +option and are sending the output to the same MySQL server. This option also is useful when restoring after a crash to avoid duplication of the statements you have logged. +.sp +This option requires that you have the +SUPER +privilege. It causes +\fBmysqlbinlog\fR +to include a +SET sql_log_bin = 0 +statement in its output to disable binary logging of the remaining output. The +SET +statement is ineffective unless you have the +SUPER +privilege. +.TP 3n +\(bu +\fB\-\-force\-read\fR, +\fB\-f\fR +.sp +With this option, if +\fBmysqlbinlog\fR +reads a binary log event that it does not recognize, it prints a warning, ignores the event, and continues. Without this option, +\fBmysqlbinlog\fR +stops if it reads such an event. +.TP 3n +\(bu +\fB\-\-hexdump\fR, +\fB\-H\fR +.sp +Display a hex dump of the log in comments, as described in +the section called \(lq\fBMYSQLBINLOG\fR HEX DUMP FORMAT\(rq. This output can be helpful for replication debugging. This option was added in MySQL 5.1.2. +.TP 3n +\(bu +\fB\-\-host=\fR\fB\fIhost_name\fR\fR, +\fB\-h \fR\fB\fIhost_name\fR\fR +.sp +Get the binary log from the MySQL server on the given host. +.TP 3n +\(bu +\fB\-\-local\-load=\fR\fB\fIpath\fR\fR, +\fB\-l \fR\fB\fIpath\fR\fR +.sp +Prepare local temporary files for +LOAD DATA INFILE +in the specified directory. +.TP 3n +\(bu +\fB\-\-offset=\fR\fB\fIN\fR\fR, +\fB\-o \fR\fB\fIN\fR\fR +.sp +Skip the first +\fIN\fR +entries in the log. +.TP 3n +\(bu +\fB\-\-password[=\fR\fB\fIpassword\fR\fR\fB]\fR, +\fB\-p[\fR\fB\fIpassword\fR\fR\fB]\fR +.sp +The password to use when connecting to the server. If you use the short option form (\fB\-p\fR), you +\fIcannot\fR +have a space between the option and the password. If you omit the +\fIpassword\fR +value following the +\fB\-\-password\fR +or +\fB\-p\fR +option on the command line, you are prompted for one. +.sp +Specifying a password on the command line should be considered insecure. See +Section\ 5.5.6.2, \(lqEnd\-User Guidelines for Password Security\(rq. +.TP 3n +\(bu +\fB\-\-port=\fR\fB\fIport_num\fR\fR, +\fB\-P \fR\fB\fIport_num\fR\fR +.sp +The TCP/IP port number to use for connecting to a remote server. +.TP 3n +\(bu +\fB\-\-position=\fR\fB\fIN\fR\fR, +\fB\-j \fR\fB\fIN\fR\fR +.sp +Deprecated. Use +\fB\-\-start\-position\fR +instead. +.TP 3n +\(bu +\fB\-\-protocol={TCP|SOCKET|PIPE|MEMORY}\fR +.sp +The connection protocol to use for connecting to the server. It is useful when the other connection parameters normally would cause a protocol to be used other than the one you want. For details on the allowable values, see +Section\ 4.2.2, \(lqConnecting to the MySQL Server\(rq. +.TP 3n +\(bu +\fB\-\-read\-from\-remote\-server\fR, +\fB\-R\fR +.sp +Read the binary log from a MySQL server rather than reading a local log file. Any connection parameter options are ignored unless this option is given as well. These options are +\fB\-\-host\fR, +\fB\-\-password\fR, +\fB\-\-port\fR, +\fB\-\-protocol\fR, +\fB\-\-socket\fR, and +\fB\-\-user\fR. +.sp +This option requires that the remote server be running. It works only for binary log files on the remote server, not relay log files. +.TP 3n +\(bu +\fB\-\-result\-file=\fR\fB\fIname\fR\fR, +\fB\-r \fR\fB\fIname\fR\fR +.sp +Direct output to the given file. +.TP 3n +\(bu +\fB\-\-server\-id=\fR\fB\fIid\fR\fR +.sp +Extract only those events created by the server having the given server ID. This option is available as of MySQL 5.1.4. +.TP 3n +\(bu +\fB\-\-set\-charset=\fR\fB\fIcharset_name\fR\fR +.sp +Add a +SET NAMES \fIcharset_name\fR +statement to the output to specify the character set to be used for processing log files. This option was added in MySQL 5.1.12. +.TP 3n +\(bu +\fB\-\-short\-form\fR, +\fB\-s\fR +.sp +Display only the statements contained in the log, without any extra information. +.TP 3n +\(bu +\fB\-\-socket=\fR\fB\fIpath\fR\fR, +\fB\-S \fR\fB\fIpath\fR\fR +.sp +For connections to +localhost, the Unix socket file to use, or, on Windows, the name of the named pipe to use. +.TP 3n +\(bu +\fB\-\-start\-datetime=\fR\fB\fIdatetime\fR\fR +.sp +Start reading the binary log at the first event having a timestamp equal to or later than the +\fIdatetime\fR +argument. The +\fIdatetime\fR +value is relative to the local time zone on the machine where you run +\fBmysqlbinlog\fR. The value should be in a format accepted for the +DATETIME +or +TIMESTAMP +data types. For example: +.sp +.RS 3n +.nf +shell> \fBmysqlbinlog \-\-start\-datetime="2005\-12\-25 11:25:56" binlog.000003\fR +.fi +.RE +This option is useful for point\-in\-time recovery. See +Section\ 6.2, \(lqExample Backup and Recovery Strategy\(rq. +.TP 3n +\(bu +\fB\-\-start\-position=\fR\fB\fIN\fR\fR +.sp +Start reading the binary log at the first event having a position equal to or greater than +\fIN\fR. This option applies to the first log file named on the command line. +.TP 3n +\(bu +\fB\-\-stop\-datetime=\fR\fB\fIdatetime\fR\fR +.sp +Stop reading the binary log at the first event having a timestamp equal to or later than the +\fIdatetime\fR +argument. This option is useful for point\-in\-time recovery. See the description of the +\fB\-\-start\-datetime\fR +option for information about the +\fIdatetime\fR +value. +.TP 3n +\(bu +\fB\-\-stop\-position=\fR\fB\fIN\fR\fR +.sp +Stop reading the binary log at the first event having a position equal to or greater than +\fIN\fR. This option applies to the last log file named on the command line. +.TP 3n +\(bu +\fB\-\-to\-last\-log\fR, +\fB\-t\fR +.sp +Do not stop at the end of the requested binary log from a MySQL server, but rather continue printing until the end of the last binary log. If you send the output to the same MySQL server, this may lead to an endless loop. This option requires +\fB\-\-read\-from\-remote\-server\fR. +.TP 3n +\(bu +\fB\-\-user=\fR\fB\fIuser_name\fR\fR, +\fB\-u \fR\fB\fIuser_name\fR\fR +.sp +The MySQL user name to use when connecting to a remote server. +.TP 3n +\(bu +\fB\-\-verbose\fR, +\fB\-v\fR +.sp +Reconstruct row events and display them as commented SQL statements. If given twice, the output includes comments to indicate column data types and some metadata. This option was added in MySQL 5.1.28. +.sp +For examples that show the effect of +\fB\-\-base64\-output\fR +and +\fB\-\-verbose\fR +on row event output, see +the section called \(lq\fBMYSQLBINLOG\fR ROW EVENT DISPLAY\(rq. +.TP 3n +\(bu +\fB\-\-version\fR, +\fB\-V\fR +.sp +Display version information and exit. +.TP 3n +\(bu +\fB\-\-write\-binlog\fR +.sp +This option is enabled by default, so that +ANALYZE TABLE, +OPTIMIZE TABLE, and +REPAIR TABLE +statements generated by +\fBmysqlcheck\fR +are written to the binary log. Use +\fB\-\-skip\-write\-binlog\fR +to cause +NO_WRITE_TO_BINLOG +to be added to the statements so that they are not logged. Use the +\fB\-\-skip\-write\-binlog\fR +when these statements should not be sent to replication slaves or run when using the binary logs for recovery from backup. This option was added in MySQL 5.1.18. +.sp +.RE +.PP +You can also set the following variable by using +\fB\-\-\fR\fB\fIvar_name\fR\fR\fB=\fR\fB\fIvalue\fR\fR +syntax: +.TP 3n +\(bu +open_files_limit +.sp +Specify the number of open file descriptors to reserve. +.sp +.RE +.PP +You can pipe the output of +\fBmysqlbinlog\fR +into the +\fBmysql\fR +client to execute the statements contained in the binary log. This is used to recover from a crash when you have an old backup (see +Section\ 6.1, \(lqDatabase Backups\(rq). For example: +.sp +.RS 3n +.nf +shell> \fBmysqlbinlog binlog.000001 | mysql\fR +.fi +.RE +.PP +Or: +.sp +.RS 3n +.nf +shell> \fBmysqlbinlog binlog.[0\-9]* | mysql\fR +.fi +.RE +.PP +You can also redirect the output of +\fBmysqlbinlog\fR +to a text file instead, if you need to modify the statement log first (for example, to remove statements that you do not want to execute for some reason). After editing the file, execute the statements that it contains by using it as input to the +\fBmysql\fR +program. +.PP +\fBmysqlbinlog\fR +has the +\fB\-\-start\-position\fR +option, which prints only those statements with an offset in the binary log greater than or equal to a given position (the given position must match the start of one event). It also has options to stop and start when it sees an event with a given date and time. This enables you to perform point\-in\-time recovery using the +\fB\-\-stop\-datetime\fR +option (to be able to say, for example, +\(lqroll forward my databases to how they were today at 10:30 a.m.\(rq). +.PP +If you have more than one binary log to execute on the MySQL server, the safe method is to process them all using a single connection to the server. Here is an example that demonstrates what may be +\fIunsafe\fR: +.sp +.RS 3n +.nf +shell> \fBmysqlbinlog binlog.000001 | mysql # DANGER!!\fR +shell> \fBmysqlbinlog binlog.000002 | mysql # DANGER!!\fR +.fi +.RE +.PP +Processing binary logs this way using different connections to the server causes problems if the first log file contains a +CREATE TEMPORARY TABLE +statement and the second log contains a statement that uses the temporary table. When the first +\fBmysql\fR +process terminates, the server drops the temporary table. When the second +\fBmysql\fR +process attempts to use the table, the server reports +\(lqunknown table.\(rq +.PP +To avoid problems like this, use a +\fIsingle\fR +connection to execute the contents of all binary logs that you want to process. Here is one way to do so: +.sp +.RS 3n +.nf +shell> \fBmysqlbinlog binlog.000001 binlog.000002 | mysql\fR +.fi +.RE +.PP +Another approach is to write all the logs to a single file and then process the file: +.sp +.RS 3n +.nf +shell> \fBmysqlbinlog binlog.000001 > /tmp/statements.sql\fR +shell> \fBmysqlbinlog binlog.000002 >> /tmp/statements.sql\fR +shell> \fBmysql \-e "source /tmp/statements.sql"\fR +.fi +.RE +.PP +\fBmysqlbinlog\fR +can produce output that reproduces a +LOAD DATA INFILE +operation without the original data file. +\fBmysqlbinlog\fR +copies the data to a temporary file and writes a +LOAD DATA LOCAL INFILE +statement that refers to the file. The default location of the directory where these files are written is system\-specific. To specify a directory explicitly, use the +\fB\-\-local\-load\fR +option. +.PP +Because +\fBmysqlbinlog\fR +converts +LOAD DATA INFILE +statements to +LOAD DATA LOCAL INFILE +statements (that is, it adds +LOCAL), both the client and the server that you use to process the statements must be configured to allow +LOCAL +capability. See +Section\ 5.3.4, \(lqSecurity Issues with LOAD DATA LOCAL\(rq. +.sp +.it 1 an-trap +.nr an-no-space-flag 1 +.nr an-break-flag 1 +.br +\fBWarning\fR +.PP +The temporary files created for +LOAD DATA LOCAL +statements are +\fInot\fR +automatically deleted because they are needed until you actually execute those statements. You should delete the temporary files yourself after you no longer need the statement log. The files can be found in the temporary file directory and have names like +\fIoriginal_file_name\-#\-#\fR. +.SH "\fBMYSQLBINLOG\fR HEX DUMP FORMAT" +.PP +The +\fB\-\-hexdump\fR +option produces a hex dump of the log contents: +.sp +.RS 3n +.nf +shell> \fBmysqlbinlog \-\-hexdump master\-bin.000001\fR +.fi +.RE +.PP +The hex output consists of comment lines beginning with +#, so the output might look like this for the preceding command: +.sp +.RS 3n +.nf +/*!40019 SET @@session.max_insert_delayed_threads=0*/; +/*!50003 SET @OLD_COMPLETION_TYPE=@@COMPLETION_TYPE,COMPLETION_TYPE=0*/; +# at 4 +#051024 17:24:13 server id 1 end_log_pos 98 +# Position Timestamp Type Master ID Size Master Pos Flags +# 00000004 9d fc 5c 43 0f 01 00 00 00 5e 00 00 00 62 00 00 00 00 00 +# 00000017 04 00 35 2e 30 2e 31 35 2d 64 65 62 75 67 2d 6c |..5.0.15.debug.l| +# 00000027 6f 67 00 00 00 00 00 00 00 00 00 00 00 00 00 00 |og..............| +# 00000037 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 |................| +# 00000047 00 00 00 00 9d fc 5c 43 13 38 0d 00 08 00 12 00 |.......C.8......| +# 00000057 04 04 04 04 12 00 00 4b 00 04 1a |.......K...| +# Start: binlog v 4, server v 5.0.15\-debug\-log created 051024 17:24:13 +# at startup +ROLLBACK; +.fi +.RE +.PP +Hex dump output currently contains the following elements. This format is subject to change. +.TP 3n +\(bu +Position: The byte position within the log file. +.TP 3n +\(bu +Timestamp: The event timestamp. In the example shown, +\'9d fc 5c 43' +is the representation of +\'051024 17:24:13' +in hexadecimal. +.TP 3n +\(bu +Type: The event type code. In the example shown, +\'0f' +indicates a +FORMAT_DESCRIPTION_EVENT. The following table lists the possible type codes. +.TS +allbox tab(:); +l l l +l l l +l l l +l l l +l l l +l l l +l l l +l l l +l l l +l l l +l l l +l l l +l l l +l l l +l l l +l l l +l l l +l l l +l l l +l l l +l l l +l l l +l l l +l l l +l l l +l l l +l l l +l l l. +T{ +Type +T}:T{ +Name +T}:T{ +Meaning +T} +T{ +08 +T}:T{ +CREATE_FILE_EVENT +T}:T{ +Used for LOAD DATA + INFILE statements. This indicates the + start of execution of such a statement. A temporary + file is created on the slave. Used in MySQL 4 only. +T} +T{ +09 +T}:T{ +APPEND_BLOCK_EVENT +T}:T{ +Contains data for use in a + LOAD DATA + INFILE statement. The data is stored in + the temporary file on the slave. +T} +T{ +0a +T}:T{ +EXEC_LOAD_EVENT +T}:T{ +Used for LOAD DATA + INFILE statements. The contents of the + temporary file is stored in the table on the slave. + Used in MySQL 4 only. +T} +T{ +0b +T}:T{ +DELETE_FILE_EVENT +T}:T{ +Rollback of a LOAD DATA + INFILE statement. The temporary file + should be deleted on the slave. +T} +T{ +0c +T}:T{ +NEW_LOAD_EVENT +T}:T{ +Used for LOAD DATA + INFILE in MySQL 4 and earlier. +T} +T{ +0d +T}:T{ +RAND_EVENT +T}:T{ +Used to send information about random values if the + RAND() function is + used in the statement. +T} +T{ +0e +T}:T{ +USER_VAR_EVENT +T}:T{ +Used to replicate user variables. +T} +T{ +0f +T}:T{ +FORMAT_DESCRIPTION_EVENT +T}:T{ +This indicates the start of a log file written by MySQL 5 or later. +T} +T{ +10 +T}:T{ +XID_EVENT +T}:T{ +Event indicating commit of an XA transaction. +T} +T{ +11 +T}:T{ +BEGIN_LOAD_QUERY_EVENT +T}:T{ +Used for LOAD DATA + INFILE statements in MySQL 5 and later. +T} +T{ +00 +T}:T{ +UNKNOWN_EVENT +T}:T{ +This event should never be present in the log. +T} +T{ +12 +T}:T{ +EXECUTE_LOAD_QUERY_EVENT +T}:T{ +Used for LOAD DATA + INFILE statements in MySQL 5 and later. +T} +T{ +13 +T}:T{ +TABLE_MAP_EVENT +T}:T{ +Information about a table definition. Used in MySQL 5.1.5 and later. +T} +T{ +14 +T}:T{ +PRE_GA_WRITE_ROWS_EVENT +T}:T{ +Row data for a single table that should be created. Used in MySQL 5.1.5 + to 5.1.17. +T} +T{ +15 +T}:T{ +PRE_GA_UPDATE_ROWS_EVENT +T}:T{ +Row data for a single table that needs to be updated. Used in MySQL + 5.1.5 to 5.1.17. +T} +T{ +16 +T}:T{ +PRE_GA_DELETE_ROWS_EVENT +T}:T{ +Row data for a single table that should be deleted. Used in MySQL 5.1.5 + to 5.1.17. +T} +T{ +17 +T}:T{ +WRITE_ROWS_EVENT +T}:T{ +Row data for a single table that should be created. Used in MySQL 5.1.18 + and later. +T} +T{ +18 +T}:T{ +UPDATE_ROWS_EVENT +T}:T{ +Row data for a single table that needs to be updated. Used in MySQL + 5.1.18 and later. +T} +T{ +19 +T}:T{ +DELETE_ROWS_EVENT +T}:T{ +Row data for a single table that should be deleted. Used in MySQL 5.1.18 + and later. +T} +T{ +1a +T}:T{ +INCIDENT_EVENT +T}:T{ +Something out of the ordinary happened. Added in MySQL 5.1.18. +T} +T{ +01 +T}:T{ +START_EVENT_V3 +T}:T{ +This indicates the start of a log file written by MySQL 4 or earlier. +T} +T{ +02 +T}:T{ +QUERY_EVENT +T}:T{ +The most common type of events. These contain statements executed on the + master. +T} +T{ +03 +T}:T{ +STOP_EVENT +T}:T{ +Indicates that master has stopped. +T} +T{ +04 +T}:T{ +ROTATE_EVENT +T}:T{ +Written when the master switches to a new log file. +T} +T{ +05 +T}:T{ +INTVAR_EVENT +T}:T{ +Used for AUTO_INCREMENT values or when the + LAST_INSERT_ID() + function is used in the statement. +T} +T{ +06 +T}:T{ +LOAD_EVENT +T}:T{ +Used for LOAD DATA + INFILE in MySQL 3.23. +T} +T{ +07 +T}:T{ +SLAVE_EVENT +T}:T{ +Reserved for future use. +T} +.TE +.sp +.TP 3n +\(bu +Master ID: The server ID of the master that created the event. +.TP 3n +\(bu +Size: The size in bytes of the event. +.TP 3n +\(bu +Master Pos: The position of the next event in the original master log file. +.TP 3n +\(bu +Flags: 16 flags. Currently, the following flags are used. The others are reserved for future use. +.TS +allbox tab(:); +l l l +l l l +l l l +l l l +l l l. +T{ +Flag +T}:T{ +Name +T}:T{ +Meaning +T} +T{ +01 +T}:T{ +LOG_EVENT_BINLOG_IN_USE_F +T}:T{ +Log file correctly closed. (Used only in + FORMAT_DESCRIPTION_EVENT.) If + this flag is set (if the flags are, for example, + '01 00') in a + FORMAT_DESCRIPTION_EVENT, the log + file has not been properly closed. Most probably + this is because of a master crash (for example, due + to power failure). +T} +T{ +02 +T}:T{ +\ +T}:T{ +Reserved for future use. +T} +T{ +04 +T}:T{ +LOG_EVENT_THREAD_SPECIFIC_F +T}:T{ +Set if the event is dependent on the connection it was executed in (for + example, '04 00'), for example, + if the event uses temporary tables. +T} +T{ +08 +T}:T{ +LOG_EVENT_SUPPRESS_USE_F +T}:T{ +Set in some circumstances when the event is not dependent on the default + database. +T} +.TE +.sp +.SH "\fBMYSQLBINLOG\fR ROW EVENT DISPLAY" +.PP +The following examples illustrate how +\fBmysqlbinlog\fR +displays row events that specify data modifications. These correspond to events with the +WRITE_ROWS_EVENT, +UPDATE_ROWS_EVENT, and +DELETE_ROWS_EVENT +type codes. The +\fB\-\-base64\-output=DECODE\-ROWS\fR +and +\fB\-\-verbose\fR +options may be used to affect row event output. These options are available as of MySQL 5.1.28. +.PP +Suppose that the server is using row\-based binary logging and that you execute the following sequence of statements: +.sp +.RS 3n +.nf +CREATE TABLE t +( + id INT NOT NULL, + name VARCHAR(20) NOT NULL, + date DATE NULL +) ENGINE = InnoDB; +START TRANSACTION; +INSERT INTO t VALUES(1, 'apple', NULL); +UPDATE t SET name = 'pear', date = '2009\-01\-01' WHERE id = 1; +DELETE FROM t WHERE id = 1; +COMMIT; +.fi +.RE +.PP +By default, +\fBmysqlbinlog\fR +displays row events encoded as base\-64 strings using +BINLOG +statements. Omitting extraneous lines, the output for the row events produced by the preceding statement sequence looks like this: +.sp +.RS 3n +.nf +shell> \fBmysqlbinlog \fR\fB\fIlog_file\fR\fR +... +# at 218 +#080828 15:03:08 server id 1 end_log_pos 258 Write_rows: table id 17 flags: STMT_END_F +BINLOG ' +fAS3SBMBAAAALAAAANoAAAAAABEAAAAAAAAABHRlc3QAAXQAAwMPCgIUAAQ= +fAS3SBcBAAAAKAAAAAIBAAAQABEAAAAAAAEAA//8AQAAAAVhcHBsZQ== +\'/*!*/; +... +# at 302 +#080828 15:03:08 server id 1 end_log_pos 356 Update_rows: table id 17 flags: STMT_END_F +BINLOG ' +fAS3SBMBAAAALAAAAC4BAAAAABEAAAAAAAAABHRlc3QAAXQAAwMPCgIUAAQ= +fAS3SBgBAAAANgAAAGQBAAAQABEAAAAAAAEAA////AEAAAAFYXBwbGX4AQAAAARwZWFyIbIP +\'/*!*/; +... +# at 400 +#080828 15:03:08 server id 1 end_log_pos 442 Delete_rows: table id 17 flags: STMT_END_F +BINLOG ' +fAS3SBMBAAAALAAAAJABAAAAABEAAAAAAAAABHRlc3QAAXQAAwMPCgIUAAQ= +fAS3SBkBAAAAKgAAALoBAAAQABEAAAAAAAEAA//4AQAAAARwZWFyIbIP +\'/*!*/; +.fi +.RE +.PP +To see the row events as comments in the form of +\(lqpseudo\-SQL\(rq +statements, run +\fBmysqlbinlog\fR +with the +\fB\-\-verbose\fR +or +\fB\-v\fR +option. The output will contain lines beginning with +###: +.sp +.RS 3n +.nf +shell> \fBmysqlbinlog \-v \fR\fB\fIlog_file\fR\fR +... +# at 218 +#080828 15:03:08 server id 1 end_log_pos 258 Write_rows: table id 17 flags: STMT_END_F +BINLOG ' +fAS3SBMBAAAALAAAANoAAAAAABEAAAAAAAAABHRlc3QAAXQAAwMPCgIUAAQ= +fAS3SBcBAAAAKAAAAAIBAAAQABEAAAAAAAEAA//8AQAAAAVhcHBsZQ== +\'/*!*/; +### INSERT INTO test.t +### SET +### @1=1 +### @2='apple' +### @3=NULL +... +# at 302 +#080828 15:03:08 server id 1 end_log_pos 356 Update_rows: table id 17 flags: STMT_END_F +BINLOG ' +fAS3SBMBAAAALAAAAC4BAAAAABEAAAAAAAAABHRlc3QAAXQAAwMPCgIUAAQ= +fAS3SBgBAAAANgAAAGQBAAAQABEAAAAAAAEAA////AEAAAAFYXBwbGX4AQAAAARwZWFyIbIP +\'/*!*/; +### UPDATE test.t +### WHERE +### @1=1 +### @2='apple' +### @3=NULL +### SET +### @1=1 +### @2='pear' +### @3='2009:01:01' +... +# at 400 +#080828 15:03:08 server id 1 end_log_pos 442 Delete_rows: table id 17 flags: STMT_END_F +BINLOG ' +fAS3SBMBAAAALAAAAJABAAAAABEAAAAAAAAABHRlc3QAAXQAAwMPCgIUAAQ= +fAS3SBkBAAAAKgAAALoBAAAQABEAAAAAAAEAA//4AQAAAARwZWFyIbIP +\'/*!*/; +### DELETE FROM test.t +### WHERE +### @1=1 +### @2='pear' +### @3='2009:01:01' +.fi +.RE +.PP +Specify +\fB\-\-verbose\fR +or +\fB\-v\fR +twice to also display data types and some metadata for each column. The output will contain an additional comment following each column change: +.sp +.RS 3n +.nf +shell> \fBmysqlbinlog \-vv \fR\fB\fIlog_file\fR\fR +... +# at 218 +#080828 15:03:08 server id 1 end_log_pos 258 Write_rows: table id 17 flags: STMT_END_F +BINLOG ' +fAS3SBMBAAAALAAAANoAAAAAABEAAAAAAAAABHRlc3QAAXQAAwMPCgIUAAQ= +fAS3SBcBAAAAKAAAAAIBAAAQABEAAAAAAAEAA//8AQAAAAVhcHBsZQ== +\'/*!*/; +### INSERT INTO test.t +### SET +### @1=1 /* INT meta=0 nullable=0 is_null=0 */ +### @2='apple' /* VARSTRING(20) meta=20 nullable=0 is_null=0 */ +### @3=NULL /* VARSTRING(20) meta=0 nullable=1 is_null=1 */ +... +# at 302 +#080828 15:03:08 server id 1 end_log_pos 356 Update_rows: table id 17 flags: STMT_END_F +BINLOG ' +fAS3SBMBAAAALAAAAC4BAAAAABEAAAAAAAAABHRlc3QAAXQAAwMPCgIUAAQ= +fAS3SBgBAAAANgAAAGQBAAAQABEAAAAAAAEAA////AEAAAAFYXBwbGX4AQAAAARwZWFyIbIP +\'/*!*/; +### UPDATE test.t +### WHERE +### @1=1 /* INT meta=0 nullable=0 is_null=0 */ +### @2='apple' /* VARSTRING(20) meta=20 nullable=0 is_null=0 */ +### @3=NULL /* VARSTRING(20) meta=0 nullable=1 is_null=1 */ +### SET +### @1=1 /* INT meta=0 nullable=0 is_null=0 */ +### @2='pear' /* VARSTRING(20) meta=20 nullable=0 is_null=0 */ +### @3='2009:01:01' /* DATE meta=0 nullable=1 is_null=0 */ +... +# at 400 +#080828 15:03:08 server id 1 end_log_pos 442 Delete_rows: table id 17 flags: STMT_END_F +BINLOG ' +fAS3SBMBAAAALAAAAJABAAAAABEAAAAAAAAABHRlc3QAAXQAAwMPCgIUAAQ= +fAS3SBkBAAAAKgAAALoBAAAQABEAAAAAAAEAA//4AQAAAARwZWFyIbIP +\'/*!*/; +### DELETE FROM test.t +### WHERE +### @1=1 /* INT meta=0 nullable=0 is_null=0 */ +### @2='pear' /* VARSTRING(20) meta=20 nullable=0 is_null=0 */ +### @3='2009:01:01' /* DATE meta=0 nullable=1 is_null=0 */ +.fi +.RE +.PP +You can tell +\fBmysqlbinlog\fR +to suppress the +BINLOG +statements for row events by using the +\fB\-\-base64\-output=DECODE\-ROWS\fR +option. This is similar to +\fB\-\-base64\-output=NEVER\fR +but does not exit with an error if a row event is found. The combination of +\fB\-\-base64\-output=DECODE\-ROWS\fR +and +\fB\-\-verbose\fR +provides a convenient way to see row events only as SQL statements: +.sp +.RS 3n +.nf +shell> \fBmysqlbinlog \-v \-\-base64\-output=DECODE\-ROWS \fR\fB\fIlog_file\fR\fR +... +# at 218 +#080828 15:03:08 server id 1 end_log_pos 258 Write_rows: table id 17 flags: STMT_END_F +### INSERT INTO test.t +### SET +### @1=1 +### @2='apple' +### @3=NULL +... +# at 302 +#080828 15:03:08 server id 1 end_log_pos 356 Update_rows: table id 17 flags: STMT_END_F +### UPDATE test.t +### WHERE +### @1=1 +### @2='apple' +### @3=NULL +### SET +### @1=1 +### @2='pear' +### @3='2009:01:01' +... +# at 400 +#080828 15:03:08 server id 1 end_log_pos 442 Delete_rows: table id 17 flags: STMT_END_F +### DELETE FROM test.t +### WHERE +### @1=1 +### @2='pear' +### @3='2009:01:01' +.fi +.RE +.sp +.it 1 an-trap +.nr an-no-space-flag 1 +.nr an-break-flag 1 +.br +\fBNote\fR +.PP +You should not suppress +BINLOG +statements if you intend to re\-execute +\fBmysqlbinlog\fR +output. +.PP +The SQL statements produced by +\fB\-\-verbose\fR +for row events are much more readable than the corresponding +BINLOG +statements. However, they do not correspond exactly to the original SQL statements that generated the events. The following limitations apply: +.TP 3n +\(bu +The original column names are lost and replace by +@\fIN\fR, where +\fIN\fR +is a column number. +.TP 3n +\(bu +Character set information is not available in the binary log, which affects string column display: +.RS 3n +.TP 3n +\(bu +There is no distinction made between corresponding binary and non\-binary string types (BINARY +and +CHAR, +VARBINARY +and +VARCHAR, +BLOB +and +TEXT). The output uses a data type of +STRING +for fixed\-length strings and +VARSTRING +for variable\-length strings. +.TP 3n +\(bu +For multi\-byte character sets, the maximum number of bytes per character is not present in the binary log, so the length for string types is displayed in bytes rather than in characters. For example, +STRING(4) +will be used as the data type for values from either of these column types: +.sp +.RS 3n +.nf +CHAR(4) CHARACTER SET latin1 +CHAR(2) CHARACTER SET ucs2 +.fi +.RE +.TP 3n +\(bu +Due to the storage format for events of type +UPDATE_ROWS_EVENT, +UPDATE +statements are displayed with the +WHERE +clause preceding the +SET +clause. +.RE +.SH "COPYRIGHT" +.PP +Copyright 2007\-2008 MySQL AB, 2009 Sun Microsystems, Inc. +.PP +This documentation is free software; you can redistribute it and/or modify it only under the terms of the GNU General Public License as published by the Free Software Foundation; version 2 of the License. +.PP +This documentation is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. +.PP +You should have received a copy of the GNU General Public License along with the program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110\-1301 USA or see http://www.gnu.org/licenses/. +.SH "SEE ALSO" +For more information, please refer to the MySQL Reference Manual, +which may already be installed locally and which is also available +online at http://dev.mysql.com/doc/. +.SH AUTHOR +MySQL AB (http://www.mysql.com/). === added file 'man/mysqlbug.1' --- a/man/mysqlbug.1 1970-01-01 00:00:00 +0000 +++ b/man/mysqlbug.1 2009-05-25 09:59:47 +0000 @@ -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/). === added file 'man/mysqlcheck.1' --- a/man/mysqlcheck.1 1970-01-01 00:00:00 +0000 +++ b/man/mysqlcheck.1 2009-05-25 09:59:47 +0000 @@ -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/). === added file 'man/mysqld.8' --- a/man/mysqld.8 1970-01-01 00:00:00 +0000 +++ b/man/mysqld.8 2009-05-25 09:59:47 +0000 @@ -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/). === added file 'man/mysqld_multi.1' --- a/man/mysqld_multi.1 1970-01-01 00:00:00 +0000 +++ b/man/mysqld_multi.1 2009-05-25 09:59:47 +0000 @@ -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/). === added file 'man/mysqld_safe.1' --- a/man/mysqld_safe.1 1970-01-01 00:00:00 +0000 +++ b/man/mysqld_safe.1 2009-05-25 09:59:47 +0000 @@ -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/). === added file 'man/mysqldump.1' --- a/man/mysqldump.1 1970-01-01 00:00:00 +0000 +++ b/man/mysqldump.1 2009-05-25 09:59:47 +0000 @@ -0,0 +1,1250 @@ +.\" Title: \fBmysqldump\fR +.\" Author: +.\" Generator: DocBook XSL Stylesheets v1.70.1 <http://docbook.sf.net/> +.\" Date: 03/31/2009 +.\" Manual: MySQL Database System +.\" Source: MySQL 5.1 +.\" +.TH "\fBMYSQLDUMP\fR" "1" "03/31/2009" "MySQL 5.1" "MySQL Database System" +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.SH "NAME" +mysqldump \- a database backup program +.SH "SYNOPSIS" +.HP 45 +\fBmysqldump [\fR\fB\fIoptions\fR\fR\fB] [\fR\fB\fIdb_name\fR\fR\fB [\fR\fB\fItbl_name\fR\fR\fB ...]]\fR +.SH "DESCRIPTION" +.PP +The +\fBmysqldump\fR +client is a backup program originally written by Igor Romanenko. It can be used to dump a database or a collection of databases for backup or transfer to another SQL server (not necessarily a MySQL server). The dump typically contains SQL statements to create the table, populate it, or both. However, +\fBmysqldump\fR +can also be used to generate files in CSV, other delimited text, or XML format. +.PP +If you are doing a backup on the server and your tables all are +MyISAM +tables, consider using the +\fBmysqlhotcopy\fR +instead because it can accomplish faster backups and faster restores. See +\fBmysqlhotcopy\fR(1). +.PP +There are three general ways to invoke +\fBmysqldump\fR: +.sp +.RS 3n +.nf +shell> \fBmysqldump [\fR\fB\fIoptions\fR\fR\fB] \fR\fB\fIdb_name\fR\fR\fB [\fR\fB\fItables\fR\fR\fB]\fR +shell> \fBmysqldump [\fR\fB\fIoptions\fR\fR\fB] \-\-databases \fR\fB\fIdb_name1\fR\fR\fB [\fR\fB\fIdb_name2\fR\fR\fB \fR\fB\fIdb_name3\fR\fR\fB...]\fR +shell> \fBmysqldump [\fR\fB\fIoptions\fR\fR\fB] \-\-all\-databases\fR +.fi +.RE +.PP +If you do not name any tables following +\fIdb_name\fR +or if you use the +\fB\-\-databases\fR +or +\fB\-\-all\-databases\fR +option, entire databases are dumped. +.PP +\fBmysqldump\fR +does not dump the +INFORMATION_SCHEMA +database. If you name that database explicitly on the command line, +\fBmysqldump\fR +silently ignores it. +.PP +To get a list of the options your version of +\fBmysqldump\fR +supports, execute +\fBmysqldump \-\-help\fR. +.PP +Some +\fBmysqldump\fR +options are shorthand for groups of other options. +\fB\-\-opt\fR +and +\fB\-\-compact\fR +fall into this category. For example, use of +\fB\-\-opt\fR +is the same as specifying +\fB\-\-add\-drop\-table\fR +\fB\-\-add\-locks\fR +\fB\-\-create\-options\fR +\fB\-\-disable\-keys\fR +\fB\-\-extended\-insert\fR +\fB\-\-lock\-tables\fR +\fB\-\-quick\fR +\fB\-\-set\-charset\fR. Note that all of the options that +\fB\-\-opt\fR +stands for also are on by default because +\fB\-\-opt\fR +is on by default. +.PP +To reverse the effect of a group option, uses its +\fB\-\-skip\-\fR\fB\fIxxx\fR\fR +form (\fB\-\-skip\-opt\fR +or +\fB\-\-skip\-compact\fR). It is also possible to select only part of the effect of a group option by following it with options that enable or disable specific features. Here are some examples: +.TP 3n +\(bu +To select the effect of +\fB\-\-opt\fR +except for some features, use the +\fB\-\-skip\fR +option for each feature. For example, to disable extended inserts and memory buffering, use +\fB\-\-opt\fR +\fB\-\-skip\-extended\-insert\fR +\fB\-\-skip\-quick\fR. (As of MySQL 5.1, +\fB\-\-skip\-extended\-insert\fR +\fB\-\-skip\-quick\fR +is sufficient because +\fB\-\-opt\fR +is on by default.) +.TP 3n +\(bu +To reverse +\fB\-\-opt\fR +for all features except index disabling and table locking, use +\fB\-\-skip\-opt\fR +\fB\-\-disable\-keys\fR +\fB\-\-lock\-tables\fR. +.sp +.RE +.PP +When you selectively enable or disable the effect of a group option, order is important because options are processed first to last. For example, +\fB\-\-disable\-keys\fR +\fB\-\-lock\-tables\fR +\fB\-\-skip\-opt\fR +would not have the intended effect; it is the same as +\fB\-\-skip\-opt\fR +by itself. +.PP +\fBmysqldump\fR +can retrieve and dump table contents row by row, or it can retrieve the entire content from a table and buffer it in memory before dumping it. Buffering in memory can be a problem if you are dumping large tables. To dump tables row by row, use the +\fB\-\-quick\fR +option (or +\fB\-\-opt\fR, which enables +\fB\-\-quick\fR). The +\fB\-\-opt\fR +option (and hence +\fB\-\-quick\fR) is enabled by default in MySQL 5.1; to enable memory buffering, use +\fB\-\-skip\-quick\fR. +.PP +If you are using a recent version of +\fBmysqldump\fR +to generate a dump to be reloaded into a very old MySQL server, you should not use the +\fB\-\-opt\fR +or +\fB\-\-extended\-insert\fR +option. Use +\fB\-\-skip\-opt\fR +instead. +.sp +.it 1 an-trap +.nr an-no-space-flag 1 +.nr an-break-flag 1 +.br +\fBNote\fR +.PP +\fBmysqldump\fR +from the MySQL 5.1.21 distribution cannot be used to create dumps from MySQL server versions 5.1.20 and older. This issue is fixed in MySQL 5.1.22. ([1]\&\fIBug#30123\fR) +.PP +\fBmysqldump\fR +supports the following options: +.TP 3n +\(bu +\fB\-\-help\fR, +\fB\-?\fR +.sp +Display a help message and exit. +.TP 3n +\(bu +\fB\-\-add\-drop\-database\fR +.sp +Add a +DROP DATABASE +statement before each +CREATE DATABASE +statement. +.TP 3n +\(bu +\fB\-\-add\-drop\-table\fR +.sp +Add a +DROP TABLE +statement before each +CREATE TABLE +statement. +.TP 3n +\(bu +\fB\-\-add\-locks\fR +.sp +Surround each table dump with +LOCK TABLES +and +UNLOCK TABLES +statements. This results in faster inserts when the dump file is reloaded. See +Section\ 7.2.20, \(lqSpeed of INSERT Statements\(rq. +.TP 3n +\(bu +\fB\-\-all\-databases\fR, +\fB\-A\fR +.sp +Dump all tables in all databases. This is the same as using the +\fB\-\-databases\fR +option and naming all the databases on the command line. +.TP 3n +\(bu +\fB\-\-all\-tablespaces\fR, +\fB\-Y\fR +.sp +Adds to a table dump all SQL statements needed to create any tablespaces used by an +NDBCLUSTER +table. This information is not otherwise included in the output from +\fBmysqldump\fR. This option is currently relevant only to MySQL Cluster tables. +.sp +This option was added in MySQL 5.1.6. +.TP 3n +\(bu +\fB\-\-allow\-keywords\fR +.sp +Allow creation of column names that are keywords. This works by prefixing each column name with the table name. +.TP 3n +\(bu +\fB\-\-character\-sets\-dir=\fR\fB\fIpath\fR\fR +.sp +The directory where character sets are installed. See +Section\ 9.2, \(lqThe Character Set Used for Data and Sorting\(rq. +.TP 3n +\(bu +\fB\-\-comments\fR, +\fB\-i\fR +.sp +Write additional information in the dump file such as program version, server version, and host. This option is enabled by default. To suppress this additional information, use +\fB\-\-skip\-comments\fR. +.TP 3n +\(bu +\fB\-\-compact\fR +.sp +Produce less verbose output. This option enables the +\fB\-\-skip\-add\-drop\-table\fR, +\fB\-\-skip\-add\-locks\fR, +\fB\-\-skip\-comments\fR, +\fB\-\-skip\-disable\-keys\fR, and +\fB\-\-skip\-set\-charset\fR +options. +.sp +.it 1 an-trap +.nr an-no-space-flag 1 +.nr an-break-flag 1 +.br +\fBNote\fR +Prior to release 5.1.21, this option did not create valid SQL if the database dump contained views. The recreation of views requires the creation and removal of temporary tables and this option suppressed the removal of those temporary tables. As a workaround, use +\fB\-\-compact\fR +with the +\fB\-\-add\-drop\-table\fR +option and then manually adjust the dump file. +.TP 3n +\(bu +\fB\-\-compatible=\fR\fB\fIname\fR\fR +.sp +Produce output that is more compatible with other database systems or with older MySQL servers. The value of +name +can be +ansi, +mysql323, +mysql40, +postgresql, +oracle, +mssql, +db2, +maxdb, +no_key_options, +no_table_options, or +no_field_options. To use several values, separate them by commas. These values have the same meaning as the corresponding options for setting the server SQL mode. See +Section\ 5.1.7, \(lqServer SQL Modes\(rq. +.sp +This option does not guarantee compatibility with other servers. It only enables those SQL mode values that are currently available for making dump output more compatible. For example, +\fB\-\-compatible=oracle\fR +does not map data types to Oracle types or use Oracle comment syntax. +.sp +\fIThis option requires a server version of 4.1.0 or higher\fR. With older servers, it does nothing. +.TP 3n +\(bu +\fB\-\-complete\-insert\fR, +\fB\-c\fR +.sp +Use complete +INSERT +statements that include column names. +.TP 3n +\(bu +\fB\-\-compress\fR, +\fB\-C\fR +.sp +Compress all information sent between the client and the server if both support compression. +.TP 3n +\(bu +\fB\-\-create\-options\fR +.sp +Include all MySQL\-specific table options in the +CREATE TABLE +statements. +.TP 3n +\(bu +\fB\-\-databases\fR, +\fB\-B\fR +.sp +Dump several databases. Normally, +\fBmysqldump\fR +treats the first name argument on the command line as a database name and following names as table names. With this option, it treats all name arguments as database names. +CREATE DATABASE +and +USE +statements are included in the output before each new database. +.TP 3n +\(bu +\fB\-\-debug[=\fR\fB\fIdebug_options\fR\fR\fB]\fR, +\fB\-# [\fR\fB\fIdebug_options\fR\fR\fB]\fR +.sp +Write a debugging log. The +\fIdebug_options\fR +string is often +\'d:t:o,\fIfile_name\fR'. The default value is +\'d:t:o,/tmp/mysqldump.trace'. +.TP 3n +\(bu +\fB\-\-debug\-check\fR +.sp +Print some debugging information when the program exits. This option was added in MySQL 5.1.21. +.TP 3n +\(bu +\fB\-\-debug\-info\fR +.sp +Print debugging information and memory and CPU usage statistics when the program exits. This option was added in MySQL 5.1.14. +.TP 3n +\(bu +\fB\-\-default\-character\-set=\fR\fB\fIcharset_name\fR\fR +.sp +Use +\fIcharset_name\fR +as the default character set. See +Section\ 9.2, \(lqThe Character Set Used for Data and Sorting\(rq. If no character set is specified, +\fBmysqldump\fR +uses +utf8, and earlier versions use +latin1. +.sp +This option has no effect for output data files produced by using the +\fB\-\-tab\fR +option. See the description for that option. +.TP 3n +\(bu +\fB\-\-delayed\-insert\fR +.sp +Write +INSERT DELAYED +statements rather than +INSERT +statements. +.TP 3n +\(bu +\fB\-\-delete\-master\-logs\fR +.sp +On a master replication server, delete the binary logs after performing the dump operation. This option automatically enables +\fB\-\-master\-data\fR. +.TP 3n +\(bu +\fB\-\-disable\-keys\fR, +\fB\-K\fR +.sp +For each table, surround the +INSERT +statements with +/*!40000 ALTER TABLE \fItbl_name\fR DISABLE KEYS */; +and +/*!40000 ALTER TABLE \fItbl_name\fR ENABLE KEYS */; +statements. This makes loading the dump file faster because the indexes are created after all rows are inserted. This option is effective only for non\-unique indexes of +MyISAM +tables. +.TP 3n +\(bu +\fB\-\-dump\-date\fR +.sp +\fBmysqldump\fR +produces a +\-\- Dump completed on \fIDATE\fR +comment at the end of the dump if the +\fB\-\-comments\fR +option is given. However, the date causes dump files for identical data take at different times to appear to be different. +\fB\-\-dump\-date\fR +and +\fB\-\-skip\-dump\-date\fR +control whether the date is added to the comment. The default is +\fB\-\-dump\-date\fR +(include the date in the comment). +\fB\-\-skip\-dump\-date\fR +suppresses date printing. This option was added in MySQL 5.1.23. +.TP 3n +\(bu +\fB\-\-events\fR, +\fB\-E\fR +.sp +Dump events from the dumped databases. This option was added in MySQL 5.1.8. +.TP 3n +\(bu +\fB\-\-extended\-insert\fR, +\fB\-e\fR +.sp +Use multiple\-row +INSERT +syntax that include several +VALUES +lists. This results in a smaller dump file and speeds up inserts when the file is reloaded. +.TP 3n +\(bu +\fB\-\-fields\-terminated\-by=...\fR, +\fB\-\-fields\-enclosed\-by=...\fR, +\fB\-\-fields\-optionally\-enclosed\-by=...\fR, +\fB\-\-fields\-escaped\-by=...\fR +.sp +These options are used with the +\fB\-T\fR +option and have the same meaning as the corresponding clauses for +LOAD DATA INFILE. See +Section\ 12.2.6, \(lqLOAD DATA INFILE Syntax\(rq. +.TP 3n +\(bu +\fB\-\-first\-slave\fR, +\fB\-x\fR +.sp +Deprecated. Now renamed to +\fB\-\-lock\-all\-tables\fR. +.TP 3n +\(bu +\fB\-\-flush\-logs\fR, +\fB\-F\fR +.sp +Flush the MySQL server log files before starting the dump. This option requires the +RELOAD +privilege. Note that if you use this option in combination with the +\fB\-\-all\-databases\fR +(or +\fB\-A\fR) option, the logs are flushed +\fIfor each database dumped\fR. The exception is when using +\fB\-\-lock\-all\-tables\fR +or +\fB\-\-master\-data\fR: In this case, the logs are flushed only once, corresponding to the moment that all tables are locked. If you want your dump and the log flush to happen at exactly the same moment, you should use +\fB\-\-flush\-logs\fR +together with either +\fB\-\-lock\-all\-tables\fR +or +\fB\-\-master\-data\fR. +.TP 3n +\(bu +\fB\-\-flush\-privileges\fR +.sp +Emit a +FLUSH PRIVILEGES +statement after dumping the +mysql +database. This option should be used any time the dump contains the +mysql +database and any other database that depends on the data in the +mysql +database for proper restoration. This option was added in MySQL 5.1.12. +.TP 3n +\(bu +\fB\-\-force\fR, +\fB\-f\fR +.sp +Continue even if an SQL error occurs during a table dump. +.sp +One use for this option is to cause +\fBmysqldump\fR +to continue executing even when it encounters a view that has become invalid because the definition refers to a table that has been dropped. Without +\fB\-\-force\fR, +\fBmysqldump\fR +exits with an error message. With +\fB\-\-force\fR, +\fBmysqldump\fR +prints the error message, but it also writes an SQL comment containing the view definition to the dump output and continues executing. +.TP 3n +\(bu +\fB\-\-host=\fR\fB\fIhost_name\fR\fR, +\fB\-h \fR\fB\fIhost_name\fR\fR +.sp +Dump data from the MySQL server on the given host. The default host is +localhost. +.TP 3n +\(bu +\fB\-\-hex\-blob\fR +.sp +Dump binary columns using hexadecimal notation (for example, +\'abc' +becomes +0x616263). The affected data types are +BINARY, +VARBINARY, +BLOB, and +BIT. +.TP 3n +\(bu +\fB\-\-ignore\-table=\fR\fB\fIdb_name.tbl_name\fR\fR +.sp +Do not dump the given table, which must be specified using both the database and table names. To ignore multiple tables, use this option multiple times. This option also can be used to ignore views. +.TP 3n +\(bu +\fB\-\-insert\-ignore\fR +.sp +Write +INSERT +statements with the +IGNORE +option. +.TP 3n +\(bu +\fB\-\-lines\-terminated\-by=...\fR +.sp +This option is used with the +\fB\-T\fR +option and has the same meaning as the corresponding clause for +LOAD DATA INFILE. See +Section\ 12.2.6, \(lqLOAD DATA INFILE Syntax\(rq. +.TP 3n +\(bu +\fB\-\-lock\-all\-tables\fR, +\fB\-x\fR +.sp +Lock all tables across all databases. This is achieved by acquiring a global read lock for the duration of the whole dump. This option automatically turns off +\fB\-\-single\-transaction\fR +and +\fB\-\-lock\-tables\fR. +.TP 3n +\(bu +\fB\-\-lock\-tables\fR, +\fB\-l\fR +.sp +Lock all tables before dumping them. The tables are locked with +READ LOCAL +to allow concurrent inserts in the case of +MyISAM +tables. For transactional tables such as +InnoDB +and +BDB, +\fB\-\-single\-transaction\fR +is a much better option, because it does not need to lock the tables at all. +.sp +Please note that when dumping multiple databases, +\fB\-\-lock\-tables\fR +locks tables for each database separately. Therefore, this option does not guarantee that the tables in the dump file are logically consistent between databases. Tables in different databases may be dumped in completely different states. +.TP 3n +\(bu +\fB\-\-log\-error=\fR\fB\fIfile_name\fR\fR +.sp +Append warnings and errors to the named file. This option was added in MySQL 5.1.18. +.TP 3n +\(bu +\fB\-\-master\-data[=\fR\fB\fIvalue\fR\fR\fB]\fR +.sp +Use this option to dump a master replication server to produce a dump file that can be used to set up another server as a slave of the master. It causes the dump output to include a +CHANGE MASTER TO +statement that indicates the binary log coordinates (file name and position) of the dumped server. These are the master server coordinates from which the slave should start replicating. +.sp +If the option value is 2, the +CHANGE MASTER TO +statement is written as an SQL comment, and thus is informative only; it has no effect when the dump file is reloaded. If the option value is 1, the statement takes effect when the dump file is reloaded. If the option value is not specified, the default value is 1. +.sp +This option requires the +RELOAD +privilege and the binary log must be enabled. +.sp +The +\fB\-\-master\-data\fR +option automatically turns off +\fB\-\-lock\-tables\fR. It also turns on +\fB\-\-lock\-all\-tables\fR, unless +\fB\-\-single\-transaction\fR +also is specified, in which case, a global read lock is acquired only for a short time at the beginning of the dump (see the description for +\fB\-\-single\-transaction\fR). In all cases, any action on logs happens at the exact moment of the dump. +.sp +It is also possible to set up a slave by dumping an existing slave of the master. To do this, use the following procedure on the existing slave: +.RS 3n +.TP 3n +1. +Stop the slave's SQL thread and get its current status: +.sp +.RS 3n +.nf +mysql> \fBSTOP SLAVE SQL_THREAD;\fR +mysql> \fBSHOW SLAVE STATUS;\fR +.fi +.RE +.TP 3n +2. +From the output of the SHOW SLAVE STATUS statement, get the binary log coordinates of the master server from which the new slave should start replicating. These coordinates are the values of the Relay_Master_Log_File and Exec_Master_Log_Pos values. Denote those values as file_name and file_pos. +.TP 3n +3. +Dump the slave server: +.sp +.RS 3n +.nf +shell> \fBmysqldump \-\-master\-data=2 \-\-all\-databases > dumpfile\fR +.fi +.RE +.TP 3n +4. +Restart the slave: +.sp +.RS 3n +.nf +mysql> \fBSTART SLAVE;\fR +.fi +.RE +.TP 3n +5. +On the new slave, reload the dump file: +.sp +.RS 3n +.nf +shell> \fBmysql < dumpfile\fR +.fi +.RE +.TP 3n +6. +On the new slave, set the replication coordinates to those of the master server obtained earlier: +.sp +.RS 3n +.nf +mysql> \fBCHANGE MASTER TO\fR + \-> \fBMASTER_LOG_FILE = 'file_name', MASTER_LOG_POS = file_pos;\fR +.fi +.RE +The +CHANGE MASTER TO +statement might also need other parameters, such as +MASTER_HOST +to point the slave to the correct master server host. Add any such parameters as necessary. +.RE +.TP 3n +\(bu +\fB\-\-no\-autocommit\fR +.sp +Enclose the +INSERT +statements for each dumped table within +SET autocommit = 0 +and +COMMIT +statements. +.TP 3n +\(bu +\fB\-\-no\-create\-db\fR, +\fB\-n\fR +.sp +This option suppresses the +CREATE DATABASE +statements that are otherwise included in the output if the +\fB\-\-databases\fR +or +\fB\-\-all\-databases\fR +option is given. +.TP 3n +\(bu +\fB\-\-no\-create\-info\fR, +\fB\-t\fR +.sp +Do not write +CREATE TABLE +statements that re\-create each dumped table. +.TP 3n +\(bu +\fB\-\-no\-data\fR, +\fB\-d\fR +.sp +Do not write any table row information (that is, do not dump table contents). This is very useful if you want to dump only the +CREATE TABLE +statement for the table. +.TP 3n +\(bu +\fB\-\-opt\fR +.sp +This option is shorthand; it is the same as specifying +\fB\-\-add\-drop\-table\fR +\fB\-\-add\-locks\fR +\fB\-\-create\-options\fR +\fB\-\-disable\-keys\fR +\fB\-\-extended\-insert\fR +\fB\-\-lock\-tables\fR +\fB\-\-quick\fR +\fB\-\-set\-charset\fR. It should give you a fast dump operation and produce a dump file that can be reloaded into a MySQL server quickly. +.sp +\fIThe \fR\fI\fB\-\-opt\fR\fR\fI option is enabled by default. Use \fR\fI\fB\-\-skip\-opt\fR\fR\fI to disable it.\fR +See the discussion at the beginning of this section for information about selectively enabling or disabling certain of the options affected by +\fB\-\-opt\fR. +.TP 3n +\(bu +\fB\-\-order\-by\-primary\fR +.sp +Sorts each table's rows by its primary key, or by its first unique index, if such an index exists. This is useful when dumping a +MyISAM +table to be loaded into an +InnoDB +table, but will make the dump itself take considerably longer. +.TP 3n +\(bu +\fB\-\-password[=\fR\fB\fIpassword\fR\fR\fB]\fR, +\fB\-p[\fR\fB\fIpassword\fR\fR\fB]\fR +.sp +The password to use when connecting to the server. If you use the short option form (\fB\-p\fR), you +\fIcannot\fR +have a space between the option and the password. If you omit the +\fIpassword\fR +value following the +\fB\-\-password\fR +or +\fB\-p\fR +option on the command line, you are prompted for one. +.sp +Specifying a password on the command line should be considered insecure. See +Section\ 5.5.6.2, \(lqEnd\-User Guidelines for Password Security\(rq. +.TP 3n +\(bu +\fB\-\-pipe\fR, +\fB\-W\fR +.sp +On Windows, connect to the server via a named pipe. This option applies only for connections to a local server, and only if the server supports named\-pipe connections. +.TP 3n +\(bu +\fB\-\-port=\fR\fB\fIport_num\fR\fR, +\fB\-P \fR\fB\fIport_num\fR\fR +.sp +The TCP/IP port number to use for the connection. +.TP 3n +\(bu +\fB\-\-protocol={TCP|SOCKET|PIPE|MEMORY}\fR +.sp +The connection protocol to use for connecting to the server. It is useful when the other connection parameters normally would cause a protocol to be used other than the one you want. For details on the allowable values, see +Section\ 4.2.2, \(lqConnecting to the MySQL Server\(rq. +.TP 3n +\(bu +\fB\-\-quick\fR, +\fB\-q\fR +.sp +This option is useful for dumping large tables. It forces +\fBmysqldump\fR +to retrieve rows for a table from the server a row at a time rather than retrieving the entire row set and buffering it in memory before writing it out. +.TP 3n +\(bu +\fB\-\-quote\-names\fR, +\fB\-Q\fR +.sp +Quote database, table, and column names within +\(lq`\(rq +characters. If the +ANSI_QUOTES +SQL mode is enabled, names are quoted within +\(lq"\(rq +characters. This option is enabled by default. It can be disabled with +\fB\-\-skip\-quote\-names\fR, but this option should be given after any option such as +\fB\-\-compatible\fR +that may enable +\fB\-\-quote\-names\fR. +.TP 3n +\(bu +\fB\-\-replace\fR +.sp +Write +REPLACE +statements rather than +INSERT +statements. Available as of MySQL 5.1.3. +.TP 3n +\(bu +\fB\-\-result\-file=\fR\fB\fIfile_name\fR\fR, +\fB\-r \fR\fB\fIfile_name\fR\fR +.sp +Direct output to a given file. This option should be used on Windows to prevent newline +\(lq\\n\(rq +characters from being converted to +\(lq\\r\\n\(rq +carriage return/newline sequences. The result file is created and its contents overwritten, even if an error occurs while generating the dump. The previous contents are lost. +.TP 3n +\(bu +\fB\-\-routines\fR, +\fB\-R\fR +.sp +Dump stored routines (procedures and functions) from the dumped databases. Use of this option requires the +SELECT +privilege for the +mysql.proc +table. The output generated by using +\fB\-\-routines\fR +contains +CREATE PROCEDURE +and +CREATE FUNCTION +statements to re\-create the routines. However, these statements do not include attributes such as the routine creation and modification timestamps. This means that when the routines are reloaded, they will be created with the timestamps equal to the reload time. +.sp +If you require routines to be re\-created with their original timestamp attributes, do not use +\fB\-\-routines\fR. Instead, dump and reload the contents of the +mysql.proc +table directly, using a MySQL account that has appropriate privileges for the +mysql +database. +.sp +This option was added in MySQL 5.1.2. Before that, stored routines are not dumped. Routine +DEFINER +values are not dumped until MySQL 5.1.8. This means that before 5.1.8, when routines are reloaded, they will be created with the definer set to the reloading user. If you require routines to be re\-created with their original definer, dump and load the contents of the +mysql.proc +table directly as described earlier. +.TP 3n +\(bu +\fB\-\-set\-charset\fR +.sp +Add +SET NAMES \fIdefault_character_set\fR +to the output. This option is enabled by default. To suppress the +SET NAMES +statement, use +\fB\-\-skip\-set\-charset\fR. +.TP 3n +\(bu +\fB\-\-single\-transaction\fR +.sp +This option issues a +BEGIN +SQL statement before dumping data from the server. It is useful only with transactional tables such as +InnoDB, because then it dumps the consistent state of the database at the time when +BEGIN +was issued without blocking any applications. +.sp +When using this option, you should keep in mind that only +InnoDB +tables are dumped in a consistent state. For example, any +MyISAM +or +MEMORY +tables dumped while using this option may still change state. +.sp +While a +\fB\-\-single\-transaction\fR +dump is in process, to ensure a valid dump file (correct table contents and binary log position), no other connection should use the following statements: +ALTER TABLE, +DROP TABLE, +RENAME TABLE, +TRUNCATE TABLE. A consistent read is not isolated from those statements, so use of them on a table to be dumped can cause the +SELECT +performed by +\fBmysqldump\fR +to retrieve the table contents to obtain incorrect contents or fail. +.sp +This option is not supported for MySQL Cluster tables; the results cannot be guaranteed to be consistent due to the fact that the +NDBCLUSTER +storage engine supports only the +READ_COMMITTED +transaction isolation level. You should always use +NDB +backup and restore instead. +.sp +The +\fB\-\-single\-transaction\fR +option and the +\fB\-\-lock\-tables\fR +option are mutually exclusive, because +LOCK TABLES +causes any pending transactions to be committed implicitly. +.sp +To dump large tables, you should combine this option with +\fB\-\-quick\fR. +.TP 3n +\(bu +\fB\-\-skip\-comments\fR +.sp +See the description for the +\fB\-\-comments\fR +option. +.TP 3n +\(bu +\fB\-\-skip\-opt\fR +.sp +See the description for the +\fB\-\-opt\fR +option. +.TP 3n +\(bu +\fB\-\-socket=\fR\fB\fIpath\fR\fR, +\fB\-S \fR\fB\fIpath\fR\fR +.sp +For connections to +localhost, the Unix socket file to use, or, on Windows, the name of the named pipe to use. +.TP 3n +\(bu +\fB\-\-ssl*\fR +.sp +Options that begin with +\fB\-\-ssl\fR +specify whether to connect to the server via SSL and indicate where to find SSL keys and certificates. See +Section\ 5.5.7.3, \(lqSSL Command Options\(rq. +.TP 3n +\(bu +\fB\-\-tab=\fR\fB\fIpath\fR\fR, +\fB\-T \fR\fB\fIpath\fR\fR +.sp +Produce tab\-separated data files. For each dumped table, +\fBmysqldump\fR +creates a +\fI\fItbl_name\fR\fR\fI.sql\fR +file that contains the +CREATE TABLE +statement that creates the table, and a +\fI\fItbl_name\fR\fR\fI.txt\fR +file that contains its data. The option value is the directory in which to write the files. +.sp +By default, the +\fI.txt\fR +data files are formatted using tab characters between column values and a newline at the end of each line. The format can be specified explicitly using the +\fB\-\-fields\-\fR\fB\fIxxx\fR\fR +and +\fB\-\-lines\-terminated\-by\fR +options. +.sp +Column values are dumped using the +binary +character set and the +\fB\-\-default\-character\-set\fR +option is ignored. In effect, there is no character set conversion. If a table contains columns in several character sets, the output data file will as well and you may not be able to reload the file correctly. +.sp +.it 1 an-trap +.nr an-no-space-flag 1 +.nr an-break-flag 1 +.br +\fBNote\fR +This option should be used only when +\fBmysqldump\fR +is run on the same machine as the +\fBmysqld\fR +server. You must have the +FILE +privilege, and the server must have permission to write files in the directory that you specify. +.TP 3n +\(bu +\fB\-\-tables\fR +.sp +Override the +\fB\-\-databases\fR +or +\fB\-B\fR +option. +\fBmysqldump\fR +regards all name arguments following the option as table names. +.TP 3n +\(bu +\fB\-\-triggers\fR +.sp +Dump triggers for each dumped table. This option is enabled by default; disable it with +\fB\-\-skip\-triggers\fR. +.TP 3n +\(bu +\fB\-\-tz\-utc\fR +.sp +This option enables +TIMESTAMP +columns to be dumped and reloaded between servers in different time zones. +\fBmysqldump\fR +sets its connection time zone to UTC and adds +SET TIME_ZONE='+00:00' +to the dump file. Without this option, +TIMESTAMP +columns are dumped and reloaded in the time zones local to the source and destination servers, which can cause the values to change. +\fB\-\-tz\-utc\fR +also protects against changes due to daylight saving time. +\fB\-\-tz\-utc\fR +is enabled by default. To disable it, use +\fB\-\-skip\-tz\-utc\fR. This option was added in MySQL 5.1.2. +.TP 3n +\(bu +\fB\-\-user=\fR\fB\fIuser_name\fR\fR, +\fB\-u \fR\fB\fIuser_name\fR\fR +.sp +The MySQL user name to use when connecting to the server. +.TP 3n +\(bu +\fB\-\-verbose\fR, +\fB\-v\fR +.sp +Verbose mode. Print more information about what the program does. +.TP 3n +\(bu +\fB\-\-version\fR, +\fB\-V\fR +.sp +Display version information and exit. +.TP 3n +\(bu +\fB\-\-where='\fR\fB\fIwhere_condition\fR\fR\fB'\fR, +\fB\-w '\fR\fB\fIwhere_condition\fR\fR\fB'\fR +.sp +Dump only rows selected by the given +WHERE +condition. Quotes around the condition are mandatory if it contains spaces or other characters that are special to your command interpreter. +.sp +Examples: +.sp +.RS 3n +.nf +\-\-where="user='jimf'" +\-w"userid>1" +\-w"userid<1" +.fi +.RE +.TP 3n +\(bu +\fB\-\-xml\fR, +\fB\-X\fR +.sp +Write dump output as well\-formed XML. +.sp +\fBNULL\fR\fB, \fR\fB'NULL'\fR\fB, and Empty Values\fR: For some column named +\fIcolumn_name\fR, the +NULL +value, an empty string, and the string value +\'NULL' +are distinguished from one another in the output generated by this option as follows. +.TS +allbox tab(:); +l l +l l +l l +l l. +T{ +\fBValue\fR: +T}:T{ +\fBXML Representation\fR: +T} +T{ +NULL (\fIunknown value\fR) +T}:T{ +<field name="\fIcolumn_name\fR" + xsi:nil="true" /> +T} +T{ +\'' (\fIempty string\fR) +T}:T{ +<field + name="\fIcolumn_name\fR"></field> +T} +T{ +\'NULL' (\fIstring value\fR) +T}:T{ +<field + name="\fIcolumn_name\fR">NULL</field> +T} +.TE +.sp +Beginning with MySQL 5.1.12, the output from the +\fBmysql\fR +client when run using the +\fB\-\-xml\fR +option also follows these rules. (See +the section called \(lq\fBMYSQL\fR OPTIONS\(rq.) +.sp +Beginning with MySQL 5.1.18, XML output from +\fBmysqldump\fR +includes the XML namespace, as shown here: +.sp +.RS 3n +.nf +shell> \fBmysqldump \-\-xml \-u root world City\fR +<?xml version="1.0"?> +<mysqldump xmlns:xsi="http://www.w3.org/2001/XMLSchema\-instance"> +<database name="world"> +<table_structure name="City"> +<field Field="ID" Type="int(11)" Null="NO" Key="PRI" Extra="auto_increment" /> +<field Field="Name" Type="char(35)" Null="NO" Key="" Default="" Extra="" /> +<field Field="CountryCode" Type="char(3)" Null="NO" Key="" Default="" Extra="" /> +<field Field="District" Type="char(20)" Null="NO" Key="" Default="" Extra="" /> +<field Field="Population" Type="int(11)" Null="NO" Key="" Default="0" Extra="" /> +<key Table="City" Non_unique="0" Key_name="PRIMARY" Seq_in_index="1" Column_name="ID" Collation="A" Cardinality="4079" +Null="" Index_type="BTREE" Comment="" /> +<options Name="City" Engine="MyISAM" Version="10" Row_format="Fixed" Rows="4079" Avg_row_length="67" Data_length="27329 +3" Max_data_length="18858823439613951" Index_length="43008" Data_free="0" Auto_increment="4080" Create_time="2007\-03\-31 01:47:01" Updat +e_time="2007\-03\-31 01:47:02" Collation="latin1_swedish_ci" Create_options="" Comment="" /> +</table_structure> +<table_data name="City"> +<row> +<field name="ID">1</field> +<field name="Name">Kabul</field> +<field name="CountryCode">AFG</field> +<field name="District">Kabol</field> +<field name="Population">1780000</field> +</row> +\fI...\fR +<row> +<field name="ID">4079</field> +<field name="Name">Rafah</field> +<field name="CountryCode">PSE</field> +<field name="District">Rafah</field> +<field name="Population">92020</field> +</row> +</table_data> +</database> +</mysqldump> +.fi +.RE +.sp +.sp +.RE +.PP +You can also set the following variables by using +\fB\-\-\fR\fB\fIvar_name\fR\fR\fB=\fR\fB\fIvalue\fR\fR +syntax: +.TP 3n +\(bu +max_allowed_packet +.sp +The maximum size of the buffer for client/server communication. The maximum is 1GB. +.TP 3n +\(bu +net_buffer_length +.sp +The initial size of the buffer for client/server communication. When creating multiple\-row\-insert statements (as with option +\fB\-\-extended\-insert\fR +or +\fB\-\-opt\fR), +\fBmysqldump\fR +creates rows up to +net_buffer_length +length. If you increase this variable, you should also ensure that the +net_buffer_length +variable in the MySQL server is at least this large. +.sp +.RE +.PP +The most common use of +\fBmysqldump\fR +is probably for making a backup of an entire database: +.sp +.RS 3n +.nf +shell> \fBmysqldump \fR\fB\fIdb_name\fR\fR\fB > \fR\fB\fIbackup\-file.sql\fR\fR +.fi +.RE +.PP +You can read the dump file back into the server like this: +.sp +.RS 3n +.nf +shell> \fBmysql \fR\fB\fIdb_name\fR\fR\fB < \fR\fB\fIbackup\-file.sql\fR\fR +.fi +.RE +.PP +Or like this: +.sp +.RS 3n +.nf +shell> \fBmysql \-e "source \fR\fB\fI/path\-to\-backup/backup\-file.sql\fR\fR\fB" \fR\fB\fIdb_name\fR\fR +.fi +.RE +.PP +\fBmysqldump\fR +is also very useful for populating databases by copying data from one MySQL server to another: +.sp +.RS 3n +.nf +shell> \fBmysqldump \-\-opt \fR\fB\fIdb_name\fR\fR\fB | mysql \-\-host=\fR\fB\fIremote_host\fR\fR\fB \-C \fR\fB\fIdb_name\fR\fR +.fi +.RE +.PP +It is possible to dump several databases with one command: +.sp +.RS 3n +.nf +shell> \fBmysqldump \-\-databases \fR\fB\fIdb_name1\fR\fR\fB [\fR\fB\fIdb_name2\fR\fR\fB ...] > my_databases.sql\fR +.fi +.RE +.PP +To dump all databases, use the +\fB\-\-all\-databases\fR +option: +.sp +.RS 3n +.nf +shell> \fBmysqldump \-\-all\-databases > all_databases.sql\fR +.fi +.RE +.PP +For +InnoDB +tables, +\fBmysqldump\fR +provides a way of making an online backup: +.sp +.RS 3n +.nf +shell> \fBmysqldump \-\-all\-databases \-\-single\-transaction > all_databases.sql\fR +.fi +.RE +.PP +This backup acquires a global read lock on all tables (using +FLUSH TABLES WITH READ LOCK) at the beginning of the dump. As soon as this lock has been acquired, the binary log coordinates are read and the lock is released. If long updating statements are running when the +FLUSH +statement is issued, the MySQL server may get stalled until those statements finish. After that, the dump becomes lock\-free and does not disturb reads and writes on the tables. If the update statements that the MySQL server receives are short (in terms of execution time), the initial lock period should not be noticeable, even with many updates. +.PP +For point\-in\-time recovery (also known as +\(lqroll\-forward,\(rq +when you need to restore an old backup and replay the changes that happened since that backup), it is often useful to rotate the binary log (see +Section\ 5.2.4, \(lqThe Binary Log\(rq) or at least know the binary log coordinates to which the dump corresponds: +.sp +.RS 3n +.nf +shell> \fBmysqldump \-\-all\-databases \-\-master\-data=2 > all_databases.sql\fR +.fi +.RE +.PP +Or: +.sp +.RS 3n +.nf +shell> \fBmysqldump \-\-all\-databases \-\-flush\-logs \-\-master\-data=2\fR + \fB> all_databases.sql\fR +.fi +.RE +.PP +The +\fB\-\-master\-data\fR +and +\fB\-\-single\-transaction\fR +options can be used simultaneously, which provides a convenient way to make an online backup suitable for point\-in\-time recovery if tables are stored using the +InnoDB +storage engine. +.PP +For more information on making backups, see +Section\ 6.1, \(lqDatabase Backups\(rq, and +Section\ 6.2, \(lqExample Backup and Recovery Strategy\(rq. +.PP +If you encounter problems backing up views, please read the section that covers restrictions on views which describes a workaround for backing up views when this fails due to insufficient privileges. See +Section\ D.4, \(lqRestrictions on Views\(rq. +.SH "COPYRIGHT" +.PP +Copyright 2007\-2008 MySQL AB, 2009 Sun Microsystems, Inc. +.PP +This documentation is free software; you can redistribute it and/or modify it only under the terms of the GNU General Public License as published by the Free Software Foundation; version 2 of the License. +.PP +This documentation is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. +.PP +You should have received a copy of the GNU General Public License along with the program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110\-1301 USA or see http://www.gnu.org/licenses/. +.SH "REFERENCES" +.TP 3 +1.\ Bug#30123 +\%http://bugs.mysql.com/30123 +.SH "SEE ALSO" +For more information, please refer to the MySQL Reference Manual, +which may already be installed locally and which is also available +online at http://dev.mysql.com/doc/. +.SH AUTHOR +MySQL AB (http://www.mysql.com/). === added file 'man/mysqldumpslow.1' --- a/man/mysqldumpslow.1 1970-01-01 00:00:00 +0000 +++ b/man/mysqldumpslow.1 2009-05-25 09:59:47 +0000 @@ -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/). === added file 'man/mysqlhotcopy.1' --- a/man/mysqlhotcopy.1 1970-01-01 00:00:00 +0000 +++ b/man/mysqlhotcopy.1 2009-05-25 09:59:47 +0000 @@ -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/). === added file 'man/mysqlimport.1' --- a/man/mysqlimport.1 1970-01-01 00:00:00 +0000 +++ b/man/mysqlimport.1 2009-05-25 09:59:47 +0000 @@ -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/). === added file 'man/mysqlmanager.8' --- a/man/mysqlmanager.8 1970-01-01 00:00:00 +0000 +++ b/man/mysqlmanager.8 2009-05-25 09:59:47 +0000 @@ -0,0 +1,1216 @@ +.\" Title: \fBmysqlmanager\fR +.\" Author: +.\" Generator: DocBook XSL Stylesheets v1.70.1 <http://docbook.sf.net/> +.\" Date: 03/31/2009 +.\" Manual: MySQL Database System +.\" Source: MySQL 5.1 +.\" +.TH "\fBMYSQLMANAGER\fR" "8" "03/31/2009" "MySQL 5.1" "MySQL Database System" +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.SH "NAME" +mysqlmanager \- the MySQL Instance Manager +.SH "SYNOPSIS" +.HP 23 +\fBmysqlmanager [\fR\fB\fIoptions\fR\fR\fB]\fR +.SH "DESCRIPTION" +.sp +.it 1 an-trap +.nr an-no-space-flag 1 +.nr an-break-flag 1 +.br +\fBImportant\fR +.PP +MySQL Instance Manager has been deprecated and is removed in MySQL 6.0. +.PP +\fBmysqlmanager\fR +is the MySQL Instance Manager (IM). This program monitors and manages MySQL Database Server instances. MySQL Instance Manager is available for Unix\-like operating systems, as well as Windows. It runs as a daemon that listens on a TCP/IP port. On Unix, it also listens on a Unix socket file. +.PP +MySQL Instance Manager can be used in place of the +mysqld_safe +script to start and stop one or more instances of MySQL Server. Because Instance Manager can manage multiple server instances, it can also be used in place of the +\fBmysqld_multi\fR +script. Instance Manager offers these capabilities: +.TP 3n +\(bu +Instance Manager can start and stop instances, and report on the status of instances. +.TP 3n +\(bu +Server instances can be treated as guarded or unguarded: +.RS 3n +.TP 3n +\(bu +When Instance Manager starts, it starts each guarded instance. If the instance crashes, Instance Manager detects this and restarts it. When Instance Manager stops, it stops the instance. +.TP 3n +\(bu +A nonguarded instance is not started when Instance Manager starts or monitored by it. If the instance crashes after being started, Instance Manager does not restart it. When Instance Manager exits, it does not stop the instance if it is running. +.RE +.IP "" 3n +Instances are guarded by default. An instance can be designated as nonguarded by including the +\fBnonguarded\fR +option in the configuration file. +.TP 3n +\(bu +Instance Manager provides an interactive interface for configuring instances, so that the need to edit the configuration file manually is reduced or eliminated. +.TP 3n +\(bu +Instance Manager provides remote instance management. That is, it runs on the host where you want to control MySQL Server instances, but you can connect to it from a remote host to perform instance\-management operations. +.sp +.RE +.PP +The following sections describe MySQL Instance Manager operation in more detail. +.SH "MYSQL INSTANCE MANAGER COMMAND OPTIONS" +.sp +.it 1 an-trap +.nr an-no-space-flag 1 +.nr an-break-flag 1 +.br +\fBImportant\fR +.PP +MySQL Instance Manager has been deprecated and is removed in MySQL 6.0. +.PP +The MySQL Instance Manager supports a number of command options. For a brief listing, invoke +\fBmysqlmanager\fR +with the +\fB\-\-help\fR +option. Options may be given on the command line or in the Instance Manager configuration file. On Windows, the standard configuration file is +\fImy.ini\fR +in the directory where Instance Manager is installed. On Unix, the standard file is +\fI/etc/my.cnf\fR. To specify a different configuration file, start Instance Manager with the +\fB\-\-defaults\-file\fR +option. +.PP +\fBmysqlmanager\fR +supports the options described in the following list. The options for managing entries in the password file are described further in +the section called \(lqINSTANCE MANAGER USER AND PASSWORD MANAGEMENT\(rq. +.TP 3n +\(bu +\fB\-\-help\fR, +\fB\-?\fR +.sp +Display a help message and exit. +.TP 3n +\(bu +\fB\-\-add\-user\fR +.sp +Add a new user (specified with the +\fB\-\-username\fR +option) to the password file. This option was added in MySQL 5.1.12. +.TP 3n +\(bu +\fB\-\-angel\-pid\-file=\fR\fB\fIfile_name\fR\fR +.sp +The file in which the angel process records its process ID when +\fBmysqlmanager\fR +runs in daemon mode (that is, when the +\fB\-\-run\-as\-service\fR +option is given). The default file name is +\fImysqlmanager.angel.pid\fR. +.sp +If the +\fB\-\-angel\-pid\-file\fR +option is not given, the default angel PID file has the same name as the PID file except that any PID file extension is replaced with an extension of +\fI.angel.pid\fR. (For example, +\fImysqlmanager.pid\fR +becomes +\fImysqlmanager.angel.pid\fR.) +.sp +This option was added in MySQL 5.1.11. +.TP 3n +\(bu +\fB\-\-bind\-address=\fR\fB\fIIP\fR\fR +.sp +The IP address to bind to. +.TP 3n +\(bu +\fB\-\-check\-password\-file\fR +.sp +Check the validity and consistency of the password file. This option was added in MySQL 5.1.12. +.TP 3n +\(bu +\fB\-\-clean\-password\-file\fR +.sp +Drop all users from the password file. This option was added in MySQL 5.1.12. +.TP 3n +\(bu +\fB\-\-debug=\fR\fB\fIdebug_options\fR\fR\fB, \-# \fR\fB\fIdebug_options\fR\fR +.sp +Write a debugging log. The +\fIdebug_options\fR +string often is +\'d:t:o,\fIfile_name\fR'. This option was added in MySQL 5.1.10. +.TP 3n +\(bu +\fB\-\-default\-mysqld\-path=\fR\fB\fIpath\fR\fR +.sp +The path name of the MySQL Server binary. This path name is used for all server instance sections in the configuration file for which no +\fBmysqld\-path\fR +option is present. The default value of this option is the compiled\-in path name, which depends on how the MySQL distribution was configured. Example: +\fB\-\-default\-mysqld\-path=/usr/sbin/mysqld\fR +.TP 3n +\(bu +\fB\-\-defaults\-file=\fR\fB\fIfile_name\fR\fR +.sp +Read Instance Manager and MySQL Server settings from the given file. All configuration changes made by the Instance Manager will be written to this file. This must be the first option on the command line if it is used, and the file must exist. +.sp +If this option is not given, Instance Manager uses its standard configuration file. On Windows, the standard file is +\fImy.ini\fR +in the directory where Instance Manager is installed. On Unix, the standard file is +\fI/etc/my.cnf\fR. +.TP 3n +\(bu +\fB\-\-drop\-user\fR +.sp +Drop a user (specified with the +\fB\-\-username\fR +option) from the password file. This option was added in MySQL 5.1.12. +.TP 3n +\(bu +\fB\-\-edit\-user\fR +.sp +Change an entry for an existing user (specified with the +\fB\-\-username\fR +option) in the password file. This option was added in MySQL 5.1.12. +.TP 3n +\(bu +\fB\-\-install\fR +.sp +On Windows, install Instance Manager as a Windows service. The service name is +MySQL Manager. +.TP 3n +\(bu +\fB\-\-list\-users\fR +.sp +List the users in the password file. This option was added in MySQL 5.1.12. +.TP 3n +\(bu +\fB\-\-log=\fR\fB\fIfile_name\fR\fR +.sp +The path to the Instance Manager log file. This option has no effect unless the +\fB\-\-run\-as\-service\fR +option is also given. If the file name specified for the option is a relative name, the log file is created under the directory from which Instance Manager is started. To ensure that the file is created in a specific directory, specify it as a full path name. +.sp +If +\fB\-\-run\-as\-service\fR +is given without +\fB\-\-log\fR, the log file is +\fImysqlmanager.log\fR +in the data directory. +.sp +If +\fB\-\-run\-as\-service\fR +is not given, log messages go to the standard output. To capture log output, you can redirect Instance Manager output to a file: +.sp +.RS 3n +.nf +mysqlmanager > im.log +.fi +.RE +.TP 3n +\(bu +\fB\-\-monitoring\-interval=\fR\fB\fIseconds\fR\fR +.sp +The interval in seconds for monitoring server instances. The default value is 20 seconds. Instance Manager tries to connect to each monitored (guarded) instance using the non\-existing +MySQL_Instance_Manager +user account to check whether it is alive/not hanging. If the result of the connection attempt indicates that the instance is unavailable, Instance Manager performs several attempts to restart the instance. +.sp +Normally, the +MySQL_Instance_Manager +account does not exist, so the connection attempts by Instance Manager cause the monitored instance to produce messages in its general query log similar to the following: +.sp +.RS 3n +.nf +Access denied for user 'MySQL_Instance_M'@'localhost' \(Fc + (using password: YES) +.fi +.RE +.sp +.sp +The +nonguarded +option in the appropriate server instance section disables monitoring for a particular instance. If the instance dies after being started, Instance Manager will not restart it. Instance Manager tries to connect to a nonguarded instance only when you request the instance's status (for example, with the +SHOW INSTANCES +status. +.sp +See +the section called \(lqMYSQL SERVER INSTANCE STATUS MONITORING\(rq, for more information. +.TP 3n +\(bu +\fB\-\-mysqld\-safe\-compatible\fR +.sp +Run in a +\fBmysqld_safe\fR\-compatible manner. For details, see +the section called \(lqSTARTING THE MYSQL SERVER WITH MYSQL INSTANCE MANAGER\(rq. This option was added in MySQL 5.1.12. +.TP 3n +\(bu +\fB\-\-password=\fR\fB\fIpassword\fR\fR, +\fB\-p \fR\fB\fIpassword\fR\fR +.sp +Specify the password for an entry to be added to or modified in the password file. Unlike the +\fB\-\-password\fR/\fB\-P\fR +option for most MySQL programs, the password value is required, not optional. See also +the section called \(lqINSTANCE MANAGER USER AND PASSWORD MANAGEMENT\(rq. This option was added in MySQL 5.1.12. +.TP 3n +\(bu +\fB\-\-password\-file=\fR\fB\fIfile_name\fR\fR +.sp +The name of the file where the Instance Manager looks for users and passwords. On Windows, the default is +\fImysqlmanager.passwd\fR +in the directory where Instance Manager is installed. On Unix, the default file is +\fI/etc/mysqlmanager.passwd\fR. See also +the section called \(lqINSTANCE MANAGER USER AND PASSWORD MANAGEMENT\(rq. +.TP 3n +\(bu +\fB\-\-pid\-file=\fR\fB\fIfile_name\fR\fR +.sp +The process ID file to use. On Windows, the default file is +\fImysqlmanager.pid\fR +in the directory where Instance Manager is installed. On Unix, the default is +\fImysqlmanager.pid\fR +in the data directory. +.TP 3n +\(bu +\fB\-\-port=\fR\fB\fIport_num\fR\fR +.sp +The port number to use when listening for TCP/IP connections from clients. The default port number (assigned by IANA) is 2273. +.TP 3n +\(bu +\fB\-\-print\-defaults\fR +.sp +Print the current defaults and exit. This must be the first option on the command line if it is used. +.TP 3n +\(bu +\fB\-\-print\-password\-line\fR +.sp +Prepare an entry for the password file, print it to the standard output, and exit. You can redirect the output from Instance Manager to a file to save the entry in the file. +.sp +Prior to MySQL 5.1.12, this option was named +\fB\-\-passwd\fR. +.TP 3n +\(bu +\fB\-\-remove\fR +.sp +On Windows, removes Instance Manager as a Windows service. This assumes that Instance Manager has been run with +\fB\-\-install\fR +previously. +.TP 3n +\(bu +\fB\-\-run\-as\-service\fR +.sp +On Unix, daemonize and start an angel process. The angel process monitors Instance Manager and restarts it if it crashes. (The angel process itself is simple and unlikely to crash.) +.TP 3n +\(bu +\fB\-\-socket=\fR\fB\fIpath\fR\fR +.sp +On Unix, the socket file to use for incoming connections. The default file is named +\fI/tmp/mysqlmanager.sock\fR. This option has no meaning on Windows. +.TP 3n +\(bu +\fB\-\-standalone\fR +.sp +This option is used on Windows to run Instance Manager in standalone mode. You should specify it when you start Instance Manager from the command line. +.TP 3n +\(bu +\fB\-\-user=\fR\fB\fIuser_name\fR\fR +.sp +On Unix, the user name of the system account to use for starting and running +\fBmysqlmanager\fR. This option generates a warning and has no effect unless you start +\fBmysqlmanager\fR +as +root +(so that it can change its effective user ID), or as the named user. It is recommended that you configure +\fBmysqlmanager\fR +to run using the same account used to run the +\fBmysqld\fR +server. (\(lqUser\(rq +in this context refers to a system login account, not a MySQL user listed in the grant tables.) +.TP 3n +\(bu +\fB\-\-username=\fR\fB\fIuser_name\fR\fR, +\fB\-u \fR\fB\fIuser_name\fR\fR +.sp +Specify the user name for an entry to be added to or modified in the password file. This option was added in MySQL 5.1.12. +.TP 3n +\(bu +\fB\-\-version\fR, +\fB\-V\fR +.sp +Display version information and exit. +.TP 3n +\(bu +\fB\-\-wait\-timeout=\fR\fB\fIN\fR\fR +.sp +The number of seconds to wait for activity on an incoming connection before closing it. The default is 28800 seconds (8 hours). +.sp +This option was added in MySQL 5.1.7. Before that, the timeout is 30 seconds and cannot be changed. +.SH "MYSQL INSTANCE MANAGER CONFIGURATION FILES" +.sp +.it 1 an-trap +.nr an-no-space-flag 1 +.nr an-break-flag 1 +.br +\fBImportant\fR +.PP +MySQL Instance Manager has been deprecated and is removed in MySQL 6.0. +.PP +Instance Manager uses its standard configuration file unless it is started with a +\fB\-\-defaults\-file\fR +option that specifies a different file. On Windows, the standard file is +\fImy.ini\fR +in the directory where Instance Manager is installed. On Unix, the standard file is +\fI/etc/my.cnf\fR. +.PP +Instance Manager reads options for itself from the +[manager] +section of the configuration file, and options for server instances from +[mysqld] +or +[mysqld\fIN\fR] +sections. The +[manager] +section contains any of the options listed in +the section called \(lqMYSQL INSTANCE MANAGER COMMAND OPTIONS\(rq, except for those specified as having to be given as the first option on the command line. Here is a sample +[manager] +section: +.sp +.RS 3n +.nf +# MySQL Instance Manager options section +[manager] +default\-mysqld\-path = /usr/local/mysql/libexec/mysqld +socket=/tmp/manager.sock +pid\-file=/tmp/manager.pid +password\-file = /home/cps/.mysqlmanager.passwd +monitoring\-interval = 2 +port = 1999 +bind\-address = 192.168.1.5 +.fi +.RE +.PP +Each +[mysqld] +or +[mysqld\fIN\fR] +instance section specifies options given by Instance Manager to a server instance at startup. These are mainly common MySQL Server options (see +Section\ 5.1.2, \(lqServer Command Options\(rq). In addition, a +[mysqld\fIN\fR] +section can contain the options in the following list, which are specific to Instance Manager. These options are interpreted by Instance Manager itself; it does not pass them to the server when it attempts to start that server. +.sp +.it 1 an-trap +.nr an-no-space-flag 1 +.nr an-break-flag 1 +.br +\fBWarning\fR +.PP +The Instance Manager\-specific options must not be used in a +[mysqld] +section. If a server is started without using Instance Manager, it will not recognize these options and will fail to start properly. +.TP 3n +\(bu +mysqld\-path = \fIpath\fR +.sp +The path name of the +\fBmysqld\fR +server binary to use for the server instance. +.TP 3n +\(bu +nonguarded +.sp +This option disables Instance Manager monitoring functionality for the server instance. By default, an instance is guarded: At Instance Manager start time, it starts the instance. It also monitors the instance status and attempts to restart it if it fails. At Instance Manager exit time, it stops the instance. None of these things happen for nonguarded instances. +.TP 3n +\(bu +shutdown\-delay = \fIseconds\fR +.sp +The number of seconds Instance Manager should wait for the server instance to shut down. The default value is 35 seconds. After the delay expires, Instance Manager assumes that the instance is hanging and attempts to terminate it. If you use +InnoDB +with large tables, you should increase this value. +.sp +.RE +.PP +Here are some sample instance sections: +.sp +.RS 3n +.nf +[mysqld1] +mysqld\-path=/usr/local/mysql/libexec/mysqld +socket=/tmp/mysql.sock +port=3307 +server_id=1 +skip\-stack\-trace +core\-file +log\-bin +log\-error +log=mylog +log\-slow\-queries +[mysqld2] +nonguarded +port=3308 +server_id=2 +mysqld\-path= /home/cps/mysql/trees/mysql\-5.1/sql/mysqld +socket = /tmp/mysql.sock5 +pid\-file = /tmp/hostname.pid5 +datadir= /home/cps/mysql_data/data_dir1 +language=/home/cps/mysql/trees/mysql\-5.1/sql/share/english +log\-bin +log=/tmp/fordel.log +.fi +.RE +.SH "STARTING THE MYSQL SERVER WITH MYSQL INSTANCE MANAGER" +.sp +.it 1 an-trap +.nr an-no-space-flag 1 +.nr an-break-flag 1 +.br +\fBImportant\fR +.PP +MySQL Instance Manager has been deprecated and is removed in MySQL 6.0. +.PP +This section discusses how Instance Manager starts server instances when it starts. However, before you start Instance Manager, you should set up a password file for it. Otherwise, you will not be able to connect to Instance Manager to control it after it starts. For details about creating Instance Manager accounts, see +the section called \(lqINSTANCE MANAGER USER AND PASSWORD MANAGEMENT\(rq. +.PP +On Unix, the +\fBmysqld\fR +MySQL database server normally is started with the +\fBmysql.server\fR +script, which usually resides in the +/etc/init.d/ +folder. That script invokes the +\fBmysqld_safe\fR +script by default. However, you can use Instance Manager instead if you modify the +\fI/etc/my.cnf\fR +configuration file by adding +use\-manager +to the +[mysql.server] +section: +.sp +.RS 3n +.nf +[mysql.server] +use\-manager +.fi +.RE +.PP +Before MySQL 5.1.12, Instance Manager always tries to start at least one server instance: When it starts, it reads its configuration file if it exists to find server instance sections and prepare a list of instances. Instance sections have names of the form +[mysqld] +or +[mysqld\fIN\fR], where +\fIN\fR +is an unsigned integer (for example, +[mysqld1], +[mysqld2], and so forth). +.PP +After preparing the list of instances, Instance Manager starts the guarded instances in the list. If there are no instances, Instance Manager creates an instance named +mysqld +and attempts to start it with default (compiled\-in) configuration values. This means that the Instance Manager cannot find the +\fBmysqld\fR +program if it is not installed in the default location. (Section\ 2.1.5, \(lqInstallation Layouts\(rq, describes default locations for components of MySQL distributions.) If you have installed the MySQL server in a non\-standard location, you should create the Instance Manager configuration file. +.PP +The startup behavior just described is similar to that of +\fBmysqld_safe\fR, which always attempts to start a server. However, it lacks the flexibility required for some operations because it is not possible to run Instance Manager in such a way that it refrains from starting any server instances. For example, you cannot invoke Instance Manager for the purpose of configuring an instance without also starting it (a task that a MySQL installer application might want to perform). Consequently, MySQL 5.1.12 introduces the following changes: +.TP 3n +\(bu +A new option, +\fB\-\-mysqld\-safe\-compatible\fR, may be used to cause Instance Manager to run with startup behavior similar to that used before MySQL 5.1.12: If Instance Manager finds a +[mysqld] +instance section in the configuration file, it will start it. If Instance Manager finds no +[mysqld] +section, it creates one using default configuration values, writes a +[mysqld] +section to the configuration file if it is accessible, and starts the +mysqld +instance. Instance Manager also starts any other guarded instances listed in the configuration file. +.TP 3n +\(bu +Without +\fB\-\-mysqld\-safe\-compatible\fR, Instance Manager reads its configuration file if it exists and starts instances for any guarded instance sections that it finds. If there are none, it starts no instances. +.sp +.RE +.PP +Instance Manager also stops all guarded server instances when it shuts down. +.PP +The allowable options for +[mysqld\fIN\fR] +server instance sections are described in +the section called \(lqMYSQL INSTANCE MANAGER CONFIGURATION FILES\(rq. In these sections, you can use a special +\fBmysqld\-path=\fR\fB\fIpath\-to\-mysqld\-binary\fR\fR +option that is recognized only by Instance Manager. Use this option to let Instance Manager know where the +\fBmysqld\fR +binary resides. If there are multiple instances, it may also be necessary to set other options such as +\fBdatadir\fR +and +\fBport\fR, to ensure that each instance has a different data directory and TCP/IP port number. +Section\ 5.6, \(lqRunning Multiple MySQL Servers on the Same Machine\(rq, discusses the configuration values that must differ for each instance when you run multiple instance on the same machine. +.sp +.it 1 an-trap +.nr an-no-space-flag 1 +.nr an-break-flag 1 +.br +\fBWarning\fR +.PP +The +[mysqld] +instance section, if it exists, must not contain any Instance Manager\-specific options. +.PP +The typical Unix startup/shutdown cycle for a MySQL server with the MySQL Instance Manager enabled is as follows: +.TP 3n +1. +The +\fB/etc/init.d/mysql\fR +script starts MySQL Instance Manager. +.TP 3n +2. +Instance Manager starts the guarded server instances and monitors them. +.TP 3n +3. +If a server instance fails, Instance Manager restarts it. +.TP 3n +4. +If Instance Manager is shut down (for example, with the +\fB/etc/init.d/mysql stop\fR +command), it shuts down all server instances. +.SH "INSTANCE MANAGER USER AND PASSWORD MANAGEMENT" +.sp +.it 1 an-trap +.nr an-no-space-flag 1 +.nr an-break-flag 1 +.br +\fBImportant\fR +.PP +MySQL Instance Manager has been deprecated and is removed in MySQL 6.0. +.PP +The Instance Manager stores its user information in a password file. On Windows, the default is +\fImysqlmanager.passwd\fR +in the directory where Instance Manager is installed. On Unix, the default file is +\fI/etc/mysqlmanager.passwd\fR. To specify a different location for the password file, use the +\fB\-\-password\-file\fR +option. +.PP +If the password file does not exist or contains no password entries, you cannot connect to the Instance Manager. +.sp +.it 1 an-trap +.nr an-no-space-flag 1 +.nr an-break-flag 1 +.br +\fBNote\fR +.PP +Any Instance Manager process that is running to monitor server instances does not notice changes to the password file. You must stop it and restart it after making password entry changes. +.PP +Entries in the password file have the following format, where the two fields are the account user name and encrypted password, separated by a colon: +.sp +.RS 3n +.nf +petr:*35110DC9B4D8140F5DE667E28C72DD2597B5C848 +.fi +.RE +.PP +Instance Manager password encryption is the same as that used by MySQL Server. It is a one\-way operation; no means are provided for decrypting encrypted passwords. +.PP +Instance Manager accounts differ somewhat from MySQL Server accounts: +.TP 3n +\(bu +MySQL Server accounts are associated with a host name, user name, and password (see +Section\ 5.5.1, \(lqUser Names and Passwords\(rq). +.TP 3n +\(bu +Instance Manager accounts are associated with a user name and password only. +.sp +.RE +.PP +This means that a client can connect to Instance Manager with a given user name from any host. To limit connections so that clients can connect only from the local host, start Instance Manager with the +\fB\-\-bind\-address=127.0.0.1\fR +option so that it listens only to the local network interface. Remote clients will not be able to connect. Local clients can connect like this: +.sp +.RS 3n +.nf +shell> \fBmysql \-h 127.0.0.1 \-P 2273\fR +.fi +.RE +.PP +Before MySQL 5.1.12, the only option for creating password file entries is +\fB\-\-passwd\fR, which causes Instance Manager to prompt for user name and password values and display the resulting entry. You can save the output in the +\fI/etc/mysqlmanager.passwd\fR +password file to store it. Here is an example: +.sp +.RS 3n +.nf +shell> \fBmysqlmanager \-\-passwd >> /etc/mysqlmanager.passwd\fR +Creating record for new user. +Enter user name: \fBmike\fR +Enter password: \fBmikepass\fR +Re\-type password: \fBmikepass\fR +.fi +.RE +.PP +At the prompts, enter the user name and password for the new Instance Manager user. You must enter the password twice. It does not echo to the screen, so double entry guards against entering a different password than you intend (if the two passwords do not match, no entry is generated). +.PP +The preceding command causes the following line to be added to +\fI/etc/mysqlmanager.passwd\fR: +.sp +.RS 3n +.nf +mike:*BBF1F551DD9DD96A01E66EC7DDC073911BAD17BA +.fi +.RE +.PP +Use of the +\fB\-\-password\fR +option fails if +\fBmysqlmanager\fR +is invoked directly from an IBM 5250 terminal. To work around this, use a command like the following from the command line to generate the password entry: +.sp +.RS 3n +.nf +shell< \fBmysql \-B \-\-skip\-column\-name \\\fR + \fB\-e 'SELECT CONCAT("\fR\fB\fIuser_name\fR\fR\fB",":",PASSWORD("\fR\fB\fIpass_val\fR\fR\fB"));'\fR +.fi +.RE +.PP +The output from the command can be used an entry in the +\fI/etc/mysqlmanager.passwd\fR +file. +.PP +Beginning with MySQL 5.1.12, the +\fB\-\-passwd\fR +option is renamed to +\fB\-\-print\-password\-line\fR +and there are several other options for managing user accounts from the command line. For example, the +\fB\-\-username\fR +and +\fB\-\-password\fR +options are available on the command line for specifying the user name and password for an account entry. You can use them to generate an entry with no prompting like this (type the command on a single line): +.sp +.RS 3n +.nf +shell> \fBmysqlmanager \-\-print\-password\-line\fR + \fB\-\-username=mike \-\-password=mikepass >> /etc/mysqlmanager.passwd\fR +.fi +.RE +.PP +If you omit the +\fB\-\-username\fR +or +\fB\-\-password\fR +option, Instance Manager prompts for the required value. +.PP +\fB\-\-print\-password\-line\fR +causes Instance Manager to send the resulting account entry to its output, which you can append to the password file. The following list describes other account\-management options that cause Instance Manager to operate directly on the password file. (These options make Instance Manager scriptable for account\-management purposes.) For operations on the password file to succeed, the file must exist and it must be accessible by Instance Manager. (The exception is +\fB\-\-clean\-password\-file\fR, which creates the file if it does not exist. Alternatively, if there is no password file, manually create it as an empty file and ensure that its ownership and access modes allow it to be read and written by Instance Manager.) The default password file is used unless you specify a +\fB\-\-password\-file\fR +option. +.PP +To ensure consistent treatment of the password file, it should be owned by the system account that you use for running Instance Manager to manage server instances, and you should invoke it from that account when you use it to manage accounts in the password file. +.TP 3n +\(bu +Create a new user: +.sp +.RS 3n +.nf +mysqlmanager \-\-add\-user \-\-username=\fIuser_name\fR [\-\-password=\fIpassword\fR] +.fi +.RE +This command adds a new entry with the given user name and password to the password file. The +\fB\-\-username\fR +(or +\fB\-u\fR) option is required. +\fBmysqlmanager\fR +prompts for the password if it is not given on the command line with the +\fB\-\-password\fR +(or +\fB\-p\fR) option. The command fails if the user already exists. +.TP 3n +\(bu +Drop an existing user: +.sp +.RS 3n +.nf +mysqlmanager \-\-drop\-user \-\-username=\fIuser_name\fR +.fi +.RE +This command removes the entry with the given user name from the password file. The user name is required. The command fails if the user does not exist. +.TP 3n +\(bu +Change the password for an existing user: +.sp +.RS 3n +.nf +mysqlmanager \-\-edit\-user \-\-username=\fIuser_name\fR [\-\-password=\fIpassword\fR] +.fi +.RE +This command changes the given user's password in the password file. The user name is required. +\fBmysqlmanager\fR +prompts for the password it is not given on the command line. The command fails if the user does not exist. +.TP 3n +\(bu +List existing users: +.sp +.RS 3n +.nf +mysqlmanager \-\-list\-users +.fi +.RE +This command lists the user names of the accounts in the password file. +.TP 3n +\(bu +Check the password file: +.sp +.RS 3n +.nf +mysqlmanager \-\-check\-password\-file +.fi +.RE +This command performs a consistency and validity check of the password file. The command fails if there is something wrong with the file. +.TP 3n +\(bu +Empty the password file: +.sp +.RS 3n +.nf +mysqlmanager \-\-clean\-password\-file +.fi +.RE +This command empties the password file, which has the effect of dropping all users listed in it. The option creates the password file if it does not exist, so it can be used to initialize a new password file to be used for other account\-management operations. Take care not to use this option to reinitialize a file containing accounts that you do not want to drop. +.SH "MYSQL SERVER INSTANCE STATUS MONITORING" +.sp +.it 1 an-trap +.nr an-no-space-flag 1 +.nr an-break-flag 1 +.br +\fBImportant\fR +.PP +MySQL Instance Manager has been deprecated and is removed in MySQL 6.0. +.PP +To monitor the status of each guarded server instance, the MySQL Instance Manager attempts to connect to the instance at regular intervals using the +MySQL_Instance_Manager@localhost +user account with a password of +check_connection. +.PP +You are +\fInot\fR +required to create this account for MySQL Server; in fact, it is expected that it will not exist. Instance Manager can tell that a server is operational if the server accepts the connection attempt but refuses access for the account by returning a login error. However, these failed connection attempts are logged by the server to its general query log (see +Section\ 5.2.3, \(lqThe General Query Log\(rq). +.PP +Instance Manager also attempts a connection to nonguarded server instances when you use the +SHOW INSTANCES +or +SHOW INSTANCE STATUS +command. This is the only status monitoring done for nonguarded instances. +.PP +Instance Manager knows if a server instance fails at startup because it receives a status from the attempt. For an instance that starts but later crashes, Instance Manager receives a signal because it is the parent process of the instance. +.PP +Beginning with MySQL 5.1.12, Instance Manager tracks instance states so that it can determine which commands are allowed for each instance. For example, commands that modify an instance's configuration are allowed only while the instance is offline. +.PP +Each instance is in one of the states described in the following table. Guarded instances can be in any of the states. Nonguarded instances can only be offline or online. Instance state information is displayed in the +status +column of the +SHOW INSTANCES +and +SHOW INSTANCE STATUS +commands. +.TS +allbox tab(:); +l l +l l +l l +l l +l l +l l +l l +l l. +T{ +\fBState\fR +T}:T{ +\fBMeaning\fR +T} +T{ +offline +T}:T{ +The instance has not been started and is not running. +T} +T{ +starting +T}:T{ +The instance is starting (initializing). Nonguarded instances cannot be + in this state. A nonguarded instance goes directly from + offline to online. +T} +T{ +stopping +T}:T{ +The instance is stopping. Nonguarded instances cannot be in this state. + A nonguarded instance goes directly from online to + offline, or stays offline if startup fails. +T} +T{ +online +T}:T{ +The instance has started and is running. +T} +T{ +failed +T}:T{ +The instance was online but it crashed and is being restarted by + Instance Manager, or else the instance failed to start + at all and Instance Manager is again attempting to start + it. Nonguarded instances cannot be in this state. +T} +T{ +crashed +T}:T{ +Instance Manager failed to start the instance after several attempts. + (Instance Manager will try again later.) Nonguarded + instances cannot be in this state. +T} +T{ +abandoned +T}:T{ +Instance Manager was not able to start the instance, has given up, and + will make no further attempts until instructed + otherwise. To tell Instance Manager to try again, you + must first use STOP INSTANCE to put + the instance in offline state, and then use + START INSTANCE to start the instance. + If it is necessary to make configuration changes for the + instance, you must do so after putting the instance + offline and before starting it. (Instance Manager + accepts configuration\-changing commands only for offline + instances.) Nonguarded instances cannot be in this + state. +T} +.TE +.sp +.SH "CONNECTING TO MYSQL INSTANCE MANAGER" +.sp +.it 1 an-trap +.nr an-no-space-flag 1 +.nr an-break-flag 1 +.br +\fBImportant\fR +.PP +MySQL Instance Manager has been deprecated and is removed in MySQL 6.0. +.PP +After you set up a password file for the MySQL Instance Manager and Instance Manager is running, you can connect to it. The MySQL client\-server protocol is used to communicate with the Instance Manager. For example, you can connect to it using the standard +\fBmysql\fR +client program: +.sp +.RS 3n +.nf +shell> \fBmysql \-\-port=2273 \-\-host=im.example.org \-\-user=mysql \-\-password\fR +.fi +.RE +.PP +Instance Manager supports the version of the MySQL client\-server protocol used by the client tools and libraries distributed with MySQL 4.1 or later, so other programs that use the MySQL C API also can connect to it. +.SH "MYSQL INSTANCE MANAGER COMMANDS" +.sp +.it 1 an-trap +.nr an-no-space-flag 1 +.nr an-break-flag 1 +.br +\fBImportant\fR +.PP +MySQL Instance Manager has been deprecated and is removed in MySQL 6.0. +.PP +After you connect to MySQL Instance Manager, you can issue commands. The following general principles apply to Instance Manager command execution: +.TP 3n +\(bu +Commands that take an instance name fail if the name is not a valid instance name. +.TP 3n +\(bu +Commands that take an instance name (other than +CREATE INSTANCE) fail if the instance does not exist. +.TP 3n +\(bu +As of MySQL 5.1.12, commands for an instance require that the instance be in an appropriate state. You cannot configure or start an instance that is not offline. You cannot start an instance that is online. +.TP 3n +\(bu +Instance Manager maintains information about instance configuration in an internal (in\-memory) cache. Initially, this information comes from the configuration file if it exists, but some commands change the configuration of an instance. Commands that modify the configuration file fail if the file does not exist or is not accessible to Instance Manager. +.sp +As of MySQL 5.1.12, configuration\-changing commands modify both the in\-memory cache and the server instance section recorded in the configuration file to maintain consistency between them. For this to occur, the instance must be offline and the configuration file must be accessible and not malformed. If the configuration file cannot be updated, the command fails and the cache remains unchanged. +.TP 3n +\(bu +On Windows, the standard file is +\fImy.ini\fR +in the directory where Instance Manager is installed. On Unix, the standard configuration file is +\fI/etc/my.cnf\fR. To specify a different configuration file, start Instance Manager with the +\fB\-\-defaults\-file\fR +option. +.TP 3n +\(bu +If a +[mysqld] +instance section exists in the configuration file, it must not contain any Instance Manager\-specific options (see +the section called \(lqMYSQL INSTANCE MANAGER CONFIGURATION FILES\(rq). Therefore, you must not add any of these options if you change the configuration for an instance named +mysqld. +.sp +.RE +.PP +The following list describes the commands that Instance Manager accepts, with examples. +.TP 3n +\(bu +CREATE INSTANCE \fIinstance_name\fR [\fIoption_name\fR[=\fIoption_value\fR], ...] +.sp +This command configures a new instance by creating an +[\fIinstance_name\fR] +section in the configuration file. The command fails if +\fIinstance_name\fR +is not a valid instance name or the instance already exists. +.sp +The created section instance is empty if no options are given. Otherwise, the options are added to the section. Options should be given in the same format used when you write options in option files. (See +Section\ 4.2.3.2, \(lqUsing Option Files\(rq +for a description of the allowable syntax.) If you specify multiple options, separate them by commas. +.sp +For example, to create an instance section named +[mysqld98], you might write something like this were you to modify the configuration file directly: +.sp +.RS 3n +.nf +[mysqld98] +basedir=/var/mysql98 +.fi +.RE +To achieve the same effect via +CREATE INSTANCE, issue this command to Instance Manager: +.sp +.RS 3n +.nf +mysql> \fBCREATE INSTANCE mysqld98 basedir="/var/mysql98";\fR +Query OK, 0 rows affected (0,00 sec) +.fi +.RE +CREATE INSTANCE +creates the instance but does not start it. +.sp +If the instance name is the (deprecated) name +mysqld, the option list cannot include any options that are specific to Instance Manager, such as +nonguarded +(see +the section called \(lqMYSQL INSTANCE MANAGER CONFIGURATION FILES\(rq). +.sp +This command was added in MySQL 5.1.12. +.TP 3n +\(bu +DROP INSTANCE \fIinstance_name\fR +.sp +This command removes the configuration for +\fIinstance_name\fR +from the configuration file. +.sp +.RS 3n +.nf +mysql> \fBDROP INSTANCE mysqld98;\fR +Query OK, 0 rows affected (0,00 sec) +.fi +.RE +The command fails if +\fIinstance_name\fR +is not a valid instance name, the instance does not exist, or is not offline. +.sp +This command was added in MySQL 5.1.12. +.TP 3n +\(bu +START INSTANCE \fIinstance_name\fR +.sp +This command attempts to start an offline instance. The command is asynchronous; it does not wait for the instance to start. +.sp +.RS 3n +.nf +mysql> \fBSTART INSTANCE mysqld4;\fR +Query OK, 0 rows affected (0,00 sec) +.fi +.RE +.TP 3n +\(bu +STOP INSTANCE \fIinstance_name\fR +.sp +This command attempts to stop an instance. The command is synchronous; it waits for the instance to stop. +.sp +.RS 3n +.nf +mysql> \fBSTOP INSTANCE mysqld4;\fR +Query OK, 0 rows affected (0,00 sec) +.fi +.RE +.TP 3n +\(bu +SHOW INSTANCES +.sp +Shows the names and status of all loaded instances. +.sp +.RS 3n +.nf +mysql> \fBSHOW INSTANCES;\fR ++\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-+ +| instance_name | status | ++\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-+ +| mysqld3 | offline | +| mysqld4 | online | +| mysqld2 | offline | ++\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-+ +.fi +.RE +.TP 3n +\(bu +SHOW INSTANCE STATUS \fIinstance_name\fR +.sp +Shows status and version information for an instance. +.sp +.RS 3n +.nf +mysql> \fBSHOW INSTANCE STATUS mysqld3;\fR ++\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-+ +| instance_name | status | version | ++\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-+ +| mysqld3 | online | unknown | ++\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-+ +.fi +.RE +.TP 3n +\(bu +SHOW INSTANCE OPTIONS \fIinstance_name\fR +.sp +Shows the options used by an instance. +.sp +.RS 3n +.nf +mysql> \fBSHOW INSTANCE OPTIONS mysqld3;\fR ++\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+ +| option_name | value | ++\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+ +| instance_name | mysqld3 | +| mysqld\-path | /home/cps/mysql/trees/mysql\-4.1/sql/mysqld | +| port | 3309 | +| socket | /tmp/mysql.sock3 | +| pid\-file | hostname.pid3 | +| datadir | /home/cps/mysql_data/data_dir1/ | +| language | /home/cps/mysql/trees/mysql\-4.1/sql/share/english | ++\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+ +.fi +.RE +.TP 3n +\(bu +SHOW \fIinstance_name\fR LOG FILES +.sp +The command lists all log files used by the instance. The result set contains the path to the log file and the log file size. If no log file path is specified in the instance section of the configuration file (for example, +log=/var/mysql.log), the Instance Manager tries to guess its placement. If Instance Manager is unable to guess the log file placement you should specify the log file location explicitly by using a log option in the appropriate instance section of the configuration file. +.sp +.RS 3n +.nf +mysql> \fBSHOW mysqld LOG FILES;\fR ++\-\-\-\-\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-\-+ +| Logfile | Path | Filesize | ++\-\-\-\-\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-\-+ +| ERROR LOG | /home/cps/var/mysql/owlet.err | 9186 | +| GENERAL LOG | /home/cps/var/mysql/owlet.log | 471503 | +| SLOW LOG | /home/cps/var/mysql/owlet\-slow.log | 4463 | ++\-\-\-\-\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-\-+ +.fi +.RE +SHOW ... LOG FILES +displays information only about log files. If a server instance uses log tables (see +Section\ 5.2.1, \(lqSelecting General Query and Slow Query Log Output Destinations\(rq), no information about those tables is shown. +.sp +Log options are described in +Section\ 5.1.2, \(lqServer Command Options\(rq. +.TP 3n +\(bu +SHOW \fIinstance_name\fR LOG {ERROR | SLOW | GENERAL} \fIsize\fR[,\fIoffset_from_end\fR] +.sp +This command retrieves a portion of the specified log file. Because most users are interested in the latest log messages, the +\fIsize\fR +parameter defines the number of bytes to retrieve from the end of the log. To retrieve data from the middle of the log file, specify the optional +\fIoffset_from_end\fR +parameter. The following example retrieves 21 bytes of data, starting 23 bytes before the end of the log file and ending 2 bytes before the end: +.sp +.RS 3n +.nf +mysql> \fBSHOW mysqld LOG GENERAL 21, 2;\fR ++\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+ +| Log | ++\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+ +| using password: YES | ++\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+ +.fi +.RE +.TP 3n +\(bu +SET \fIinstance_name\fR.\fIoption_name\fR[=\fIoption_value\fR] +.sp +This command edits the specified instance's configuration section to change or add instance options. The option is added to the section is it is not already present. Otherwise, the new setting replaces the existing one. +.sp +.RS 3n +.nf +mysql> \fBSET mysqld2.port=3322;\fR +Query OK, 0 rows affected (0.00 sec) +.fi +.RE +As of MySQL 5.1.12, you can specify multiple options (separated by commas), and +SET +can be used only for offline instances. Each option must indicate the instance name: +.sp +.RS 3n +.nf +mysql> \fBSET mysqld2.port=3322, mysqld3.nonguarded;\fR +Query OK, 0 rows affected (0.00 sec) +.fi +.RE +Before MySQL 5.1.12, only a single option can be specified. Also, changes made to the configuration file do not take effect until the MySQL server is restarted. In addition, these changes are not stored in the instance manager's local cache of instance settings until a +FLUSH INSTANCES +command is executed. +.TP 3n +\(bu +UNSET \fIinstance_name\fR.\fIoption_name\fR +.sp +This command removes an option from an instance's configuration section. +.sp +.RS 3n +.nf +mysql> \fBUNSET mysqld2.port;\fR +Query OK, 0 rows affected (0.00 sec) +.fi +.RE +As of MySQL 5.1.12, you can specify multiple options (separated by commas), and +UNSET +can be used only for offline instances. Each option must indicate the instance name: +.sp +.RS 3n +.nf +mysql> \fBUNSET mysqld2.port, mysqld4.nonguarded;\fR +Query OK, 0 rows affected (0.00 sec) +.fi +.RE +Before MySQL 5.1.12, only a single option can be specified. Also, changes made to the configuration file do not take effect until the MySQL server is restarted. In addition, these changes are not stored in the instance manager's local cache of instance settings until a +FLUSH INSTANCES +command is executed. +.TP 3n +\(bu +FLUSH INSTANCES +.sp +As of MySQL 5.1.12, +FLUSH INSTANCES +cannot be used unless all instances are offline. The command causes Instance Manager to reread the configuration file, update its in\-memory configuration cache, and start any guarded instances. +.sp +Before MySQL 5.1.12, this command forces Instance Manager reread the configuration file and to refresh internal structures. This command should be performed after editing the configuration file. The command does not restart instances. +.sp +.RS 3n +.nf +mysql> \fBFLUSH INSTANCES;\fR +Query OK, 0 rows affected (0.04 sec) +.fi +.RE +.SH "COPYRIGHT" +.PP +Copyright 2007\-2008 MySQL AB, 2009 Sun Microsystems, Inc. +.PP +This documentation is free software; you can redistribute it and/or modify it only under the terms of the GNU General Public License as published by the Free Software Foundation; version 2 of the License. +.PP +This documentation is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. +.PP +You should have received a copy of the GNU General Public License along with the program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110\-1301 USA or see http://www.gnu.org/licenses/. +.SH "SEE ALSO" +For more information, please refer to the MySQL Reference Manual, +which may already be installed locally and which is also available +online at http://dev.mysql.com/doc/. +.SH AUTHOR +MySQL AB (http://www.mysql.com/). === added file 'man/mysqlshow.1' --- a/man/mysqlshow.1 1970-01-01 00:00:00 +0000 +++ b/man/mysqlshow.1 2009-05-25 09:59:47 +0000 @@ -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/). === added file 'man/mysqlslap.1' --- a/man/mysqlslap.1 1970-01-01 00:00:00 +0000 +++ b/man/mysqlslap.1 2009-05-25 09:59:47 +0000 @@ -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/). === added file 'man/mysqltest.1' --- a/man/mysqltest.1 1970-01-01 00:00:00 +0000 +++ b/man/mysqltest.1 2009-05-25 09:59:47 +0000 @@ -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/). === added file 'man/mysqltest_embedded.1' --- a/man/mysqltest_embedded.1 1970-01-01 00:00:00 +0000 +++ b/man/mysqltest_embedded.1 2009-05-25 09:59:47 +0000 @@ -0,0 +1 @@ +.so man1/mysqltest.1 === added file 'man/ndbd.8' --- a/man/ndbd.8 1970-01-01 00:00:00 +0000 +++ b/man/ndbd.8 2009-05-25 09:59:47 +0000 @@ -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/). === added file 'man/ndbd_redo_log_reader.1' --- a/man/ndbd_redo_log_reader.1 1970-01-01 00:00:00 +0000 +++ b/man/ndbd_redo_log_reader.1 2009-05-25 09:59:47 +0000 @@ -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/). === added file 'man/ndbmtd.8' --- a/man/ndbmtd.8 1970-01-01 00:00:00 +0000 +++ b/man/ndbmtd.8 2009-05-25 09:59:47 +0000 @@ -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/). === added file 'man/perror.1' --- a/man/perror.1 1970-01-01 00:00:00 +0000 +++ b/man/perror.1 2009-05-25 09:59:47 +0000 @@ -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/). === added file 'man/replace.1' --- a/man/replace.1 1970-01-01 00:00:00 +0000 +++ b/man/replace.1 2009-05-25 09:59:47 +0000 @@ -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/). === added file 'man/resolve_stack_dump.1' --- a/man/resolve_stack_dump.1 1970-01-01 00:00:00 +0000 +++ b/man/resolve_stack_dump.1 2009-05-25 09:59:47 +0000 @@ -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/). === added file 'man/resolveip.1' --- a/man/resolveip.1 1970-01-01 00:00:00 +0000 +++ b/man/resolveip.1 2009-05-25 09:59:47 +0000 @@ -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 address