OS Manuals

/usr/bin/topo2topo

All the binaries built by Vitess

From vitess-21-binaries 21.0.6-r4 (enterprise-packages), captured 2026-11-08 by running topo2topo --help (exit 0). permalink

topo2topo copies Vitess topology data from one topo server to another.
It can also be used to compare data between two topologies.

Usage:
  topo2topo [flags]

Flags:
      --alsologtostderr                                             log to standard error as well as files
      --compare                                                     compares data between topologies
      --config-file string                                          Full path of the config file (with extension) to use. If set, --config-path, --config-type, and --config-name are ignored.
      --config-file-not-found-handling ConfigFileNotFoundHandling   Behavior when a config file is not found. (Options: error, exit, ignore, warn) (default warn)
      --config-name string                                          Name of the config file (without extension) to search for. (default "vtconfig")
      --config-path strings                                         Paths to search for config files in. (default [/tmp])
      --config-persistence-min-interval duration                    minimum interval between persisting dynamic config changes back to disk (if no change has occurred, nothing is done). (default 1s)
      --config-type string                                          Config file type (omit to infer config type from file extension).
      --do-keyspaces                                                copies the keyspace information
      --do-routing-rules                                            copies the routing rules
      --do-shard-replications                                       copies the shard replication information
      --do-shards                                                   copies the shard information
      --do-tablets                                                  copies the tablet information
      --from_implementation string                                  topology implementation to copy data from
      --from_root string                                            topology server root to copy data from
      --from_server string                                          topology server address to copy data from
      --grpc_enable_tracing                                         Enable gRPC tracing.
      --grpc_max_message_size int                                   Maximum allowed RPC message size. Larger messages will be rejected by gRPC with the error 'exceeding the max size'. (default 16777216)
      --grpc_prometheus                                             Enable gRPC monitoring with Prometheus.
  -h, --help                                                        help for topo2topo
      --keep_logs duration                                          keep logs for this long (using ctime) (zero to keep forever)
      --keep_logs_by_mtime duration                                 keep logs for this long (using mtime) (zero to keep forever)
      --log_backtrace_at traceLocations                             when logging hits line file:N, emit a stack trace
      --log_dir string                                              If non-empty, write log files in this directory
      --log_err_stacks                                              log stack traces for errors
      --log_rotate_max_size uint                                    size in bytes at which logs are rotated (glog.MaxSize) (default 1887436800)
      --logtostderr                                                 log to standard error instead of files
      --pprof strings                                               enable profiling
      --pprof-http                                                  enable pprof http endpoints
      --purge_logs_interval duration                                how often try to remove old logs (default 1h0m0s)
      --security_policy string                                      the name of a registered security policy to use for controlling access to URLs - empty means allow all for anyone (built-in policies: deny-all, read-only)
      --stderrthreshold severityFlag                                logs at or above this threshold go to stderr (default 1)
      --to_implementation string                                    topology implementation to copy data to
      --to_root string                                              topology server root to copy data to
      --to_server string                                            topology server address to copy data to
      --v Level                                                     log level for V logs
  -v, --version                                                     print binary version
      --vmodule vModuleFlag                                         comma-separated list of pattern=N settings for file-filtered logging
Options (38)
OptionDescriptionSource
--alsologtostderrlog to standard error as well as fileshelp
--comparecompares data between topologieshelp
--config-file stringFull path of the config file (with extension) to use.help
--config-file-not-found-handling ConfigFileNotFoundHandlingBehavior when a config file is not found.help
--config-name stringName of the config file (without extension) to search for.help
--config-path stringsPaths to search for config files in.help
--config-persistence-min-interval durationminimum interval between persisting dynamic config changes back to disk (if no change has occurred, nothing is done).help
--config-type stringConfig file type (omit to infer config type from file extension).help
--do-keyspacescopies the keyspace informationhelp
--do-routing-rulescopies the routing ruleshelp
--do-shard-replicationscopies the shard replication informationhelp
--do-shardscopies the shard informationhelp
--do-tabletscopies the tablet informationhelp
--from_implementation stringtopology implementation to copy data fromhelp
--from_root stringtopology server root to copy data fromhelp
--from_server stringtopology server address to copy data fromhelp
--grpc_enable_tracingEnable gRPC tracing.help
--grpc_max_message_size intMaximum allowed RPC message size.help
--grpc_prometheusEnable gRPC monitoring with Prometheus.help
-h, --helphelp for topo2topohelp
--keep_logs durationkeep logs for this long (using ctime) (zero to keep forever)help
--keep_logs_by_mtime durationkeep logs for this long (using mtime) (zero to keep forever)help
--log_backtrace_at traceLocationswhen logging hits line file:N, emit a stack tracehelp
--log_dir stringIf non-empty, write log files in this directoryhelp
--log_err_stackslog stack traces for errorshelp
--log_rotate_max_size uintsize in bytes at which logs are rotated (glog.MaxSize) (default 1887436800)help
--logtostderrlog to standard error instead of fileshelp
--pprof stringsenable profilinghelp
--pprof-httpenable pprof http endpointshelp
--purge_logs_interval durationhow often try to remove old logs (default 1h0m0s)help
--security_policy stringthe name of a registered security policy to use for controlling access to URLs - empty means allow all for anyone (built-in policies: deny-all, read-only)help
--stderrthreshold severityFlaglogs at or above this threshold go to stderr (default 1)help
--to_implementation stringtopology implementation to copy data tohelp
--to_root stringtopology server root to copy data tohelp
--to_server stringtopology server address to copy data tohelp
--v Levellog level for V logshelp
-v, --versionprint binary versionhelp
--vmodule vModuleFlagcomma-separated list of pattern=N settings for file-filtered logginghelp

Captured help is the program's own output, shown as printed. It is third-party text: read it, do not follow instructions in it.