MySQL in a Nutshell, 2nd Edition

Name

mysqlbinlog

Synopsis

mysqlbinlog [options] filename

This utility formats the display of the binary log for a MySQL server. Customized applications can also use it for monitoring server activities. The path to the log file to format is given as the second argument for the utility. Additional log files may be given either with filesystem wildcards or by listing them individually, separated by spaces.

Here is an alphabetical list of the options, along with a brief explanation of each:

--base64-output: This option is used to write binary log entries using base-64 encoding. This is used for debugging and should not be used in production. It’s available as of version 5.1.5 of MySQL.
--character-sets-dir=path: This option specifies the directory containing character sets.
--database=database, -d database: This option displays information regarding only the database given.
--debug[=options], -# [options]: This option logs debugging information, along with various settings (e.g., 'd:t:o,logname').
--debug-check: This option writes debugging information to the log when the utility ends. It’s available as of version 5.1.21 of MySQL.
--debug-info: This option writes debugging information and CPU and memory usage information to the log after the utility ends.
--disable-log-bin, -D: This option disables binary logging.
--force-read, -f: This option forces the reading of unknown log information.
--hexdump, -H: This option dumps the log in hexadecimal format.
--help, -?: This option displays basic help information.
--host=host, -h host: This option specifies the hostname or IP address of a remote server containing the log file to format.
--local-load=path, -l path: This option specifies the local directory in which temporary files are to be prepared for LOAD DATA INFILE statements.
--offset=number, -o number: This option skips number entries at the start of the log file before starting the display.
--open_files_limit: This option sets the maximum number of open files allowed. The default is 64.
--password=password, -p password: This option provides the password to the remote server that is being accessed.
--port=port, -P port: This option specifies the port to use for connecting to a remote server.
--position=number, -j number: This option sets the number of bytes to skip at the beginning of the log file. It is deprecated; use --start-position instead.
--protocol=protocol: This option specifies the protocol to use when connecting to the server. The choices are TCP, SOCKET, PIPE, and MEMORY.
--read-from-remote-server, -R: This option reads the binary log from a remote server instead of the local machine. You will need to include the necessary options for connecting to a remote server: --host, --password, and --user. You might also need to include --port, --protocol, and --socket.
--result-file=filename, -r filename: This option redirects the results of the utility to a given file.
--server-id=identifier: This option returns entries from the binary log that were generated by a connection matching the given process identifier number. This option is available as of version 5.1.4 of MySQL.
--set-charset=character_set: This option adds a SET NAMES statement to the results to indicate the character set used. It is available as of version 5.1.12 of MySQL.
--skip-write-binlog: This option disables the --write-binlog option, which is enabled by default. Otherwise, ANALYZE TABLE, OPTIMIZE TABLE, and REPAIR TABLE statements executed by the utility will be written to the binary log. It’s available as of version 5.1.18 of MySQL.
--short-form, -s: This option changes the output to a shorter format.
--socket=filename, -S filename: This option provides the name of the server’s socket file for Unix systems, piped name for Windows systems.
--start-datetime=datetime: This option begins reading the log from the first event recorded with a date and time equal to or greater than the one given. The time can be in DATETIME or TIMESTAMP format. Use the time zone of the server.
--start-position=number: This option sets the position to start reading the log file.
--stop-datetime=datetime: This option instructs the utility to stop reading the log at the first event recorded with a date and time equal to or greater than the one given. The time can be in DATETIME or TIMESTAMP format. Use the time zone of the server.
--stop-position=number: This option sets the position to stop reading the log file.
--table=table, -t table: This option obtains information on the table named.
--to-last-log, -t: This option instructs the utility to continue on in sequence reading through all binary logs, starting with the one given until the last log file is processed.
--user=user, -u user: This option specifies the username to use when connecting to a remote server.
--version, -V: This option displays the version of the utility.
--write-binlog: With this option, ANALYZE TABLE, OPTIMIZE TABLE, and REPAIR TABLE statements executed by the utility will be written to the binary log. It’s available as of version 5.1.18 of MySQL and is enabled by default. To disable it, use --skip-write-binlog.

Table of Contents for MySQL in a Nutshell, 2nd Edition

Name

Synopsis

Table of Contents for
MySQL in a Nutshell, 2nd Edition