4.6.8. mysqlbinlog — Utility for Processing Binary Log Files

--help, -?

Display a help message and exit.

--base64-output=value

This option determines when events should be displayed encoded as base-64 strings using BINLOG statements. The option has these permissible values (not case sensitive):

For examples that show the effect of --base64-output and --verbose on row event output, see Section 4.6.8.2, "mysqlbinlog Row Event Display".

--bind-address=ip_address

On a computer having multiple network interfaces, this option can be used to select which interface is employed when connecting to the MySQL server.

--binlog-row-event-max-size=N

Specify the maximum size of a row-based binary log event, in bytes. Rows are grouped into events smaller than this size if possible. The value should be a multiple of 256. The default is 4GB.

--character-sets-dir=path

The directory where character sets are installed. See Section 10.5, "Character Set Configuration".

--database=db_name, -d db_name

This option causes mysqlbinlog to output entries from the binary log (local log only) that occur while db_name is been selected as the default database by USE.

The --database option for mysqlbinlog is similar to the --binlog-do-db option for mysqld, but can be used to specify only one database. If --database is given multiple times, only the last instance is used.

The effects of this option depend on whether the statement-based or row-based logging format is in use, in the same way that the effects of --binlog-do-db depend on whether statement-based or row-based logging is in use.

Statement-based logging. The --database option works as follows:

Suppose that the binary log was created by executing these statements using statement-based-logging:

INSERT INTO test.t1 (i) VALUES(100);INSERT INTO db2.t2 (j)  VALUES(200);USE test;INSERT INTO test.t1 (i) VALUES(101);INSERT INTO t1 (i)      VALUES(102);INSERT INTO db2.t2 (j)  VALUES(201);USE db2;INSERT INTO test.t1 (i) VALUES(103);INSERT INTO db2.t2 (j)  VALUES(202);INSERT INTO t2 (j)      VALUES(203);

mysqlbinlog --database=test does not output the first two INSERT statements because there is no default database. It outputs the three INSERT statements following USE test, but not the three INSERT statements following USE db2.

mysqlbinlog --database=db2 does not output the first two INSERT statements because there is no default database. It does not output the three INSERT statements following USE test, but does output the three INSERT statements following USE db2.

Row-based logging. mysqlbinlog outputs only entries that change tables belonging to db_name. The default database has no effect on this. Suppose that the binary log just described was created using row-based logging rather than statement-based logging. mysqlbinlog --database=test outputs only those entries that modify t1 in the test database, regardless of whether USE was issued or what the default database is.

If a server is running with binlog_format set to MIXED and you want it to be possible to use mysqlbinlog with the --database option, you must ensure that tables that are modified are in the database selected by USE. (In particular, no cross-database updates should be used.)

