oak-prepare-shutdown: openark kit documentation

oak-prepare-shutdown

NAME

oak-prepare-shutdown: make for a fast and safe MySQL shutdown

SYNOPSIS

Prepare and shutdown the MySQL server:

oak-prepare-shutdown --user=root --ask-pass --socket=/tmp/mysql.sock && /etc/init.d/mysql stop

Prepare and shutdown the MySQL server, RedHat style:

oak-prepare-shutdown --user=root --ask-pass --socket=/tmp/mysql.sock && service mysql stop

Same as above, use defaults file:

oak-prepare-shutdown --defaults-file=/home/myuser/.my-oak.cnf && service mysql stop

DESCRIPTION

This tools makes for a faster and safe shutdown process:

It flushes InnoDB buffer pool pages until no further progress can be achieved for the duration of 10 consequent seconds
When server acts as a slave, it gracefully stops replication while verifying no slave temporary tables remain open

Flushing of InnoDB pages is performed by setting innodb_max_dirty_pages_pct to 0. InnoDB follows by attempting to reach that target. On an active server, it will most probably never reach 0. oak-prepare-shutdown follows up on the rate of page flush, and terminates when it concludes no more gain is expected.

Interrupting this tool with Ctrl-C results with restoring original settings and termination with error.

Any abnormal termination of this tools results with innodb_max_dirty_pages_pct still being set to 0. This may seriously degrade the performance of your running database. Make sure to manually restore to original settings, e.g. via:

mysql> SET GLOBAL innodb_max_dirty_pages_pct = 90;

OPTIONS

--ask-pass

Prompt for password.

--debug

Print stack trace on error.

--defaults-file=DEFAULTS_FILE

Read from MySQL configuration file. Overrides --user, --password, --socket, --port.

Configuration needs to be in the following format:

[client]
user=my_user
password=my_pass
socket=/tmp/mysql.sock
port=3306

-H HOST, --host=HOST

MySQL host (default: localhost)

-p PASSWORD, --password=PASSWORD

MySQL password

-P PORT, --port=PORT

TCP/IP port (default: 3306)

-S SOCKET, --socket=SOCKET

MySQL socket file. Only applies when host is localhost

-u USER, --user=USER

MySQL user

-v, --verbose

Print user friendly messages

ENVIRONMENT

Requires MySQL 5.0 or newer, python 2.3 or newer. python-mysqldb must be installed in order to use this tool. You can

apt-get install python-mysqldb

yum install mysql-python

LICENSE

This tool is released under the BSD license.

Copyright (c) 2008 - 2010, Shlomi Noach
All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
* Neither the name of the organization nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 
A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR 
TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

AUTHOR

Shlomi Noach

openark kit documentation

openark kit documentation