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

     1  diff --git a/flags/14.0/vtexplain.txt b/flags/15.0/vtexplain.txt
     2  index 00a605e..2666e0b 100644
     3  --- a/flags/14.0/vtexplain.txt
     4  +++ b/flags/15.0/vtexplain.txt
     5  @@ -1,353 +1,60 @@
     6   Usage of vtexplain:
     7  -      --allowed_tablet_types value                                       Specifies the tablet types this vtgate is allowed to route queries to
     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  -      --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)
    12  -      --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)
    13  -      --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)
    14  -      --backup_storage_hook string                                       if set, we send the contents of the backup files through this hook.
    15  -      --backup_storage_implementation string                             which implementation to use for the backup storage feature
    16  -      --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)
    17  -      --batch-interval duration                                          Interval between logical time slots. (default 10ms)
    18  -      --binlog_player_protocol string                                    the protocol to download binlogs from a vttablet (default grpc)
    19  -      --binlog_use_v3_resharding_mode                                    (DEPRECATED) True if and only if the binlog streamer should use V3-style sharding, which doesn't require a preset sharding key column. (default true)
    20  -      --buffer_drain_concurrency int                                     Maximum number of requests retried simultaneously. More concurrency will increase the load on the PRIMARY vttablet when draining the buffer. (default 1)
    21  -      --buffer_implementation string                                     Allowed values: healthcheck (legacy implementation), keyspace_events (default) (default keyspace_events)
    22  -      --buffer_keyspace_shards string                                    If not empty, limit buffering to these entries (comma separated). Entry format: keyspace or keyspace/shard. Requires --enable_buffer=true.
    23  -      --buffer_max_failover_duration duration                            Stop buffering completely if a failover takes longer than this duration. (default 20s)
    24  -      --buffer_min_time_between_failovers duration                       Minimum time between the end of a failover and the start of the next one (tracked per shard). Faster consecutive failovers will not trigger buffering. (default 1m0s)
    25  -      --buffer_size int                                                  Maximum number of buffered requests in flight (across all ongoing failovers). (default 1000)
    26  -      --buffer_window duration                                           Duration for how long a request should be buffered at most. (default 10s)
    27  -      --builtinbackup_mysqld_timeout duration                            how long to wait for mysqld to shutdown at the start of the backup (default 10m0s)
    28  -      --builtinbackup_progress duration                                  how often to send progress updates when backing up large files (default 5s)
    29  -      --catch-sigpipe                                                    catch and ignore SIGPIPE on stdout and stderr if specified
    30  -      --cells_to_watch string                                            comma-separated list of cells for watching tablets
    31  -      --client-found-rows-pool-size int                                  DEPRECATED: queryserver-config-transaction-cap will be used instead.
    32  -      --cpu_profile string                                               deprecated: use '-pprof=cpu' instead
    33  -      --datadog-agent-host string                                        host to send spans to. if empty, no tracing will be done
    34  -      --datadog-agent-port string                                        port to send spans to. if empty, no tracing will be done
    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  -      --dba_idle_timeout duration                                        Idle timeout for dba connections (default 1m0s)
    47  -      --dba_pool_size int                                                Size of the connection pool for dba connections (default 20)
    48  -      --dbddl_plugin string                                              controls how to handle CREATE/DROP DATABASE. use it if you are using your own database provisioning service (default fail)
    49  -      --dbname string                                                    Optional database target to override normal routing
    50  -      --ddl_strategy string                                              Set default strategy for DDL statements. Override with @@ddl_strategy session variable (default direct)
    51  -      --default_tablet_type value                                        The default tablet type to set for queries, when one is not explicitly selected (default PRIMARY)
    52  -      --degraded_threshold duration                                      replication lag after which a replica is considered degraded (default 30s)
    53  -      --disable_active_reparents                                         if set, do not allow active reparents. Use this to protect a cluster using external reparents.
    54  -      --disable_local_gateway                                            deprecated: if specified, this process will not route any queries to local tablets in the local cell
    55  -      --discovery_high_replication_lag_minimum_serving duration          the replication lag that is considered too high when applying the min_number_serving_vttablets threshold (default 2h0m0s)
    56  -      --discovery_low_replication_lag duration                           the replication lag that is considered low enough to be healthy (default 30s)
    57  -      --emit_stats                                                       If set, emit stats to push-based monitoring and stats backends
    58  -      --enable-autocommit                                                This flag is deprecated. Autocommit is always allowed. (default true)
    59  -      --enable-consolidator                                              Synonym to -enable_consolidator (default true)
    60  -      --enable-consolidator-replicas                                     Synonym to -enable_consolidator_replicas
    61  -      --enable-lag-throttler                                             Synonym to -enable_lag_throttler
    62  -      --enable-query-plan-field-caching                                  Synonym to -enable_query_plan_field_caching (default true)
    63  -      --enable-tx-throttler                                              Synonym to -enable_tx_throttler
    64  -      --enable_buffer                                                    Enable buffering (stalling) of primary traffic during failovers.
    65  -      --enable_buffer_dry_run                                            Detect and log failover events, but do not actually buffer requests.
    66  -      --enable_consolidator                                              This option enables the query consolidator. (default true)
    67  -      --enable_consolidator_replicas                                     This option enables the query consolidator only on replicas.
    68  -      --enable_direct_ddl                                                Allow users to submit direct DDL statements (default true)
    69  -      --enable_hot_row_protection                                        If true, incoming transactions for the same row (range) will be queued and cannot consume all txpool slots.
    70  -      --enable_hot_row_protection_dry_run                                If true, hot row protection is not enforced but logs if transactions would have been queued.
    71  -      --enable_lag_throttler                                             If true, vttablet will run a throttler service, and will implicitly enable heartbeats
    72  -      --enable_online_ddl                                                Allow users to submit, review and control Online DDL (default true)
    73  -      --enable_query_plan_field_caching                                  This option fetches & caches fields (columns) when storing query plans (default true)
    74  -      --enable_replication_reporter                                      Use polling to track replication lag.
    75  -      --enable_set_var                                                   This will enable the use of MySQL's SET_VAR query hint for certain system variables instead of using reserved connections (default true)
    76  -      --enable_system_settings                                           This will enable the system settings to be changed per session at the database connection level (default true)
    77  -      --enable_transaction_limit                                         If true, limit on number of transactions open at the same time will be enforced for all users. User trying to open a new transaction after exhausting their limit will receive an error immediately, regardless of whether there are available slots or not.
    78  -      --enable_transaction_limit_dry_run                                 If true, limit on number of transactions open at the same time will be tracked for all users, but not enforced.
    79  -      --enable_tx_throttler                                              If true replication-lag-based throttling on transactions will be enabled.
    80  -      --enforce_strict_trans_tables                                      If true, vttablet requires MySQL to run with STRICT_TRANS_TABLES or STRICT_ALL_TABLES on. It is recommended to not turn this flag off. Otherwise MySQL may alter your supplied values before saving them to the database. (default true)
    81  -      --execution-mode string                                            The execution mode to simulate -- must be set to multi, legacy-autocommit, or twopc (default multi)
    82  -      --foreign_key_mode string                                          This is to provide how to handle foreign key constraint in create/alter table. Valid values are: allow, disallow (default allow)
    83  -      --gate_query_cache_lfu                                             gate server cache algorithm. when set to true, a new cache algorithm based on a TinyLFU admission policy will be used to improve cache behavior and prevent pollution from sparse queries (default true)
    84  -      --gate_query_cache_memory int                                      gate server query cache size in bytes, maximum amount of memory to be cached. vtgate analyzes every incoming query and generate a query plan, these plans are being cached in a lru cache. This config controls the capacity of the lru cache. (default 33554432)
    85  -      --gate_query_cache_size int                                        gate server query cache size, maximum number of queries to be cached. vtgate analyzes every incoming query and generate a query plan, these plans are being cached in a cache. This config controls the expected amount of unique entries in the cache. (default 5000)
    86  -      --gateway_initial_tablet_timeout duration                          At startup, the tabletGateway will wait up to this duration to get at least one tablet per keyspace/shard/tablet type (default 30s)
    87  -      --gc_check_interval duration                                       Interval between garbage collection checks (default 1h0m0s)
    88  -      --gc_purge_check_interval duration                                 Interval between purge discovery checks (default 1m0s)
    89  -      --gh-ost-path string                                               override default gh-ost binary full path
    90  -      --grpc_auth_mode string                                            Which auth plugin implementation to use (eg: static)
    91  -      --grpc_auth_mtls_allowed_substrings string                         List of substrings of at least one of the client certificate names (separated by colon).
    92  -      --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
    93  -      --grpc_auth_static_password_file string                            JSON File to read the users/passwords from.
    94  -      --grpc_ca string                                                   server CA to use for gRPC connections, requires TLS, and enforces client certificate check
    95  -      --grpc_cert string                                                 server certificate to use for gRPC connections, requires grpc_key, enables TLS
    96  -      --grpc_compression string                                          Which protocol to use for compressing gRPC. Default: nothing. Supported: snappy
    97  -      --grpc_crl string                                                  path to a certificate revocation list in PEM format, client certificates will be further verified against this file during TLS handshake
    98  -      --grpc_enable_optional_tls                                         enable optional TLS mode when a server accepts both TLS and plain-text connections on the same port
    99  -      --grpc_enable_tracing                                              Enable GRPC tracing
   100  -      --grpc_initial_conn_window_size int                                gRPC initial connection window size
   101  -      --grpc_initial_window_size int                                     gRPC initial window size
   102  -      --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)
   103  -      --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)
   104  -      --grpc_key string                                                  server private key to use for gRPC connections, requires grpc_cert, enables TLS
   105  -      --grpc_max_connection_age duration                                 Maximum age of a client connection before GoAway is sent. (default 2562047h47m16.854775807s)
   106  -      --grpc_max_connection_age_grace duration                           Additional grace period after grpc_max_connection_age, after which connections are forcibly closed. (default 2562047h47m16.854775807s)
   107  -      --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)
   108  -      --grpc_port int                                                    Port to listen on for gRPC calls
   109  -      --grpc_prometheus                                                  Enable gRPC monitoring with Prometheus
   110  -      --grpc_server_ca string                                            path to server CA in PEM format, which will be combine with server cert, return full certificate chain to clients
   111  -      --grpc_server_initial_conn_window_size int                         gRPC server initial connection window size
   112  -      --grpc_server_initial_window_size int                              gRPC server initial window size
   113  -      --grpc_server_keepalive_enforcement_policy_min_time duration       gRPC server minimum keepalive time (default 10s)
   114  -      --grpc_server_keepalive_enforcement_policy_permit_without_stream   gRPC server permit client keepalive pings even when there are no active streams (RPCs)
   115  -      --health_check_interval duration                                   Interval between health checks (default 20s)
   116  -      --healthcheck_retry_delay duration                                 health check retry delay (default 2ms)
   117  -      --healthcheck_timeout duration                                     the health check timeout period (default 1m0s)
   118  -      --heartbeat_enable                                                 If true, vttablet records (if master) or checks (if replica) the current time of a replication heartbeat in the table _vt.heartbeat. The result is used to inform the serving state of the vttablet via healthchecks.
   119  -      --heartbeat_interval duration                                      How frequently to read and write replication heartbeat. (default 1s)
   120  -      --heartbeat_on_demand_duration duration                            If non-zero, heartbeats are only written upon consumer request, and only run for up to given duration following the request. Frequent requests can keep the heartbeat running consistently; when requests are infrequent heartbeat may completely stop between requests
   121  -      --hot_row_protection_concurrent_transactions int                   Number of concurrent transactions let through to the txpool/MySQL for the same hot row. Should be > 1 to have enough 'ready' transactions in MySQL and benefit from a pipelining effect. (default 5)
   122  -      --hot_row_protection_max_global_queue_size int                     Global queue limit across all row (ranges). Useful to prevent that the queue can grow unbounded. (default 1000)
   123  -      --hot_row_protection_max_queue_size int                            Maximum number of BeginExecute RPCs which will be queued for the same row (range). (default 20)
   124  -      --jaeger-agent-host string                                         host and port to send spans to. if empty, no tracing will be done
   125  -      --keep_logs duration                                               keep logs for this long (using ctime) (zero to keep forever)
   126  -      --keep_logs_by_mtime duration                                      keep logs for this long (using mtime) (zero to keep forever)
   127  -      --keyspaces_to_watch value                                         Specifies which keyspaces this vtgate should have access to while routing queries or accessing the vschema
   128  -      --ks-shard-map string                                              JSON map of keyspace name -> shard name -> ShardReference object. The inner map is the same as the output of FindAllShardsInKeyspace
   129  -      --ks-shard-map-file string                                         File containing json blob of keyspace name -> shard name -> ShardReference object
   130  -      --lameduck-period duration                                         keep running at least this long after SIGTERM before stopping (default 50ms)
   131  -      --legacy_replication_lag_algorithm                                 use the legacy algorithm when selecting the vttablets for serving (default true)
   132  -      --lock_heartbeat_time duration                                     If there is lock function used. This will keep the lock connection active by using this heartbeat (default 5s)
   133  -      --log_backtrace_at value                                           when logging hits line file:N, emit a stack trace
   134  -      --log_dir string                                                   If non-empty, write log files in this directory
   135  -      --log_err_stacks                                                   log stack traces for errors
   136  -      --log_queries_to_file string                                       Enable query logging to the specified file
   137  -      --log_rotate_max_size uint                                         size in bytes at which logs are rotated (glog.MaxSize) (default 1887436800)
   138  -      --logtostderr                                                      log to standard error instead of files
   139  -      --master_connect_retry duration                                    Deprecated, use -replication_connect_retry (default 10s)
   140  -      --max_memory_rows int                                              Maximum number of rows that will be held in memory for intermediate results as well as the final result. (default 300000)
   141  -      --max_payload_size int                                             The threshold for query payloads in bytes. A payload greater than this threshold will result in a failure to handle the query.
   142  -      --mem-profile-rate int                                             deprecated: use '-pprof=mem' instead (default 524288)
   143  -      --message_stream_grace_period duration                             the amount of time to give for a vttablet to resume if it ends a message stream, usually because of a reparent. (default 30s)
   144  -      --migration_check_interval duration                                Interval between migration checks (default 1m0s)
   145  -      --min_number_serving_vttablets int                                 the minimum number of vttablets for each replicating tablet_type (e.g. replica, rdonly) that will be continue to be used even with replication lag above discovery_low_replication_lag, but still below discovery_high_replication_lag_minimum_serving (default 2)
   146  -      --mutex-profile-fraction int                                       deprecated: use '-pprof=mutex' instead
   147  -      --mysql_allow_clear_text_without_tls                               If set, the server will allow the use of a clear text password over non-SSL connections.
   148  -      --mysql_auth_server_impl string                                    Which auth server implementation to use. Options: none, ldap, clientcert, static, vault. (default static)
   149  -      --mysql_auth_server_static_file string                             JSON File to read the users/passwords from.
   150  -      --mysql_auth_server_static_string string                           JSON representation of the users/passwords config.
   151  -      --mysql_auth_static_reload_interval duration                       Ticker to reload credentials
   152  -      --mysql_clientcert_auth_method string                              client-side authentication method to use. Supported values: mysql_clear_password, dialog. (default mysql_clear_password)
   153  -      --mysql_default_workload string                                    Default session workload (OLTP, OLAP, DBA) (default OLTP)
   154  -      --mysql_server_bind_address string                                 Binds on this address when listening to MySQL binary protocol. Useful to restrict listening to 'localhost' only for instance.
   155  -      --mysql_server_flush_delay duration                                Delay after which buffered response will be flushed to the client. (default 100ms)
   156  -      --mysql_server_port int                                            If set, also listen for MySQL binary protocol connections on this port. (default -1)
   157  -      --mysql_server_query_timeout duration                              mysql query timeout
   158  -      --mysql_server_read_timeout duration                               connection read timeout
   159  -      --mysql_server_require_secure_transport                            Reject insecure connections but only if mysql_server_ssl_cert and mysql_server_ssl_key are provided
   160  -      --mysql_server_socket_path string                                  This option specifies the Unix socket file to use when listening for local connections. By default it will be empty and it won't listen to a unix socket
   161  -      --mysql_server_ssl_ca string                                       Path to ssl CA for mysql server plugin SSL. If specified, server will require and validate client certs.
   162  -      --mysql_server_ssl_cert string                                     Path to the ssl cert for mysql server plugin SSL
   163  -      --mysql_server_ssl_crl string                                      Path to ssl CRL for mysql server plugin SSL
   164  -      --mysql_server_ssl_key string                                      Path to ssl key for mysql server plugin SSL
   165  -      --mysql_server_ssl_server_ca string                                path to server CA in PEM format, which will be combine with server cert, return full certificate chain to clients
   166  -      --mysql_server_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.
   167  -      --mysql_server_version string                                      MySQL server version to advertise.
   168  -      --mysql_server_write_timeout duration                              connection write timeout
   169  -      --mysql_slow_connect_warn_threshold duration                       Warn if it takes more than the given threshold for a mysql connection to establish
   170  -      --mysql_tcp_version string                                         Select tcp, tcp4, or tcp6 to control the socket type. (default tcp)
   171  -      --mysqlctl_client_protocol string                                  the protocol to use to talk to the mysqlctl server (default grpc)
   172  -      --mysqlctl_mycnf_template string                                   template file to use for generating the my.cnf file during server init
   173  -      --mysqlctl_socket string                                           socket file to use for remote mysqlctl actions (empty for local actions)
   174  -      --no_scatter                                                       when set to true, the planner will fail instead of producing a plan that includes scatter queries
   175  -      --normalize                                                        Whether to enable vtgate normalization
   176  -      --normalize_queries                                                Rewrite queries with bind vars. Turn this off if the app itself sends normalized queries with bind vars. (default true)
   177  -      --onclose_timeout duration                                         wait no more than this for OnClose handlers before stopping (default 1ns)
   178  -      --onterm_timeout duration                                          wait no more than this for OnTermSync handlers before stopping (default 10s)
   179  -      --output-mode string                                               Output in human-friendly text or json (default text)
   180  -      --pid_file string                                                  If set, the process will write its pid to the named file, and delete it on graceful shutdown.
   181  -      --planner-version string                                           Sets the query planner version to use when generating the explain output. Valid values are V3 and Gen4
   182  -      --planner_version string                                           Deprecated flag. Use planner-version instead
   183  -      --pool-name-prefix string                                          Deprecated
   184  -      --pool_hostname_resolve_interval duration                          if set force an update to all hostnames and reconnect if changed, defaults to 0 (disabled)
   185  -      --pprof string                                                     enable profiling
   186  -      --proxy_protocol                                                   Enable HAProxy PROXY protocol on MySQL listener socket
   187  -      --pt-osc-path string                                               override default pt-online-schema-change binary full path
   188  -      --purge_logs_interval duration                                     how often try to remove old logs (default 1h0m0s)
   189  -      --query-log-stream-handler string                                  URL handler for streaming queries log (default /debug/querylog)
   190  -      --querylog-filter-tag string                                       string that must be present in the query for it to be logged; if using a value as the tag, you need to disable query normalization
   191  -      --querylog-format string                                           format for query logs ("text" or "json") (default text)
   192  -      --querylog-row-threshold uint                                      Number of rows a query has to return or affect before being logged; not useful for streaming queries. 0 means all queries will be logged.
   193  -      --queryserver-config-acl-exempt-acl string                         an acl that exempt from table acl checking (this acl is free to access any vitess tables).
   194  -      --queryserver-config-allowunsafe-dmls                              deprecated
   195  -      --queryserver-config-annotate-queries                              prefix queries to MySQL backend with comment indicating vtgate principal (user) and target tablet type
   196  -      --queryserver-config-enable-table-acl-dry-run                      If this flag is enabled, tabletserver will emit monitoring metrics and let the request pass regardless of table acl check results
   197  -      --queryserver-config-idle-timeout float                            query server idle timeout (in seconds), vttablet manages various mysql connection pools. This config means if a connection has not been used in given idle timeout, this connection will be removed from pool. This effectively manages number of connection objects and optimize the pool performance. (default 1800)
   198  -      --queryserver-config-max-dml-rows int                              query server max dml rows per statement, maximum number of rows allowed to return at a time for an update or delete with either 1) an equality where clauses on primary keys, or 2) a subselect statement. For update and delete statements in above two categories, vttablet will split the original query into multiple small queries based on this configuration value.
   199  -      --queryserver-config-max-result-size int                           query server max result size, maximum number of rows allowed to return from vttablet for non-streaming queries. (default 10000)
   200  -      --queryserver-config-message-conn-pool-prefill-parallelism int     DEPRECATED: Unused.
   201  -      --queryserver-config-message-conn-pool-size int                    DEPRECATED
   202  -      --queryserver-config-message-postpone-cap int                      query server message postpone cap is the maximum number of messages that can be postponed at any given time. Set this number to substantially lower than transaction cap, so that the transaction pool isn't exhausted by the message subsystem. (default 4)
   203  -      --queryserver-config-passthrough-dmls                              query server pass through all dml statements without rewriting
   204  -      --queryserver-config-pool-prefill-parallelism int                  query server read pool prefill parallelism, a non-zero value will prefill the pool using the specified parallism.
   205  -      --queryserver-config-pool-size int                                 query server read pool size, connection pool is used by regular queries (non streaming, not in a transaction) (default 16)
   206  -      --queryserver-config-query-cache-lfu                               query server cache algorithm. when set to true, a new cache algorithm based on a TinyLFU admission policy will be used to improve cache behavior and prevent pollution from sparse queries (default true)
   207  -      --queryserver-config-query-cache-memory int                        query server query cache size in bytes, maximum amount of memory to be used for caching. vttablet analyzes every incoming query and generate a query plan, these plans are being cached in a lru cache. This config controls the capacity of the lru cache. (default 33554432)
   208  -      --queryserver-config-query-cache-size int                          query server query cache size, maximum number of queries to be cached. vttablet analyzes every incoming query and generate a query plan, these plans are being cached in a lru cache. This config controls the capacity of the lru cache. (default 5000)
   209  -      --queryserver-config-query-pool-timeout float                      query server query pool timeout (in seconds), it is how long vttablet waits for a connection from the query pool. If set to 0 (default) then the overall query timeout is used instead.
   210  -      --queryserver-config-query-pool-waiter-cap int                     query server query pool waiter limit, this is the maximum number of queries that can be queued waiting to get a connection (default 5000)
   211  -      --queryserver-config-query-timeout float                           query server query timeout (in seconds), this is the query timeout in vttablet side. If a query takes more than this timeout, it will be killed. (default 30)
   212  -      --queryserver-config-schema-change-signal                          query server schema signal, will signal connected vtgates that schema has changed whenever this is detected. VTGates will need to have -schema_change_signal enabled for this to work (default true)
   213  -      --queryserver-config-schema-change-signal-interval float           query server schema change signal interval defines at which interval the query server shall send schema updates to vtgate. (default 5)
   214  -      --queryserver-config-schema-reload-time float                      query server schema reload time, how often vttablet reloads schemas from underlying MySQL instance in seconds. vttablet keeps table schemas in its own memory and periodically refreshes it from MySQL. This config controls the reload time. (default 1800)
   215  -      --queryserver-config-stream-buffer-size int                        query server stream buffer size, the maximum number of bytes sent from vttablet for each stream call. It's recommended to keep this value in sync with vtgate's stream_buffer_size. (default 32768)
   216  -      --queryserver-config-stream-pool-prefill-parallelism int           query server stream pool prefill parallelism, a non-zero value will prefill the pool using the specified parallelism
   217  -      --queryserver-config-stream-pool-size int                          query server stream connection pool size, stream pool is used by stream queries: queries that return results to client in a streaming fashion (default 200)
   218  -      --queryserver-config-stream-pool-timeout float                     query server stream pool timeout (in seconds), it is how long vttablet waits for a connection from the stream pool. If set to 0 (default) then there is no timeout.
   219  -      --queryserver-config-stream-pool-waiter-cap int                    query server stream pool waiter limit, this is the maximum number of streaming queries that can be queued waiting to get a connection
   220  -      --queryserver-config-strict-table-acl                              only allow queries that pass table acl checks
   221  -      --queryserver-config-terse-errors                                  prevent bind vars from escaping in client error messages
   222  -      --queryserver-config-transaction-cap int                           query server transaction cap is the maximum number of transactions allowed to happen at any given point of a time for a single vttablet. E.g. by setting transaction cap to 100, there are at most 100 transactions will be processed by a vttablet and the 101th transaction will be blocked (and fail if it cannot get connection within specified timeout) (default 20)
   223  -      --queryserver-config-transaction-prefill-parallelism int           query server transaction prefill parallelism, a non-zero value will prefill the pool using the specified parallism.
   224  -      --queryserver-config-transaction-timeout float                     query server transaction timeout (in seconds), a transaction will be killed if it takes longer than this value (default 30)
   225  -      --queryserver-config-txpool-timeout float                          query server transaction pool timeout, it is how long vttablet waits if tx pool is full (default 1)
   226  -      --queryserver-config-txpool-waiter-cap int                         query server transaction pool waiter limit, this is the maximum number of transactions that can be queued waiting to get a connection (default 5000)
   227  -      --queryserver-config-warn-result-size int                          query server result size warning threshold, warn if number of rows returned from vttablet for non-streaming queries exceeds this
   228  -      --queryserver_enable_online_ddl                                    Enable online DDL. (default true)
   229  -      --redact-debug-ui-queries                                          redact full queries and bind variables from debug UI
   230  -      --relay_log_max_items int                                          Maximum number of rows for VReplication target buffering. (default 5000)
   231  -      --relay_log_max_size int                                           Maximum buffer size (in bytes) for VReplication target buffering. If single rows are larger than this, a single row is buffered at a time. (default 250000)
   232  -      --remote_operation_timeout duration                                time to wait for a remote operation (default 30s)
   233  -      --replication-mode string                                          The replication mode to simulate -- must be set to either ROW or STATEMENT (default ROW)
   234  -      --replication_connect_retry duration                               how long to wait in between replica reconnect attempts. Only precise to the second. (default 10s)
   235  -      --retain_online_ddl_tables duration                                How long should vttablet keep an old migrated table before purging it (default 24h0m0s)
   236  -      --retry-count int                                                  retry count (default 2)
   237  -      --sanitize_log_messages                                            Remove potentially sensitive information in tablet INFO, WARNING, and ERROR log messages such as query parameters.
   238  -      --schema string                                                    The SQL table schema
   239  -      --schema-file string                                               Identifies the file that contains the SQL table schema
   240  -      --schema_change_signal                                             Enable the schema tracker; requires queryserver-config-schema-change-signal to be enabled on the underlying vttablets for this to work (default true)
   241  -      --schema_change_signal_user string                                 User to be used to send down query to vttablet to retrieve schema changes
   242  -      --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)
   243  -      --service_map value                                                comma separated list of services to enable (or disable if prefixed with '-') Example: grpc-vtworker
   244  -      --serving_state_grace_period duration                              how long to pause after broadcasting health to vtgate, before enforcing a new serving state
   245  -      --shards int                                                       Number of shards per keyspace. Passing --ks-shard-map/--ks-shard-map-file causes this flag to be ignored. (default 2)
   246  -      --shutdown_grace_period float                                      how long to wait (in seconds) for queries and transactions to complete during graceful shutdown.
   247  -      --sql string                                                       A list of semicolon-delimited SQL commands to analyze
   248  -      --sql-file string                                                  Identifies the file that contains the SQL commands to analyze
   249  -      --sql-max-length-errors int                                        truncate queries in error logs to the given length (default unlimited)
   250  -      --sql-max-length-ui int                                            truncate queries in debug UIs to the given length (default 512) (default 512)
   251  -      --srv_topo_cache_refresh duration                                  how frequently to refresh the topology for cached entries (default 1s)
   252  -      --srv_topo_cache_ttl duration                                      how long to use cached entries for topology (default 1s)
   253  -      --srv_topo_timeout duration                                        topo server timeout (default 5s)
   254  -      --stats_backend string                                             The name of the registered push-based monitoring/stats backend to use
   255  -      --stats_combine_dimensions string                                  List of dimensions to be combined into a single "all" value in exported stats vars
   256  -      --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
   257  -      --stats_drop_variables string                                      Variables to be dropped from the list of exported variables.
   258  -      --stats_emit_period duration                                       Interval between emitting stats to all registered backends (default 1m0s)
   259  -      --stderrthreshold value                                            logs at or above this threshold go to stderr (default 1)
   260  -      --stream_buffer_size int                                           the number of bytes sent from vtgate for each stream call. It's recommended to keep this value in sync with vttablet's query-server-config-stream-buffer-size. (default 32768)
   261  -      --stream_health_buffer_size uint                                   max streaming health entries to buffer per streaming health client (default 20)
   262  -      --table_gc_lifecycle string                                        States for a DROP TABLE garbage collection cycle. Default is 'hold,purge,evac,drop', use any subset ('drop' implcitly always included) (default hold,purge,evac,drop)
   263  -      --tablet_dir string                                                The directory within the vtdataroot to store vttablet/mysql files. Defaults to being generated by the tablet uid.
   264  -      --tablet_filters value                                             Specifies a comma-separated list of 'keyspace|shard_name or keyrange' values to filter the tablets to watch
   265  -      --tablet_manager_protocol string                                   the protocol to use to talk to vttablet (default grpc)
   266  -      --tablet_protocol string                                           how to talk to the vttablets (default grpc)
   267  -      --tablet_refresh_interval duration                                 tablet refresh interval (default 1m0s)
   268  -      --tablet_refresh_known_tablets                                     tablet refresh reloads the tablet address/port map from topo in case it changes (default true)
   269  -      --tablet_url_template string                                       format string describing debug tablet url formatting. See the Go code for getTabletDebugURL() how to customize this. (default http://{{.GetTabletHostPort}})
   270  -      --throttle_check_as_check_self                                     Should throttler/check return a throttler/check-self result (changes throttler behavior for writes)
   271  -      --throttle_metrics_query SELECT                                    Override default heartbeat/lag metric. Use either SELECT (must return single row, single value) or `SHOW GLOBAL ... LIKE ...` queries. Set -throttle_metrics_threshold respectively.
   272  -      --throttle_metrics_threshold float                                 Override default throttle threshold, respective to -throttle_metrics_query (default 1.7976931348623157e+308)
   273  -      --throttle_tablet_types string                                     Comma separated VTTablet types to be considered by the throttler. default: 'replica'. example: 'replica,rdonly'. 'replica' aways implicitly included (default replica)
   274  -      --throttle_threshold duration                                      Replication lag threshold for default lag throttling (default 1s)
   275  -      --topo_global_root string                                          the path of the global topology data in the global topology server
   276  -      --topo_global_server_address string                                the address of the global topology server
   277  -      --topo_implementation string                                       the topology implementation to use
   278  -      --topo_read_concurrency int                                        concurrent topo reads (default 32)
   279  -      --tracer string                                                    tracing service to use (default noop)
   280  -      --tracing-enable-logging                                           whether to enable logging in the tracing service
   281  -      --tracing-sampling-rate value                                      sampling rate for the probabilistic jaeger sampler (default 0.1)
   282  -      --tracing-sampling-type value                                      sampling strategy to use for jaeger. possible values are 'const', 'probabilistic', 'rateLimiting', or 'remote' (default const)
   283  -      --track_schema_versions                                            When enabled, vttablet will store versions of schemas at each position that a DDL is applied and allow retrieval of the schema corresponding to a position
   284  -      --transaction-log-stream-handler string                            URL handler for streaming transactions log (default /debug/txlog)
   285  -      --transaction_limit_by_component                                   Include CallerID.component when considering who the user is for the purpose of transaction limit.
   286  -      --transaction_limit_by_principal                                   Include CallerID.principal when considering who the user is for the purpose of transaction limit. (default true)
   287  -      --transaction_limit_by_subcomponent                                Include CallerID.subcomponent when considering who the user is for the purpose of transaction limit.
   288  -      --transaction_limit_by_username                                    Include VTGateCallerID.username when considering who the user is for the purpose of transaction limit. (default true)
   289  -      --transaction_limit_per_user float                                 Maximum number of transactions a single user is allowed to use at any time, represented as fraction of -transaction_cap. (default 0.4)
   290  -      --transaction_mode string                                          SINGLE: disallow multi-db transactions, MULTI: allow multi-db transactions with best effort commit, TWOPC: allow multi-db transactions with 2pc commit (default MULTI)
   291  -      --transaction_shutdown_grace_period float                          DEPRECATED: use shutdown_grace_period instead.
   292  -      --twopc_abandon_age float                                          time in seconds. Any unresolved transaction older than this time will be sent to the coordinator to be resolved.
   293  -      --twopc_coordinator_address string                                 address of the (VTGate) process(es) that will be used to notify of abandoned transactions.
   294  -      --twopc_enable                                                     if the flag is on, 2pc is enabled. Other 2pc flags must be supplied.
   295  -      --tx-throttler-config string                                       Synonym to -tx_throttler_config (default target_replication_lag_sec: 2
   296  -max_replication_lag_sec: 10
   297  -initial_rate: 100
   298  -max_increase: 1
   299  -emergency_decrease: 0.5
   300  -min_duration_between_increases_sec: 40
   301  -max_duration_between_increases_sec: 62
   302  -min_duration_between_decreases_sec: 20
   303  -spread_backlog_across_sec: 20
   304  -age_bad_rate_after_sec: 180
   305  -bad_rate_increase: 0.1
   306  -max_rate_approach_threshold: 0.9
   307  -)
   308  -      --tx-throttler-healthcheck-cells value                             Synonym to -tx_throttler_healthcheck_cells
   309  -      --tx_throttler_config string                                       The configuration of the transaction throttler as a text formatted throttlerdata.Configuration protocol buffer message (default target_replication_lag_sec: 2
   310  -max_replication_lag_sec: 10
   311  -initial_rate: 100
   312  -max_increase: 1
   313  -emergency_decrease: 0.5
   314  -min_duration_between_increases_sec: 40
   315  -max_duration_between_increases_sec: 62
   316  -min_duration_between_decreases_sec: 20
   317  -spread_backlog_across_sec: 20
   318  -age_bad_rate_after_sec: 180
   319  -bad_rate_increase: 0.1
   320  -max_rate_approach_threshold: 0.9
   321  -)
   322  -      --tx_throttler_healthcheck_cells value                             A comma-separated list of cells. Only tabletservers running in these cells will be monitored for replication lag by the transaction throttler.
   323  -      --unhealthy_threshold duration                                     replication lag after which a replica is considered unhealthy (default 2h0m0s)
   324  -      --v value                                                          log level for V logs
   325  -      --version                                                          print binary version
   326  -      --vmodule value                                                    comma-separated list of pattern=N settings for file-filtered logging
   327  -      --vreplication_copy_phase_duration duration                        Duration for each copy phase loop (before running the next catchup: default 1h) (default 1h0m0s)
   328  -      --vreplication_copy_phase_max_innodb_history_list_length int       The maximum InnoDB transaction history that can exist on a vstreamer (source) before starting another round of copying rows. This helps to limit the impact on the source tablet. (default 1000000)
   329  -      --vreplication_copy_phase_max_mysql_replication_lag int            The maximum MySQL replication lag (in seconds) that can exist on a vstreamer (source) before starting another round of copying rows. This helps to limit the impact on the source tablet. (default 43200)
   330  -      --vreplication_experimental_flags int                              (Bitmask) of experimental features in vreplication to enable (default 1)
   331  -      --vreplication_healthcheck_retry_delay duration                    healthcheck retry delay (default 5s)
   332  -      --vreplication_healthcheck_timeout duration                        healthcheck retry delay (default 1m0s)
   333  -      --vreplication_healthcheck_topology_refresh duration               refresh interval for re-reading the topology (default 30s)
   334  -      --vreplication_heartbeat_update_interval int                       Frequency (in seconds, default 1, max 60) at which the time_updated column of a vreplication stream when idling (default 1)
   335  -      --vreplication_max_time_to_retry_on_error duration                 stop automatically retrying when we've had consecutive failures with the same error for this long after the first occurrence (default 15m0s)
   336  -      --vreplication_replica_lag_tolerance duration                      Replica lag threshold duration: once lag is below this we switch from copy phase to the replication (streaming) phase (default 1m0s)
   337  -      --vreplication_retry_delay duration                                delay before retrying a failed workflow event in the replication phase (default 5s)
   338  -      --vreplication_store_compressed_gtid                               Store compressed gtids in the pos column of _vt.vreplication
   339  -      --vreplication_tablet_type string                                  comma separated list of tablet types used as a source (default in_order:REPLICA,PRIMARY)
   340  -      --vschema string                                                   Identifies the VTGate routing schema
   341  -      --vschema-file string                                              Identifies the VTGate routing schema file
   342  -      --vschema_ddl_authorized_users string                              List of users authorized to execute vschema ddl operations, or '%' to allow all users.
   343  -      --vstream_dynamic_packet_size                                      Enable dynamic packet sizing for VReplication. This will adjust the packet size during replication to improve performance. (default true)
   344  -      --vstream_packet_size int                                          Suggested packet size for VReplication streamer. This is used only as a recommendation. The actual packet size may be more or less than this amount. (default 250000)
   345  -      --vtgate-config-terse-errors                                       prevent bind vars from escaping in returned errors
   346  -      --vtgate_protocol string                                           how to talk to vtgate (default grpc)
   347  -      --warn_memory_rows int                                             Warning threshold for in-memory results. A row count higher than this amount will cause the VtGateWarnings.ResultsExceeded counter to be incremented. (default 30000)
   348  -      --warn_payload_size int                                            The warning threshold for query payloads in bytes. A payload greater than this threshold will cause the VtGateWarnings.WarnPayloadSizeExceeded counter to be incremented.
   349  -      --warn_sharded_only                                                If any features that are only available in unsharded mode are used, query execution warnings will be added to the session
   350  -      --watch_replication_stream                                         When enabled, vttablet will stream the MySQL replication stream from the local server, and use it to update schema when it sees a DDL.
   351  -      --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
   352  -      --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
   353  -      --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
   354  -      --xtrabackup_root_path string                                      directory location of the xtrabackup and xbstream executables, e.g., /usr/bin
   355  -      --xtrabackup_stream_mode string                                    which mode to use if streaming, valid values are tar and xbstream (default tar)
   356  -      --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)
   357  -      --xtrabackup_stripes uint                                          If greater than 0, use data striping across this many destination files to parallelize data transfer and decompression
   358  -      --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.
   359  +      --alsologtostderr                              log to standard error as well as files
   360  +      --batch-interval duration                      Interval between logical time slots. (default 10ms)
   361  +      --dbname string                                Optional database target to override normal routing
   362  +      --default_tablet_type topodatapb.TabletType    The default tablet type to set for queries, when one is not explicitly selected. (default PRIMARY)
   363  +      --execution-mode string                        The execution mode to simulate -- must be set to multi, legacy-autocommit, or twopc (default "multi")
   364  +  -h, --help                                         display usage and exit
   365  +      --keep_logs duration                           keep logs for this long (using ctime) (zero to keep forever)
   366  +      --keep_logs_by_mtime duration                  keep logs for this long (using mtime) (zero to keep forever)
   367  +      --ks-shard-map string                          JSON map of keyspace name -> shard name -> ShardReference object. The inner map is the same as the output of FindAllShardsInKeyspace
   368  +      --ks-shard-map-file string                     File containing json blob of keyspace name -> shard name -> ShardReference object
   369  +      --log_backtrace_at traceLocation               when logging hits line file:N, emit a stack trace (default :0)
   370  +      --log_dir string                               If non-empty, write log files in this directory
   371  +      --log_err_stacks                               log stack traces for errors
   372  +      --log_queries_to_file string                   Enable query logging to the specified file
   373  +      --log_rotate_max_size uint                     size in bytes at which logs are rotated (glog.MaxSize) (default 1887436800)
   374  +      --logtostderr                                  log to standard error instead of files
   375  +      --message_stream_grace_period duration         the amount of time to give for a vttablet to resume if it ends a message stream, usually because of a reparent. (default 30s)
   376  +      --mysql-server-pool-conn-read-buffers          If set, the server will pool incoming connection read buffers
   377  +      --mysql_allow_clear_text_without_tls           If set, the server will allow the use of a clear text password over non-SSL connections.
   378  +      --mysql_auth_server_impl string                Which auth server implementation to use. Options: none, ldap, clientcert, static, vault. (default "static")
   379  +      --mysql_default_workload string                Default session workload (OLTP, OLAP, DBA) (default "OLTP")
   380  +      --mysql_server_bind_address string             Binds on this address when listening to MySQL binary protocol. Useful to restrict listening to 'localhost' only for instance.
   381  +      --mysql_server_port int                        If set, also listen for MySQL binary protocol connections on this port. (default -1)
   382  +      --mysql_server_query_timeout duration          mysql query timeout (default 0s)
   383  +      --mysql_server_read_timeout duration           connection read timeout (default 0s)
   384  +      --mysql_server_require_secure_transport        Reject insecure connections but only if mysql_server_ssl_cert and mysql_server_ssl_key are provided
   385  +      --mysql_server_socket_path string              This option specifies the Unix socket file to use when listening for local connections. By default it will be empty and it won't listen to a unix socket
   386  +      --mysql_server_ssl_ca string                   Path to ssl CA for mysql server plugin SSL. If specified, server will require and validate client certs.
   387  +      --mysql_server_ssl_cert string                 Path to the ssl cert for mysql server plugin SSL
   388  +      --mysql_server_ssl_crl string                  Path to ssl CRL for mysql server plugin SSL
   389  +      --mysql_server_ssl_key string                  Path to ssl key for mysql server plugin SSL
   390  +      --mysql_server_ssl_server_ca string            path to server CA in PEM format, which will be combine with server cert, return full certificate chain to clients
   391  +      --mysql_server_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.
   392  +      --mysql_server_version string                  MySQL server version to advertise.
   393  +      --mysql_server_write_timeout duration          connection write timeout (default 0s)
   394  +      --mysql_slow_connect_warn_threshold duration   Warn if it takes more than the given threshold for a mysql connection to establish (default 0s)
   395  +      --mysql_tcp_version string                     Select tcp, tcp4, or tcp6 to control the socket type. (default "tcp")
   396  +      --normalize                                    Whether to enable vtgate normalization
   397  +      --output-mode string                           Output in human-friendly text or json (default "text")
   398  +      --planner-version string                       Sets the query planner version to use when generating the explain output. Valid values are V3 and Gen4
   399  +      --pprof strings                                enable profiling
   400  +      --proxy_protocol                               Enable HAProxy PROXY protocol on MySQL listener socket
   401  +      --purge_logs_interval duration                 how often try to remove old logs (default 1h0m0s)
   402  +      --querylog-buffer-size int                     Maximum number of buffered query logs before throttling log output (default 10)
   403  +      --replication-mode string                      The replication mode to simulate -- must be set to either ROW or STATEMENT (default "ROW")
   404  +      --schema string                                The SQL table schema
   405  +      --schema-file string                           Identifies the file that contains the SQL table schema
   406  +      --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)
   407  +      --shards int                                   Number of shards per keyspace. Passing --ks-shard-map/--ks-shard-map-file causes this flag to be ignored. (default 2)
   408  +      --sql string                                   A list of semicolon-delimited SQL commands to analyze
   409  +      --sql-file string                              Identifies the file that contains the SQL commands to analyze
   410  +      --sql-max-length-errors int                    truncate queries in error logs to the given length (default unlimited)
   411  +      --sql-max-length-ui int                        truncate queries in debug UIs to the given length (default 512) (default 512)
   412  +      --stderrthreshold severity                     logs at or above this threshold go to stderr (default 1)
   413  +      --v Level                                      log level for V logs
   414  +  -v, --version                                      print binary version
   415  +      --vmodule moduleSpec                           comma-separated list of pattern=N settings for file-filtered logging
   416  +      --vschema string                               Identifies the VTGate routing schema
   417  +      --vschema-file string                          Identifies the VTGate routing schema file