Movatterモバイル変換

6.6.9.1 mysqlbinlog Hex Dump Format

6.6.9.2 mysqlbinlog Row Event Display

6.6.9.3 Using mysqlbinlog to Back Up Binary Log Files

6.6.9.4 Specifying the mysqlbinlog Server ID

When using event groups, the file offsets of events may be grouped together and the comments of events may be grouped together. Do not mistake these grouped events for blank file offsets.

The end position (end_log_pos) thatmysqlbinlog states for an individual event that was part of a compressed transaction payload is the same as the end position of the original compressed payload. Multiple decompressed events can therefore have the same end position.

mysqlbinlog's own connection compression does less if transaction payloads are already compressed, but still operates on uncompressed transactions and headers.

Table 6.23 mysqlbinlog Options

• --help,-?

  Command-Line Format	--help

  Display a help message and exit.

• --base64-output=value

  Command-Line Format	--base64-output=value
  Type	String
  Default Value	AUTO
  Valid Values	AUTO NEVER DECODE-ROWS

  This option determines when events should be displayed encoded as base-64 strings usingBINLOG statements. The option has these permissible values (not case-sensitive):

  • AUTO ("automatic") orUNSPEC ("unspecified") displaysBINLOG statements automatically when necessary (that is, for format description events and row events). If no--base64-output option is given, the effect is the same as--base64-output=AUTO.

    Note

    AutomaticBINLOG display is the only safe behavior if you intend to use the output ofmysqlbinlog to re-execute binary log file contents. The other option values are intended only for debugging or testing purposes because they may produce output that does not include all events in executable form.

  • NEVER causesBINLOG statements not to be displayed.mysqlbinlog exits with an error if a row event is found that must be displayed usingBINLOG.

  • DECODE-ROWS specifies tomysqlbinlog that you intend for row events to be decoded and displayed as commented SQL statements by also specifying the--verbose option. LikeNEVER,DECODE-ROWS suppresses display ofBINLOG statements, but unlikeNEVER, it does not exit with an error if a row event is found.

  For examples that show the effect of--base64-output and--verbose on row event output, seeSection 6.6.9.2, “mysqlbinlog Row Event Display”.

• --bind-address=ip_address

  Command-Line Format	--bind-address=ip_address

  On a computer having multiple network interfaces, use this option to select which interface to use for connecting to the MySQL server.

• --binlog-row-event-max-size=N

  Command-Line Format	--binlog-row-event-max-size=#
  Type	Numeric
  Default Value	4294967040
  Minimum Value	256
  Maximum Value	18446744073709547520

  Specify the maximum size of a row-based binary log event, in bytes. Rows are grouped into events smaller than this size if possible. The value should be a multiple of 256. The default is 4GB.

• --character-sets-dir=dir_name

  Command-Line Format	--character-sets-dir=dir_name
  Type	Directory name

  The directory where character sets are installed. SeeSection 12.15, “Character Set Configuration”.

• --compress

  Command-Line Format	--compress[={OFF|ON}]
  Introduced	8.0.17
  Deprecated	8.0.18
  Type	Boolean
  Default Value	OFF

  Compress all information sent between the client and the server if possible. SeeSection 6.2.8, “Connection Compression Control”.

  This option was added in MySQL 8.0.17. As of MySQL 8.0.18 it is deprecated. Expect it to be removed in a future version of MySQL. SeeConfiguring Legacy Connection Compression.

• --compression-algorithms=value

  Command-Line Format	--compression-algorithms=value
  Introduced	8.0.18
  Type	Set
  Default Value	uncompressed
  Valid Values	zlib zstd uncompressed

  The permitted compression algorithms for connections to the server. The available algorithms are the same as for theprotocol_compression_algorithms system variable. The default value isuncompressed.

  For more information, seeSection 6.2.8, “Connection Compression Control”.

  This option was added in MySQL 8.0.18.

