vitess.io/vitess@v0.16.2/doc/flags/14.0-to-15.0-transition/vtbackup.diff (about)

     1  diff --git a/flags/14.0/vtbackup.txt b/flags/15.0/vtbackup.txt
     2  index 15e5f21..7f81472 100644
     3  --- a/flags/14.0/vtbackup.txt
     4  +++ b/flags/15.0/vtbackup.txt
     5  @@ -1,318 +1,175 @@
     6   Usage of vtbackup:
     7  -      --allow_first_backup                                               Allow this job to take the first backup of an existing shard.
     8  -      --alsologtostderr                                                  log to standard error as well as files
     9  -      --app_idle_timeout duration                                        Idle timeout for app connections (default 1m0s)
    10  -      --app_pool_size int                                                Size of the connection pool for app connections (default 40)
    11  -      --azblob_backup_account_key_file string                            Path to a file containing the Azure Storage account key; if this flag is unset, the environment variable VT_AZBLOB_ACCOUNT_KEY will be used as the key itself (NOT a file path)
    12  -      --azblob_backup_account_name string                                Azure Storage Account name for backups; if this flag is unset, the environment variable VT_AZBLOB_ACCOUNT_NAME will be used
    13  -      --azblob_backup_container_name string                              Azure Blob Container Name
    14  -      --azblob_backup_parallelism int                                    Azure Blob operation parallelism (requires extra memory when increased) (default 1)
    15  -      --azblob_backup_storage_root string                                Root prefix for all backup-related Azure Blobs; this should exclude both initial and trailing '/' (e.g. just 'a/b' not '/a/b/')
    16  -      --backup_engine_implementation string                              Specifies which implementation to use for creating new backups (builtin or xtrabackup). Restores will always be done with whichever engine created a given backup. (default builtin)
    17  -      --backup_storage_block_size int                                    if backup_storage_compress is true, backup_storage_block_size sets the byte size for each block while compressing (default is 250000). (default 250000)
    18  -      --backup_storage_compress                                          if set, the backup files will be compressed (default is true). Set to false for instance if a backup_storage_hook is specified and it compresses the data. (default true)
    19  -      --backup_storage_hook string                                       if set, we send the contents of the backup files through this hook.
    20  -      --backup_storage_implementation string                             which implementation to use for the backup storage feature
    21  -      --backup_storage_number_blocks int                                 if backup_storage_compress is true, backup_storage_number_blocks sets the number of blocks that can be processed, at once, before the writer blocks, during compression (default is 2). It should be equal to the number of CPUs available for compression (default 2)
    22  -      --builtinbackup_mysqld_timeout duration                            how long to wait for mysqld to shutdown at the start of the backup (default 10m0s)
    23  -      --builtinbackup_progress duration                                  how often to send progress updates when backing up large files (default 5s)
    24  -      --catch-sigpipe                                                    catch and ignore SIGPIPE on stdout and stderr if specified
    25  -      --ceph_backup_storage_config string                                Path to JSON config file for ceph backup storage (default ceph_backup_config.json)
    26  -      --concurrency int                                                  (init restore parameter) how many concurrent files to restore at once (default 4)
    27  -      --consul_auth_static_file string                                   JSON File to read the topos/tokens from.
    28  -      --cpu_profile string                                               deprecated: use '-pprof=cpu' instead
    29  -      --datadog-agent-host string                                        host to send spans to. if empty, no tracing will be done
    30  -      --datadog-agent-port string                                        port to send spans to. if empty, no tracing will be done
    31  -      --db-config-allprivs-charset string                                deprecated: use db_charset (default utf8mb4)
    32  -      --db-config-allprivs-flags uint                                    deprecated: use db_flags
    33  -      --db-config-allprivs-flavor string                                 deprecated: use db_flavor
    34  -      --db-config-allprivs-host string                                   deprecated: use db_host
    35  -      --db-config-allprivs-pass string                                   db allprivs deprecated: use db_allprivs_password
    36  -      --db-config-allprivs-port int                                      deprecated: use db_port
    37  -      --db-config-allprivs-server_name string                            deprecated: use db_server_name
    38  -      --db-config-allprivs-ssl-ca string                                 deprecated: use db_ssl_ca
    39  -      --db-config-allprivs-ssl-ca-path string                            deprecated: use db_ssl_ca_path
    40  -      --db-config-allprivs-ssl-cert string                               deprecated: use db_ssl_cert
    41  -      --db-config-allprivs-ssl-key string                                deprecated: use db_ssl_key
    42  -      --db-config-allprivs-uname string                                  deprecated: use db_allprivs_user (default vt_allprivs)
    43  -      --db-config-allprivs-unixsocket string                             deprecated: use db_socket
    44  -      --db-config-app-charset string                                     deprecated: use db_charset (default utf8mb4)
    45  -      --db-config-app-flags uint                                         deprecated: use db_flags
    46  -      --db-config-app-flavor string                                      deprecated: use db_flavor
    47  -      --db-config-app-host string                                        deprecated: use db_host
    48  -      --db-config-app-pass string                                        db app deprecated: use db_app_password
    49  -      --db-config-app-port int                                           deprecated: use db_port
    50  -      --db-config-app-server_name string                                 deprecated: use db_server_name
    51  -      --db-config-app-ssl-ca string                                      deprecated: use db_ssl_ca
    52  -      --db-config-app-ssl-ca-path string                                 deprecated: use db_ssl_ca_path
    53  -      --db-config-app-ssl-cert string                                    deprecated: use db_ssl_cert
    54  -      --db-config-app-ssl-key string                                     deprecated: use db_ssl_key
    55  -      --db-config-app-uname string                                       deprecated: use db_app_user (default vt_app)
    56  -      --db-config-app-unixsocket string                                  deprecated: use db_socket
    57  -      --db-config-appdebug-charset string                                deprecated: use db_charset (default utf8mb4)
    58  -      --db-config-appdebug-flags uint                                    deprecated: use db_flags
    59  -      --db-config-appdebug-flavor string                                 deprecated: use db_flavor
    60  -      --db-config-appdebug-host string                                   deprecated: use db_host
    61  -      --db-config-appdebug-pass string                                   db appdebug deprecated: use db_appdebug_password
    62  -      --db-config-appdebug-port int                                      deprecated: use db_port
    63  -      --db-config-appdebug-server_name string                            deprecated: use db_server_name
    64  -      --db-config-appdebug-ssl-ca string                                 deprecated: use db_ssl_ca
    65  -      --db-config-appdebug-ssl-ca-path string                            deprecated: use db_ssl_ca_path
    66  -      --db-config-appdebug-ssl-cert string                               deprecated: use db_ssl_cert
    67  -      --db-config-appdebug-ssl-key string                                deprecated: use db_ssl_key
    68  -      --db-config-appdebug-uname string                                  deprecated: use db_appdebug_user (default vt_appdebug)
    69  -      --db-config-appdebug-unixsocket string                             deprecated: use db_socket
    70  -      --db-config-dba-charset string                                     deprecated: use db_charset (default utf8mb4)
    71  -      --db-config-dba-flags uint                                         deprecated: use db_flags
    72  -      --db-config-dba-flavor string                                      deprecated: use db_flavor
    73  -      --db-config-dba-host string                                        deprecated: use db_host
    74  -      --db-config-dba-pass string                                        db dba deprecated: use db_dba_password
    75  -      --db-config-dba-port int                                           deprecated: use db_port
    76  -      --db-config-dba-server_name string                                 deprecated: use db_server_name
    77  -      --db-config-dba-ssl-ca string                                      deprecated: use db_ssl_ca
    78  -      --db-config-dba-ssl-ca-path string                                 deprecated: use db_ssl_ca_path
    79  -      --db-config-dba-ssl-cert string                                    deprecated: use db_ssl_cert
    80  -      --db-config-dba-ssl-key string                                     deprecated: use db_ssl_key
    81  -      --db-config-dba-uname string                                       deprecated: use db_dba_user (default vt_dba)
    82  -      --db-config-dba-unixsocket string                                  deprecated: use db_socket
    83  -      --db-config-erepl-charset string                                   deprecated: use db_charset (default utf8mb4)
    84  -      --db-config-erepl-dbname string                                    deprecated: dbname does not need to be explicitly configured
    85  -      --db-config-erepl-flags uint                                       deprecated: use db_flags
    86  -      --db-config-erepl-flavor string                                    deprecated: use db_flavor
    87  -      --db-config-erepl-host string                                      deprecated: use db_host
    88  -      --db-config-erepl-pass string                                      db erepl deprecated: use db_erepl_password
    89  -      --db-config-erepl-port int                                         deprecated: use db_port
    90  -      --db-config-erepl-server_name string                               deprecated: use db_server_name
    91  -      --db-config-erepl-ssl-ca string                                    deprecated: use db_ssl_ca
    92  -      --db-config-erepl-ssl-ca-path string                               deprecated: use db_ssl_ca_path
    93  -      --db-config-erepl-ssl-cert string                                  deprecated: use db_ssl_cert
    94  -      --db-config-erepl-ssl-key string                                   deprecated: use db_ssl_key
    95  -      --db-config-erepl-uname string                                     deprecated: use db_erepl_user (default vt_erepl)
    96  -      --db-config-erepl-unixsocket string                                deprecated: use db_socket
    97  -      --db-config-filtered-charset string                                deprecated: use db_charset (default utf8mb4)
    98  -      --db-config-filtered-flags uint                                    deprecated: use db_flags
    99  -      --db-config-filtered-flavor string                                 deprecated: use db_flavor
   100  -      --db-config-filtered-host string                                   deprecated: use db_host
   101  -      --db-config-filtered-pass string                                   db filtered deprecated: use db_filtered_password
   102  -      --db-config-filtered-port int                                      deprecated: use db_port
   103  -      --db-config-filtered-server_name string                            deprecated: use db_server_name
   104  -      --db-config-filtered-ssl-ca string                                 deprecated: use db_ssl_ca
   105  -      --db-config-filtered-ssl-ca-path string                            deprecated: use db_ssl_ca_path
   106  -      --db-config-filtered-ssl-cert string                               deprecated: use db_ssl_cert
   107  -      --db-config-filtered-ssl-key string                                deprecated: use db_ssl_key
   108  -      --db-config-filtered-uname string                                  deprecated: use db_filtered_user (default vt_filtered)
   109  -      --db-config-filtered-unixsocket string                             deprecated: use db_socket
   110  -      --db-config-repl-charset string                                    deprecated: use db_charset (default utf8mb4)
   111  -      --db-config-repl-flags uint                                        deprecated: use db_flags
   112  -      --db-config-repl-flavor string                                     deprecated: use db_flavor
   113  -      --db-config-repl-host string                                       deprecated: use db_host
   114  -      --db-config-repl-pass string                                       db repl deprecated: use db_repl_password
   115  -      --db-config-repl-port int                                          deprecated: use db_port
   116  -      --db-config-repl-server_name string                                deprecated: use db_server_name
   117  -      --db-config-repl-ssl-ca string                                     deprecated: use db_ssl_ca
   118  -      --db-config-repl-ssl-ca-path string                                deprecated: use db_ssl_ca_path
   119  -      --db-config-repl-ssl-cert string                                   deprecated: use db_ssl_cert
   120  -      --db-config-repl-ssl-key string                                    deprecated: use db_ssl_key
   121  -      --db-config-repl-uname string                                      deprecated: use db_repl_user (default vt_repl)
   122  -      --db-config-repl-unixsocket string                                 deprecated: use db_socket
   123  -      --db-credentials-file string                                       db credentials file; send SIGHUP to reload this file
   124  -      --db-credentials-server string                                     db credentials server type ('file' - file implementation; 'vault' - HashiCorp Vault implementation) (default file)
   125  -      --db-credentials-vault-addr string                                 URL to Vault server
   126  -      --db-credentials-vault-path string                                 Vault path to credentials JSON blob, e.g.: secret/data/prod/dbcreds
   127  -      --db-credentials-vault-role-mountpoint string                      Vault AppRole mountpoint; can also be passed using VAULT_MOUNTPOINT environment variable (default approle)
   128  -      --db-credentials-vault-role-secretidfile string                    Path to file containing Vault AppRole secret_id; can also be passed using VAULT_SECRETID environment variable
   129  -      --db-credentials-vault-roleid string                               Vault AppRole id; can also be passed using VAULT_ROLEID environment variable
   130  -      --db-credentials-vault-timeout duration                            Timeout for vault API operations (default 10s)
   131  -      --db-credentials-vault-tls-ca string                               Path to CA PEM for validating Vault server certificate
   132  -      --db-credentials-vault-tokenfile string                            Path to file containing Vault auth token; token can also be passed using VAULT_TOKEN environment variable
   133  -      --db-credentials-vault-ttl duration                                How long to cache DB credentials from the Vault server (default 30m0s)
   134  -      --db_allprivs_password string                                      db allprivs password
   135  -      --db_allprivs_use_ssl                                              Set this flag to false to make the allprivs connection to not use ssl (default true)
   136  -      --db_allprivs_user string                                          db allprivs user userKey (default vt_allprivs)
   137  -      --db_app_password string                                           db app password
   138  -      --db_app_use_ssl                                                   Set this flag to false to make the app connection to not use ssl (default true)
   139  -      --db_app_user string                                               db app user userKey (default vt_app)
   140  -      --db_appdebug_password string                                      db appdebug password
   141  -      --db_appdebug_use_ssl                                              Set this flag to false to make the appdebug connection to not use ssl (default true)
   142  -      --db_appdebug_user string                                          db appdebug user userKey (default vt_appdebug)
   143  -      --db_charset string                                                Character set used for this tablet. (default utf8mb4)
   144  -      --db_conn_query_info                                               enable parsing and processing of QUERY_OK info fields
   145  -      --db_connect_timeout_ms int                                        connection timeout to mysqld in milliseconds (0 for no timeout)
   146  -      --db_dba_password string                                           db dba password
   147  -      --db_dba_use_ssl                                                   Set this flag to false to make the dba connection to not use ssl (default true)
   148  -      --db_dba_user string                                               db dba user userKey (default vt_dba)
   149  -      --db_erepl_password string                                         db erepl password
   150  -      --db_erepl_use_ssl                                                 Set this flag to false to make the erepl connection to not use ssl (default true)
   151  -      --db_erepl_user string                                             db erepl user userKey (default vt_erepl)
   152  -      --db_filtered_password string                                      db filtered password
   153  -      --db_filtered_use_ssl                                              Set this flag to false to make the filtered connection to not use ssl (default true)
   154  -      --db_filtered_user string                                          db filtered user userKey (default vt_filtered)
   155  -      --db_flags uint                                                    Flag values as defined by MySQL.
   156  -      --db_flavor string                                                 Flavor overrid. Valid value is FilePos.
   157  -      --db_host string                                                   The host name for the tcp connection.
   158  -      --db_port int                                                      tcp port
   159  -      --db_repl_password string                                          db repl password
   160  -      --db_repl_use_ssl                                                  Set this flag to false to make the repl connection to not use ssl (default true)
   161  -      --db_repl_user string                                              db repl user userKey (default vt_repl)
   162  -      --db_server_name string                                            server name of the DB we are connecting to.
   163  -      --db_socket string                                                 The unix socket to connect on. If this is specified, host and port will not be used.
   164  -      --db_ssl_ca string                                                 connection ssl ca
   165  -      --db_ssl_ca_path string                                            connection ssl ca path
   166  -      --db_ssl_cert string                                               connection ssl certificate
   167  -      --db_ssl_key string                                                connection ssl key
   168  -      --db_ssl_mode value                                                SSL mode to connect with. One of disabled, preferred, required, verify_ca & verify_identity.
   169  -      --db_tls_min_version string                                        Configures the minimal TLS version negotiated when SSL is enabled. Defaults to TLSv1.2. Options: TLSv1.0, TLSv1.1, TLSv1.2, TLSv1.3.
   170  -      --dba_idle_timeout duration                                        Idle timeout for dba connections (default 1m0s)
   171  -      --dba_pool_size int                                                Size of the connection pool for dba connections (default 20)
   172  -      --detach                                                           detached mode - run backups detached from the terminal
   173  -      --disable_active_reparents                                         if set, do not allow active reparents. Use this to protect a cluster using external reparents.
   174  -      --emit_stats                                                       If set, emit stats to push-based monitoring and stats backends
   175  -      --file_backup_storage_root string                                  root directory for the file backup storage
   176  -      --gcs_backup_storage_bucket string                                 Google Cloud Storage bucket to use for backups
   177  -      --gcs_backup_storage_root string                                   root prefix for all backup-related object names
   178  -      --grpc_auth_mode string                                            Which auth plugin implementation to use (eg: static)
   179  -      --grpc_auth_mtls_allowed_substrings string                         List of substrings of at least one of the client certificate names (separated by colon).
   180  -      --grpc_auth_static_client_creds string                             when using grpc_static_auth in the server, this file provides the credentials to use to authenticate with server
   181  -      --grpc_auth_static_password_file string                            JSON File to read the users/passwords from.
   182  -      --grpc_ca string                                                   server CA to use for gRPC connections, requires TLS, and enforces client certificate check
   183  -      --grpc_cert string                                                 server certificate to use for gRPC connections, requires grpc_key, enables TLS
   184  -      --grpc_compression string                                          Which protocol to use for compressing gRPC. Default: nothing. Supported: snappy
   185  -      --grpc_crl string                                                  path to a certificate revocation list in PEM format, client certificates will be further verified against this file during TLS handshake
   186  -      --grpc_enable_optional_tls                                         enable optional TLS mode when a server accepts both TLS and plain-text connections on the same port
   187  -      --grpc_enable_tracing                                              Enable GRPC tracing
   188  -      --grpc_initial_conn_window_size int                                gRPC initial connection window size
   189  -      --grpc_initial_window_size int                                     gRPC initial window size
   190  -      --grpc_keepalive_time duration                                     After a duration of this time, if the client doesn't see any activity, it pings the server to see if the transport is still alive. (default 10s)
   191  -      --grpc_keepalive_timeout duration                                  After having pinged for keepalive check, the client waits for a duration of Timeout and if no activity is seen even after that the connection is closed. (default 10s)
   192  -      --grpc_key string                                                  server private key to use for gRPC connections, requires grpc_cert, enables TLS
   193  -      --grpc_max_connection_age duration                                 Maximum age of a client connection before GoAway is sent. (default 2562047h47m16.854775807s)
   194  -      --grpc_max_connection_age_grace duration                           Additional grace period after grpc_max_connection_age, after which connections are forcibly closed. (default 2562047h47m16.854775807s)
   195  -      --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)
   196  -      --grpc_port int                                                    Port to listen on for gRPC calls
   197  -      --grpc_prometheus                                                  Enable gRPC monitoring with Prometheus
   198  -      --grpc_server_ca string                                            path to server CA in PEM format, which will be combine with server cert, return full certificate chain to clients
   199  -      --grpc_server_initial_conn_window_size int                         gRPC server initial connection window size
   200  -      --grpc_server_initial_window_size int                              gRPC server initial window size
   201  -      --grpc_server_keepalive_enforcement_policy_min_time duration       gRPC server minimum keepalive time (default 10s)
   202  -      --grpc_server_keepalive_enforcement_policy_permit_without_stream   gRPC server permit client keepalive pings even when there are no active streams (RPCs)
   203  -      --init_db_name_override string                                     (init parameter) override the name of the db used by vttablet
   204  -      --init_db_sql_file string                                          path to .sql file to run after mysql_install_db
   205  -      --init_keyspace string                                             (init parameter) keyspace to use for this tablet
   206  -      --init_shard string                                                (init parameter) shard to use for this tablet
   207  -      --initial_backup                                                   Instead of restoring from backup, initialize an empty database with the provided init_db_sql_file and upload a backup of that for the shard, if the shard has no backups yet. This can be used to seed a brand new shard with an initial, empty backup. If any backups already exist for the shard, this will be considered a successful no-op. This can only be done before the shard exists in topology (i.e. before any tablets are deployed).
   208  -      --jaeger-agent-host string                                         host and port to send spans to. if empty, no tracing will be done
   209  -      --keep_logs duration                                               keep logs for this long (using ctime) (zero to keep forever)
   210  -      --keep_logs_by_mtime duration                                      keep logs for this long (using mtime) (zero to keep forever)
   211  -      --lameduck-period duration                                         keep running at least this long after SIGTERM before stopping (default 50ms)
   212  -      --log_backtrace_at value                                           when logging hits line file:N, emit a stack trace
   213  -      --log_dir string                                                   If non-empty, write log files in this directory
   214  -      --log_err_stacks                                                   log stack traces for errors
   215  -      --log_rotate_max_size uint                                         size in bytes at which logs are rotated (glog.MaxSize) (default 1887436800)
   216  -      --logtostderr                                                      log to standard error instead of files
   217  -      --master_connect_retry duration                                    Deprecated, use -replication_connect_retry (default 10s)
   218  -      --mem-profile-rate int                                             deprecated: use '-pprof=mem' instead (default 524288)
   219  -      --min_backup_interval duration                                     Only take a new backup if it's been at least this long since the most recent backup.
   220  -      --min_retention_count int                                          Always keep at least this many of the most recent backups in this backup storage location, even if some are older than the min_retention_time. This must be at least 1 since a backup must always exist to allow new backups to be made (default 1)
   221  -      --min_retention_time duration                                      Keep each old backup for at least this long before removing it. Set to 0 to disable pruning of old backups.
   222  -      --mutex-profile-fraction int                                       deprecated: use '-pprof=mutex' instead
   223  -      --mycnf-file string                                                path to my.cnf, if reading all config params from there
   224  -      --mycnf_bin_log_path string                                        mysql binlog path
   225  -      --mycnf_data_dir string                                            data directory for mysql
   226  -      --mycnf_error_log_path string                                      mysql error log path
   227  -      --mycnf_general_log_path string                                    mysql general log path
   228  -      --mycnf_innodb_data_home_dir string                                Innodb data home directory
   229  -      --mycnf_innodb_log_group_home_dir string                           Innodb log group home directory
   230  -      --mycnf_master_info_file string                                    mysql master.info file
   231  -      --mycnf_mysql_port int                                             port mysql is listening on
   232  -      --mycnf_pid_file string                                            mysql pid file
   233  -      --mycnf_relay_log_index_path string                                mysql relay log index path
   234  -      --mycnf_relay_log_info_path string                                 mysql relay log info path
   235  -      --mycnf_relay_log_path string                                      mysql relay log path
   236  -      --mycnf_secure_file_priv string                                    mysql path for loading secure files
   237  -      --mycnf_server_id int                                              mysql server id of the server (if specified, mycnf-file will be ignored)
   238  -      --mycnf_slow_log_path string                                       mysql slow query log path
   239  -      --mycnf_socket_file string                                         mysql socket file
   240  -      --mycnf_tmp_dir string                                             mysql tmp directory
   241  -      --mysql_auth_server_static_file string                             JSON File to read the users/passwords from.
   242  -      --mysql_auth_server_static_string string                           JSON representation of the users/passwords config.
   243  -      --mysql_auth_static_reload_interval duration                       Ticker to reload credentials
   244  -      --mysql_clientcert_auth_method string                              client-side authentication method to use. Supported values: mysql_clear_password, dialog. (default mysql_clear_password)
   245  -      --mysql_port int                                                   mysql port (default 3306)
   246  -      --mysql_server_flush_delay duration                                Delay after which buffered response will be flushed to the client. (default 100ms)
   247  -      --mysql_server_version string                                      MySQL server version to advertise.
   248  -      --mysql_socket string                                              path to the mysql socket
   249  -      --mysql_timeout duration                                           how long to wait for mysqld startup (default 5m0s)
   250  -      --mysqlctl_client_protocol string                                  the protocol to use to talk to the mysqlctl server (default grpc)
   251  -      --mysqlctl_mycnf_template string                                   template file to use for generating the my.cnf file during server init
   252  -      --mysqlctl_socket string                                           socket file to use for remote mysqlctl actions (empty for local actions)
   253  -      --onclose_timeout duration                                         wait no more than this for OnClose handlers before stopping (default 1ns)
   254  -      --onterm_timeout duration                                          wait no more than this for OnTermSync handlers before stopping (default 10s)
   255  -      --pid_file string                                                  If set, the process will write its pid to the named file, and delete it on graceful shutdown.
   256  -      --pool_hostname_resolve_interval duration                          if set force an update to all hostnames and reconnect if changed, defaults to 0 (disabled)
   257  -      --pprof string                                                     enable profiling
   258  -      --purge_logs_interval duration                                     how often try to remove old logs (default 1h0m0s)
   259  -      --remote_operation_timeout duration                                time to wait for a remote operation (default 30s)
   260  -      --replication_connect_retry duration                               how long to wait in between replica reconnect attempts. Only precise to the second. (default 10s)
   261  -      --replication_timeout duration                                     DEPRECATED AND UNUSED (default 1h0m0s)
   262  -      --restart_before_backup                                            Perform a mysqld clean/full restart after applying binlogs, but before taking the backup. Only makes sense to work around xtrabackup bugs.
   263  -      --s3_backup_aws_endpoint string                                    endpoint of the S3 backend (region must be provided)
   264  -      --s3_backup_aws_region string                                      AWS region to use (default us-east-1)
   265  -      --s3_backup_aws_retries int                                        AWS request retries (default -1)
   266  -      --s3_backup_force_path_style                                       force the s3 path style
   267  -      --s3_backup_log_level string                                       determine the S3 loglevel to use from LogOff, LogDebug, LogDebugWithSigning, LogDebugWithHTTPBody, LogDebugWithRequestRetries, LogDebugWithRequestErrors (default LogOff)
   268  -      --s3_backup_server_side_encryption string                          server-side encryption algorithm (e.g., AES256, aws:kms, sse_c:/path/to/key/file)
   269  -      --s3_backup_storage_bucket string                                  S3 bucket to use for backups
   270  -      --s3_backup_storage_root string                                    root prefix for all backup-related object names
   271  -      --s3_backup_tls_skip_verify_cert                                   skip the 'certificate is valid' check for SSL connections
   272  -      --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)
   273  -      --service_map value                                                comma separated list of services to enable (or disable if prefixed with '-') Example: grpc-vtworker
   274  -      --sql-max-length-errors int                                        truncate queries in error logs to the given length (default unlimited)
   275  -      --sql-max-length-ui int                                            truncate queries in debug UIs to the given length (default 512) (default 512)
   276  -      --stats_backend string                                             The name of the registered push-based monitoring/stats backend to use
   277  -      --stats_combine_dimensions string                                  List of dimensions to be combined into a single "all" value in exported stats vars
   278  -      --stats_common_tags string                                         Comma-separated list of common tags for the stats backend. It provides both label and values. Example: label1:value1,label2:value2
   279  -      --stats_drop_variables string                                      Variables to be dropped from the list of exported variables.
   280  -      --stats_emit_period duration                                       Interval between emitting stats to all registered backends (default 1m0s)
   281  -      --stderrthreshold value                                            logs at or above this threshold go to stderr (default 1)
   282  -      --tablet_dir string                                                The directory within the vtdataroot to store vttablet/mysql files. Defaults to being generated by the tablet uid.
   283  -      --tablet_manager_grpc_ca string                                    the server ca to use to validate servers when connecting
   284  -      --tablet_manager_grpc_cert string                                  the cert to use to connect
   285  -      --tablet_manager_grpc_concurrency int                              concurrency to use to talk to a vttablet server for performance-sensitive RPCs (like ExecuteFetchAs{Dba,AllPrivs,App}) (default 8)
   286  -      --tablet_manager_grpc_connpool_size int                            number of tablets to keep tmclient connections open to (default 100)
   287  -      --tablet_manager_grpc_crl string                                   the server crl to use to validate server certificates when connecting
   288  -      --tablet_manager_grpc_key string                                   the key to use to connect
   289  -      --tablet_manager_grpc_server_name string                           the server name to use to validate server certificate
   290  -      --tablet_manager_protocol string                                   the protocol to use to talk to vttablet (default grpc)
   291  -      --timeout duration                                                 DEPRECATED AND UNUSED (default 2h0m0s)
   292  -      --topo_consul_lock_delay duration                                  LockDelay for consul session. (default 15s)
   293  -      --topo_consul_lock_session_checks string                           List of checks for consul session. (default serfHealth)
   294  -      --topo_consul_lock_session_ttl string                              TTL for consul session.
   295  -      --topo_consul_watch_poll_duration duration                         time of the long poll for watch queries. (default 30s)
   296  -      --topo_etcd_lease_ttl int                                          Lease TTL for locks and leader election. The client will use KeepAlive to keep the lease going. (default 30)
   297  -      --topo_etcd_tls_ca string                                          path to the ca to use to validate the server cert when connecting to the etcd topo server
   298  -      --topo_etcd_tls_cert string                                        path to the client cert to use to connect to the etcd topo server, requires topo_etcd_tls_key, enables TLS
   299  -      --topo_etcd_tls_key string                                         path to the client key to use to connect to the etcd topo server, enables TLS
   300  -      --topo_global_root string                                          the path of the global topology data in the global topology server
   301  -      --topo_global_server_address string                                the address of the global topology server
   302  -      --topo_implementation string                                       the topology implementation to use
   303  -      --topo_zk_auth_file string                                         auth to use when connecting to the zk topo server, file contents should be <scheme>:<auth>, e.g., digest:user:pass
   304  -      --topo_zk_base_timeout duration                                    zk base timeout (see zk.Connect) (default 30s)
   305  -      --topo_zk_max_concurrency int                                      maximum number of pending requests to send to a Zookeeper server. (default 64)
   306  -      --topo_zk_tls_ca string                                            the server ca to use to validate servers when connecting to the zk topo server
   307  -      --topo_zk_tls_cert string                                          the cert to use to connect to the zk topo server, requires topo_zk_tls_key, enables TLS
   308  -      --topo_zk_tls_key string                                           the key to use to connect to the zk topo server, enables TLS
   309  -      --tracer string                                                    tracing service to use (default noop)
   310  -      --tracing-enable-logging                                           whether to enable logging in the tracing service
   311  -      --tracing-sampling-rate value                                      sampling rate for the probabilistic jaeger sampler (default 0.1)
   312  -      --tracing-sampling-type value                                      sampling strategy to use for jaeger. possible values are 'const', 'probabilistic', 'rateLimiting', or 'remote' (default const)
   313  -      --v value                                                          log level for V logs
   314  -      --version                                                          print binary version
   315  -      --vmodule value                                                    comma-separated list of pattern=N settings for file-filtered logging
   316  -      --xbstream_restore_flags string                                    flags to pass to xbstream command during restore. These should be space separated and will be added to the end of the command. These need to match the ones used for backup e.g. --compress / --decompress, --encrypt / --decrypt
   317  -      --xtrabackup_backup_flags string                                   flags to pass to backup command. These should be space separated and will be added to the end of the command
   318  -      --xtrabackup_prepare_flags string                                  flags to pass to prepare command. These should be space separated and will be added to the end of the command
   319  -      --xtrabackup_root_path string                                      directory location of the xtrabackup and xbstream executables, e.g., /usr/bin
   320  -      --xtrabackup_stream_mode string                                    which mode to use if streaming, valid values are tar and xbstream (default tar)
   321  -      --xtrabackup_stripe_block_size uint                                Size in bytes of each block that gets sent to a given stripe before rotating to the next stripe (default 102400)
   322  -      --xtrabackup_stripes uint                                          If greater than 0, use data striping across this many destination files to parallelize data transfer and decompression
   323  -      --xtrabackup_user string                                           User that xtrabackup will use to connect to the database server. This user must have all necessary privileges. For details, please refer to xtrabackup documentation.
   324  +      --allow_first_backup                              Allow this job to take the first backup of an existing shard.
   325  +      --alsologtostderr                                 log to standard error as well as files
   326  +      --azblob_backup_account_key_file string           Path to a file containing the Azure Storage account key; if this flag is unset, the environment variable VT_AZBLOB_ACCOUNT_KEY will be used as the key itself (NOT a file path).
   327  +      --azblob_backup_account_name string               Azure Storage Account name for backups; if this flag is unset, the environment variable VT_AZBLOB_ACCOUNT_NAME will be used.
   328  +      --azblob_backup_container_name string             Azure Blob Container Name.
   329  +      --azblob_backup_parallelism int                   Azure Blob operation parallelism (requires extra memory when increased). (default 1)
   330  +      --azblob_backup_storage_root string               Root prefix for all backup-related Azure Blobs; this should exclude both initial and trailing '/' (e.g. just 'a/b' not '/a/b/').
   331  +      --backup_engine_implementation string             Specifies which implementation to use for creating new backups (builtin or xtrabackup). Restores will always be done with whichever engine created a given backup. (default "builtin")
   332  +      --backup_storage_block_size int                   if backup_storage_compress is true, backup_storage_block_size sets the byte size for each block while compressing (default is 250000). (default 250000)
   333  +      --backup_storage_compress                         if set, the backup files will be compressed (default is true). Set to false for instance if a backup_storage_hook is specified and it compresses the data. (default true)
   334  +      --backup_storage_implementation string            Which backup storage implementation to use for creating and restoring backups.
   335  +      --backup_storage_number_blocks int                if backup_storage_compress is true, backup_storage_number_blocks sets the number of blocks that can be processed, at once, before the writer blocks, during compression (default is 2). It should be equal to the number of CPUs available for compression. (default 2)
   336  +      --ceph_backup_storage_config string               Path to JSON config file for ceph backup storage. (default "ceph_backup_config.json")
   337  +      --concurrency int                                 (init restore parameter) how many concurrent files to restore at once (default 4)
   338  +      --consul_auth_static_file string                  JSON File to read the topos/tokens from.
   339  +      --db-credentials-file string                      db credentials file; send SIGHUP to reload this file
   340  +      --db-credentials-server string                    db credentials server type ('file' - file implementation; 'vault' - HashiCorp Vault implementation) (default "file")
   341  +      --db-credentials-vault-addr string                URL to Vault server
   342  +      --db-credentials-vault-path string                Vault path to credentials JSON blob, e.g.: secret/data/prod/dbcreds
   343  +      --db-credentials-vault-role-mountpoint string     Vault AppRole mountpoint; can also be passed using VAULT_MOUNTPOINT environment variable (default "approle")
   344  +      --db-credentials-vault-role-secretidfile string   Path to file containing Vault AppRole secret_id; can also be passed using VAULT_SECRETID environment variable
   345  +      --db-credentials-vault-roleid string              Vault AppRole id; can also be passed using VAULT_ROLEID environment variable
   346  +      --db-credentials-vault-timeout duration           Timeout for vault API operations (default 10s)
   347  +      --db-credentials-vault-tls-ca string              Path to CA PEM for validating Vault server certificate
   348  +      --db-credentials-vault-tokenfile string           Path to file containing Vault auth token; token can also be passed using VAULT_TOKEN environment variable
   349  +      --db-credentials-vault-ttl duration               How long to cache DB credentials from the Vault server (default 30m0s)
   350  +      --db_allprivs_password string                     db allprivs password
   351  +      --db_allprivs_use_ssl                             Set this flag to false to make the allprivs connection to not use ssl (default true)
   352  +      --db_allprivs_user string                         db allprivs user userKey (default "vt_allprivs")
   353  +      --db_app_password string                          db app password
   354  +      --db_app_use_ssl                                  Set this flag to false to make the app connection to not use ssl (default true)
   355  +      --db_app_user string                              db app user userKey (default "vt_app")
   356  +      --db_appdebug_password string                     db appdebug password
   357  +      --db_appdebug_use_ssl                             Set this flag to false to make the appdebug connection to not use ssl (default true)
   358  +      --db_appdebug_user string                         db appdebug user userKey (default "vt_appdebug")
   359  +      --db_charset string                               Character set used for this tablet. (default "utf8mb4")
   360  +      --db_conn_query_info                              enable parsing and processing of QUERY_OK info fields
   361  +      --db_connect_timeout_ms int                       connection timeout to mysqld in milliseconds (0 for no timeout)
   362  +      --db_dba_password string                          db dba password
   363  +      --db_dba_use_ssl                                  Set this flag to false to make the dba connection to not use ssl (default true)
   364  +      --db_dba_user string                              db dba user userKey (default "vt_dba")
   365  +      --db_erepl_password string                        db erepl password
   366  +      --db_erepl_use_ssl                                Set this flag to false to make the erepl connection to not use ssl (default true)
   367  +      --db_erepl_user string                            db erepl user userKey (default "vt_erepl")
   368  +      --db_filtered_password string                     db filtered password
   369  +      --db_filtered_use_ssl                             Set this flag to false to make the filtered connection to not use ssl (default true)
   370  +      --db_filtered_user string                         db filtered user userKey (default "vt_filtered")
   371  +      --db_flags uint                                   Flag values as defined by MySQL.
   372  +      --db_flavor string                                Flavor overrid. Valid value is FilePos.
   373  +      --db_host string                                  The host name for the tcp connection.
   374  +      --db_port int                                     tcp port
   375  +      --db_repl_password string                         db repl password
   376  +      --db_repl_use_ssl                                 Set this flag to false to make the repl connection to not use ssl (default true)
   377  +      --db_repl_user string                             db repl user userKey (default "vt_repl")
   378  +      --db_server_name string                           server name of the DB we are connecting to.
   379  +      --db_socket string                                The unix socket to connect on. If this is specified, host and port will not be used.
   380  +      --db_ssl_ca string                                connection ssl ca
   381  +      --db_ssl_ca_path string                           connection ssl ca path
   382  +      --db_ssl_cert string                              connection ssl certificate
   383  +      --db_ssl_key string                               connection ssl key
   384  +      --db_ssl_mode SslMode                             SSL mode to connect with. One of disabled, preferred, required, verify_ca & verify_identity.
   385  +      --db_tls_min_version string                       Configures the minimal TLS version negotiated when SSL is enabled. Defaults to TLSv1.2. Options: TLSv1.0, TLSv1.1, TLSv1.2, TLSv1.3.
   386  +      --detach                                          detached mode - run backups detached from the terminal
   387  +      --emit_stats                                      If set, emit stats to push-based monitoring and stats backends
   388  +      --file_backup_storage_root string                 Root directory for the file backup storage.
   389  +      --gcs_backup_storage_bucket string                Google Cloud Storage bucket to use for backups.
   390  +      --gcs_backup_storage_root string                  Root prefix for all backup-related object names.
   391  +      --grpc_auth_static_client_creds string            When using grpc_static_auth in the server, this file provides the credentials to use to authenticate with server.
   392  +      --grpc_compression string                         Which protocol to use for compressing gRPC. Default: nothing. Supported: snappy
   393  +      --grpc_enable_tracing                             Enable gRPC tracing.
   394  +      --grpc_initial_conn_window_size int               gRPC initial connection window size
   395  +      --grpc_initial_window_size int                    gRPC initial window size
   396  +      --grpc_keepalive_time duration                    After a duration of this time, if the client doesn't see any activity, it pings the server to see if the transport is still alive. (default 10s)
   397  +      --grpc_keepalive_timeout duration                 After having pinged for keepalive check, the client waits for a duration of Timeout and if no activity is seen even after that the connection is closed. (default 10s)
   398  +      --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)
   399  +      --grpc_prometheus                                 Enable gRPC monitoring with Prometheus.
   400  +  -h, --help                                            display usage and exit
   401  +      --init_db_name_override string                    (init parameter) override the name of the db used by vttablet
   402  +      --init_db_sql_file string                         path to .sql file to run after mysql_install_db
   403  +      --init_keyspace string                            (init parameter) keyspace to use for this tablet
   404  +      --init_shard string                               (init parameter) shard to use for this tablet
   405  +      --initial_backup                                  Instead of restoring from backup, initialize an empty database with the provided init_db_sql_file and upload a backup of that for the shard, if the shard has no backups yet. This can be used to seed a brand new shard with an initial, empty backup. If any backups already exist for the shard, this will be considered a successful no-op. This can only be done before the shard exists in topology (i.e. before any tablets are deployed).
   406  +      --keep-alive-timeout duration                     Wait until timeout elapses after a successful backup before shutting down.
   407  +      --keep_logs duration                              keep logs for this long (using ctime) (zero to keep forever)
   408  +      --keep_logs_by_mtime duration                     keep logs for this long (using mtime) (zero to keep forever)
   409  +      --log_backtrace_at traceLocation                  when logging hits line file:N, emit a stack trace (default :0)
   410  +      --log_dir string                                  If non-empty, write log files in this directory
   411  +      --log_err_stacks                                  log stack traces for errors
   412  +      --log_rotate_max_size uint                        size in bytes at which logs are rotated (glog.MaxSize) (default 1887436800)
   413  +      --logtostderr                                     log to standard error instead of files
   414  +      --min_backup_interval duration                    Only take a new backup if it's been at least this long since the most recent backup.
   415  +      --min_retention_count int                         Always keep at least this many of the most recent backups in this backup storage location, even if some are older than the min_retention_time. This must be at least 1 since a backup must always exist to allow new backups to be made (default 1)
   416  +      --min_retention_time duration                     Keep each old backup for at least this long before removing it. Set to 0 to disable pruning of old backups.
   417  +      --mycnf-file string                               path to my.cnf, if reading all config params from there
   418  +      --mycnf_bin_log_path string                       mysql binlog path
   419  +      --mycnf_data_dir string                           data directory for mysql
   420  +      --mycnf_error_log_path string                     mysql error log path
   421  +      --mycnf_general_log_path string                   mysql general log path
   422  +      --mycnf_innodb_data_home_dir string               Innodb data home directory
   423  +      --mycnf_innodb_log_group_home_dir string          Innodb log group home directory
   424  +      --mycnf_master_info_file string                   mysql master.info file
   425  +      --mycnf_mysql_port int                            port mysql is listening on
   426  +      --mycnf_pid_file string                           mysql pid file
   427  +      --mycnf_relay_log_index_path string               mysql relay log index path
   428  +      --mycnf_relay_log_info_path string                mysql relay log info path
   429  +      --mycnf_relay_log_path string                     mysql relay log path
   430  +      --mycnf_secure_file_priv string                   mysql path for loading secure files
   431  +      --mycnf_server_id int                             mysql server id of the server (if specified, mycnf-file will be ignored)
   432  +      --mycnf_slow_log_path string                      mysql slow query log path
   433  +      --mycnf_socket_file string                        mysql socket file
   434  +      --mycnf_tmp_dir string                            mysql tmp directory
   435  +      --mysql_port int                                  mysql port (default 3306)
   436  +      --mysql_server_version string                     MySQL server version to advertise.
   437  +      --mysql_socket string                             path to the mysql socket
   438  +      --mysql_timeout duration                          how long to wait for mysqld startup (default 5m0s)
   439  +      --port int                                        port for the server
   440  +      --pprof strings                                   enable profiling
   441  +      --purge_logs_interval duration                    how often try to remove old logs (default 1h0m0s)
   442  +      --remote_operation_timeout duration               time to wait for a remote operation (default 30s)
   443  +      --restart_before_backup                           Perform a mysqld clean/full restart after applying binlogs, but before taking the backup. Only makes sense to work around xtrabackup bugs.
   444  +      --s3_backup_aws_endpoint string                   endpoint of the S3 backend (region must be provided).
   445  +      --s3_backup_aws_region string                     AWS region to use. (default "us-east-1")
   446  +      --s3_backup_aws_retries int                       AWS request retries. (default -1)
   447  +      --s3_backup_force_path_style                      force the s3 path style.
   448  +      --s3_backup_log_level string                      determine the S3 loglevel to use from LogOff, LogDebug, LogDebugWithSigning, LogDebugWithHTTPBody, LogDebugWithRequestRetries, LogDebugWithRequestErrors. (default "LogOff")
   449  +      --s3_backup_server_side_encryption string         server-side encryption algorithm (e.g., AES256, aws:kms, sse_c:/path/to/key/file).
   450  +      --s3_backup_storage_bucket string                 S3 bucket to use for backups.
   451  +      --s3_backup_storage_root string                   root prefix for all backup-related object names.
   452  +      --s3_backup_tls_skip_verify_cert                  skip the 'certificate is valid' check for SSL connections.
   453  +      --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)
   454  +      --sql-max-length-errors int                       truncate queries in error logs to the given length (default unlimited)
   455  +      --sql-max-length-ui int                           truncate queries in debug UIs to the given length (default 512) (default 512)
   456  +      --stats_backend string                            The name of the registered push-based monitoring/stats backend to use
   457  +      --stats_combine_dimensions string                 List of dimensions to be combined into a single "all" value in exported stats vars
   458  +      --stats_common_tags strings                       Comma-separated list of common tags for the stats backend. It provides both label and values. Example: label1:value1,label2:value2
   459  +      --stats_drop_variables string                     Variables to be dropped from the list of exported variables.
   460  +      --stats_emit_period duration                      Interval between emitting stats to all registered backends (default 1m0s)
   461  +      --stderrthreshold severity                        logs at or above this threshold go to stderr (default 1)
   462  +      --tablet_manager_grpc_ca string                   the server ca to use to validate servers when connecting
   463  +      --tablet_manager_grpc_cert string                 the cert to use to connect
   464  +      --tablet_manager_grpc_concurrency int             concurrency to use to talk to a vttablet server for performance-sensitive RPCs (like ExecuteFetchAs{Dba,AllPrivs,App}) (default 8)
   465  +      --tablet_manager_grpc_connpool_size int           number of tablets to keep tmclient connections open to (default 100)
   466  +      --tablet_manager_grpc_crl string                  the server crl to use to validate server certificates when connecting
   467  +      --tablet_manager_grpc_key string                  the key to use to connect
   468  +      --tablet_manager_grpc_server_name string          the server name to use to validate server certificate
   469  +      --tablet_manager_protocol string                  Protocol to use to make tabletmanager RPCs to vttablets. (default "grpc")
   470  +      --topo_consul_lock_delay duration                 LockDelay for consul session. (default 15s)
   471  +      --topo_consul_lock_session_checks string          List of checks for consul session. (default "serfHealth")
   472  +      --topo_consul_lock_session_ttl string             TTL for consul session.
   473  +      --topo_consul_watch_poll_duration duration        time of the long poll for watch queries. (default 30s)
   474  +      --topo_etcd_lease_ttl int                         Lease TTL for locks and leader election. The client will use KeepAlive to keep the lease going. (default 30)
   475  +      --topo_etcd_tls_ca string                         path to the ca to use to validate the server cert when connecting to the etcd topo server
   476  +      --topo_etcd_tls_cert string                       path to the client cert to use to connect to the etcd topo server, requires topo_etcd_tls_key, enables TLS
   477  +      --topo_etcd_tls_key string                        path to the client key to use to connect to the etcd topo server, enables TLS
   478  +      --topo_global_root string                         the path of the global topology data in the global topology server
   479  +      --topo_global_server_address string               the address of the global topology server
   480  +      --topo_implementation string                      the topology implementation to use
   481  +      --topo_zk_auth_file string                        auth to use when connecting to the zk topo server, file contents should be <scheme>:<auth>, e.g., digest:user:pass
   482  +      --topo_zk_base_timeout duration                   zk base timeout (see zk.Connect) (default 30s)
   483  +      --topo_zk_max_concurrency int                     maximum number of pending requests to send to a Zookeeper server. (default 64)
   484  +      --topo_zk_tls_ca string                           the server ca to use to validate servers when connecting to the zk topo server
   485  +      --topo_zk_tls_cert string                         the cert to use to connect to the zk topo server, requires topo_zk_tls_key, enables TLS
   486  +      --topo_zk_tls_key string                          the key to use to connect to the zk topo server, enables TLS
   487  +      --v Level                                         log level for V logs
   488  +  -v, --version                                         print binary version
   489  +      --vmodule moduleSpec                              comma-separated list of pattern=N settings for file-filtered logging
   490  +      --xbstream_restore_flags string                   Flags to pass to xbstream command during restore. These should be space separated and will be added to the end of the command. These need to match the ones used for backup e.g. --compress / --decompress, --encrypt / --decrypt
   491  +      --xtrabackup_backup_flags string                  Flags to pass to backup command. These should be space separated and will be added to the end of the command
   492  +      --xtrabackup_prepare_flags string                 Flags to pass to prepare command. These should be space separated and will be added to the end of the command
   493  +      --xtrabackup_root_path string                     Directory location of the xtrabackup and xbstream executables, e.g., /usr/bin
   494  +      --xtrabackup_stream_mode string                   Which mode to use if streaming, valid values are tar and xbstream. Please note that tar is not supported in XtraBackup 8.0 (default "tar")
   495  +      --xtrabackup_stripe_block_size uint               Size in bytes of each block that gets sent to a given stripe before rotating to the next stripe (default 102400)
   496  +      --xtrabackup_stripes uint                         If greater than 0, use data striping across this many destination files to parallelize data transfer and decompression
   497  +      --xtrabackup_user string                          User that xtrabackup will use to connect to the database server. This user must have all necessary privileges. For details, please refer to xtrabackup documentation.