mysqlbinlog - Utility for Processing Binary Log Files
The server's binary log consists of files containing "events" that describe modifications to database contents. The server writes these files in binary format. To display their contents in text format, use the mysqlbinlog utility. You can also use mysqlbinlog 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 , "The Binary Log", and , "Replication Relay and Status Logs".
Invoke mysqlbinlog like this:
shell> mysqlbinlog [options
] log_file
...
For example, to display the contents of the binary log file named binlog.000003
, use this command:
shell> mysqlbinlog binlog.0000003
The output includes events contained in binlog.000003
. For statement-based logging, event information includes the SQL 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. For row-based logging, the event indicates a row change rather than an SQL statement. See , "Replication Formats", for information about logging modes.
Events are preceded by header comments that provide additional information. For example:
# at 141 #100309 9:28:36 server id 123 end_log_pos 245 Query thread_id=3350 exec_time=11 error_code=0
In the first line, the number following at
indicates the starting position of the event in the binary log file.
The second line starts with a date and time indicating when the statement started on the server where the event originated. For replication, this timestamp is propagated to slave servers. server id
is the server_id
value of the server where the event originated. end_log_pos
indicates where the next event starts (that is, it is the end position of the current event + 1). thread_id
indicates which thread executed the event. exec_time
is the time spent executing the event, on a master server. On a slave, it is the difference of the end execution time on the slave minus the beginning execution time on the master. The difference serves as an indicator of how much replication lags behind the master. error_code
indicates the result from executing the event. Zero means that no error occurred.
The output from mysqlbinlog can be re-executed (for example, by using it as input to mysql) to redo 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 and in , "Point-in-Time (Incremental) Recovery Using the Binary Log".
Normally, you use mysqlbinlog to read binary log files directly and apply them to the local MariaDB server. It is also possible to read binary logs from a remote server by using the --read-from-remote-server
option. To read remote binary logs, the connection parameter options can be given to indicate how to connect to the server. These options are --host
, --password
, --port
, --protocol
, --socket
, and --user
; they are ignored except when you also use the --read-from-remote-server
option.
mysqlbinlog supports the following options, which can be specified on the command line or in the [mysqlbinlog]
and [client]
groups of an option file. mysqlbinlog also supports the options for processing option files described at , "Command-Line Options that Affect Option-File Handling".
Table 4.11. mysqlbinlog
Options
Format | Option File | Description | Introduction | Deprecated | Removed |
---|---|---|---|---|---|
--base64-output[=value] | base64-output | Print binary log entries using base-64 encoding | |||
--bind-address=ip_address | bind-address | Use the specified network interface to connect to the MariaDB Server | |||
--binlog-row-event-max-size=# | binlog-row-event-max-size | Binary log max event size | |||
--character-sets-dir=path | character-sets-dir | The directory where character sets are installed | |||
--database=db_name | database | List entries for just this database | |||
--debug[=debug_options] | debug | Write a debugging log | |||
--debug-check | debug-check | Print debugging information when the program exits | |||
--debug-info | debug-info | Print debugging information, memory and CPU statistics when the program exits | |||
--default-auth=plugin | default-auth=plugin | The authentication plugin to use | 5.6.2 | ||
--disable-log-bin | disable-log-bin | Disable binary logging | |||
--force-read | force-read | If mysqlbinlog reads a binary log event that it does not recognize, it prints a warning | |||
--help | Display help message and exit | ||||
--hexdump | hexdump | Display a hex dump of the log in comments | |||
--host=host_name | host | Connect to the MariaDB server on the given host | |||
--local-load=path | local-load | Prepare local temporary files for LOAD DATA INFILE in the specified directory | |||
--offset=# | offset | Skip the first N entries in the log | |||
--password[=password] | password | The password to use when connecting to the server | |||
--plugin-dir=path | plugin-dir=path | The directory where plugins are located | 5.6.2 | ||
--port=port_num | port | The TCP/IP port number to use for the connection | |||
--protocol=type | protocol | The connection protocol to use | |||
--raw | raw | Write events in raw (binary) format to output files | |||
--read-from-remote-server | read-from-remote-server | Read the binary log from a MariaDB server rather than reading a local log file | |||
--result-file=name | result-file | Direct output to the given file | |||
--server-id=id | server-id | Extract only those events created by the server having the given server ID | |||
--set-charset=charset_name | set-charset | Add a SET NAMES charset_name statement to the output | |||
--short-form | short-form | Display only the statements contained in the log | |||
--socket=path | socket | For connections to localhost | |||
--start-datetime=datetime | start-datetime | Start reading the binary log at the first event having a timestamp equal to or later than the datetime argument | |||
--start-position=# | start-position | Start reading the binary log at the first event having a position equal to or greater than the argument | |||
--stop-datetime=datetime | stop-datetime | Stop reading the binary log at the first event having a timestamp equal to or greater than the datetime argument | |||
--stop-never | stop-never | Stay connected to server after reading last binary log file | |||
--stop-never-slave-server-id=# | stop-never-slave-server-id | Slave server ID to report when connecting to server | |||
--stop-position=# | stop-position | Stop reading the binary log at the first event having a position equal to or greater than the argument | |||
--to-last-log | to-last-log | Do not stop at the end of the requested binary log from a MariaDB server, but rather continue printing until the end of the last binary log | |||
--user=user_name, | user | The MariaDB user name to use when connecting to the server | |||
--verbose | Reconstruct row events as SQL statements | ||||
--version | Display version information and exit |
--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):AUTO
('automatic') orUNSPEC
('unspecified') displaysBINLOG
statements automatically when necessary (that is, for format description events and row events). If no--base64-output
option is given or the option is given without a value, the effect is the same as--base64-output=AUTO
.NoteAutomatic
BINLOG
display is the only safe behavior if you intend to use the output of mysqlbinlog 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.NEVER
causesBINLOG
statements not to be displayed. mysqlbinlog exits with an error if a row event is found that must be displayed usingBINLOG
.DECODE-ROWS
specifies to mysqlbinlog that you intend for row events to be decoded and displayed as commented SQL statements by also specifying the--verbose
option. LikeNEVER
,DECODE-ROWS
suppresses display ofBINLOG
statements, but unlikeNEVER
, it does not exit with an error if a row event is found.
For examples that show the effect of
--base64-output
and--verbose
on row event output, see , "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 MariaDB server.
This option is supported beginning with MariaDB 5.6.1.
--binlog-row-event-max-size=
N
Command-Line Format --binlog-row-event-max-size=#
Option-File Format binlog-row-event-max-size
Permitted Values Platform Bit Size 64
Type numeric
Default 4294967040
Range 18446744073709547520
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 , "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 byUSE
.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:- While
db_name
is the default database, statements are output whether they modify tables indb_name
or a different database. - Unless
db_name
is selected as the default database, statements are not output, even if they modify tables indb_name
. - There is an exception for
CREATE DATABASE
,ALTER DATABASE
, andDROP DATABASE
. The database being created, altered, or dropped is considered to be the default database when determining whether to output the statement.
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 threeINSERT
statements followingUSE test
, but not the threeINSERT
statements followingUSE db2
.mysqlbinlog --database=db2 does not output the first two
INSERT
statements because there is no default database. It does not output the threeINSERT
statements followingUSE test
, but does output the threeINSERT
statements followingUSE 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 modifyt1
in the test database, regardless of whetherUSE
was issued or what the default database is.If a server is running with
binlog-format
set toMIXED
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 byUSE
. (In particular, no cross-database updates should be used.)- While
--debug[=
,debug_options
]-# [
debug_options
]Write a debugging log. A typical
debug_options
string is'd:t:o,
. The default isfile_name
''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 , "Pluggable Authentication".
This option was added in MariaDB 5.6.2.
--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 MariaDB 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 aSET sql_log_bin = 0
statement in its output to disable binary logging of the remaining output. TheSET
statement is ineffective unless you have theSUPER
privilege.--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 , "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 MariaDB server on the given host.
--local-load=
,path
-l
path
Prepare local temporary files for
LOAD DATA INFILE
in the specified directory.ImportantThese temporary files are not automatically removed by mysqlbinlog or any other MariaDB program.
--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 thepassword
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 , "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 , "Pluggable Authentication".This option was added in MariaDB 5.6.2.
--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 , "Connecting to the MariaDB 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 , "Using mysqlbinlog to Back Up Binary Log Files".This option was added in MariaDB 5.6.0.
--read-from-remote-server
,-R
Read the binary log from a MariaDB 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.
--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.--server-id=
id
Display only those events created by the server having the given server ID.
--set-charset=
charset_name
Add a
SET NAMES
statement to the output to specify the character set to be used for processing log files.charset_name
--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.
--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. Thedatetime
value is relative to the local time zone on the machine where you run mysqlbinlog. The value should be in a format accepted for theDATETIME
orTIMESTAMP
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 , "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 , "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 thedatetime
value.This option is useful for point-in-time recovery. See , "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.This option was added in MariaDB 5.6.0.
--stop-never-slave-server-id=
id
With
--stop-never
, mysqlbinlog reports a server ID of 65535 when it connect 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 , "Specifying the mysqlbinlog Server ID".This option was added in MariaDB 5.6.0.
--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 , "Example Backup and Recovery Strategy".
--to-last-log
,-t
Do not stop at the end of the requested binary log from a MariaDB server, but rather continue printing until the end of the last binary log. If you send the output to the same MariaDB server, this may lead to an endless loop. This option requires
--read-from-remote-server
.--user=
,user_name
-u
user_name
The MariaDB 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 , "mysqlbinlog Row Event Display".--version
,-V
Display version information and exit.
You can also set the following variable by using --
syntax:
var_name
=value
open_files_limit
Specify the number of open file descriptors to reserve.
You can pipe the output of mysqlbinlog into the mysql client to execute the events contained in the binary log. This technique is used to recover from a crash when you have an old backup (see , "Point-in-Time (Incremental) Recovery Using the Binary Log"). For example:
shell> mysqlbinlog binlog.000001 | mysql -u root -p
Or:
shell> mysqlbinlog binlog.[0-9]* | mysql -u root -p
If the statements produced by mysqlbinlog may contain BLOB
values, these may cause problems when mysql processes them. In this case, invoke mysql with the --binary-mode
option.
You can also redirect the output of mysqlbinlog 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 mysql program:
shell>mysqlbinlog binlog.000001 > tmpfile
shell> ...edit tmpfile
... shell>mysql -u root -p < tmpfile
When mysqlbinlog is invoked with the --start-position
option, it displays only those events 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 --stop-datetime
option (to be able to say, for example, "roll forward my databases to how they were today at 10:30 a.m.").
If you have more than one binary log to execute on the MariaDB 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 unsafe:
shell>mysqlbinlog binlog.000001 | mysql -u root -p # DANGER!!
shell>mysqlbinlog binlog.000002 | mysql -u root -p # DANGER!!
Processing binary logs this way using multiple 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 mysql process terminates, the server drops the temporary table. When the second mysql process attempts to use the table, the server reports "unknown table."
To avoid problems like this, use a single mysql process to execute the contents of all binary logs that you want to process. Here is one way to do so:
shell> mysqlbinlog binlog.000001 binlog.000002 | mysql -u root -p
Another approach is to write all the logs to a single file and then process the file:
shell>mysqlbinlog binlog.000001 > /tmp/statements.sql
shell>mysqlbinlog binlog.000002 >> /tmp/statements.sql
shell>mysql -u root -p -e 'source /tmp/statements.sql'
mysqlbinlog can produce output that reproduces a LOAD DATA INFILE
operation without the original data file. mysqlbinlog 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 --local-load
option.
Because mysqlbinlog 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 with the LOCAL
capability enabled. See , "Security Issues with LOAD DATA LOCAL
".Warning
The temporary files created for LOAD DATA LOCAL
statements are not 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 original_file_name-#-#
.