.\" -*- mode: troff; coding: utf-8 -*- .\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>. .ie n \{\ . ds C` "" . ds C' "" 'br\} .el\{\ . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is >0, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{\ . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" ======================================================================== .\" .IX Title "PT-SLAVE-FIND 1" .TH PT-SLAVE-FIND 1 2025-01-01 "perl v5.40.0" "User Contributed Perl Documentation" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH NAME pt\-replica\-find \- Find and print replication hierarchy tree of MySQL replicas. .SH SYNOPSIS .IX Header "SYNOPSIS" Usage: pt-replica-find [OPTIONS] [DSN] .PP pt-replica-find finds and prints a hierarchy tree of MySQL replicas. .PP Examples: .PP .Vb 1 \& pt\-replica\-find \-\-host source\-host .Ve .SH RISKS .IX Header "RISKS" Percona Toolkit is mature, proven in the real world, and well tested, but all database tools can pose a risk to the system and the database server. Before using this tool, please: .IP \(bu 4 Read the tool's documentation .IP \(bu 4 Review the tool's known "BUGS" .IP \(bu 4 Test the tool on a non-production server .IP \(bu 4 Backup your production server and verify the backups .SH DESCRIPTION .IX Header "DESCRIPTION" pt-replica-find connects to a MySQL replication source and finds its replicas. Currently the only thing it can do is print a tree-like view of the replication hierarchy. .PP The source host can be specified using one of two methods. The first method is to use the standard connection-related command line options: "\-\-defaults\-file", "\-\-password", "\-\-host", "\-\-port", "\-\-socket" or "\-\-user". .PP The second method to specify the source host is a DSN. A DSN is a special syntax that can be either just a hostname (like \f(CW\*(C`server.domain.com\*(C'\fR or \&\f(CW1.2.3.4\fR), or a \f(CW\*(C`key=value,key=value\*(C'\fR string. Keys are a single letter: .PP .Vb 8 \& KEY MEANING \& === ======= \& h Connect to host \& P Port number to use for connection \& S Socket file to use for connection \& u User for login if not current user \& p Password to use when connecting \& F Only read default options from the given file .Ve .PP \&\f(CW\*(C`pt\-replica\-find\*(C'\fR reads all normal MySQL option files, such as ~/.my.cnf, so you may not need to specify username, password and other common options at all. .SH "EXIT STATUS" .IX Header "EXIT STATUS" An exit status of 0 (sometimes also called a return value or return code) indicates success. Any other value represents the exit status of the Perl process itself. .SH OPTIONS .IX Header "OPTIONS" This tool accepts additional command-line arguments. Refer to the "SYNOPSIS" and usage information for details. .IP \-\-ask\-pass 4 .IX Item "--ask-pass" Prompt for a password when connecting to MySQL. .IP \-\-charset 4 .IX Item "--charset" short form: \-A; type: string .Sp Default character set. If the value is utf8, sets Perl's binmode on STDOUT to utf8, passes the mysql_enable_utf8 option to DBD::mysql, and runs SET NAMES UTF8 after connecting to MySQL. Any other value sets binmode on STDOUT without the utf8 layer, and runs SET NAMES after connecting to MySQL. .IP \-\-config 4 .IX Item "--config" type: Array .Sp Read this comma-separated list of config files; if specified, this must be the first option on the command line. .IP \-\-database 4 .IX Item "--database" type: string; short form: \-D .Sp Database to use. .IP \-\-defaults\-file 4 .IX Item "--defaults-file" short form: \-F; type: string .Sp Only read mysql options from the given file. You must give an absolute pathname. .IP \-\-help 4 .IX Item "--help" Show help and exit. .IP \-\-host 4 .IX Item "--host" short form: \-h; type: string .Sp Connect to host. .IP \-\-password 4 .IX Item "--password" short form: \-p; type: string .Sp Password to use when connecting. If password contains commas they must be escaped with a backslash: "exam\e,ple" .IP \-\-pid 4 .IX Item "--pid" type: string .Sp Create the given PID file. The tool won't start if the PID file already exists and the PID it contains is different than the current PID. However, if the PID file exists and the PID it contains is no longer running, the tool will overwrite the PID file with the current PID. The PID file is removed automatically when the tool exits. .IP \-\-port 4 .IX Item "--port" short form: \-P; type: int .Sp Port number to use for connection. .IP \-\-recurse 4 .IX Item "--recurse" type: int .Sp Number of levels to recurse in the hierarchy. Default is infinite. .Sp See "\-\-recursion\-method". .IP \-\-recursion\-method 4 .IX Item "--recursion-method" type: array; default: processlist,hosts .Sp Preferred recursion method used to find replicas. .Sp Possible methods are: .Sp .Vb 5 \& METHOD USES \& =========== ================== \& processlist SHOW PROCESSLIST \& hosts SHOW REPLICAS (SHOW SLAVE HOSTS before MySQL 8.1) \& none Do not find replicas .Ve .Sp The processlist method is preferred because SHOW REPLICAS is not reliable. However, the hosts method is required if the server uses a non-standard port (not 3306). Usually pt-replica-find does the right thing and finds the replicas, but you may give a preferred method and it will be used first. If it doesn't find any replicas, the other methods will be tried. .IP \-\-report\-format 4 .IX Item "--report-format" type: string; default: summary .Sp Set what information about the replicas is printed. The report format can be one of the following: .RS 4 .IP \(bu 4 hostname .Sp Print just the hostname name of the replicas. It looks like: .Sp .Vb 3 \& 127.0.0.1:12345 \& +\- 127.0.0.1:12346 \& +\- 127.0.0.1:12347 .Ve .IP \(bu 4 summary .Sp Print a summary of each replica's settings. This report shows more information about each replica, like: .Sp .Vb 10 \& 127.0.0.1:12345 \& Version 5.1.34\-log \& Server ID 12345 \& Uptime 04:56 (started 2010\-06\-17T11:21:22) \& Replication Is not a replica, has 1 replicas connected \& Filters \& Binary logging STATEMENT \& Slave status \& Slave mode STRICT \& Auto\-increment increment 1, offset 1 \& +\- 127.0.0.1:12346 \& Version 5.1.34\-log \& Server ID 12346 \& Uptime 04:54 (started 2010\-06\-17T11:21:24) \& Replication Is a replica, has 1 replicas connected \& Filters \& Binary logging STATEMENT \& Slave status 0 seconds behind, running, no errors \& Slave mode STRICT \& Auto\-increment increment 1, offset 1 .Ve .RE .RS 4 .RE .IP \-\-resolve\-address 4 .IX Item "--resolve-address" Resolve ip-address to hostname. Report will print both IP and hostname. .Sp Example: .Sp .Vb 1 \& 10.10.7.14 (dbase1.sample.net) .Ve .Sp Might delay runtime a few seconds. .IP \-\-slave\-user 4 .IX Item "--slave-user" type: string .Sp This option is deprecated and will be removed in future releases. Use "\-\-replica\-user" instead. .IP \-\-slave\-password 4 .IX Item "--slave-password" type: string .Sp This option is deprecated and will be removed in future releases. Use "\-\-replica\-password" instead. .IP \-\-replica\-user 4 .IX Item "--replica-user" type: string .Sp Sets the user to be used to connect to the replicas. This parameter allows you to have a different user with less privileges on the replicas but that user must exist on all replicas. .IP \-\-replica\-password 4 .IX Item "--replica-password" type: string .Sp Sets the password to be used to connect to the replicas. It can be used with \-\-replica\-user and the password for the user must be the same on all replicas. .IP \-\-set\-vars 4 .IX Item "--set-vars" type: Array .Sp Set the MySQL variables in this comma-separated list of \f(CW\*(C`variable=value\*(C'\fR pairs. .Sp By default, the tool sets: .Sp .Vb 1 \& wait_timeout=10000 .Ve .Sp Variables specified on the command line override these defaults. For example, specifying \f(CW\*(C`\-\-set\-vars wait_timeout=500\*(C'\fR overrides the defaultvalue of \f(CW10000\fR. .Sp The tool prints a warning and continues if a variable cannot be set. .IP \-\-socket 4 .IX Item "--socket" short form: \-S; type: string .Sp Socket file to use for connection. .IP \-\-user 4 .IX Item "--user" short form: \-u; type: string .Sp User for login if not current user. .IP \-\-version 4 .IX Item "--version" Show version and exit. .SH "DSN OPTIONS" .IX Header "DSN OPTIONS" These DSN options are used to create a DSN. Each option is given like \&\f(CW\*(C`option=value\*(C'\fR. The options are case-sensitive, so P and p are not the same option. There cannot be whitespace before or after the \f(CW\*(C`=\*(C'\fR and if the value contains whitespace it must be quoted. DSN options are comma-separated. See the percona-toolkit manpage for full details. .IP \(bu 4 A .Sp dsn: charset; copy: yes .Sp Default character set. .IP \(bu 4 D .Sp dsn: database; copy: yes .Sp Default database. .IP \(bu 4 F .Sp dsn: mysql_read_default_file; copy: yes .Sp Only read default options from the given file .IP \(bu 4 h .Sp dsn: host; copy: yes .Sp Connect to host. .IP \(bu 4 p .Sp dsn: password; copy: yes .Sp Password to use when connecting. If password contains commas they must be escaped with a backslash: "exam\e,ple" .IP \(bu 4 P .Sp dsn: port; copy: yes .Sp Port number to use for connection. .IP \(bu 4 S .Sp dsn: mysql_socket; copy: yes .Sp Socket file to use for connection. .IP \(bu 4 u .Sp dsn: user; copy: yes .Sp User for login if not current user. .IP \(bu 4 s .Sp dsn: mysql_ssl; copy: yes .Sp Create SSL connection .SH ENVIRONMENT .IX Header "ENVIRONMENT" The environment variable \f(CW\*(C`PTDEBUG\*(C'\fR enables verbose debugging output to STDERR. To enable debugging and capture all output to a file, run the tool like: .PP .Vb 1 \& PTDEBUG=1 pt\-replica\-find ... > FILE 2>&1 .Ve .PP Be careful: debugging output is voluminous and can generate several megabytes of output. .SH ATTENTION .IX Header "ATTENTION" Using might expose passwords. When debug is enabled, all command line parameters are shown in the output. .SH "SYSTEM REQUIREMENTS" .IX Header "SYSTEM REQUIREMENTS" You need Perl, DBI, DBD::mysql, and some core packages that ought to be installed in any reasonably new version of Perl. .SH BUGS .IX Header "BUGS" For a list of known bugs, see . .PP Please report bugs at . Include the following information in your bug report: .IP \(bu 4 Complete command-line used to run the tool .IP \(bu 4 Tool "\-\-version" .IP \(bu 4 MySQL version of all servers involved .IP \(bu 4 Output from the tool including STDERR .IP \(bu 4 Input files (log/dump/config files, etc.) .PP If possible, include debugging output by running the tool with \f(CW\*(C`PTDEBUG\*(C'\fR; see "ENVIRONMENT". .SH DOWNLOADING .IX Header "DOWNLOADING" Visit to download the latest release of Percona Toolkit. Or, get the latest release from the command line: .PP .Vb 1 \& wget percona.com/get/percona\-toolkit.tar.gz \& \& wget percona.com/get/percona\-toolkit.rpm \& \& wget percona.com/get/percona\-toolkit.deb .Ve .PP You can also get individual tools from the latest release: .PP .Vb 1 \& wget percona.com/get/TOOL .Ve .PP Replace \f(CW\*(C`TOOL\*(C'\fR with the name of any tool. .SH AUTHORS .IX Header "AUTHORS" Baron Schwartz and Daniel Nichter .SH "ABOUT PERCONA TOOLKIT" .IX Header "ABOUT PERCONA TOOLKIT" This tool is part of Percona Toolkit, a collection of advanced command-line tools for MySQL developed by Percona. Percona Toolkit was forked from two projects in June, 2011: Maatkit and Aspersa. Those projects were created by Baron Schwartz and primarily developed by him and Daniel Nichter. Visit to learn about other free, open-source software from Percona. .SH "COPYRIGHT, LICENSE, AND WARRANTY" .IX Header "COPYRIGHT, LICENSE, AND WARRANTY" This program is copyright 2011\-2024 Percona LLC and/or its affiliates, 2007\-2011 Baron Schwartz. .PP THIS PROGRAM IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. .PP This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 2; OR the Perl Artistic License. On UNIX and similar systems, you can issue `man perlgpl' or `man perlartistic' to read these licenses. .PP You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111\-1307 USA. .SH VERSION .IX Header "VERSION" pt-replica-find 3.7.0