vitess.io/vitess@v0.16.2/doc/flags/14.0-to-15.0-transition/mysqlctl.diff (about) 1 diff --git a/flags/14.0/mysqlctl.txt b/flags/15.0/mysqlctl.txt 2 index a535bc4..6444c8f 100644 3 --- a/flags/14.0/mysqlctl.txt 4 +++ b/flags/15.0/mysqlctl.txt 5 @@ -1,150 +1,86 @@ 6 -Usage of mysqlctl: 7 - --alsologtostderr log to standard error as well as files 8 - --app_idle_timeout duration Idle timeout for app connections (default 1m0s) 9 - --app_pool_size int Size of the connection pool for app connections (default 40) 10 - --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) 11 - --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) 12 - --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) 13 - --backup_storage_hook string if set, we send the contents of the backup files through this hook. 14 - --backup_storage_implementation string which implementation to use for the backup storage feature 15 - --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) 16 - --builtinbackup_mysqld_timeout duration how long to wait for mysqld to shutdown at the start of the backup (default 10m0s) 17 - --builtinbackup_progress duration how often to send progress updates when backing up large files (default 5s) 18 - --catch-sigpipe catch and ignore SIGPIPE on stdout and stderr if specified 19 - --cpu_profile string deprecated: use '-pprof=cpu' instead 20 - --datadog-agent-host string host to send spans to. if empty, no tracing will be done 21 - --datadog-agent-port string port to send spans to. if empty, no tracing will be done 22 - --db-config-dba-charset string deprecated: use db_charset (default utf8mb4) 23 - --db-config-dba-flags uint deprecated: use db_flags 24 - --db-config-dba-flavor string deprecated: use db_flavor 25 - --db-config-dba-host string deprecated: use db_host 26 - --db-config-dba-pass string db dba deprecated: use db_dba_password 27 - --db-config-dba-port int deprecated: use db_port 28 - --db-config-dba-server_name string deprecated: use db_server_name 29 - --db-config-dba-ssl-ca string deprecated: use db_ssl_ca 30 - --db-config-dba-ssl-ca-path string deprecated: use db_ssl_ca_path 31 - --db-config-dba-ssl-cert string deprecated: use db_ssl_cert 32 - --db-config-dba-ssl-key string deprecated: use db_ssl_key 33 - --db-config-dba-uname string deprecated: use db_dba_user (default vt_dba) 34 - --db-config-dba-unixsocket string deprecated: use db_socket 35 - --db-credentials-file string db credentials file; send SIGHUP to reload this file 36 - --db-credentials-server string db credentials server type ('file' - file implementation; 'vault' - HashiCorp Vault implementation) (default file) 37 - --db-credentials-vault-addr string URL to Vault server 38 - --db-credentials-vault-path string Vault path to credentials JSON blob, e.g.: secret/data/prod/dbcreds 39 - --db-credentials-vault-role-mountpoint string Vault AppRole mountpoint; can also be passed using VAULT_MOUNTPOINT environment variable (default approle) 40 - --db-credentials-vault-role-secretidfile string Path to file containing Vault AppRole secret_id; can also be passed using VAULT_SECRETID environment variable 41 - --db-credentials-vault-roleid string Vault AppRole id; can also be passed using VAULT_ROLEID environment variable 42 - --db-credentials-vault-timeout duration Timeout for vault API operations (default 10s) 43 - --db-credentials-vault-tls-ca string Path to CA PEM for validating Vault server certificate 44 - --db-credentials-vault-tokenfile string Path to file containing Vault auth token; token can also be passed using VAULT_TOKEN environment variable 45 - --db-credentials-vault-ttl duration How long to cache DB credentials from the Vault server (default 30m0s) 46 - --db_charset string Character set used for this tablet. (default utf8mb4) 47 - --db_conn_query_info enable parsing and processing of QUERY_OK info fields 48 - --db_connect_timeout_ms int connection timeout to mysqld in milliseconds (0 for no timeout) 49 - --db_dba_password string db dba password 50 - --db_dba_use_ssl Set this flag to false to make the dba connection to not use ssl (default true) 51 - --db_dba_user string db dba user userKey (default vt_dba) 52 - --db_flags uint Flag values as defined by MySQL. 53 - --db_flavor string Flavor overrid. Valid value is FilePos. 54 - --db_host string The host name for the tcp connection. 55 - --db_port int tcp port 56 - --db_server_name string server name of the DB we are connecting to. 57 - --db_socket string The unix socket to connect on. If this is specified, host and port will not be used. 58 - --db_ssl_ca string connection ssl ca 59 - --db_ssl_ca_path string connection ssl ca path 60 - --db_ssl_cert string connection ssl certificate 61 - --db_ssl_key string connection ssl key 62 - --db_ssl_mode value SSL mode to connect with. One of disabled, preferred, required, verify_ca & verify_identity. 63 - --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. 64 - --dba_idle_timeout duration Idle timeout for dba connections (default 1m0s) 65 - --dba_pool_size int Size of the connection pool for dba connections (default 20) 66 - --disable_active_reparents if set, do not allow active reparents. Use this to protect a cluster using external reparents. 67 - --emit_stats If set, emit stats to push-based monitoring and stats backends 68 - --grpc_auth_mode string Which auth plugin implementation to use (eg: static) 69 - --grpc_auth_mtls_allowed_substrings string List of substrings of at least one of the client certificate names (separated by colon). 70 - --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 71 - --grpc_auth_static_password_file string JSON File to read the users/passwords from. 72 - --grpc_ca string server CA to use for gRPC connections, requires TLS, and enforces client certificate check 73 - --grpc_cert string server certificate to use for gRPC connections, requires grpc_key, enables TLS 74 - --grpc_compression string Which protocol to use for compressing gRPC. Default: nothing. Supported: snappy 75 - --grpc_crl string path to a certificate revocation list in PEM format, client certificates will be further verified against this file during TLS handshake 76 - --grpc_enable_optional_tls enable optional TLS mode when a server accepts both TLS and plain-text connections on the same port 77 - --grpc_enable_tracing Enable GRPC tracing 78 - --grpc_initial_conn_window_size int gRPC initial connection window size 79 - --grpc_initial_window_size int gRPC initial window size 80 - --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) 81 - --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) 82 - --grpc_key string server private key to use for gRPC connections, requires grpc_cert, enables TLS 83 - --grpc_max_connection_age duration Maximum age of a client connection before GoAway is sent. (default 2562047h47m16.854775807s) 84 - --grpc_max_connection_age_grace duration Additional grace period after grpc_max_connection_age, after which connections are forcibly closed. (default 2562047h47m16.854775807s) 85 - --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) 86 - --grpc_port int Port to listen on for gRPC calls 87 - --grpc_prometheus Enable gRPC monitoring with Prometheus 88 - --grpc_server_ca string path to server CA in PEM format, which will be combine with server cert, return full certificate chain to clients 89 - --grpc_server_initial_conn_window_size int gRPC server initial connection window size 90 - --grpc_server_initial_window_size int gRPC server initial window size 91 - --grpc_server_keepalive_enforcement_policy_min_time duration gRPC server minimum keepalive time (default 10s) 92 - --grpc_server_keepalive_enforcement_policy_permit_without_stream gRPC server permit client keepalive pings even when there are no active streams (RPCs) 93 - --jaeger-agent-host string host and port to send spans to. if empty, no tracing will be done 94 - --keep_logs duration keep logs for this long (using ctime) (zero to keep forever) 95 - --keep_logs_by_mtime duration keep logs for this long (using mtime) (zero to keep forever) 96 - --lameduck-period duration keep running at least this long after SIGTERM before stopping (default 50ms) 97 - --log_backtrace_at value when logging hits line file:N, emit a stack trace 98 - --log_dir string If non-empty, write log files in this directory 99 - --log_err_stacks log stack traces for errors 100 - --log_rotate_max_size uint size in bytes at which logs are rotated (glog.MaxSize) (default 1887436800) 101 - --logtostderr log to standard error instead of files 102 - --master_connect_retry duration Deprecated, use -replication_connect_retry (default 10s) 103 - --mem-profile-rate int deprecated: use '-pprof=mem' instead (default 524288) 104 - --mutex-profile-fraction int deprecated: use '-pprof=mutex' instead 105 - --mysql_auth_server_static_file string JSON File to read the users/passwords from. 106 - --mysql_auth_server_static_string string JSON representation of the users/passwords config. 107 - --mysql_auth_static_reload_interval duration Ticker to reload credentials 108 - --mysql_clientcert_auth_method string client-side authentication method to use. Supported values: mysql_clear_password, dialog. (default mysql_clear_password) 109 - --mysql_port int mysql port (default 3306) 110 - --mysql_server_flush_delay duration Delay after which buffered response will be flushed to the client. (default 100ms) 111 - --mysql_server_version string MySQL server version to advertise. 112 - --mysql_socket string path to the mysql socket 113 - --mysqlctl_client_protocol string the protocol to use to talk to the mysqlctl server (default grpc) 114 - --mysqlctl_mycnf_template string template file to use for generating the my.cnf file during server init 115 - --mysqlctl_socket string socket file to use for remote mysqlctl actions (empty for local actions) 116 - --onclose_timeout duration wait no more than this for OnClose handlers before stopping (default 1ns) 117 - --onterm_timeout duration wait no more than this for OnTermSync handlers before stopping (default 10s) 118 - --pid_file string If set, the process will write its pid to the named file, and delete it on graceful shutdown. 119 - --pool_hostname_resolve_interval duration if set force an update to all hostnames and reconnect if changed, defaults to 0 (disabled) 120 - --port int vttablet port (default 6612) 121 - --pprof string enable profiling 122 - --purge_logs_interval duration how often try to remove old logs (default 1h0m0s) 123 - --remote_operation_timeout duration time to wait for a remote operation (default 30s) 124 - --replication_connect_retry duration how long to wait in between replica reconnect attempts. Only precise to the second. (default 10s) 125 - --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) 126 - --service_map value comma separated list of services to enable (or disable if prefixed with '-') Example: grpc-vtworker 127 - --sql-max-length-errors int truncate queries in error logs to the given length (default unlimited) 128 - --sql-max-length-ui int truncate queries in debug UIs to the given length (default 512) (default 512) 129 - --stats_backend string The name of the registered push-based monitoring/stats backend to use 130 - --stats_combine_dimensions string List of dimensions to be combined into a single "all" value in exported stats vars 131 - --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 132 - --stats_drop_variables string Variables to be dropped from the list of exported variables. 133 - --stats_emit_period duration Interval between emitting stats to all registered backends (default 1m0s) 134 - --stderrthreshold value logs at or above this threshold go to stderr (default 1) 135 - --tablet_dir string The directory within the vtdataroot to store vttablet/mysql files. Defaults to being generated by the tablet uid. 136 - --tablet_manager_protocol string the protocol to use to talk to vttablet (default grpc) 137 - --tablet_uid uint tablet uid (default 41983) 138 - --topo_global_root string the path of the global topology data in the global topology server 139 - --topo_global_server_address string the address of the global topology server 140 - --topo_implementation string the topology implementation to use 141 - --tracer string tracing service to use (default noop) 142 - --tracing-enable-logging whether to enable logging in the tracing service 143 - --tracing-sampling-rate value sampling rate for the probabilistic jaeger sampler (default 0.1) 144 - --tracing-sampling-type value sampling strategy to use for jaeger. possible values are 'const', 'probabilistic', 'rateLimiting', or 'remote' (default const) 145 - --v value log level for V logs 146 - --version print binary version 147 - --vmodule value comma-separated list of pattern=N settings for file-filtered logging 148 - --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 149 - --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 150 - --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 151 - --xtrabackup_root_path string directory location of the xtrabackup and xbstream executables, e.g., /usr/bin 152 - --xtrabackup_stream_mode string which mode to use if streaming, valid values are tar and xbstream (default tar) 153 - --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) 154 - --xtrabackup_stripes uint If greater than 0, use data striping across this many destination files to parallelize data transfer and decompression 155 - --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. 156 +Usage: mysqlctl [global-flags] <command> -- [command-flags] 157 + 158 +The commands are listed below. Use 'mysqlctl <command> -- {-h, --help}' for command help. 159 + 160 + init [--wait_time=5m] [--init_db_sql_file=] 161 + init_config 162 + reinit_config 163 + teardown [--wait_time=5m] [--force] 164 + start [--wait_time=5m] 165 + shutdown [--wait_time=5m] 166 + position <operation> <pos1> <pos2 | gtid> 167 + 168 +Global flags: 169 + --alsologtostderr log to standard error as well as files 170 + --app_idle_timeout duration Idle timeout for app connections (default 1m0s) 171 + --app_pool_size int Size of the connection pool for app connections (default 40) 172 + --catch-sigpipe catch and ignore SIGPIPE on stdout and stderr if specified 173 + --db-credentials-file string db credentials file; send SIGHUP to reload this file 174 + --db-credentials-server string db credentials server type ('file' - file implementation; 'vault' - HashiCorp Vault implementation) (default "file") 175 + --db-credentials-vault-addr string URL to Vault server 176 + --db-credentials-vault-path string Vault path to credentials JSON blob, e.g.: secret/data/prod/dbcreds 177 + --db-credentials-vault-role-mountpoint string Vault AppRole mountpoint; can also be passed using VAULT_MOUNTPOINT environment variable (default "approle") 178 + --db-credentials-vault-role-secretidfile string Path to file containing Vault AppRole secret_id; can also be passed using VAULT_SECRETID environment variable 179 + --db-credentials-vault-roleid string Vault AppRole id; can also be passed using VAULT_ROLEID environment variable 180 + --db-credentials-vault-timeout duration Timeout for vault API operations (default 10s) 181 + --db-credentials-vault-tls-ca string Path to CA PEM for validating Vault server certificate 182 + --db-credentials-vault-tokenfile string Path to file containing Vault auth token; token can also be passed using VAULT_TOKEN environment variable 183 + --db-credentials-vault-ttl duration How long to cache DB credentials from the Vault server (default 30m0s) 184 + --db_charset string Character set used for this tablet. (default "utf8mb4") 185 + --db_conn_query_info enable parsing and processing of QUERY_OK info fields 186 + --db_connect_timeout_ms int connection timeout to mysqld in milliseconds (0 for no timeout) 187 + --db_dba_password string db dba password 188 + --db_dba_use_ssl Set this flag to false to make the dba connection to not use ssl (default true) 189 + --db_dba_user string db dba user userKey (default "vt_dba") 190 + --db_flags uint Flag values as defined by MySQL. 191 + --db_flavor string Flavor overrid. Valid value is FilePos. 192 + --db_host string The host name for the tcp connection. 193 + --db_port int tcp port 194 + --db_server_name string server name of the DB we are connecting to. 195 + --db_socket string The unix socket to connect on. If this is specified, host and port will not be used. 196 + --db_ssl_ca string connection ssl ca 197 + --db_ssl_ca_path string connection ssl ca path 198 + --db_ssl_cert string connection ssl certificate 199 + --db_ssl_key string connection ssl key 200 + --db_ssl_mode SslMode SSL mode to connect with. One of disabled, preferred, required, verify_ca & verify_identity. 201 + --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. 202 + --dba_idle_timeout duration Idle timeout for dba connections (default 1m0s) 203 + --dba_pool_size int Size of the connection pool for dba connections (default 20) 204 + --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. 205 + --grpc_compression string Which protocol to use for compressing gRPC. Default: nothing. Supported: snappy 206 + --grpc_initial_conn_window_size int gRPC initial connection window size 207 + --grpc_initial_window_size int gRPC initial window size 208 + --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) 209 + --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) 210 + -h, --help display usage and exit 211 + --keep_logs duration keep logs for this long (using ctime) (zero to keep forever) 212 + --keep_logs_by_mtime duration keep logs for this long (using mtime) (zero to keep forever) 213 + --lameduck-period duration keep running at least this long after SIGTERM before stopping (default 50ms) 214 + --log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0) 215 + --log_dir string If non-empty, write log files in this directory 216 + --log_err_stacks log stack traces for errors 217 + --log_rotate_max_size uint size in bytes at which logs are rotated (glog.MaxSize) (default 1887436800) 218 + --logtostderr log to standard error instead of files 219 + --mysql_port int MySQL port (default 3306) 220 + --mysql_server_version string MySQL server version to advertise. 221 + --mysql_socket string Path to the mysqld socket file 222 + --mysqlctl_client_protocol string the protocol to use to talk to the mysqlctl server (default "grpc") 223 + --mysqlctl_mycnf_template string template file to use for generating the my.cnf file during server init 224 + --mysqlctl_socket string socket file to use for remote mysqlctl actions (empty for local actions) 225 + --onclose_timeout duration wait no more than this for OnClose handlers before stopping (default 1ns) 226 + --onterm_timeout duration wait no more than this for OnTermSync handlers before stopping (default 10s) 227 + --pid_file string If set, the process will write its pid to the named file, and delete it on graceful shutdown. 228 + --pool_hostname_resolve_interval duration if set force an update to all hostnames and reconnect if changed, defaults to 0 (disabled) 229 + --port int port for the server 230 + --pprof strings enable profiling 231 + --purge_logs_interval duration how often try to remove old logs (default 1h0m0s) 232 + --replication_connect_retry duration how long to wait in between replica reconnect attempts. Only precise to the second. (default 10s) 233 + --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) 234 + --service_map strings comma separated list of services to enable (or disable if prefixed with '-') Example: grpc-queryservice 235 + --socket_file string Local unix socket file to listen on 236 + --stderrthreshold severity logs at or above this threshold go to stderr (default 1) 237 + --tablet_dir string The directory within the vtdataroot to store vttablet/mysql files. Defaults to being generated by the tablet uid. 238 + --tablet_uid uint Tablet UID (default 41983) 239 + --v Level log level for V logs 240 + -v, --version print binary version 241 + --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging