mysqlctl is a command-line client used for managing mysqld instances. It is responsible for bootstrapping tasks such as generating a configuration file for mysqld and initializing the instance and its data directory.

The mysqld_safe watchdog is utilized when present. This helps ensure that mysqld is automatically restarted after failures.

Commands #

init [--wait_time=5m] [--init_db_sql_file=(default)] #

Bootstraps a new mysqld instance, initializes its data directory, and starts the instance. The MySQL version and flavor will be auto-detected, with a minimal configuration file applied. For example:

export VTDATAROOT=/tmp
mysqlctl \
 --alsologtostderr \
 --tablet_uid 101 \
 --mysql_port 12345 \
 init

init_config #

Bootstraps the configuration for a new mysqld instance and initializes its data directory. This command is the same as init except the mysqld server will not be started. For example:

export VTDATAROOT=/tmp
mysqlctl \
 --alsologtostderr \
 --tablet_uid 101 \
 --mysql_port 12345 \
 init_config

reinit_config #

Regenerate new configuration files for an existing mysqld instance (generating new server_id and server_uuid values). This could be helpful to revert configuration changes, or to pick up changes made to the bundled config in newer Vitess versions. For example:

export VTDATAROOT=/tmp
mysqlctl \
 --alsologtostderr \
 --tablet_uid 101 \
 --mysql_port 12345 \
 reinit_config

teardown [--wait_time=5m] [--force] #

Shuts down a mysqld instance and removes its data directory. For example:

export VTDATAROOT=/tmp
mysqlctl --tablet_uid 101 --alsologtostderr teardown

start [--wait_time=5m] #

Resume an existing mysqld instance that was previously bootstrapped with init or init_config:

export VTDATAROOT=/tmp
mysqlctl --tablet_uid 101 --alsologtostderr start

shutdown [--wait_time=5m] #

Stop a mysqld instance that was previously started with init or start.

For large mysqld instances, you may need to extend the wait_time to shutdown cleanly.

export VTDATAROOT=/tmp
mysqlctl --tablet_uid 101 --alsologtostderr shutdown

Options #

The following global parameters apply to mysqlctl: