MAN page from Other MySQL-client-community-5.0.96-1.sles10.x86_64.rpm


Section: MySQL Database System (1)
Updated: 03/02/2012


mysqlbinlog - utility for processing binary log files 


mysqlbinlog [options] log_file ...


The server's binary log consists of files containinglqeventsrqthat describe modifications to database contents. The server writes these files in binary format. To display their contents in text format, use themysqlbinlogutility. You can also usemysqlbinlogto 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 inSection 5.2.3, lqThe Binary Logrq, andSection 15.2.2, lqReplication Relay and Status Logsrq.

Invokemysqlbinloglike this:

shell> mysqlbinlog [options] log_file ...

For example, to display the contents of the binary log file namedbinlog.000003, use this command:

shell> mysqlbinlog binlog.0000003

The output includes events contained inbinlog.000003. 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.

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 followingatindicates 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 idis theserver_idvalue of the server where the event originated.end_log_posindicates where the next event starts (that is, it is the end position of the current event + 1).thread_idindicates which thread executed the event.exec_timeis 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_codeindicates the result from executing the event. Zero means that no error occurred.

The output frommysqlbinlogcan be re-executed (for example, by using it as input tomysql) 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 inSection 6.5, lqPoint-in-Time (Incremental) Recovery Using the Binary Logrq.

Normally, you usemysqlbinlogto read binary log files directly and apply them to the local MySQL server. It is also possible to read binary logs from a remote server by using the--read-from-remote-serveroption. 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-serveroption.

mysqlbinlogsupports the following options, which can be specified on the command line or in the[mysqlbinlog]and[client]groups of an option file.mysqlbinlogalso supports the options for processing option files described atSection, lqCommand-Line Options that Affect Option-File Handlingrq.


Display a help message and exit.


The directory where character sets are installed. SeeSection 9.5, lqCharacter Set Configurationrq.

*--database=db_name,-d db_name

This option causesmysqlbinlogto output entries from the binary log (local log only) that occur whiledb_nameis been selected as the default database byUSE.

The--databaseoption formysqlbinlogis similar to the--binlog-do-dboption formysqld, but can be used to specify only one database. If--databaseis given multiple times, only the last instance is used.

The--databaseoption works as follows:

*Whiledb_nameis the default database, statements are output whether they modify tables indb_nameor a different database.

*Unlessdb_nameis selected as the default database, statements are not output, even if they modify tables indb_name.

*There is an exception forCREATE DATABASE,ALTER DATABASE, andDROP DATABASE. The database beingcreated, altered, or droppedis considered to be the default database when determining whether to output the statement.
Suppose that the binary log contains these statements:

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=testdoes not output the first twoINSERTstatements because there is no default database. It outputs the threeINSERTstatements followingUSE test, but not the threeINSERTstatements followingUSE db2.

mysqlbinlog --database=db2does not output the first twoINSERTstatements because there is no default database. It does not output the threeINSERTstatements followingUSE test, but does output the threeINSERTstatements followingUSE db2.

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

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


Disable binary logging. This is useful for avoiding an endless loop if you use the--to-last-logoption 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 theSUPERprivilege. It causesmysqlbinlogto include aSET sql_log_bin = 0statement in its output to disable binary logging of the remaining output. TheSETstatement is ineffective unless you have theSUPERprivilege.


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


Display a hex dump of the log in comments. The hex output can be helpful for replication debugging. Hex dump format is discussed later in this section. This option was added in MySQL 5.0.16.

*--host=host_name,-h host_name

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

*--local-load=path,-l path

Prepare local temporary files forLOAD DATA INFILEin the specified directory.

These temporary files are not automatically removed bymysqlbinlogor any other MySQL program.

*--offset=N,-o N

Skip the firstNentries in the log.


The password to use when connecting to the server. If you use the short option form (-p), youcannothave a space between the option and the password. If you omit thepasswordvalue following the--passwordor-poption on the command line,mysqlbinlogprompts for one.

Specifying a password on the command line should be considered insecure. SeeSection, lqEnd-User Guidelines for Password Securityrq. You can use an option file to avoid giving the password on the command line.

*--port=port_num,-P port_num

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


Deprecated. Use--start-positioninstead.--positionis removed in MySQL 5.5.


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, seeSection 4.2.2, lqConnecting to the MySQL Serverrq.


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.

*--result-file=name,-r name

Direct output to the given file.


Add aSET NAMES charset_namestatement to the output to specify the character set to be used for processing log files. This option was added in MySQL 5.0.23.


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

*--socket=path,-S path

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


Start reading the binary log at the first event having a timestamp equal to or later than thedatetimeargument. Thedatetimevalue is relative to the local time zone on the machine where you runmysqlbinlog. The value should be in a format accepted for theDATETIMEorTIMESTAMPdata types. For example:

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

This option is useful for point-in-time recovery. SeeSection 6.3, lqExample Backup and Recovery Strategyrq.

*--start-position=N,-j N

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

This option is useful for point-in-time recovery. SeeSection 6.3, lqExample Backup and Recovery Strategyrq.


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

This option is useful for point-in-time recovery. SeeSection 6.3, lqExample Backup and Recovery Strategyrq.


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

This option is useful for point-in-time recovery. SeeSection 6.3, lqExample Backup and Recovery Strategyrq.


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.


Display version information and exit.

You can also set the following variable by using--var_name=valuesyntax:


Specify the number of open file descriptors to reserve.

It is also possible to set variables by using--set-variable=var_name=valueor-O var_name=valuesyntax.This syntax is deprecated.

You can pipe the output ofmysqlbinloginto themysqlclient to execute the events contained in the binary log. This technique is used to recover from a crash when you have an old backup (seeSection 6.5, lqPoint-in-Time (Incremental) Recovery Using the Binary Logrq). For example:

shell> mysqlbinlog binlog.000001 | mysql -u root -p


shell> mysqlbinlog binlog.[0-9]* | mysql -u root -p

You can also redirect the output ofmysqlbinlogto 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 themysqlprogram:

shell> mysqlbinlog binlog.000001 > tmpfileshell> ... edit tmpfile> mysql -u root -p < tmpfile

Whenmysqlbinlogis invoked with the--start-positionoption, 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-datetimeoption (to be able to say, for example,lqroll forward my databases to how they were today at 10:30 a.m.rq).

If you have more than one binary log to execute on the MySQL server, the safe method is to process them all using a single connection to the server. Here is an example that demonstrates what may beunsafe:

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 aCREATE TEMPORARY TABLEstatement and the second log contains a statement that uses the temporary table. When the firstmysqlprocess terminates, the server drops the temporary table. When the secondmysqlprocess attempts to use the table, the server reportslqunknown table.rq

To avoid problems like this, use asinglemysqlprocess 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.sqlshell> mysqlbinlog binlog.000002 >> /tmp/statements.sqlshell> mysql -u root -p -e "source /tmp/statements.sql"

mysqlbinlogcan produce output that reproduces aLOAD DATA INFILEoperation without the original data file.mysqlbinlogcopies the data to a temporary file and writes aLOAD DATA LOCAL INFILEstatement 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-loadoption.

BecausemysqlbinlogconvertsLOAD DATA INFILEstatements toLOAD DATA LOCAL INFILEstatements (that is, it addsLOCAL), both the client and the server that you use to process the statements must be configured with theLOCALcapability enabled. SeeSection 5.3.5, lqSecurity Issues with LOAD DATA LOCALrq.


The temporary files created forLOAD DATA LOCALstatements arenotautomatically 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 likeoriginal_file_name-#-#.

The--hexdumpoption produces a hex dump of the log contents:

shell> mysqlbinlog --hexdump master-bin.000001

The hex output consists of comment lines beginning with#, so the output might look like this for the preceding command:

