mariadb/man/mariadb-binlog.1

'\" t
.\"
.TH "\fBMARIADB-BINLOG\fR" "1" "3 September 2024" "MariaDB 11.4" "MariaDB Database System"
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.\" mariadb-binlog
.SH "NAME"
mariadb-binlog \- utility for processing binary log files (mariadb-binlog is now a symlink to mariadb-binlog)
.SH "SYNOPSIS"
.HP \w'\fBmariadb-binlog\ [\fR\fBoptions\fR\fB]\ \fR\fB\fIlog_file\fR\fR\fB\ \&.\&.\&.\fR\ 'u
\fBmariadb-binlog [\fR\fBoptions\fR\fB] \fR\fB\fIlog_file\fR\fR\fB \&.\&.\&.\fR
.SH "DESCRIPTION"
.PP
The server's binary log consists of files containing
\(lqevents\(rq
that describe modifications to database contents\&. The server writes these files in binary format\&. To display their contents in text format, use the
\fBmariadb-binlog\fR
utility\&. You can also use
\fBmariadb-binlog\fR
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\&.
.PP
Invoke
\fBmariadb-binlog\fR
like this:
.sp
.if n \{\
.RS 4
.\}
.nf
shell> \fBmariadb-binlog [\fR\fB\fIoptions\fR\fR\fB] \fR\fB\fIlog_file\fR\fR\fB \&.\&.\&.\fR
.fi
.if n \{\
.RE
.\}
.PP
For example, to display the contents of the binary log file named
binlog\&.000003, use this command:
.sp
.if n \{\
.RS 4
.\}
.nf
shell> \fBmariadb-binlog binlog\&.0000003\fR
.fi
.if n \{\
.RE
.\}
.PP
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\&.
.PP
Events are preceded by header comments that provide additional information\&. For example:
.sp
.if n \{\
.RS 4
.\}
.nf
# at 141
#100309  9:28:36 server id 123  end_log_pos 245
  Query thread_id=3350  exec_time=11  error_code=0
.fi
.if n \{\
.RE
.\}
.PP
In the first line, the number following
at
indicates the starting position of the event in the binary log file\&.
.PP
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\&.
.PP
The output from
\fBmariadb-binlog\fR
can be re\-executed (for example, by using it as input to
\fBmariadb\fR) 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\&.
.PP
Normally, you use
\fBmariadb-binlog\fR
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
\fB\-\-read\-from\-remote\-server\fR
option\&. To read remote binary logs, the connection parameter options can be given to indicate how to connect to the server\&. These options are
\fB\-\-host\fR,
\fB\-\-password\fR,
\fB\-\-port\fR,
\fB\-\-protocol\fR,
\fB\-\-socket\fR, and
\fB\-\-user\fR; they are ignored except when you also use the
\fB\-\-read\-from\-remote\-server\fR
option\&.
.PP
\fBmariadb-binlog\fR
supports the following options, which can be specified on the command line or in the
[mariadb-binlog]
and
[client]
option file groups\&.
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
.\" mariadb-binlog: help option
.\" help option: mariadb-binlog
\fB\-\-help\fR,
\fB\-?\fR
.sp
Display a help message and exit\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
.\" mariadb-binlog: base64-output option
.\" base64-output option: mariadb-binlog
\fB\-\-base64\-output=\fR\fB\fIvalue\fR\fR\fB\fR
.sp
This option determines when events should be displayed encoded as base\-64 strings using
BINLOG
statements\&. The option has these allowable values (not case sensitive):
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
AUTO
("automatic") or
UNSPEC
("unspecified") displays
BINLOG
statements automatically when necessary (that is, for format description events and row events)\&. This is the default if no
\fB\-\-base64\-output\fR
option is given\&.
.if n \{\
.sp
.\}
.RS 4
.it 1
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBNote\fR
.ps -1
.br
Automatic
BINLOG
display is the only safe behavior if you intend to use the output of
\fBmariadb-binlog\fR
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\&.
.sp .5v
.RE
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
NEVER
causes
BINLOG
statements not to be displayed\&.
\fBmariadb-binlog\fR
exits with an error if a row event is found that must be displayed using
BINLOG\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
DECODE\-ROWS
specifies to
\fBmariadb-binlog\fR
that you intend for row events to be decoded and displayed as commented SQL statements by also specifying the
\fB\-\-verbose\fR
option\&. Like
NEVER,
DECODE\-ROWS
suppresses display of
BINLOG
statements, but unlike
NEVER, it does not exit with an error if a row event is found\&.
.RE
.RS 4
The
\fB\-\-base64\-output\fR
can be given as
\fB\-\-base64\-output\fR
or
\fB\-\-skip\-base64\-output\fR
(with the sense of
AUTO
or
NEVER)\&.
.sp
For examples that show the effect of
\fB\-\-base64\-output\fR
and
\fB\-\-verbose\fR
on row event output, see
the section called \(lqMARIADB-BINLOG ROW EVENT DISPLAY\(rq\&.
.RE
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
.\" mariadb-binlog: binlog-row-event-max-size option
.\" binlog-row-event-max-size option: mariadb-binlog
\fB\-\-binlog\-row\-event\-max\-size\=\fR\fB\fIpath\fR\fR
.sp
The directory where character sets are installed\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
.\" mariadb-binlog: character-sets-dir option
.\" character-sets-dir option: mariadb-binlog
\fB\-\-character\-sets\-dir=\fR\fB\fIpath\fR\fR
.sp
The directory where character sets are installed\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
.\" mariadb-binlog: database option
.\" database option: mariadb-binlog
\fB\-\-database=\fR\fB\fIdb_name\fR\fR,
\fB\-d \fR\fB\fIdb_name\fR\fR
.sp
This option causes
\fBmariadb-binlog\fR
to output entries from the binary log (local log only) that occur while
\fIdb_name\fR
has been selected as the default database by
USE\&.
.sp
The
\fB\-\-database\fR
option for
\fBmariadb-binlog\fR
is similar to the
\fB\-\-binlog\-do\-db\fR
option for
\fBmariadbd\fR, but can be used to specify only one database\&. If
\fB\-\-database\fR
is given multiple times, only the last instance is used\&.
.sp
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
\fB\-\-binlog\-do\-db\fR
depend on whether statement\-based or row\-based logging is in use\&.
.PP
\fBStatement-based logging\fR. The
\fB\-\-database\fR
option works as follows:
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
While
\fIdb_name\fR
is the default database, statements are output whether they modify tables in
\fIdb_name\fR
or a different database\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Unless
\fIdb_name\fR
is selected as the default database, statements are not output, even if they modify tables in
\fIdb_name\fR\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
There is an exception for
CREATE DATABASE,
ALTER DATABASE, and
DROP DATABASE\&. The database being
\fIcreated, altered, or dropped\fR
is considered to be the default database when determining whether to output the statement\&.
.RE
.RS 4
Suppose that the binary log was created by executing these statements using statement\-based\-logging:
.sp
.if n \{\
.RS 4
.\}
.nf
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);
.fi
.if n \{\
.RE
.\}
.sp
\fBmariadb-binlog \-\-database=test\fR
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\&.
.sp
\fBmariadb-binlog \-\-database=db2\fR
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\&.
.PP
\fBRow-based logging\fR.
\fBmariadb-binlog\fR
outputs only entries that change tables belonging to
\fIdb_name\fR\&. 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\&.
\fBmariadb-binlog \-\-database=test\fR
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
\fBmariadb-binlog\fR
with the
\fB\-\-database\fR
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\&.)
.if n \{\
.sp
.\}
.RS 4
.it 1
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBNote\fR
.ps -1
.br
This option did not work correctly for
\fBmariadb-binlog\fR
with row\-based logging prior to MySQL 5\&.1\&.37\&.
.sp .5v
.RE
.RE
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
.\" mariadb-binlog: debug option
.\" debug option: mariadb-binlog
\fB\-\-debug[=\fR\fB\fIdebug_options\fR\fR\fB]\fR,
\fB\-# [\fR\fB\fIdebug_options\fR\fR\fB]\fR
.sp
Write a debugging log\&. A typical
\fIdebug_options\fR
string is 'd:t:o,\fIfile_name\fR'. The default is 'd:t:o,/tmp/mariadb-binlog.trace'.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
.\" mariadb-binlog: debug-check option
.\" debug-check option: mariadb-binlog
\fB\-\-debug\-check\fR
.sp
Print some debugging information when the program exits\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
.\" mariadb-binlog: debug-info option
.\" debug-info option: mariadb-binlog
\fB\-\-debug\-info\fR
.sp
Print debugging information and memory and CPU usage statistics when the program exits\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
.\" mariadb-binlog: defaults-extra-file option
.\" defaults-extra-file option: mariadb-binlog
\fB\-\-defaults\-extra\-file=\fR\fB\fIname\fR
.sp
Read this file after the global files are read\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
.\" mariadb-binlog: defaults-file option
.\" defaults-file option: mariadb-binlog
\fB\-\-defaults\-file=\fR\fB\fIname\fR
.sp
Only read default options from the given file\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
.\" mariadb-binlog: default-auth option
.\" default-auth option: mariadb-binlog
\fB\-\-default\-auth=\fR\fB\fIname\fR
.sp
Default authentication client-side plugin to use\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
.\" mariadb-binlog: disable-log-bin option
.\" disable-log-bin option: mariadb-binlog
\fB\-\-disable\-log\-bin\fR,
\fB\-D\fR
.sp
Disable binary logging\&. This is useful for avoiding an endless loop if you use the
\fB\-\-to\-last\-log\fR
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\&.
.sp
This option requires that you have the
SUPER
privilege\&. It causes
\fBmariadb-binlog\fR
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\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
.\" mariadb-binlog: flashback option
.\" flashback option: mariadb-binlog
\fB\-\-flashback\fR,
\fB\-B\fR
.sp
Support flashback mode\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
.\" mariadb-binlog: force-if-open option
.\" force-if-open option: mariadb-binlog
\fB\-\-force\-if\-open\fR
.sp
Force if binlog was not closed properly. Defaults to on; use \fB--skip-force-if-open\fR to disable\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
.\" mariadb-binlog: force-read option
.\" force-read option: mariadb-binlog
\fB\-\-force\-read\fR,
\fB\-f\fR
.sp
With this option, if
\fBmariadb-binlog\fR
reads a binary log event that it does not recognize, it prints a warning, ignores the event, and continues\&. Without this option,
\fBmariadb-binlog\fR
stops if it reads such an event\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
.\" mariadb-binlog: hexdump option
.\" hexdump option: mariadb-binlog
\fB\-\-hexdump\fR,
\fB\-H\fR
.sp
Display a hex dump of the log in comments, as described in
the section called \(lqMARIADB-BINLOG HEX DUMP FORMAT\(rq\&. The hex output can be helpful for replication debugging\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
.\" mariadb-binlog: host option
.\" host option: mariadb-binlog
\fB\-\-host=\fR\fB\fIhost_name\fR\fR,
\fB\-h \fR\fB\fIhost_name\fR\fR
.sp
Get the binary log from the MariaDB server on the given host\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
.\" mariadb-binlog: local-load option
.\" local-load option: mariadb-binlog
\fB\-\-local\-load=\fR\fB\fIpath\fR\fR,
\fB\-l \fR\fB\fIpath\fR\fR
.sp
Prepare local temporary files for
LOAD DATA INFILE
in the specified directory\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
.\" mariadb-binlog: no-defaults option
.\" no-defaults option: mariadb-binlog
\fB\-\-no\-defaults\fR
.sp
Don't read default options from any option file\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
.\" mariadb-binlog: offset option
.\" offset option: mariadb-binlog
\fB\-\-offset=\fR\fB\fIN\fR\fR,
\fB\-o \fR\fB\fIN\fR\fR
.sp
Skip the first
\fIN\fR
entries in the log\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
.\" mariadb-binlog: open-files-limit option
.\" open-files-limit option: mariadb-binlog
\fB\-\-open\-files\-limit=\fR\fB\fINUM\fR\fR
.sp
Sets the open_files_limit variable, which is used to reserve file descriptors for
\fBmariadb-binlog\fR\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
.\" mariadb-binlog: password option
.\" password option: mariadb-binlog
\fB\-\-password[=\fR\fB\fIpassword\fR\fR\fB]\fR,
\fB\-p[\fR\fB\fIpassword\fR\fR\fB]\fR
.sp
The password to use when connecting to the server\&. If you use the short option form (\fB\-p\fR), you
\fIcannot\fR
have a space between the option and the password\&. If you omit the
\fIpassword\fR
value following the
\fB\-\-password\fR
or
\fB\-p\fR
option on the command line,
\fBmariadb-binlog\fR
prompts for one\&.
.sp
Specifying a password on the command line should be considered insecure\&. You
can use an option file to avoid giving the password on the command line\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
.\" mariadb-binlog: plugin-dir option
.\" plugin-dir option: mariadb-binlog
\fB\-\-plugin\-dir=\fIdir_name\fR
.sp
Directory for client-side plugins\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
.\" mariadb-binlog: print-defaults option
.\" print-defaults option: mariadb-binlog
\fB\-\-print\-defaults\fR
.sp
Print the program argument list from all option files and exit\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
.\" mariadb-binlog: port option
.\" port option: mariadb-binlog
\fB\-\-port=\fR\fB\fIport_num\fR\fR,
\fB\-P \fR\fB\fIport_num\fR\fR
.sp
The TCP/IP port number to use for connecting to a remote server,
or \fB0\fR for default to, in order of preference, \fBmy.cnf\fR,
\fB$MYSQL_TCP_PORT\fR, \fB/etc/services\fR, \fRbuilt-in default (3306)\fR\&.
Forces --protocol=tcp when specified on the command line without other connection properties\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
.\" mariadb-binlog: protocol option
.\" protocol option: mariadb-binlog
\fB\-\-protocol={TCP|SOCKET|PIPE|MEMORY}\fR
.sp
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\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
.\" mariadb-binlog: raw option
.\" raw option: mariadb-binlog
\fB\-\-raw\fR
.sp
Requires \fB-R\fR\&. Output raw binlog data instead of SQL statements\&. Output files named after server logs\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
.\" mariadb-binlog: read-from-remote-server option
.\" read-from-remote-server option: mariadb-binlog
\fB\-\-read\-from\-remote\-server\fR,
\fB\-R\fR
.sp
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
\fB\-\-host\fR,
\fB\-\-password\fR,
\fB\-\-port\fR,
\fB\-\-protocol\fR,
\fB\-\-socket\fR, and
\fB\-\-user\fR\&.
.sp
This option requires that the remote server be running\&. It works only for binary log files on the remote server, not relay log files\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
.\" mariadb-binlog: result-file option
.\" result-file option: mariadb-binlog
\fB\-\-result\-file=\fR\fB\fIname\fR\fR,
\fB\-r \fR\fB\fIname\fR\fR
.sp
Direct output to the given file\&. With --raw this is a prefix for the file names\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
.\" mariadb-binlog: rewrite-db option
.\" rewrite-db option: mariadb-binlog
\fB\-\-rewrite\-db=\fR\fB\fIname\fR\fR,
\fB\-r \fR\fB\fIname\fR\fR
.sp
Updates to a database with a different name than the original.
Example: \fBrewrite-db='from->to'\fR\&. For events that are
binlogged as statements, rewriting the database constitutes changing a
statement's default database from \fIdb1\fB to \fIdb2\fR\&. There is no statement
analysis or rewrite of any kind, that is, if one specifies \fB"db1.tbl"\fR
in the statement explicitly, that occurrence won't be changed to
\fB"db2.tbl"\fR\&. Row-based events are rewritten correctly to use the new
database name\&. Filtering (e.g. with \fB--database=name\fR) happens after
the database rewrites have been performed\&. If you use this option on the
command line and \fB">"\fR has a special meaning to your command interpreter,
quote the value (e.g. \fB--rewrite-db="oldname->newname"\fR\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
.\" mariadb-binlog: server-id option
.\" server-id option: mariadb-binlog
\fB\-\-server\-id=\fR\fB\fIid\fR\fR
.sp
Display only those events created by the server having the given server ID\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
.\" mariadb-binlog: set-charset option
.\" set-charset option: mariadb-binlog
\fB\-\-set\-charset=\fR\fB\fIcharset_name\fR\fR
.sp
Add a
SET NAMES \fIcharset_name\fR
statement to the output to specify the character set to be used for processing log files\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
.\" mariadb-binlog: short-form option
.\" short-form option: mariadb-binlog
\fB\-\-short\-form\fR,
\fB\-s\fR
.sp
Display only the statements contained in the log, no extra info
and no row-based events\&. This is for testing only, and should
not be used in production systems. If you want to suppress
base64-output, consider using \fB--base64-output=never\fR instead\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
.\" mariadb-binlog: socket option
.\" socket option: mariadb-binlog
\fB\-\-socket=\fR\fB\fIpath\fR\fR,
\fB\-S \fR\fB\fIpath\fR\fR
.sp
For connections to
localhost, the Unix socket file to use, or, on Windows, the name of the named pipe to use\&.
Forces --protocol=socket when specified on the command line without other connection properties; on Windows, forces --protocol=pipe\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
.\" mariadb-binlog: start-datetime option
.\" start-datetime option: mariadb-binlog
\fB\-\-start\-datetime=\fR\fB\fIdatetime\fR\fR
.sp
Start reading the binary log at the first event having a timestamp equal to or later than the
\fIdatetime\fR
argument\&. The
\fIdatetime\fR
value is relative to the local time zone on the machine where you run
\fBmariadb-binlog\fR\&. The value should be in a format accepted for the
DATETIME
or
TIMESTAMP
data types\&. For example:
.sp
.if n \{\
.RS 4
.\}
.nf
shell> \fBmariadb-binlog \-\-start\-datetime="2014\-12\-25 11:25:56" binlog\&.000003\fR
.fi
.if n \{\
.RE
.\}
.sp
This option is useful for point\-in\-time recovery\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
.\" mariadb-binlog: start-position option
.\" start-position option: mariadb-binlog
\fB\-\-start\-position=\fR\fB\fIN\fR\fR,
\fB\-j \fR\fB\fIN\fR\fR
.sp
Start reading the binary log at \fIN\fR\&. Type can either be a positive
integer or a GTID\& list\&. When using a positive integer, the value only
applies to the first binlog passed on the command line, and the first event
that has a position equal to or greater than \fIN\fR is printed\&. In GTID mode,
multiple GTIDs can be passed as a comma separated list, where each must have a
unique domain id\&. The list represents the gtid binlog state that the client
(another "replica" server) is aware of\&. Therefore, each GTID is exclusive; only
events after a given sequence number will be printed to allow users to receive
events after their current state\&.
.sp
This option is useful for point\-in\-time recovery\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
.\" mariadb-binlog: gtid-strict-mode
.\" gtid-strict-mode option: mariadb-binlog
\fB\-\-gtid\-strict\-mode
.sp
Process binlog according to gtid-strict-mode specification\&. The start, stop
positions are verified to satisfy start < stop comparison condition\&. Sequence
numbers of any gtid domain must comprise monotically growing sequence\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
.\" mariadb-binlog: stop-datetime option
.\" stop-datetime option: mariadb-binlog
\fB\-\-stop\-datetime=\fR\fB\fIdatetime\fR\fR
.sp
Stop reading the binary log at the first event having a timestamp equal to or later than the
\fIdatetime\fR
argument\&. This option is useful for point\-in\-time recovery\&. See the description of the
\fB\-\-start\-datetime\fR
option for information about the
\fIdatetime\fR
value\&.
.sp
This option is useful for point\-in\-time recovery\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
.\" mariadb-binlog: stop-never option
.\" stop-never option: mariadb-binlog
\fB\-\-stop\-never\fR
.sp
Wait for more data from the server instead of stopping at the end of the last log\&. Implies \fB--to-last-log\fR\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
.\" mariadb-binlog: stop-never-slave-server-id option
.\" stop-never-slave-server-id option: mariadb-binlog
\fB\-\-stop\-never-slave-server-id\fR
.sp
The slave server_id used for \fB--read-from-remote-server --stop-never\fR\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
.\" mariadb-binlog: stop-position option
.\" stop-position option: mariadb-binlog
\fB\-\-stop\-position=\fR\fB\fIN\fR\fR
.sp
Stop reading the binary log at the first event having a position equal to or
greater than \fIN\fR\&. Type can either be a positive integer or a GTID
list\&. When using a positive integer, the value only applies to the last log
file named on the command line\&. When in GTID mode, multiple GTIDs can be
passed as a comma separated list, where each must have a unique domain id\&.
Each GTID is inclusive; only events up to the given sequence numbers are
printed.
.sp
This option is useful for point\-in\-time recovery\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
.\" mariadb-binlog: table option
.\" table option: mariadb-binlog
\fB\-\-table\fR,
\fB\-T\fR
.sp
List entries for just this table (local log only)\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}

.\" mariadb-binlog: to-last-log option
.\" to-last-log option: mariadb-binlog
\fB\-\-to\-last\-log\fR,
\fB\-t\fR
.sp
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, so this option requires
\fB\-\-read\-from\-remote\-server\fR\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
.\" mariadb-binlog: user option
.\" user option: mariadb-binlog
\fB\-\-user=\fR\fB\fIuser_name\fR\fR,
\fB\-u \fR\fB\fIuser_name\fR\fR
.sp
The MariaDB username to use when connecting to a remote server\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
.\" mariadb-binlog: verbose option
.\" verbose option: mariadb-binlog
\fB\-\-verbose\fR,
\fB\-v\fR
.sp
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\&.
If this option is given three times, the output includes diagnostic warnings about event integrity before program exit\&.
.sp
For examples that show the effect of
\fB\-\-base64\-output\fR
and
\fB\-\-verbose\fR
on row event output, see
the section called \(lqMARIADB-BINLOG ROW EVENT DISPLAY\(rq\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
.\" mariadb-binlog: version option
.\" version option: mariadb-binlog
\fB\-\-version\fR,
\fB\-V\fR
.sp
Display version information and exit\&.
.RE
.PP
You can also set the following variable by using
\fB\-\-\fR\fB\fIvar_name\fR\fR\fB=\fR\fB\fIvalue\fR\fR
syntax:
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
.\" open_files_limit variable
open_files_limit
.sp
Specify the number of open file descriptors to reserve\&.
.RE
.PP
You can pipe the output of
\fBmariadb-binlog\fR
into the
\fBmariadb\fR
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\&. For example:
.sp
.if n \{\
.RS 4
.\}
.nf
shell> \fBmariadb-binlog binlog\&.000001 | mariadb \-u root \-p\fR
.fi
.if n \{\
.RE
.\}
.PP
Or:
.sp
.if n \{\
.RS 4
.\}
.nf
shell> \fBmariadb-binlog binlog\&.[0\-9]* | mariadb \-u root \-p\fR
.fi
.if n \{\
.RE
.\}
.PP
You can also redirect the output of
\fBmariadb-binlog\fR
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
\fBmariadb\fR
program:
.sp
.if n \{\
.RS 4
.\}
.nf
shell> \fBmariadb-binlog binlog\&.000001 > tmpfile\fR
shell> \&.\&.\&. \fIedit tmpfile\fR \&.\&.\&.
shell> \fBmariadb \-u root \-p < tmpfile\fR
.fi
.if n \{\
.RE
.\}
.PP
When
\fBmariadb-binlog\fR
is invoked with the
\fB\-\-start\-position\fR
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
\fB\-\-stop\-datetime\fR
option (to be able to say, for example,
\(lqroll forward my databases to how they were today at 10:30 a\&.m\&.\(rq)\&.
.PP
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
\fIunsafe\fR:
.sp
.if n \{\
.RS 4
.\}
.nf
shell> \fBmariadb-binlog binlog\&.000001 | mariadb \-u root \-p # DANGER!!\fR
shell> \fBmariadb-binlog binlog\&.000002 | mariadb \-u root \-p # DANGER!!\fR
.fi
.if n \{\
.RE
.\}
.PP
Processing binary logs this way using different 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
\fBmariadb\fR
process terminates, the server drops the temporary table\&. When the second
\fBmariadb\fR
process attempts to use the table, the server reports
\(lqunknown table\&.\(rq
.PP
To avoid problems like this, use a
\fIsingle\fR
\fBmariadb\fR
process to execute the contents of all binary logs that you want to process\&. Here is one way to do so:
.sp
.if n \{\
.RS 4
.\}
.nf
shell> \fBmariadb-binlog binlog\&.000001 binlog\&.000002 | mariadb \-u root \-p\fR
.fi
.if n \{\
.RE
.\}
.PP
Another approach is to write all the logs to a single file and then process the file:
.sp
.if n \{\
.RS 4
.\}
.nf
shell> \fBmariadb-binlog binlog\&.000001 >  /tmp/statements\&.sql\fR
shell> \fBmariadb-binlog binlog\&.000002 >> /tmp/statements\&.sql\fR
shell> \fBmariadb \-u root \-p \-e "source /tmp/statements\&.sql"\fR
.fi
.if n \{\
.RE
.\}
.PP
\fBmariadb-binlog\fR
can produce output that reproduces a
LOAD DATA INFILE
operation without the original data file\&.
\fBmariadb-binlog\fR
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
\fB\-\-local\-load\fR
option\&.
.PP
Because
\fBmariadb-binlog\fR
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\&.
.if n \{\
.sp
.\}
.RS 4
.it 1
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBWarning\fR
.ps -1
.br
.PP
The temporary files created for
LOAD DATA LOCAL
statements are
\fInot\fR
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
\fIoriginal_file_name\-#\-#\fR\&.
.sp .5v
.RE
.SH "MARIADB-BINLOG HEX DUMP FORMAT"
.PP
The
\fB\-\-hexdump\fR
option causes
\fBmariadb-binlog\fR
to produce a hex dump of the binary log contents:
.sp
.if n \{\
.RS 4
.\}
.nf
shell> \fBmariadb-binlog \-\-hexdump master\-bin\&.000001\fR
.fi
.if n \{\
.RE
.\}
.PP
The hex output consists of comment lines beginning with
#, so the output might look like this for the preceding command:
.sp
.if n \{\
.RS 4
.\}
.nf
/*!40019 SET @@session\&.max_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 startup
ROLLBACK;
.fi
.if n \{\
.RE
.\}
.PP
Hex dump output currently contains the elements in the following list\&. This format is subject to change\&. (For more information about binary log format, see
\m[blue]\fB\%http://forge.mysql.com/wiki/MySQL_Internals_Binary_Log\fR\m[]\&.)
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Position: The byte position within the log file\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Timestamp: The event timestamp\&. In the example shown, '9d fc 5c 43'
is the representation of '051024 17:24:13' in hexadecimal\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Type: The event type code\&. In the example shown, '0f' indicates a
FORMAT_DESCRIPTION_EVENT\&. The following table lists the possible type codes\&.
.TS
allbox tab(:);
l l lx.
T{
Type
T}:T{
Name
T}:T{
Meaning
T}
T{
00
T}:T{
UNKNOWN_EVENT
T}:T{
This event should never be present in the log\&.
T}
T{
01
T}:T{
START_EVENT_V3
T}:T{
This indicates the start of a log file written by MySQL 4 or earlier\&.
T}
T{
02
T}:T{
QUERY_EVENT
T}:T{
The most common type of events\&. These contain statements executed on the
master\&.
T}
T{
03
T}:T{
STOP_EVENT
T}:T{
Indicates that master has stopped\&.
T}
T{
04
T}:T{
ROTATE_EVENT
T}:T{
Written when the master switches to a new log file\&.
T}
T{
05
T}:T{
INTVAR_EVENT
T}:T{
Used for AUTO_INCREMENT values or when the
LAST_INSERT_ID()
function is used in the statement\&.
T}
T{
06
T}:T{
LOAD_EVENT
T}:T{
Used for LOAD DATA
INFILE in MySQL 3\&.23\&.
T}
T{
07
T}:T{
SLAVE_EVENT
T}:T{
Reserved for future use\&.
T}
T{
08
T}:T{
CREATE_FILE_EVENT
T}:T{
Used for LOAD DATA
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\&.
T}
T{
09
T}:T{
APPEND_BLOCK_EVENT
T}:T{
Contains data for use in a
LOAD DATA
INFILE statement\&. The data is stored in
the temporary file on the slave\&.
T}
T{
0a
T}:T{
EXEC_LOAD_EVENT
T}:T{
Used for LOAD DATA
INFILE statements\&. The contents of the
temporary file is stored in the table on the slave\&.
Used in MySQL 4 only\&.
T}
T{
0b
T}:T{
DELETE_FILE_EVENT
T}:T{
Rollback of a LOAD DATA
INFILE statement\&. The temporary file
should be deleted on the slave\&.
T}
T{
0c
T}:T{
NEW_LOAD_EVENT
T}:T{
Used for LOAD DATA
INFILE in MySQL 4 and earlier\&.
T}
T{
0d
T}:T{
RAND_EVENT
T}:T{
Used to send information about random values if the
RAND() function is
used in the statement\&.
T}
T{
0e
T}:T{
USER_VAR_EVENT
T}:T{
Used to replicate user variables\&.
T}
T{
0f
T}:T{
.nf
FORMAT_DESCRIPTION_EVENT
T}:T{
This indicates the start of a log file written by MySQL 5 or later\&.
T}
T{
10
T}:T{
XID_EVENT
T}:T{
Event indicating commit of an XA transaction\&.
T}
T{
11
T}:T{
BEGIN_LOAD_QUERY_EVENT
T}:T{
Used for LOAD DATA
INFILE statements in MySQL 5 and later\&.
T}
T{
12
T}:T{
EXECUTE_LOAD_QUERY_EVENT
T}:T{
Used for LOAD DATA
INFILE statements in MySQL 5 and later\&.
T}
T{
13
T}:T{
TABLE_MAP_EVENT
T}:T{
Information about a table definition\&. Used in MySQL 5\&.1\&.5 and later\&.
T}
T{
14
T}:T{
PRE_GA_WRITE_ROWS_EVENT
T}:T{
Row data for a single table that should be created\&. Used in MySQL 5\&.1\&.5
to 5\&.1\&.17\&.
T}
T{
15
T}:T{
PRE_GA_UPDATE_ROWS_EVENT
T}:T{
Row data for a single table that needs to be updated\&. Used in MySQL
5\&.1\&.5 to 5\&.1\&.17\&.
T}
T{
16
T}:T{
PRE_GA_DELETE_ROWS_EVENT
T}:T{
Row data for a single table that should be deleted\&. Used in MySQL 5\&.1\&.5
to 5\&.1\&.17\&.
T}
T{
17
T}:T{
WRITE_ROWS_EVENT
T}:T{
Row data for a single table that should be created\&. Used in MySQL 5\&.1\&.18
and later\&.
T}
T{
18
T}:T{
UPDATE_ROWS_EVENT
T}:T{
Row data for a single table that needs to be updated\&. Used in MySQL
5\&.1\&.18 and later\&.
T}
T{
19
T}:T{
DELETE_ROWS_EVENT
T}:T{
Row data for a single table that should be deleted\&. Used in MySQL 5\&.1\&.18
and later\&.
T}
T{
1a
T}:T{
INCIDENT_EVENT
T}:T{
Something out of the ordinary happened\&. Added in MySQL 5\&.1\&.18\&.
T}
.TE
.sp 1
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Master ID: The server ID of the master that created the event\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Size: The size in bytes of the event\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Master Pos: The position of the next event in the original master log file\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Flags: 16 flags\&. Currently, the following flags are used\&. The others are reserved for future use\&.
.TS
allbox tab(:);
l l lx.
T{
Flag
T}:T{
Name
T}:T{
Meaning
T}
T{
01
T}:T{
.nf
LOG_EVENT_BINLOG_IN_USE_F
T}:T{
Log 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)\&.
T}
T{
02
T}:T{
\ \&
T}:T{
Reserved for future use\&.
T}
T{
04
T}:T{
.nf
LOG_EVENT_THREAD_SPECIFIC_F
T}:T{
Set if the event is dependent on the connection it was executed in (for
example, '04 00'), for example,
if the event uses temporary tables\&.
T}
T{
08
T}:T{
LOG_EVENT_SUPPRESS_USE_F
T}:T{
Set in some circumstances when the event is not dependent on the default
database\&.
T}
.TE
.sp 1
.RE
.SH "MARIADB-BINLOG ROW EVENT DISPLAY"
.\" BINLOG statement: mariadb-binlog output
.PP
The following examples illustrate how
\fBmariadb-binlog\fR
displays row events that specify data modifications\&. These correspond to events with the
WRITE_ROWS_EVENT,
UPDATE_ROWS_EVENT, and
DELETE_ROWS_EVENT
type codes\&. The
\fB\-\-base64\-output=DECODE\-ROWS\fR
and
\fB\-\-verbose\fR
options may be used to affect row event output\&.
.PP
Suppose that the server is using row\-based binary logging and that you execute the following sequence of statements:
.sp
.if n \{\
.RS 4
.\}
.nf
CREATE TABLE t
(
  id   INT NOT NULL,
  name VARCHAR(20) NOT NULL,
  date DATE NULL
) ENGINE = InnoDB;
START TRANSACTION;
INSERT INTO t VALUES(1, 'apple', NULL);
UPDATE t SET name = 'pear', date = '2009\-01\-01' WHERE id = 1;
DELETE FROM t WHERE id = 1;
COMMIT;
.fi
.if n \{\
.RE
.\}
.PP
By default,
\fBmariadb-binlog\fR
displays row events encoded as base\-64 strings using
BINLOG
statements\&. Omitting extraneous lines, the output for the row events produced by the preceding statement sequence looks like this:
.sp
.if n \{\
.RS 4
.\}
.nf
shell> \fBmariadb-binlog \fR\fB\fIlog_file\fR\fR
\&.\&.\&.
# at 218
#080828 15:03:08 server id 1  end_log_pos 258 	Write_rows: table id 17 flags: STMT_END_F
BINLOG 'fAS3SBMBAAAALAAAANoAAAAAABEAAAAAAAAABHRlc3QAAXQAAwMPCgIUAAQ=
fAS3SBcBAAAAKAAAAAIBAAAQABEAAAAAAAEAA//8AQAAAAVhcHBsZQ=='/*!*/;
\&.\&.\&.
# at 302
#080828 15:03:08 server id 1  end_log_pos 356 	Update_rows: table id 17 flags: STMT_END_F
BINLOG 'fAS3SBMBAAAALAAAAC4BAAAAABEAAAAAAAAABHRlc3QAAXQAAwMPCgIUAAQ=
fAS3SBgBAAAANgAAAGQBAAAQABEAAAAAAAEAA////AEAAAAFYXBwbGX4AQAAAARwZWFyIbIP'/*!*/;
\&.\&.\&.
# at 400
#080828 15:03:08 server id 1  end_log_pos 442 	Delete_rows: table id 17 flags: STMT_END_F
BINLOG 'fAS3SBMBAAAALAAAAJABAAAAABEAAAAAAAAABHRlc3QAAXQAAwMPCgIUAAQ=
fAS3SBkBAAAAKgAAALoBAAAQABEAAAAAAAEAA//4AQAAAARwZWFyIbIP'/*!*/;
.fi
.if n \{\
.RE
.\}
.PP
To see the row events as comments in the form of
\(lqpseudo\-SQL\(rq
statements, run
\fBmariadb-binlog\fR
with the
\fB\-\-verbose\fR
or
\fB\-v\fR
option\&. The output will contain lines beginning with
###:
.sp
.if n \{\
.RS 4
.\}
.nf
shell> \fBmariadb-binlog \-v \fR\fB\fIlog_file\fR\fR
\&.\&.\&.
# at 218
#080828 15:03:08 server id 1  end_log_pos 258 	Write_rows: table id 17 flags: STMT_END_F
BINLOG 'fAS3SBMBAAAALAAAANoAAAAAABEAAAAAAAAABHRlc3QAAXQAAwMPCgIUAAQ=
fAS3SBcBAAAAKAAAAAIBAAAQABEAAAAAAAEAA//8AQAAAAVhcHBsZQ=='/*!*/;
### INSERT INTO test\&.t
### SET
###   @1=1
###   @2='apple'
###   @3=NULL
\&.\&.\&.
# at 302
#080828 15:03:08 server id 1  end_log_pos 356 	Update_rows: table id 17 flags: STMT_END_F
BINLOG 'fAS3SBMBAAAALAAAAC4BAAAAABEAAAAAAAAABHRlc3QAAXQAAwMPCgIUAAQ=
fAS3SBgBAAAANgAAAGQBAAAQABEAAAAAAAEAA////AEAAAAFYXBwbGX4AQAAAARwZWFyIbIP'/*!*/;
### UPDATE test\&.t
### WHERE
###   @1=1
###   @2='apple'
###   @3=NULL
### SET
###   @1=1
###   @2='pear'
###   @3='2009:01:01'
\&.\&.\&.
# at 400
#080828 15:03:08 server id 1  end_log_pos 442 	Delete_rows: table id 17 flags: STMT_END_F
BINLOG 'fAS3SBMBAAAALAAAAJABAAAAABEAAAAAAAAABHRlc3QAAXQAAwMPCgIUAAQ=
fAS3SBkBAAAAKgAAALoBAAAQABEAAAAAAAEAA//4AQAAAARwZWFyIbIP'/*!*/;
### DELETE FROM test\&.t
### WHERE
###   @1=1
###   @2='pear'
###   @3='2009:01:01'
.fi
.if n \{\
.RE
.\}
.PP
Specify
\fB\-\-verbose\fR
or
\fB\-v\fR
twice to also display data types and some metadata for each column\&. The output will contain an additional comment following each column change:
.sp
.if n \{\
.RS 4
.\}
.nf
shell> \fBmariadb-binlog \-vv \fR\fB\fIlog_file\fR\fR
\&.\&.\&.
# at 218
#080828 15:03:08 server id 1  end_log_pos 258 	Write_rows: table id 17 flags: STMT_END_F
BINLOG 'fAS3SBMBAAAALAAAANoAAAAAABEAAAAAAAAABHRlc3QAAXQAAwMPCgIUAAQ=
fAS3SBcBAAAAKAAAAAIBAAAQABEAAAAAAAEAA//8AQAAAAVhcHBsZQ=='/*!*/;
### INSERT INTO test\&.t
### SET
###   @1=1 /* INT meta=0 nullable=0 is_null=0 */
###   @2='apple' /* VARSTRING(20) meta=20 nullable=0 is_null=0 */
###   @3=NULL /* VARSTRING(20) meta=0 nullable=1 is_null=1 */
\&.\&.\&.
# at 302
#080828 15:03:08 server id 1  end_log_pos 356 	Update_rows: table id 17 flags: STMT_END_F
BINLOG 'fAS3SBMBAAAALAAAAC4BAAAAABEAAAAAAAAABHRlc3QAAXQAAwMPCgIUAAQ=
fAS3SBgBAAAANgAAAGQBAAAQABEAAAAAAAEAA////AEAAAAFYXBwbGX4AQAAAARwZWFyIbIP'/*!*/;
### UPDATE test\&.t
### WHERE
###   @1=1 /* INT meta=0 nullable=0 is_null=0 */
###   @2='apple' /* VARSTRING(20) meta=20 nullable=0 is_null=0 */
###   @3=NULL /* VARSTRING(20) meta=0 nullable=1 is_null=1 */
### SET
###   @1=1 /* INT meta=0 nullable=0 is_null=0 */
###   @2='pear' /* VARSTRING(20) meta=20 nullable=0 is_null=0 */
###   @3='2009:01:01' /* DATE meta=0 nullable=1 is_null=0 */
\&.\&.\&.
# at 400
#080828 15:03:08 server id 1  end_log_pos 442 	Delete_rows: table id 17 flags: STMT_END_F
BINLOG 'fAS3SBMBAAAALAAAAJABAAAAABEAAAAAAAAABHRlc3QAAXQAAwMPCgIUAAQ=
fAS3SBkBAAAAKgAAALoBAAAQABEAAAAAAAEAA//4AQAAAARwZWFyIbIP'/*!*/;
### DELETE FROM test\&.t
### WHERE
###   @1=1 /* INT meta=0 nullable=0 is_null=0 */
###   @2='pear' /* VARSTRING(20) meta=20 nullable=0 is_null=0 */
###   @3='2009:01:01' /* DATE meta=0 nullable=1 is_null=0 */
.fi
.if n \{\
.RE
.\}
.PP
You can tell
\fBmariadb-binlog\fR
to suppress the
BINLOG
statements for row events by using the
\fB\-\-base64\-output=DECODE\-ROWS\fR
option\&. This is similar to
\fB\-\-base64\-output=NEVER\fR
but does not exit with an error if a row event is found\&. The combination of
\fB\-\-base64\-output=DECODE\-ROWS\fR
and
\fB\-\-verbose\fR
provides a convenient way to see row events only as SQL statements:
.sp
.if n \{\
.RS 4
.\}
.nf
shell> \fBmariadb-binlog \-v \-\-base64\-output=DECODE\-ROWS \fR\fB\fIlog_file\fR\fR
\&.\&.\&.
# at 218
#080828 15:03:08 server id 1  end_log_pos 258 	Write_rows: table id 17 flags: STMT_END_F
### INSERT INTO test\&.t
### SET
###   @1=1
###   @2='apple'
###   @3=NULL
\&.\&.\&.
# at 302
#080828 15:03:08 server id 1  end_log_pos 356 	Update_rows: table id 17 flags: STMT_END_F
### UPDATE test\&.t
### WHERE
###   @1=1
###   @2='apple'
###   @3=NULL
### SET
###   @1=1
###   @2='pear'
###   @3='2009:01:01'
\&.\&.\&.
# at 400
#080828 15:03:08 server id 1  end_log_pos 442 	Delete_rows: table id 17 flags: STMT_END_F
### DELETE FROM test\&.t
### WHERE
###   @1=1
###   @2='pear'
###   @3='2009:01:01'
.fi
.if n \{\
.RE
.\}
.sp
.if n \{\
.sp
.\}
.RS 4
.it 1
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBNote\fR
.ps -1
.br
.PP
You should not suppress
BINLOG
statements if you intend to re\-execute
\fBmariadb-binlog\fR
output\&.
.sp .5v
.RE
.PP
The SQL statements produced by
\fB\-\-verbose\fR
for row events are much more readable than the corresponding
BINLOG
statements\&. However, they do not correspond exactly to the original SQL statements that generated the events\&. The following limitations apply:
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
The original column names are lost and replaced by
@\fIN\fR, where
\fIN\fR
is a column number\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Character set information is not available in the binary log, which affects string column display:
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
There is no distinction made between corresponding binary and nonbinary string types (BINARY
and
CHAR,
VARBINARY
and
VARCHAR,
BLOB
and
TEXT)\&. The output uses a data type of
STRING
for fixed\-length strings and
VARSTRING
for variable\-length strings\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
For multi\-byte character sets, the maximum number of bytes per character is not present in the binary log, so the length for string types is displayed in bytes rather than in characters\&. For example,
STRING(4)
will be used as the data type for values from either of these column types:
.sp
.if n \{\
.RS 4
.\}
.nf
CHAR(4) CHARACTER SET latin1
CHAR(2) CHARACTER SET ucs2
.fi
.if n \{\
.RE
.\}
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Due to the storage format for events of type
UPDATE_ROWS_EVENT,
UPDATE
statements are displayed with the
WHERE
clause preceding the
SET
clause\&.
.RE
.RE
.PP
Proper interpretation of row events requires the information from the format description event at the beginning of the binary log\&. Because
\fBmariadb-binlog\fR
does not know in advance whether the rest of the log contains row events, by default it displays the format description event using a
BINLOG
statement in the initial part of the output\&.
.PP
If the binary log is known not to contain any events requiring a
BINLOG
statement (that is, no row events), the
\fB\-\-base64\-output=NEVER\fR
option can be used to prevent this header from being written\&.
.SH "COPYRIGHT"
.br
.PP
Copyright 2007-2008 MySQL AB, 2008-2010 Sun Microsystems, Inc., 2010-2024 MariaDB Foundation
.PP
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.
.PP
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.
.PP
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-1335 USA or see http://www.gnu.org/licenses/.
.sp
.SH "NOTES"
.IP " 1." 4
Bug#42941
.RS 4
\%http://bugs.mysql.com/bug.php?id=42941
.RE
.SH "SEE ALSO"
For more information, please refer to the MariaDB Knowledge Base, available online at https://mariadb.com/kb/
.SH AUTHOR
MariaDB Foundation (http://www.mariadb.org/).