Prior to MySQL 5.7.1, the --database option did not work correctly with a log written by a GTID-enabled MySQL server. (Bug #15912728)

--debug[=debug_options], -# [debug_options]

Write a debugging log. A typical debug_options string is 'd:t:o,file_name'. The default is 'd:t:o,/tmp/mysqlbinlog.trace'.

--debug-check

Print some debugging information when the program exits.

--debug-info

Print debugging information and memory and CPU usage statistics when the program exits.

--default-auth=plugin

The client-side authentication plugin to use. See Section 6.3.7, "Pluggable Authentication".

--disable-log-bin, -D

Disable binary logging. This is useful for avoiding an endless loop if you use the --to-last-log 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.

This option requires that you have the SUPER privilege. It causes mysqlbinlog 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.

--exclude-gtids=gtid_set

Do not display any of the groups listed in the gtid_set.

--force-if-open, -F

Read binary log files even if they are open or were not closed properly.

--force-read, -f

With this option, if mysqlbinlog reads a binary log event that it does not recognize, it prints a warning, ignores the event, and continues. Without this option, mysqlbinlog stops if it reads such an event.

--hexdump, -H

Display a hex dump of the log in comments, as described in Section 4.6.8.1, "mysqlbinlog Hex Dump Format". The hex output can be helpful for replication debugging.

--host=host_name, -h host_name

Get the binary log from the MySQL server on the given host.

--idempotent

Tell the MySQL Server to use idempotent mode while processing updates; this causes suppression of any duplicate-key or key-not-found errors that the server encounters in the current session while processing updates. This option may prove useful whenever it is desirable or necessary to replay one or more binary logs to a MySQL Server which may not contain all of the data to which the logs refer.

The scope of effect for this option includes the current mysqlbinlog client and session only.

The --idempotent option was introduced in MySQL 5.7.0.

--include-gtids=gtid_set

Display only the groups listed in the gtid_set.

--local-load=path, -l path

Prepare local temporary files for LOAD DATA INFILE in the specified directory.

--offset=N, -o N

Skip the first N entries in the log.

--password[=password], -p[password]

The password to use when connecting to the server. If you use the short option form (-p), you cannot have a space between the option and the password. If you omit the password value following the --password or -p option on the command line, mysqlbinlog prompts for one.

Specifying a password on the command line should be considered insecure. See Section 6.1.2.1, "End-User Guidelines for Password Security". You can use an option file to avoid giving the password on the command line.

--plugin-dir=path

The directory in which to look for plugins. It may be necessary to specify this option if the --default-auth option is used to specify an authentication plugin but mysqlbinlog does not find it. See Section 6.3.7, "Pluggable Authentication".

--port=port_num, -P port_num

The TCP/IP port number to use for connecting to a remote server.

--protocol={TCP|SOCKET|PIPE|MEMORY}

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 permissible values, see Section 4.2.2, "Connecting to the MySQL Server".

--raw

By default, mysqlbinlog reads binary log files and writes events in text format. The --raw option tells mysqlbinlog to write them in their original binary format. Its use requires that --read-from-remote-server also be used because the files are requested from a server. mysqlbinlog writes one output file for each file read from the server. The --raw option can be used to make a backup of a server's binary log. With the --stop-never option, the backup is "live" because mysqlbinlog stays connected to the server. By default, output files are written in the current directory with the same names as the original log files. Output file names can be modified using the --result-file option. For more information, see Section 4.6.8.3, "Using mysqlbinlog to Back Up Binary Log Files".

--read-from-remote-master=type

Read binary logs from a MySQL server with the COM_BINLOG_DUMP or COM_BINLOG_DUMP_GTID commands by setting the option value to either BINLOG-DUMP-NON-GTIDS or BINLOG-DUMP-GTIDS, respectively. If --read-from-remote-master=BINLOG-DUMP-GTIDS is combined with --exclude-gtids, transactions can be filtered out on the master, avoiding unnecessary network traffic.

See also the description for --read-from-remote-server.

--read-from-remote-server, -R

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 --host, --password, --port, --protocol, --socket, and --user.

This option requires that the remote server be running. It works only for binary log files on the remote server, not relay log files.

This option is like --read-from-remote-master=BINLOG-DUMP-NON-GTIDS.

--result-file=name, -r name

Without the --raw option, this option indicates the file to which mysqlbinlog writes text output. With --raw, mysqlbinlog writes one binary output file for each log file transferred from the server, writing them by default in the current directory using the same names as the original log file. In this case, the --result-file option value is treated as a prefix that modifies output file names.

--rewrite-db='dboldname->dbnewname'

When reading from a row-based log, rewrite all occurrences of dboldname to dbnewname. For use when restoring tables logged using the row-based format to a database having a different name from the original database.

The rewrite rule employed as a value for this option is a string having the form 'dboldname->dbnewname', as shown previously, and for this reason must be enclosed by quotation marks. These can be single or double quotation marks (' or ").

To employ multiple rewrite rules, specify the option multiple times, as shown here:

shell> mysqlbinlog
                    --rewrite-db='dbcurrent->dbold' --rewrite-db='dbtest->dbcurrent' \ binlog.00001 >
                    /tmp/statements.sql

This option was added in MySQL 5.7.1.

--server-id=id

Display only those events created by the server having the given server ID.

--set-charset=charset_name

Add a SET NAMES charset_name statement to the output to specify the character set to be used for processing log files.

--short-form, -s

Display only the statements contained in the log, without any extra information or row-based events. This is for testing only, and should not be used in production systems.

--skip-gtids[=(true|false)]

Do not display any GTIDs. Not recommended in production.

--socket=path, -S path

For connections to localhost, the Unix socket file to use, or, on Windows, the name of the named pipe to use.

--start-datetime=datetime

Start reading the binary log at the first event having a timestamp equal to or later than the datetime argument. The datetime value is relative to the local time zone on the machine where you run mysqlbinlog. The value should be in a format accepted for the DATETIME or TIMESTAMP data types. For example:

shell> mysqlbinlog
                    --start-datetime="2005-12-25 11:25:56" binlog.000003

This option is useful for point-in-time recovery. See Section 7.3, "Example Backup and Recovery Strategy".

--start-position=N, -j N

Start reading the binary log at the first event having a position equal to or greater than N. This option applies to the first log file named on the command line.

This option is useful for point-in-time recovery. See Section 7.3, "Example Backup and Recovery Strategy".

--stop-datetime=datetime

Stop reading the binary log at the first event having a timestamp equal to or later than the datetime argument. This option is useful for point-in-time recovery. See the description of the --start-datetime option for information about the datetime value.

This option is useful for point-in-time recovery. See Section 7.3, "Example Backup and Recovery Strategy".

--stop-never

This option is used with --read-from-remote-server. It tells mysqlbinlog to remain connected to the server. Otherwise mysqlbinlog exits when the last log file has been transferred from the server. --stop-never implies --to-last-log, so only the first log file to transfer need be named on the command line.

--stop-never is commonly used with --raw to make a live binary log backup, but also can be used without --raw to maintain a continuous text display of log events as the server generates them.

--stop-never-slave-server-id=id

With --stop-never, mysqlbinlog reports a server ID of 65535 when it connects to the server. --stop-never-slave-server-id explicitly specifies the server ID to report. It can be used to avoid a conflict with the ID of a slave server or another mysqlbinlog process. See Section 4.6.8.4, "Specifying the mysqlbinlog Server ID".

--stop-position=N

Stop reading the binary log at the first event having a position equal to or greater than N. This option applies to the last log file named on the command line.

This option is useful for point-in-time recovery. See Section 7.3, "Example Backup and Recovery Strategy".

--to-last-log, -t

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 --read-from-remote-server.

--user=user_name, -u user_name

The MySQL user name to use when connecting to a remote server.

--verbose, -v

Reconstruct row events and display them as commented SQL statements. If this option is given twice, the output includes comments to indicate column data types and some metadata.

For examples that show the effect of --base64-output and --verbose on row event output, see Section 4.6.8.2, "mysqlbinlog Row Event Display".

--verify-binlog-checksum, -c

Verify checksums in binary log files.

--version, -V

Display version information and exit.

In MySQL 5.7.1 and later, the mysqlbinlog version number shown when using this option is 3.4. (Bug #15894381, Bug #67643)

open_files_limit

Specify the number of open file descriptors to reserve.