• --connection-server-id=server_id

  Command-Line Format	--connection-server-id=#]
  Type	Integer
  Default Value	0 (1)
  Minimum Value	0 (1)
  Maximum Value	4294967295

  --connection-server-id specifies the server ID thatmysqlbinlog reports when it connects to the server. It can be used to avoid a conflict with the ID of a replica server or anothermysqlbinlog process.

  If the--read-from-remote-server option is specified,mysqlbinlog reports a server ID of 0, which tells the server to disconnect after sending the last log file (nonblocking behavior). If the--stop-never option is also specified to maintain the connection to the server,mysqlbinlog reports a server ID of 1 by default instead of 0, and--connection-server-id can be used to replace that server ID if required. SeeSection 6.6.9.4, “Specifying the mysqlbinlog Server ID”.

• --database=db_name,-ddb_name

  Command-Line Format	--database=db_name
  Type	String

  This option causesmysqlbinlog to output entries from the binary log (local log only) that occur whiledb_name is been selected as the default database byUSE.

  The--database option formysqlbinlog is similar to the--binlog-do-db option formysqld, but can be used to specify only one database. If--database is given multiple times, only the last instance is used.

  The effects of this option depend on whether the statement-based or row-based logging format is in use, in the same way that the effects of--binlog-do-db depend on whether statement-based or row-based logging is in use.

  Statement-based logging.  The--database option works as follows:

  • Whiledb_name is the default database, statements are output whether they modify tables indb_name or a different database.

  • Unlessdb_name is 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 dropped is considered to be the default database when determining whether to output the statement.

  Suppose that the binary log was created by executing these statements using statement-based-logging:

  INSERT INTO test.t1 (i) VALUES(100);INSERT INTO db2.t2 (j)  VALUES(200);USE test;INSERT INTO test.t1 (i) VALUES(101);INSERT INTO t1 (i)      VALUES(102);INSERT INTO db2.t2 (j)  VALUES(201);USE db2;INSERT INTO test.t1 (i) VALUES(103);INSERT INTO db2.t2 (j)  VALUES(202);INSERT INTO t2 (j)      VALUES(203);

  mysqlbinlog --database=test does not output the first twoINSERT statements because there is no default database. It outputs the threeINSERT statements followingUSE test, but not the threeINSERT statements followingUSE db2.

  mysqlbinlog --database=db2 does not output the first twoINSERT statements because there is no default database. It does not output the threeINSERT statements followingUSE test, but does output the threeINSERT statements followingUSE db2.

  Row-based logging. mysqlbinlog outputs only entries that change tables belonging todb_name. The default database has no effect on this. Suppose that the binary log just described was created using row-based logging rather than statement-based logging.mysqlbinlog --database=test outputs only those entries that modifyt1 in the test database, regardless of whetherUSE was issued or what the default database is.

  If a server is running withbinlog_format set toMIXED and you want it to be possible to usemysqlbinlog with the--database option, you must ensure that tables that are modified are in the database selected byUSE. (In particular, no cross-database updates should be used.)

  When used together with the--rewrite-db option, the--rewrite-db option is applied first; then the--database option is applied, using the rewritten database name. The order in which the options are provided makes no difference in this regard.

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

  Command-Line Format	--debug[=debug_options]
  Type	String
  Default Value	d:t:o,/tmp/mysqlbinlog.trace

  Write a debugging log. A typicaldebug_options string isd:t:o,file_name. The default isd:t:o,/tmp/mysqlbinlog.trace.

  This option is available only if MySQL was built usingWITH_DEBUG. MySQL release binaries provided by Oracle arenot built using this option.

• --debug-check

  Command-Line Format	--debug-check
  Type	Boolean
  Default Value	FALSE

  Print some debugging information when the program exits.

  This option is available only if MySQL was built usingWITH_DEBUG. MySQL release binaries provided by Oracle arenot built using this option.

• --debug-info

  Command-Line Format	--debug-info
  Type	Boolean
  Default Value	FALSE

  Print debugging information and memory and CPU usage statistics when the program exits.

  This option is available only if MySQL was built usingWITH_DEBUG. MySQL release binaries provided by Oracle arenot built using this option.

• --default-auth=plugin

  Command-Line Format	--default-auth=plugin
  Type	String

  A hint about which client-side authentication plugin to use. SeeSection 8.2.17, “Pluggable Authentication”.

• --defaults-extra-file=file_name

  Command-Line Format	--defaults-extra-file=file_name
  Type	File name

  Read this option file after the global option file but (on Unix) before the user option file. If the file does not exist or is otherwise inaccessible, an error occurs. Iffile_name is not an absolute path name, it is interpreted relative to the current directory.

  For additional information about this and other option-file options, seeSection 6.2.2.3, “Command-Line Options that Affect Option-File Handling”.

• --defaults-file=file_name

  Command-Line Format	--defaults-file=file_name
  Type	File name

  Use only the given option file. If the file does not exist or is otherwise inaccessible, an error occurs. Iffile_name is not an absolute path name, it is interpreted relative to the current directory.

  Exception: Even with--defaults-file, client programs read.mylogin.cnf.

  For additional information about this and other option-file options, seeSection 6.2.2.3, “Command-Line Options that Affect Option-File Handling”.

• --defaults-group-suffix=str

  Command-Line Format	--defaults-group-suffix=str
  Type	String

  Read not only the usual option groups, but also groups with the usual names and a suffix ofstr. For example,mysqlbinlog normally reads the[client] and[mysqlbinlog] groups. If this option is given as--defaults-group-suffix=_other,mysqlbinlog also reads the[client_other] and[mysqlbinlog_other] groups.

  For additional information about this and other option-file options, seeSection 6.2.2.3, “Command-Line Options that Affect Option-File Handling”.

• --disable-log-bin,-D

  Command-Line Format	--disable-log-bin

  Disable binary logging. This is useful for avoiding an endless loop if you use the--to-last-log option and are sending the output to the same MySQL server. This option also is useful when restoring after an unexpected exit to avoid duplication of the statements you have logged.

  This option causesmysqlbinlog to include aSET sql_log_bin = 0 statement in its output to disable binary logging of the remaining output. Manipulating the session value of thesql_log_bin system variable is a restricted operation, so this option requires that you have privileges sufficient to set restricted session variables. SeeSection 7.1.9.1, “System Variable Privileges”.

• --exclude-gtids=gtid_set

  Command-Line Format	--exclude-gtids=gtid_set
  Type	String
  Default Value

  Do not display any of the groups listed in thegtid_set.

• --force-if-open,-F

  Command-Line Format	--force-if-open

  Read binary log files even if they are open or were not closed properly (IN_USE flag is set); do not fail if the file ends with a truncated event.

  TheIN_USE flag is set only for the binary log that is currently written by the server; if the server has crashed, the flag remains set until the server is started up again and recovers the binary log. Without this option,mysqlbinlog refuses to process a file with this flag set. Since the server may be in the process of writing the file, truncation of the last event is considered normal.

• --force-read,-f

  Command-Line Format	--force-read

  With this option, ifmysqlbinlog 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.

• --get-server-public-key

  Command-Line Format	--get-server-public-key
  Type	Boolean

  Request from the server the public key required for RSA key pair-based password exchange. This option applies to clients that authenticate with thecaching_sha2_password authentication plugin. For that plugin, the server does not send the public key unless requested. This option is ignored for accounts that do not authenticate with that plugin. It is also ignored if RSA-based password exchange is not used, as is the case when the client connects to the server using a secure connection.

  If--server-public-key-path=file_name is given and specifies a valid public key file, it takes precedence over--get-server-public-key.

  For information about thecaching_sha2_password plugin, seeSection 8.4.1.2, “Caching SHA-2 Pluggable Authentication”.

• --hexdump,-H

  Command-Line Format	--hexdump

  Display a hex dump of the log in comments, as described inSection 6.6.9.1, “mysqlbinlog Hex Dump Format”. The hex output can be helpful for replication debugging.

• --host=host_name,-hhost_name

  Command-Line Format	--host=host_name
  Type	String
  Default Value	localhost

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

• --idempotent

  Command-Line Format	--idempotent
  Type	Boolean
  Default Value	true

  Tell the MySQL Server to use idempotent mode while processing updates; this causes suppression of any duplicate-key or key-not-found errors that the server encounters in the current session while processing updates. This option may prove useful whenever it is desirable or necessary to replay one or more binary logs to a MySQL Server which may not contain all of the data to which the logs refer.

  The scope of effect for this option includes the currentmysqlbinlog client and session only.

• --include-gtids=gtid_set

  Command-Line Format	--include-gtids=gtid_set
  Type	String
  Default Value

  Display only the groups listed in thegtid_set.

• --local-load=dir_name,-ldir_name

  Command-Line Format	--local-load=dir_name
  Type	Directory name

  For data loading operations corresponding toLOAD DATA statements,mysqlbinlog extracts the files from the binary log events, writes them as temporary files to the local file system, and writesLOAD DATA LOCAL statements to cause the files to be loaded. By default,mysqlbinlog writes these temporary files to an operating system-specific directory. The--local-load option can be used to explicitly specify the directory wheremysqlbinlog should prepare local temporary files.

  Because other processes can write files to the default system-specific directory, it is advisable to specify the--local-load option tomysqlbinlog to designate a different directory for data files, and then designate that same directory by specifying the--load-data-local-dir option tomysql when processing the output frommysqlbinlog. For example:

  mysqlbinlog --local-load=/my/local/data ...    | mysql --load-data-local-dir=/my/local/data ...

  Important

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

• --login-path=name

  Command-Line Format	--login-path=name
  Type	String

  Read options from the named login path in the.mylogin.cnf login path file. A“login path” is an option group containing options that specify which MySQL server to connect to and which account to authenticate as. To create or modify a login path file, use themysql_config_editor utility. SeeSection 6.6.7, “mysql_config_editor — MySQL Configuration Utility”.

  For additional information about this and other option-file options, seeSection 6.2.2.3, “Command-Line Options that Affect Option-File Handling”.

• --no-defaults

  Command-Line Format	--no-defaults

  Do not read any option files. If program startup fails due to reading unknown options from an option file,--no-defaults can be used to prevent them from being read.

  The exception is that the.mylogin.cnf file is read in all cases, if it exists. This permits passwords to be specified in a safer way than on the command line even when--no-defaults is used. To create.mylogin.cnf, use themysql_config_editor utility. SeeSection 6.6.7, “mysql_config_editor — MySQL Configuration Utility”.

  For additional information about this and other option-file options, seeSection 6.2.2.3, “Command-Line Options that Affect Option-File Handling”.

• --offset=N,-oN

  Command-Line Format	--offset=#
  Type	Numeric

  Skip the firstN entries in the log.

• --open-files-limit=N

  Command-Line Format	--open-files-limit=#
  Type	Numeric
  Default Value	8
  Minimum Value	1
  Maximum Value	[platform dependent]

  Specify the number of open file descriptors to reserve.

• --password[=password],-p[password]

  Command-Line Format	--password[=password]
  Type	String

  The password of the MySQL account used for connecting to the server. The password value is optional. If not given,mysqlbinlog prompts for one. If given, there must beno space between--password= or-p and the password following it. If no password option is specified, the default is to send no password.

  Specifying a password on the command line should be considered insecure. To avoid giving the password on the command line, use an option file. SeeSection 8.1.2.1, “End-User Guidelines for Password Security”.

  To explicitly specify that there is no password and thatmysqlbinlog should not prompt for one, use the--skip-password option.

• --plugin-dir=dir_name

  Command-Line Format	--plugin-dir=dir_name
  Type	Directory name

  The directory in which to look for plugins. Specify this option if the--default-auth option is used to specify an authentication plugin butmysqlbinlog does not find it. SeeSection 8.2.17, “Pluggable Authentication”.

• --port=port_num,-Pport_num

  Command-Line Format	--port=port_num
  Type	Numeric
  Default Value	3306

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

• --print-defaults

  Command-Line Format	--print-defaults

  Print the program name and all options that it gets from option files.

  For additional information about this and other option-file options, seeSection 6.2.2.3, “Command-Line Options that Affect Option-File Handling”.

• --print-table-metadata

  Command-Line Format	--print-table-metadata

  Print table related metadata from the binary log. Configure the amount of table related metadata binary logged usingbinlog-row-metadata.

• --protocol={TCP|SOCKET|PIPE|MEMORY}

  Command-Line Format	--protocol=type
  Type	String
  Default Value	[see text]
  Valid Values	TCP SOCKET PIPE MEMORY

  The transport protocol to use for connecting to the server. It is useful when the other connection parameters normally result in use of a protocol other than the one you want. For details on the permissible values, seeSection 6.2.7, “Connection Transport Protocols”.

• --raw

  Command-Line Format	--raw
  Type	Boolean
  Default Value	FALSE

  By default,mysqlbinlog reads binary log files and writes events in text format. The--raw option tellsmysqlbinlog to write them in their original binary format. Its use requires that--read-from-remote-server also be used because the files are requested from a server.mysqlbinlog writes one output file for each file read from the server. The--raw option can be used to make a backup of a server's binary log. With the--stop-never option, the backup is“live” becausemysqlbinlog stays connected to the server. By default, output files are written in the current directory with the same names as the original log files. Output file names can be modified using the--result-file option. For more information, seeSection 6.6.9.3, “Using mysqlbinlog to Back Up Binary Log Files”.

• --read-from-remote-source=type

  Command-Line Format	--read-from-remote-source=type
  Introduced	8.0.26

  From MySQL 8.0.26, use--read-from-remote-source, and before MySQL 8.0.26, use--read-from-remote-master. Both options have the same effect. The options read binary logs from a MySQL server with theCOM_BINLOG_DUMP orCOM_BINLOG_DUMP_GTID commands by setting the option value to eitherBINLOG-DUMP-NON-GTIDS orBINLOG-DUMP-GTIDS, respectively. If--read-from-remote-source=BINLOG-DUMP-GTIDS or--read-from-remote-master=BINLOG-DUMP-GTIDS is combined with--exclude-gtids, transactions can be filtered out on the source, avoiding unnecessary network traffic.

  The connection parameter options are used with these options or the--read-from-remote-server option. These options are--host,--password,--port,--protocol,--socket, and--user. If none of the remote options is specified, the connection parameter options are ignored.

  TheREPLICATION SLAVE privilege is required to use these options.

• --read-from-remote-master=type

  Command-Line Format	--read-from-remote-master=type
  Deprecated	8.0.26

  Use this option before MySQL 8.0.26 rather than--read-from-remote-source. Both options have the same effect.

• --read-from-remote-server=file_name,-R

  Command-Line Format	--read-from-remote-server=file_name

  Read the binary log from a MySQL server rather than reading a local log file. This option requires that the remote server be running. It works only for binary log files on the remote server and not relay log files. This accepts the binary log file name (including the numeric suffix) without the file path.

  The connection parameter options are used with this option or the--read-from-remote-master option. These options are--host,--password,--port,--protocol,--socket, and--user. If neither of the remote options is specified, the connection parameter options are ignored.

  TheREPLICATION SLAVE privilege is required to use this option.

  This option is like--read-from-remote-master=BINLOG-DUMP-NON-GTIDS.

• --result-file=name,-rname

  Command-Line Format	--result-file=name

  Without the--raw option, this option indicates the file to whichmysqlbinlog writes text output. With--raw,mysqlbinlog writes one binary output file for each log file transferred from the server, writing them by default in the current directory using the same names as the original log file. In this case, the--result-file option value is treated as a prefix that modifies output file names.

• --require-row-format

  Command-Line Format	--require-row-format
  Introduced	8.0.19
  Type	Boolean
  Default Value	false

  Require row-based binary logging format for events. This option enforces row-based replication events formysqlbinlog output. The stream of events produced with this option would be accepted by a replication channel that is secured using theREQUIRE_ROW_FORMAT option of theCHANGE REPLICATION SOURCE TO statement (from MySQL 8.0.23) orCHANGE MASTER TO statement (before MySQL 8.0.23).binlog_format=ROW must be set on the server where the binary log was written. When you specify this option,mysqlbinlog stops with an error message if it encounters any events that are disallowed under theREQUIRE_ROW_FORMAT restrictions, includingLOAD DATA INFILE instructions, creating or dropping temporary tables,INTVAR,RAND, orUSER_VAR events, and non-row-based events within a DML transaction.mysqlbinlog also prints aSET @@session.require_row_format statement at the start of its output to apply the restrictions when the output is executed, and does not print theSET @@session.pseudo_thread_id statement.

  This option was added in MySQL 8.0.19.

