Overview

The MariaDB server's binary log is a set of files containing "events" which represent modifications to the contents of a MariaDB database.

Events are written in a binary (that is, non-human-readable) format. The mariadb-binlog utility is used to view these events in plain text.

Run from a command line:

See for details on the available options.

Usage

Display the contents of a file named mariadb-bin.000152 like this:

Processing a Single Log File

The logging format is determined by the value of the system variable. If you are using statement-based logging, the output includes the SQL statement, the ID of the server the statement was executed on, a timestamp, and how much time the statement took to execute. If you are using row-based logging, the output of an event will not include an SQL statement, but will instead output how individual rows were changed.

The output from mariadb-binlog can be used as input to the mariadb client to redo the statements contained in a . This is useful for recovering after a server crash (replace binlog-filename with the name of a binary log file):

If you would like to view and possibly edit the file before applying it to your database, use the -r flag to redirect the output to a file (replace outputfile with the name of a file to store the output, and binlog-filename with the name of a binary log file):

In the output file, delete any statements you don't want executed (such as an accidental DROP DATABASE). Once you are satisfied with the contents, you can execute it:

Be careful to process multiple log files in a single connection, especially if one or more of them have any CREATE TEMPORARY TABLE ... statements. Temporary tables are dropped when the mariadb client terminates, so if you are processing multiple log files one at a time (i.e. multiple connections), and one log file creates a temporary table and then a subsequent log file refers to the table, you get an 'unknown table' error.

Processing Multiple Log Files

To execute multiple log files using a single connection, list them all on the mariadb-binlog command line:

If you need to manually edit the binlogs before executing them, combine them all into a single file before processing:

See Also

mysqlbinlog is a client tool which is called mariadb-binlog now. It can still be accessed under its original name via a symlink in Linux, or an alternate binary in Windows.

_{This page is licensed: CC BY-SA / Gnu FDL}

Overview

Annotate_rows events accompany row events and describe the query which caused the row event.

In the , each Annotate_rows event precedes the corresponding Table map event or the first of the Table map events, if there are more than one (for instance, in a case of multi-delete or insert delayed).

Example

Options

The following options control the behavior ofAnnotate_rows_log_event.

Master Option: --binlog-annotate-row-events

This option tells the master to write Annotate_rows events to the binary log. See for a detailed description of the variable.

Session values allow to annotate only some selected statements:

Replica Option: --replicate-annotate-row-events

This option tells the replica to reproduce Annotate_row events received from the master in its own binary log (sensible only when used in tandem with the log-slave-updates option).

See for a detailed description of the variable.

mariadb-binlog Option: --skip-annotate-row-events

This option tells to skip all Annotate_row events in its output (by default, mariadb-binlog prints Annotate_row events, if the binary log contains them).

Example of mariadb-binlog Output

See Also

_{This page is licensed: CC BY-SA / Gnu FDL}

Options

mariadb-binlog is a utility included with MariaDB for processing binary log and relay log files.

The following options are supported by . They can be specified on the command line or in option files.

-?, --help

Display a help statement.

Default value: auto.

--binlog-row-event-max-size=val

The maximum size in bytes of a row-based event. Should be a multiple of 256. Minimum 256, maximum 18446744073709547520. Default value: 4294967040 (4GB)

--character-sets-dir=name

Directory where the are.

-d, --database=name

Output entries from the binary log (local log only) that occur while the name has been selected as the default database by . Only one database can be specified. The effects depend on whether the is in use. For statement-based logging, the server only logs statements where the default database is name. The default database is set with the statement. For row-based logging, the server logs any updates to any tables in the named database, irrespective of the current database. Ignored in --raw mode.

## [options], --debug[=options]

In a debug build, write a debugging log. A typical debug options string is d:t:o,file\_name. Default value: d:t:o,/tmp/mariadb-binlog.trace

--debug-check

Print some debug info at exit. Default value: FALSE

--debug-info

Print some debug info and memory and CPU info at exit. Default value: FALSE

--default-auth=name

Default authentication client-side plugin to use.

--defaults-extra-file=name

Read the file name, which can be the full path or the path relative to the current directory, after the global files are read.

--defaults-file=name

Only read default options from the given file name, which can be the full path or the path relative to the current directory.

--defaults-group-suffix=str

Also read groups with a suffix of str. For example, since mariadb-binlog normally reads the [client] and [mysqlbinlog] groups, --defaults-group-suffix=x would cause it to also read the groups \[mysqlbinlog\_x] and \[client\_x].

-D, --disable-log-bin

Disable binary log. This is useful if you enabled --to-last-log and are sending the output to the same MariaDB server. This way, you could avoid an endless loop. You would also like to use it when restoring after a crash to avoid duplication of the statements you already have. The SUPER privilege is needed to use this option. Default value: FALSE

--do-domain-ids=name