/*!40019 SET @@session.max_insert_delayed_threads=0*/;/*!50003 SET @OLD_COMPLETION_TYPE=@@COMPLETION_TYPE,COMPLETION_TYPE=0*/;# at 4#051024 17:24:13 server id 1  end_log_pos 98# Position  Timestamp   Type   Master ID        Size      Master Pos    Flags# 00000004 9d fc 5c 43   0f   01 00 00 00   5e 00 00 00   62 00 00 00   00 00# 00000017 04 00 35 2e 30 2e 31 35  2d 64 65 62 75 67 2d 6c |..5.0.15.debug.l|# 00000027 6f 67 00 00 00 00 00 00  00 00 00 00 00 00 00 00 |og..............|# 00000037 00 00 00 00 00 00 00 00  00 00 00 00 00 00 00 00 |................|# 00000047 00 00 00 00 9d fc 5c 43  13 38 0d 00 08 00 12 00 |.......C.8......|# 00000057 04 04 04 04 12 00 00 4b  00 04 1a                |.......K...|#       Start: binlog v 4, server v 5.0.15-debug-log created 051024 17:24:13#       at startupROLLBACK;

Hex dump output currently contains the following elements. This format is subject to change.

*Position: The byte position within the log file.

*Timestamp: The event timestamp. In the example shown,'9d fc 5c 43'is the representation of'051024 17:24:13'in hexadecimal.

*Type: The event type code. In the example shown,'0f'indicates aFORMAT_DESCRIPTION_EVENT. The following table lists the possible type codes.
00UNKNOWN_EVENTThis event should never be present in the log.
01START_EVENT_V3This indicates the start of a log file written by MySQL 4 or earlier.
02QUERY_EVENTThe most common type of events. These contain statements executed on the
03STOP_EVENTIndicates that master has stopped.
04ROTATE_EVENTWritten when the master switches to a new log file.
05INTVAR_EVENTUsed for AUTO_INCREMENT values or when the
                    function is used in the statement.
                    INFILE in MySQL 3.23.
07SLAVE_EVENTReserved for future use.
                    INFILE statements. This indicates the
                    start of execution of such a statement. A temporary
                    file is created on the slave. Used in MySQL 4 only.
09APPEND_BLOCK_EVENTContains data for use in a
                    LOAD DATA
                    INFILE statement. The data is stored in
                    the temporary file on the slave.
                    INFILE statements. The contents of the
                    temporary file is stored in the table on the slave.
                    Used in MySQL 4 only.
                    INFILE statement. The temporary file
                    should be deleted on the slave.
                    INFILE in MySQL 4 and earlier.
0dRAND_EVENTUsed to send information about random values if the
                    RAND() function is
                    used in the statement.
0eUSER_VAR_EVENTUsed to replicate user variables.
0fFORMAT_DESCRIPTION_EVENTThis indicates the start of a log file written by MySQL 5 or later.
10XID_EVENTEvent indicating commit of an XA transaction.
                    INFILE statements in MySQL 5 and later.
                    INFILE statements in MySQL 5 and later.
13TABLE_MAP_EVENTReserved for future use.
14WRITE_ROWS_EVENTReserved for future use.
15UPDATE_ROWS_EVENTReserved for future use.
16DELETE_ROWS_EVENTReserved for future use.

*Master ID: The server ID of the master that created the event.

*Size: The size in bytes of the event.

*Master Pos: The position of the next event in the original master log file.

*Flags: 16 flags. Currently, the following flags are used. The others are reserved for future use.
01LOG_EVENT_BINLOG_IN_USE_FLog file correctly closed. (Used only in
                    FORMAT_DESCRIPTION_EVENT.) If
                    this flag is set (if the flags are, for example,
                    '01 00') in a
                    FORMAT_DESCRIPTION_EVENT, the log
                    file has not been properly closed. Most probably
                    this is because of a master crash (for example, due
                    to power failure).
02 Reserved for future use.
04LOG_EVENT_THREAD_SPECIFIC_FSet if the event is dependent on the connection it was executed in (for
                    example, '04 00'), for example,
                    if the event uses temporary tables.
08LOG_EVENT_SUPPRESS_USE_FSet in some circumstances when the event is not dependent on the default



Copyright © 1997, 2012, Oracle and/or its affiliates. All rights reserved.

This documentation is free software; you can redistribute it and/or modify it only under the terms of the GNU General Public License as published by the Free Software Foundation; version 2 of the License.

This documentation is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with the program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA or see



For more information, please refer to the MySQL Reference Manual,which may already be installed locally and which is also availableonline at 


Oracle Corporation (




This document was created byman2html,using the manual pages.