• --rewrite-db='from_name->to_name'

  Command-Line Format	--rewrite-db='oldname->newname'
  Type	String
  Default Value	[none]

  When reading from a row-based or statement-based log, rewrite all occurrences offrom_name toto_name. Rewriting is done on the rows, for row-based logs, as well as on theUSE clauses, for statement-based logs.

  Warning

  Statements in which table names are qualified with database names are not rewritten to use the new name when using this option.

  The rewrite rule employed as a value for this option is a string having the form'from_name->to_name', as shown previously, and for this reason must be enclosed by quotation marks.

  To employ multiple rewrite rules, specify the option multiple times, as shown here:

  mysqlbinlog --rewrite-db='dbcurrent->dbold' --rewrite-db='dbtest->dbcurrent' \    binlog.00001 > /tmp/statements.sql

  When used together with the--database option, the--rewrite-db option is applied first; then--database option is applied, using the rewritten database name. The order in which the options are provided makes no difference in this regard.

  This means that, for example, ifmysqlbinlog is started with--rewrite-db='mydb->yourdb' --database=yourdb, then all updates to any tables in databasesmydb andyourdb are included in the output. On the other hand, if it is started with--rewrite-db='mydb->yourdb' --database=mydb, thenmysqlbinlog outputs no statements at all: since all updates tomydb are first rewritten as updates toyourdb before applying the--database option, there remain no updates that match--database=mydb.

• --server-id=id

  Command-Line Format	--server-id=id
  Type	Numeric

  Display only those events created by the server having the given server ID.

• --server-id-bits=N

  Command-Line Format	--server-id-bits=#
  Type	Numeric
  Default Value	32
  Minimum Value	7
  Maximum Value	32

  Use only the firstN bits of theserver_id to identify the server. If the binary log was written by amysqld with server-id-bits set to less than 32 and user data stored in the most significant bit, runningmysqlbinlog with--server-id-bits set to 32 enables this data to be seen.

  This option is supported only by the version ofmysqlbinlog supplied with the NDB Cluster distribution, or built with NDB Cluster support.

• --server-public-key-path=file_name

  Command-Line Format	--server-public-key-path=file_name
  Type	File name

  The path name to a file in PEM format containing a client-side copy of the public key required by the server for RSA key pair-based password exchange. This option applies to clients that authenticate with thesha256_password orcaching_sha2_password authentication plugin. This option is ignored for accounts that do not authenticate with one of those plugins. It is also ignored if RSA-based password exchange is not used, as is the case when the client connects to the server using a secure connection.

  If--server-public-key-path=file_name is given and specifies a valid public key file, it takes precedence over--get-server-public-key.

  Forsha256_password, this option applies only if MySQL was built using OpenSSL.

  For information about thesha256_password andcaching_sha2_password plugins, seeSection 8.4.1.3, “SHA-256 Pluggable Authentication”, andSection 8.4.1.2, “Caching SHA-2 Pluggable Authentication”.

• --set-charset=charset_name

  Command-Line Format	--set-charset=charset_name
  Type	String

  Add aSET NAMEScharset_name statement to the output to specify the character set to be used for processing log files.

• --shared-memory-base-name=name

  Command-Line Format	--shared-memory-base-name=name
  Platform Specific	Windows

  On Windows, the shared-memory name to use for connections made using shared memory to a local server. The default value isMYSQL. The shared-memory name is case-sensitive.

  This option applies only if the server was started with theshared_memory system variable enabled to support shared-memory connections.

• --short-form,-s

  Command-Line Format	--short-form

  Display only the statements contained in the log, without any extra information or row-based events. This is for testing only, and should not be used in production systems. It is deprecated, and you should expect it to be removed in a future release.