A list of positive integers, separated by commas, that form a whitelist of domain ids. Any log event with a that originates from a domain id specified in this list is displayed. Cannot be used with --ignore-domain-ids. When used with --ignore-server-ids or --do-server-ids, the result is the intersection between the two datasets. Available from MariaDB 10.9.

--do-server-ids=name

A list of positive integers, separated by commas, that form a whitelist of server ids. Any log event originating from a server id specified in this list is displayed. Cannot be used with --ignore-server-ids. When used with --ignore-domain-ids or do-domain-ids, the result is the intersection between the two datasets. Alias for --server-id. Available from MariaDB 10.9.

-B, --flashback

Support mode. Default value: FALSE

-F, --force-if-open

Force if binlog was not closed properly. Defaults to ON; use --skip-force-if-open to disable. Default value: TRUE

-f, --force-read

If mariadb-binlog reads a binary log event that it does not recognize, it prints a warning, ignores the event, and continues. Without this option, mariadb-binlog stops if it reads such an event. Default value: FALSE

--gtid-strict-mode

Process binlog according to gtid-strict-mode specification. The start, stop positions are verified to satisfy the start < stop comparison condition. Sequence numbers of any domain must comprise a monotonically growing sequence. Defaults to ON; use --skip-gtid-strict-mode to disable. Available from MariaDB 10.8. Default value: TRUE

-H, --hexdump

Augment output with hexadecimal and ASCII event dump. Default value: FALSE

-h, --host=name

Get the binlog from the MariaDB server on the given host.

--ignore-domain-ids=name

A list of positive integers, separated by commas, that form a blacklist of domain ids. Any log event with a that originates from a domain id specified in this list is hidden. Cannot be used with --do-domain-ids. When used with --ignore-server-ids or --do-server-ids, the result is the intersection between the two datasets. Available from MariaDB 10.9.

--ignore-server-ids=name

A list of positive integers, separated by commas, that form a blacklist of server ids. Any log event originating from a server id specified in this list is hidden. Cannot be used with --do-server-ids. When used with --ignore-domain-ids or --do-domain-ids, the result is the intersection between the two datasets. Available from MariaDB 10.9.

-l path, --local-load=path

Prepare local temporary files for in the specified directory. The temporary files are not automatically removed.

--no-defaults

Don't read default options from any option file.

-o value, --offset=value

Skip the first value entries in the log. Default value: 0

--open_files_limit=#

Reserve file descriptors for usage by mariadb-binlog. Default value: 64

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

Password to connect to the remote server. The password can be omitted, allow it to be entered from the prompt, or an option file can be used to avoid the security risk of passing a password on the command line.

--plugin-dir=dir_name

Directory for client-side plugins.

-P num, --port=num

Port number to use for connection or 0 for default to, in order of preference, my.cnf, $MYSQL_TCP_PORT, /etc/services, built-in default (3306). Default value: 0

--position=#

Removed. Use --start-position instead.

--print-defaults

Print the program argument list from all option files and exit.

--print-row-count

Print row counts for each row of events. (Defaults to ON; use --skip-print-row-count to disable.) Default value: TRUE

--print-row-event-positions

Print row event positions. Defaults to on; use --skip-print-row-event-positions to disable.) Default value: TRUE

print-table-metadata

Print metadata stored in Table_map_log_event.

--protocol=name

The protocol of the connection (tcp, socket, pipe, memory).

--raw

Requires -R. Output raw binlog data instead of SQL statements. Output files are named after server logs.

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

Read binary logs from a remote 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. Default value: FALSE

-r name, --result-file=name

Direct output to a given file. With --raw, this is a prefix for the file names.

--rewrite-db=name

Updates to a database with a different name than the original. Example: rewrite-db='from->to'. For events that are logged as statements, rewriting the database constitutes changing a statement's default database from db1 to db2. There is no statement analysis or rewrite of any kind; that is, if you specify db1.tbl in the statement explicitly, that occurrence won't be changed to db2.tbl. Row-based events are rewritten correctly to use the new database name. Filtering (for instance, with --database=name) happens before the database rewrites have been performed. If you use this option on the command line and > has a special meaning to your command interpreter, quote the value (for instance, --rewrite-db="oldname->newname").

--server-id=idnum

Extract only binlog entries created by the server having the given id. From MariaDB 10.9, an alias for --do-server-ids. Default value: 0

--set-charset=character_set

Add SET NAMES character_set to the output to specify the to be used for processing log files.

--shared-memory-base-name=name

Shared-memory name to use for Windows connections using shared memory to a local server (started with the --shared-memory option). Case-sensitive. Default value: MYSQL

-s, --short-form

Just show regular queries: 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 --base64-output=never instead. Default value: FALSE

--skip-annotate-row-events

Skip all events in the mariadb-binlog output (by default, mariadb-binlog prints Annotate_rows events if the binary log contains them).

-S, --socket=name

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

--ssl

Enables . TLS is also enabled even without setting this option when certain other TLS options are set. The --ssl option does not enable by default. In order to verify the server certificate, you must specify the --ssl-verify-server-cert option. Default value: FALSE

--ssl-ca=name

Defines a path to a PEM file that should contain one or more X509 certificates for trusted Certificate Authorities (CAs) to use for . This option requires that you use the absolute path, not a relative path. See for more information. This option implies the --ssl option.

--ssl-capath=name

Defines a path to a directory that contains one or more PEM files that should each contain one X509 certificate for a trusted Certificate Authority (CA) to use for . This option requires that you use the absolute path, not a relative path. The directory specified by this option needs to be run through the command. See for more information. This option is only supported if the client was built with OpenSSL or yaSSL. If the client was built with GnuTLS or Schannel, then this option is not supported. See for more information about which libraries are used on which platforms. This option implies the --ssl option.

--ssl-cert=name

Defines a path to the X509 certificate file to use for . This option requires that you use the absolute path, not a relative path. This option implies the --ssl option.

--ssl-cipher=name

List of permitted ciphers or cipher suites to use for . This option implies the --ssl option.

--ssl-crl=name

Defines a path to a PEM file that should contain one or more revoked X509 certificates to use for . This option requires that you use the absolute path, not a relative path. See for more information. This option is only supported if the client was built with OpenSSL or Schannel. If the client was built with yaSSL or GnuTLS, then this option is not supported. See for more information about which libraries are used on which platforms.

--ssl-crlpath=name

Defines a path to a directory that contains one or more PEM files that should each contain one revoked X509 certificate to use for . This option requires that you use the absolute path, not a relative path. The directory specified by this option needs to be run through the command. See for more information. This option is only supported if the client was built with OpenSSL. If the client was built with yaSSL, GnuTLS, or Schannel, then this option is not supported. See for more information about which libraries are used on which platforms.

--ssl-key=name

Defines a path to a private key file to use for . This option requires that you use the absolute path, not a relative path. This option implies the --ssl option.

--ssl-verify-server-cert

Enables . This option is disabled by default. Default value: FALSE

--start-datetime=datetime

If specified, start reading the binlog at the first event having a datetime equal to or later than the argument; the argument must be a date and time in the local time zone, in any format accepted by the MariaDB server for and types, for example: 2014-12-25 11:25:56 (you should probably use quotes for your shell to set it properly). This option is useful for point-in-time recovery.

-j pos, --start-position=pos

Start reading the binlog at this position. Type can either be a positive integer or, from MariaDB 10.8, a list. When using a positive integer, the value only applies to the first binlog passed on the command line. 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 are printed to allow users to receive events after their current state. Default value: 4

--stop-datetime=name

If specified, stop reading the binlog at the first event having a datetime equal to or posterior to the argument; the argument must be a date and time in the local time zone, in any format accepted by the MariaDB server for DATETIME and TIMESTAMP types, for example: 2014-12-25 11:25:56 (you should probably use quotes for your shell to set it properly). Ignored in --raw mode.

--stop-never

Wait for more data from the server (and thus requires -R or --read-from-remote-server) instead of stopping at the end of the last log. Implies --to-last-log.

--stop-never-slave-server-id

The replica used for --read-from-remote-server --stop-never.

--stop-position=position

If specified, stop reading the binlog at this position. Type can either be a positive integer or, from MariaDB 10.8, a list. When using a positive integer, the value only applies to the last binlog passed on the command line. 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. Ignored in --raw mode.

-T, --table

List entries for just this table (affects only row events).

--tls-version=name

This option accepts a comma-separated list of TLS protocol versions. A TLS protocol version will only be enabled if it is present in this list. All other TLS protocol versions will not be permitted. See for more information. Default value: TLSv1.1,TLSv1.2,TLSv1.3

-t, --to-last-log

Requires -R or --read-from-remote-server. Does not stop at the end of the requested binlog but rather continues printing until the end of the last binlog of the MariaDB server. If you send the output to the same MariaDB server, that may lead to an endless loop. Default value: FALSE

-u, --user=username

Connect to the remote server as username.

-v, --verbose

Reconstruct SQL statements out of row events. -v -v adds comments on column data types.

-V, --version

Print version and exit.

--verify-binlog-checksum

Verify when reading a binlog file.

Option Files

In addition to reading options from the command line, mariadb-binlog can also read options from . If an unknown option is provided to mariadb-binlog in an option file, it is ignored.

The following options relate to how MariaDB command line tools handle option files. They must be given as the first argument on the command line:

mariadb-binlog is linked with . However, MariaDB Connector/C does not handle the parsing of option files for this client. That is performed by the server's option file parsing code. See for more information.

Option Groups

mariadb-binlog reads options from the following from the :

_{This page is licensed: CC BY-SA / Gnu FDL}