mysqlbinlog Options

The following options are supported by mysqlbinlog. They can be specified on the command line or in the [client] and [mysqlbinlog] option file groups.

Optiondefault valueDescriptionIntroduced     
-?, --helpDisplay a help statement.
--base64-output[=name](No default Value)Determine when the output statements should be base64-encoded BINLOG statements. Options (case-insensitive) include auto, unspec, always (deprecated), never and decode-rows. never disables it and works only for binlogs without row-based events; decode-rows decodes row events into commented SQL statements if the --verbose option is also given; Unlike never, mysqlbinlog does not exit with an error if a row event is found auto or unspec, the default, prints base64 only when necessary (i.e., for row-based events and format description events), and 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.; always prints base64 whenever possible, and is for debugging only and should not be used in a production system. If this option is not given, the default is auto; if it is given with no argument, always is used.MySQL 5.1.5
--binlog-row-event-max-size=val4294967040 (4GB)The maximum size in bytes of a row-based binary log event. Should be a multiple of 256. Minimum 256, maximum 18446744073709547520.MariaDB 5.5.45, MariaDB 10.0.17
--character-sets-dir=name(No default value)Directory where the character sets are.
-d, --database=name(No default value)Output entries from the binary log (local log only) that occur while name has been selected as the default database by USE. Only one database can be specified. The effects depend on whether the statement-based or row-based logging format is in use. For statement-based logging, the server will only log statements where the default database is name. The default database is set with the USE statement. For row-based logging, the server will log any updates to any tables in the named database, irrespective of the current database. Ignored in --raw mode.
-# [options], --debug[=options]d:t:o,/tmp/mysqlbinlog.traceIn a debug build, write a debugging log. A typical debug options string is d:t:o,file_name.
--debug-checkFALSEPrint some debug info at exit..MySQL 5.1.21
--debug-infoFALSEPrint some debug info and memory and CPU info at exit.MySQL 5.1.21
--default-auth=nameDefault authentication client-side plugin to use.MariaDB 5.5
--defaults-extra-file=nameRead 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=nameOnly read default options from the given file
, which can be the full path, or the path relative to the current directory.
--defaults-group-suffix=strAlso read groups with a suffix of str. For example, since mysqlbinlog 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-binFALSEDisable 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. NOTE: you will need a SUPER privilege to use this option.
-F, --force-if-openTRUEForce if binlog was not closed properly. Defaults to ON; use --skip-force-if-open to disable.
-B, --flashbackFALSESupport flashback mode.MariaDB 10.2.4
-f, --force-readFALSEIf 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.
-H, --hexdumpFALSEAugment output with hexadecimal and ASCII event dump.MySQL 5.1.2
-h, --host=name(No default value)Get the binlog from the MariaDB server on the given host.
-l path, --local-load=path(No default value)Prepare local temporary files for LOAD DATA INFILE in the specified directory. The temporary files are not automatically removed.
--no-defaultsDon't read default options from any option file
-o value, --offset=value0Skip the first value entries in the log.
--open_files_limit=# 64Reserve file descriptors for usage by mysqlbinlog.
-p[passwd], --password[=passwd](No default value)Password to connect to the remote server. The password can be omitted allow it be entered from the prompt, or an option file can be used to avoid the security risk of passing a password on the commandline.
--plugin-dir=dir_name,Directory for client-side plugins.MariaDB 5.5
-P num, --port=num0Port 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).
--position=# 4Removed in MariaDB 5.5. Use --start-position instead.
--print-defaultsPrint the program argument list from all option files and exit.
--protocol=name(No default value)The protocol of the connection (tcp,socket,pipe,memory).
--rawRequires -R. Output raw binlog data instead of SQL statements. Output files named after server logs.MariaDB 10.2.0
-R, --read-from-remote-serverFALSERead 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.
-r name, --result-file=name(No default value)Direct output to a given file. With --raw this is a prefix for the file names.
--rewrite-db=name(No default value)Updates to a database with a different name than the original. Example: rewrite-db='from->to'

For events that are binlogged 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 one specifies "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 (e.g. with --database=name ) happens after 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 (e.g. --rewrite-db="oldname->newname").
MariaDB 5.2.0
--server-id=idnum0Extract only binlog entries created by the server having the given id.MySQL 5.1.4
--set-charset=character_set(No default value)Add 'SET NAMES character_set' to the output to specify the character set to be used for processing log files.MySQL 5.1.12
--shared-memory-base-name=nameMYSQLShared-memory name to use for Windows connections using shared memory to a local server (started with the --shared-memory option). Case-sensitive.
-s, --short-formFALSEJust 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.
--skip-annotate-rows-eventsSkip all Annotate_rows events in the mysqlbinlog output (by default, mysqlbinlog prints Annotate_rows events, if the binary log does contain them).MariaDB 5.3
-S, --socket=name(No default value)For connections to localhost, the Unix socket file to use, or, on Windows, the name of the named pipe to use.
--start-datetime=datetime(No default value)Start reading the binlog at 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 DATETIME and TIMESTAMP 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=pos4Start reading the binlog at position pos. Applies to the first binlog passed on the command line.
--stop-datetime=name(No default value)Stop reading the binlog at first event having a datetime equal 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-neverWait for more data from the server instead of stopping at the end of the last log. Implies --to-last-log.MariaDB 10.2.0
--stop-never-slave-server-idThe slave server_id used for --read-from-remote-server --stop-never.MariaDB 10.2.0
--stop-position=pos18446744073709551615Stop reading the binlog at position pos. Applies to the last binlog passed on the command line. Ignored in --raw mode.
-t, --to-last-logFALSERequires -R or --read-from-remote-server . Will not stop at the end of the requested binlog but rather continue 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.
-u, --user=username(No default value)Connect to the remote server as username.
-v, --verboseReconstruct SQL statements out of row events. -v -v adds comments on column data typesMySQL 5.1.28
-V, --versionPrint version and exit.
--verify-binlog-checksumVerify binlog event checksums when reading a binlog file.MariaDB 5.3

See Also


Comments loading...