• --skip-gtids[=(true|false)]

  Command-Line Format	--skip-gtids[=true|false]
  Type	Boolean
  Default Value	false

  Do not include the GTIDs from the binary log files in the output dump file. For example:

  mysqlbinlog --skip-gtids binlog.000001 >  /tmp/dump.sqlmysql -u root -p -e "source /tmp/dump.sql"

  You should not normally use this option in production or in recovery, except in the specific, and rare, scenarios where the GTIDs are actively unwanted. For example, an administrator might want to duplicate selected transactions (such as table definitions) from a deployment to another, unrelated, deployment that will not replicate to or from the original. In that scenario,--skip-gtids can be used to enable the administrator to apply the transactions as if they were new, and ensure that the deployments remain unrelated. However, you should only use this option if the inclusion of the GTIDs causes a known issue for your use case.

• --socket=path,-Spath

  Command-Line Format	--socket={file_name|pipe_name}
  Type	String

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

  On Windows, this option applies only if the server was started with thenamed_pipe system variable enabled to support named-pipe connections. In addition, the user making the connection must be a member of the Windows group specified by thenamed_pipe_full_access_group system variable.

• --ssl*

  Options that begin with--ssl specify whether to connect to the server using encryption and indicate where to find SSL keys and certificates. SeeCommand Options for Encrypted Connections.

• --ssl-fips-mode={OFF|ON|STRICT}

  Command-Line Format	--ssl-fips-mode={OFF|ON|STRICT}
  Deprecated	8.0.34
  Type	Enumeration
  Default Value	OFF
  Valid Values	OFF ON STRICT

  Controls whether to enable FIPS mode on the client side. The--ssl-fips-mode option differs from other--ssl-xxx options in that it is not used to establish encrypted connections, but rather to affect which cryptographic operations to permit. SeeSection 8.8, “FIPS Support”.

  These--ssl-fips-mode values are permitted:

  • OFF: Disable FIPS mode.

  • ON: Enable FIPS mode.

  • STRICT: Enable“strict” FIPS mode.

  Note

  If the OpenSSL FIPS Object Module is not available, the only permitted value for--ssl-fips-mode isOFF. In this case, setting--ssl-fips-mode toON orSTRICT causes the client to produce a warning at startup and to operate in non-FIPS mode.

  As of MySQL 8.0.34, this option is deprecated. Expect it to be removed in a future version of MySQL.

• --start-datetime=datetime

  Command-Line Format	--start-datetime=datetime
  Type	Datetime

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

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

  This option is useful for point-in-time recovery. SeeSection 9.5, “Point-in-Time (Incremental) Recovery”.

• --start-position=N,-jN

  Command-Line Format	--start-position=#
  Type	Numeric

  Start decoding the binary log at the log positionN, including in the output any events that begin at positionN or after. The position is a byte point in the log file, not an event counter; it needs to point to the starting position of an event to generate useful output. This option applies to the first log file named on the command line.

  Prior to MySQL 8.0.33, the maximum value supported for this option was 4294967295 (2³²-1). In MySQL 8.0.33 and later, it is 18446744073709551616 (2⁶⁴-1), unless--read-from-remote-server or--read-from-remote-source is also used, in which case the maximum is 4294967295.

  This option is useful for point-in-time recovery. SeeSection 9.5, “Point-in-Time (Incremental) Recovery”.

• --stop-datetime=datetime

  Command-Line Format	--stop-datetime=datetime

  Stop reading the binary log at the first event having a timestamp equal to or later than thedatetime argument. See the description of the--start-datetime option for information about thedatetime value.

  This option is useful for point-in-time recovery. SeeSection 9.5, “Point-in-Time (Incremental) Recovery”.

• --stop-never

  Command-Line Format	--stop-never
  Type	Boolean
  Default Value	FALSE

  This option is used with--read-from-remote-server. It tellsmysqlbinlog to remain connected to the server. Otherwisemysqlbinlog exits when the last log file has been transferred from the server.--stop-never implies--to-last-log, so only the first log file to transfer need be named on the command line.

  --stop-never is commonly used with--raw to make a live binary log backup, but also can be used without--raw to maintain a continuous text display of log events as the server generates them.

  With--stop-never, by default,mysqlbinlog reports a server ID of 1 when it connects to the server. Use--connection-server-id to explicitly specify an alternative ID to report. It can be used to avoid a conflict with the ID of a replica server or anothermysqlbinlog process. SeeSection 6.6.9.4, “Specifying the mysqlbinlog Server ID”.

• --stop-never-slave-server-id=id

  Command-Line Format	--stop-never-slave-server-id=#
  Type	Numeric
  Default Value	65535
  Minimum Value	1

  This option is deprecated; expect it to be removed in a future release. Use the--connection-server-id option instead to specify a server ID formysqlbinlog to report.

• --stop-position=N

  Command-Line Format	--stop-position=#
  Type	Numeric

  Stop decoding the binary log at the log positionN, excluding from the output any events that begin at positionN or after. The position is a byte point in the log file, not an event counter; it needs to point to a spot after the starting position of the last event you want to include in the output. The event starting before positionN and finishing at or after the position is the last event to be processed. This option applies to the last log file named on the command line.

  This option is useful for point-in-time recovery. SeeSection 9.5, “Point-in-Time (Incremental) Recovery”.

• --tls-ciphersuites=ciphersuite_list

  Command-Line Format	--tls-ciphersuites=ciphersuite_list
  Introduced	8.0.16
  Type	String

  The permissible ciphersuites for encrypted connections that use TLSv1.3. The value is a list of one or more colon-separated ciphersuite names. The ciphersuites that can be named for this option depend on the SSL library used to compile MySQL. For details, seeSection 8.3.2, “Encrypted Connection TLS Protocols and Ciphers”.

  This option was added in MySQL 8.0.16.

• --tls-version=protocol_list

  Command-Line Format	--tls-version=protocol_list
  Type	String
  Default Value (≥ 8.0.16)	TLSv1,TLSv1.1,TLSv1.2,TLSv1.3 (OpenSSL 1.1.1 or higher) TLSv1,TLSv1.1,TLSv1.2 (otherwise)
  Default Value (≤ 8.0.15)	TLSv1,TLSv1.1,TLSv1.2

  The permissible TLS protocols for encrypted connections. The value is a list of one or more comma-separated protocol names. The protocols that can be named for this option depend on the SSL library used to compile MySQL. For details, seeSection 8.3.2, “Encrypted Connection TLS Protocols and Ciphers”.

• --to-last-log,-t

  Command-Line Format	--to-last-log

  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,-uuser_name

  Command-Line Format	--user=user_name,
  Type	String

  The user name of the MySQL account to use when connecting to a remote server.

  If you are using theRewriter plugin with MySQL 8.0.31 or later, you should grant this user theSKIP_QUERY_REWRITE privilege.

• --verbose,-v

  Command-Line Format	--verbose

  Reconstruct row events and display them as commented SQL statements, with table partition information where applicable. If this option is given twice (by passing in either "-vv" or "--verbose --verbose"), the output includes comments to indicate column data types and some metadata, and informational log events such as row query log events if thebinlog_rows_query_log_events system variable is set toTRUE.

  For examples that show the effect of--base64-output and--verbose on row event output, seeSection 6.6.9.2, “mysqlbinlog Row Event Display”.

• --verify-binlog-checksum,-c

  Command-Line Format	--verify-binlog-checksum

  Verify checksums in binary log files.

• --version,-V

  Command-Line Format	--version

  Display version information and exit.

  Unlike the case with previous versions of MySQL, the version number shown bymysqlbinlog when using this option is the same as the MySQL Server version.

• --zstd-compression-level=level

  Command-Line Format	--zstd-compression-level=#
  Introduced	8.0.18
  Type	Integer

  The compression level to use for connections to the server that use thezstd compression algorithm. The permitted levels are from 1 to 22, with larger values indicating increasing levels of compression. The defaultzstd compression level is 3. The compression level setting has no effect on connections that do not usezstd compression.

  For more information, seeSection 6.2.8, “Connection Compression Control”.

  This option was added in MySQL 8.0.18.

The temporary files created forLOAD DATA LOCAL statements arenot 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 likeoriginal_file_name-#-#.