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

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