OS Manuals

/usr/bin/vttablet

All the binaries built by Vitess

From vitess-23-binaries 23.0.8-r7 (enterprise-packages), captured 2026-11-08 by running vttablet --help (exit 0). permalink

The VTTablet server _controls_ a running MySQL server. VTTablet supports two primary types of deployments:

* Managed MySQL (most common)
* External MySQL

In addition to these deployment types, a partially managed VTTablet is also possible by setting `--disable-active-reparents`.

### Managed MySQL

In this mode, Vitess actively manages MySQL.

### External MySQL.

In this mode, an external MySQL can be used such as AWS RDS, AWS Aurora, Google CloudSQL; or just an existing (vanilla) MySQL installation.

See "Unmanaged Tablet" for the full guide.

Even if a MySQL is external, you can still make vttablet perform some management functions. They are as follows:

* `--unmanaged`: This flag indicates that this tablet is running in unmanaged mode. In this mode, any reparent or replica commands are not allowed. These are InitShardPrimary, PlannedReparentShard, EmergencyReparentShard, and ReparentTablet. You should use the TabletExternallyReparented command to inform vitess of the current primary.
* `--replication-connect-retry`: This value is give to mysql when it connects a replica to the primary as the retry duration parameter.
* `--heartbeat-enable` and `--heartbeat-interval duration`: cause vttablet to write heartbeats to the sidecar database. This information is also used by the replication reporter to assess replica lag.

Usage:
  vttablet [flags]

Examples:

vttablet \
	--topo-implementation etcd2 \
	--topo-global-server-address localhost:2379 \
	--topo-global-root /vitess/ \
	--tablet-path $alias \
	--init-keyspace $keyspace \
	--init-shard $shard \
	--init-tablet-type $tablet_type \
	--port $port \
	--grpc-port $grpc_port \
	--service-map 'grpc-queryservice,grpc-tabletmanager,grpc-updatestream'

`$alias` needs to be of the form: `<cell>-id`, and the cell should match one of the local cells that was created in the topology. The id can be left padded with zeroes: `cell-100` and `cell-000000100` are synonymous.

Flags:
      --alsologtostderr                                                  log to standard error as well as files
      --app-idle-timeout duration                                        Idle timeout for app connections (default 1m0s)
      --app-pool-size int                                                Size of the connection pool for app connections (default 40)
      --azblob-backup-account-key-file string                            Path to a file containing the Azure Storage account key; if this flag is unset, the environment variable VT_AZBLOB_ACCOUNT_KEY will be used as the key itself (NOT a file path).
      --azblob-backup-account-name string                                Azure Storage Account name for backups; if this flag is unset, the environment variable VT_AZBLOB_ACCOUNT_NAME will be used.
      --azblob-backup-buffer-size int                                    The memory buffer size to use in bytes, per file or stripe, when streaming to Azure Blob Service. (default 104857600)
      --azblob-backup-container-name string                              Azure Blob Container Name.
      --azblob-backup-parallelism int                                    Azure Blob operation parallelism (requires extra memory when increased -- a multiple of azblob-backup-buffer-size). (default 1)
      --azblob-backup-storage-root string                                Root prefix for all backup-related Azure Blobs; this should exclude both initial and trailing '/' (e.g. just 'a/b' not '/a/b/').
      --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")
      --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)
      --backup-storage-compress                                          if set, the backup files will be compressed. (default true)
      --backup-storage-implementation string                             Which backup storage implementation to use for creating and restoring backups.
      --backup-storage-number-blocks int                                 if backup-storage-compress is true, backup-storage-number-blocks sets the number of blocks that can be processed, in parallel, before the writer blocks, during compression (default is 2). It should be equal to the number of CPUs available for compression. (default 2)
      --bind-address string                                              Bind address for the server. If empty, the server will listen on all available unicast and anycast IP addresses of the local system.
      --binlog-in-memory-decompressor-max-size uint                      This value sets the uncompressed transaction payload size at which we switch from in-memory buffer based decompression to the slower streaming mode. (default 134217728)
      --binlog-player-grpc-ca string                                     the server ca to use to validate servers when connecting
      --binlog-player-grpc-cert string                                   the cert to use to connect
      --binlog-player-grpc-crl string                                    the server crl to use to validate server certificates when connecting
      --binlog-player-grpc-key string                                    the key to use to connect
      --binlog-player-grpc-server-name string                            the server name to use to validate server certificate
      --binlog-player-protocol string                                    the protocol to download binlogs from a vttablet (default "grpc")
      --builtinbackup-file-read-buffer-size uint                         read files using an IO buffer of this many bytes. Golang defaults are used when set to 0.
      --builtinbackup-file-write-buffer-size uint                        write files using an IO buffer of this many bytes. Golang defaults are used when set to 0. (default 2097152)
      --builtinbackup-incremental-restore-path string                    the directory where incremental restore files, namely binlog files, are extracted to. In k8s environments, this should be set to a directory that is shared between the vttablet and mysqld pods. The path should exist. When empty, the default OS temp dir is assumed.
      --builtinbackup-mysqld-timeout duration                            how long to wait for mysqld to shutdown at the start of the backup. (default 10m0s)
      --builtinbackup-progress duration                                  how often to send progress updates when backing up large files. (default 5s)
      --catch-sigpipe                                                    catch and ignore SIGPIPE on stdout and stderr if specified
      --ceph-backup-storage-config string                                Path to JSON config file for ceph backup storage. (default "ceph_backup_config.json")
      --compression-engine-name string                                   compressor engine used for compression. (default "pargzip")
      --compression-level int                                            what level to pass to the compressor. (default 1)
      --config-file string                                               Full path of the config file (with extension) to use. If set, --config-path, --config-type, and --config-name are ignored.
      --config-file-not-found-handling ConfigFileNotFoundHandling        Behavior when a config file is not found. (Options: error, exit, ignore, warn) (default warn)
      --config-name string                                               Name of the config file (without extension) to search for. (default "vtconfig")
      --config-path strings                                              Paths to search for config files in. (default [/tmp])
      --config-persistence-min-interval duration                         minimum interval between persisting dynamic config changes back to disk (if no change has occurred, nothing is done). (default 1s)
      --config-type string                                               Config file type (omit to infer config type from file extension).
      --consolidator-query-waiter-cap int                                Configure the maximum number of clients allowed to wait on the consolidator.
      --consolidator-stream-query-size int                               Configure the stream consolidator query size in bytes. Setting to 0 disables the stream consolidator. (default 2097152)
      --consolidator-stream-total-size int                               Configure the stream consolidator total size in bytes. Setting to 0 disables the stream consolidator. (default 134217728)
      --consul-auth-static-file string                                   JSON File to read the topos/tokens from.
      --datadog-agent-host string                                        host to send spans to. if empty, no tracing will be done
      --datadog-agent-port string                                        port to send spans to. if empty, no tracing will be done
      --datadog-trace-debug-mode                                         enable debug mode for datadog tracing
      --db-allprivs-password string                                      db allprivs password
      --db-allprivs-use-ssl                                              Set this flag to false to make the allprivs connection to not use ssl (default true)
      --db-allprivs-user string                                          db allprivs user userKey (default "vt_allprivs")
      --db-app-password string                                           db app password
      --db-app-use-ssl                                                   Set this flag to false to make the app connection to not use ssl (default true)
      --db-app-user string                                               db app user userKey (default "vt_app")
      --db-appdebug-password string                                      db appdebug password
      --db-appdebug-use-ssl                                              Set this flag to false to make the appdebug connection to not use ssl (default true)
      --db-appdebug-user string                                          db appdebug user userKey (default "vt_appdebug")
      --db-charset string                                                Character set/collation used for this tablet. Make sure to configure this to a charset/collation supported by the lowest MySQL version in your environment. (default "utf8mb4")
      --db-conn-query-info                                               enable parsing and processing of QUERY_OK info fields
      --db-connect-timeout-ms int                                        connection timeout to mysqld in milliseconds (0 for no timeout)
      --db-credentials-file string                                       db credentials file; send SIGHUP to reload this file
      --db-credentials-server string                                     db credentials server type ('file' - file implementation; 'vault' - HashiCorp Vault implementation) (default "file")
      --db-credentials-vault-addr string                                 URL to Vault server
      --db-credentials-vault-path string                                 Vault path to credentials JSON blob, e.g.: secret/data/prod/dbcreds
      --db-credentials-vault-role-mountpoint string                      Vault AppRole mountpoint; can also be passed using VAULT_MOUNTPOINT environment variable (default "approle")
      --db-credentials-vault-role-secretidfile string                    Path to file containing Vault AppRole secret_id; can also be passed using VAULT_SECRETID environment variable
      --db-credentials-vault-roleid string                               Vault AppRole id; can also be passed using VAULT_ROLEID environment variable
      --db-credentials-vault-timeout duration                            Timeout for vault API operations (default 10s)
      --db-credentials-vault-tls-ca string                               Path to CA PEM for validating Vault server certificate
      --db-credentials-vault-tokenfile string                            Path to file containing Vault auth token; token can also be passed using VAULT_TOKEN environment variable
      --db-credentials-vault-ttl duration                                How long to cache DB credentials from the Vault server (default 30m0s)
      --db-dba-password string                                           db dba password
      --db-dba-use-ssl                                                   Set this flag to false to make the dba connection to not use ssl (default true)
      --db-dba-user string                                               db dba user userKey (default "vt_dba")
      --db-erepl-password string                                         db erepl password
      --db-erepl-use-ssl                                                 Set this flag to false to make the erepl connection to not use ssl (default true)
      --db-erepl-user string                                             db erepl user userKey (default "vt_erepl")
      --db-filtered-password string                                      db filtered password
      --db-filtered-use-ssl                                              Set this flag to false to make the filtered connection to not use ssl (default true)
      --db-filtered-user string                                          db filtered user userKey (default "vt_filtered")
      --db-flags uint                                                    Flag values as defined by MySQL.
      --db-flavor string                                                 Flavor overrid. Valid value is FilePos.
      --db-host string                                                   The host name for the tcp connection.
      --db-port int                                                      tcp port
      --db-repl-password string                                          db repl password
      --db-repl-use-ssl                                                  Set this flag to false to make the repl connection to not use ssl (default true)
      --db-repl-user string                                              db repl user userKey (default "vt_repl")
      --db-server-name string                                            server name of the DB we are connecting to.
      --db-socket string                                                 The unix socket to connect on. If this is specified, host and port will not be used.
      --db-ssl-ca string                                                 connection ssl ca
      --db-ssl-ca-path string                                            connection ssl ca path
      --db-ssl-cert string                                               connection ssl certificate
      --db-ssl-key string                                                connection ssl key
      --db-ssl-mode SslMode                                              SSL mode to connect with. One of disabled, preferred, required, verify_ca & verify_identity.
      --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.
      --dba-idle-timeout duration                                        Idle timeout for dba connections (default 1m0s)
      --dba-pool-size int                                                Size of the connection pool for dba connections (default 20)
      --degraded-threshold duration                                      replication lag after which a replica is considered degraded (default 30s)
      --disk-write-dir string                                            if provided, tablet will attempt to write a file to this directory to check if the disk is stalled
      --disk-write-interval duration                                     how often to write to the disk to check whether it is stalled (default 5s)
      --disk-write-timeout duration                                      if writes exceed this duration, the disk is considered stalled (default 30s)
      --emit-stats                                                       If set, emit stats to push-based monitoring and stats backends
      --enable-consolidator                                              This option enables the query consolidator. (default true)
      --enable-consolidator-replicas                                     This option enables the query consolidator only on replicas.
      --enable-hot-row-protection                                        If true, incoming transactions for the same row (range) will be queued and cannot consume all txpool slots.
      --enable-hot-row-protection-dry-run                                If true, hot row protection is not enforced but logs if transactions would have been queued.
      --enable-per-workload-table-metrics                                If true, query counts and query error metrics include a label that identifies the workload
      --enable-replication-reporter                                      Use polling to track replication lag.
      --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.
      --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.
      --enable-tx-throttler                                              If true replication-lag-based throttling on transactions will be enabled.
      --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)
      --enforce-tableacl-config                                          if this flag is true, vttablet will fail to start if a valid tableacl config does not exist
      --external-compressor string                                       command with arguments to use when compressing a backup.
      --external-compressor-extension string                             extension to use when using an external compressor.
      --external-decompressor string                                     command with arguments to use when decompressing a backup.
      --external-decompressor-use-manifest                               allows the decompressor command stored in the backup manifest to be used at restore time. Enabling this is a security risk: an attacker with write access to the backup storage could modify the manifest to execute arbitrary commands on the tablet as the Vitess user. NOT RECOMMENDED.
      --file-backup-storage-root string                                  Root directory for the file backup storage.
      --filecustomrules string                                           file based custom rule path
      --filecustomrules-watch                                            set up a watch on the target file and reload query rules when it changes
      --gc-check-interval duration                                       Interval between garbage collection checks (default 1h0m0s)
      --gc-purge-check-interval duration                                 Interval between purge discovery checks (default 1m0s)
      --gcs-backup-storage-bucket string                                 Google Cloud Storage bucket to use for backups.
      --gcs-backup-storage-root string                                   Root prefix for all backup-related object names.
      --grpc-auth-mode string                                            Which auth plugin implementation to use (eg: static)
      --grpc-auth-mtls-allowed-substrings string                         List of substrings of at least one of the client certificate names (separated by colon).
      --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.
      --grpc-auth-static-password-file string                            JSON File to read the users/passwords from.
      --grpc-bind-address string                                         Bind address for gRPC calls. If empty, listen on all addresses.
      --grpc-ca string                                                   server CA to use for gRPC connections, requires TLS, and enforces client certificate check
      --grpc-cert string                                                 server certificate to use for gRPC connections, requires grpc-key, enables TLS
      --grpc-compression string                                          Which protocol to use for compressing gRPC. Default: nothing. Supported: snappy
      --grpc-crl string                                                  path to a certificate revocation list in PEM format, client certificates will be further verified against this file during TLS handshake
      --grpc-dial-concurrency-limit int                                  Maximum concurrency of grpc dial operations. This should be less than the golang max thread limit of 10000. (default 1024)
      --grpc-enable-optional-tls                                         enable optional TLS mode when a server accepts both TLS and plain-text connections on the same port; plain-text connections are served unauthenticated, even with --grpc-ca
      --grpc-enable-orca-metrics                                         gRPC server option to enable sending ORCA metrics to clients for load balancing
      --grpc-enable-tracing                                              Enable gRPC tracing.
      --grpc-initial-conn-window-size int                                gRPC initial connection window size
      --grpc-initial-window-size int                                     gRPC initial window size
      --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)
      --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)
      --grpc-key string                                                  server private key to use for gRPC connections, requires grpc-cert, enables TLS
      --grpc-max-connection-age duration                                 Maximum age of a client connection before GoAway is sent. (default 2562047h47m16.854775807s)
      --grpc-max-connection-age-grace duration                           Additional grace period after grpc-max-connection-age, after which connections are forcibly closed. (default 2562047h47m16.854775807s)
      --grpc-max-message-size int                                        Maximum allowed RPC message size. Larger messages will be rejected by gRPC with the error 'exceeding the max size'. (default 16777216)
      --grpc-port int                                                    Port to listen on for gRPC calls. If zero, do not listen.
      --grpc-prometheus                                                  Enable gRPC monitoring with Prometheus.
      --grpc-server-ca string                                            path to server CA in PEM format, which will be combine with server cert, return full certificate chain to clients
      --grpc-server-initial-conn-window-size int                         gRPC server initial connection window size
      --grpc-server-initial-window-size int                              gRPC server initial window size
      --grpc-server-keepalive-enforcement-policy-min-time duration       gRPC server minimum keepalive time (default 10s)
      --grpc-server-keepalive-enforcement-policy-permit-without-stream   gRPC server permit client keepalive pings even when there are no active streams (RPCs)
      --grpc-server-keepalive-time duration                              After a duration of this time, if the server doesn't see any activity, it pings the client to see if the transport is still alive. (default 10s)
      --grpc-server-keepalive-timeout duration                           After having pinged for keepalive check, the server waits for a duration of Timeout and if no activity is seen even after that the connection is closed. (default 10s)
      --health-check-interval duration                                   Interval between health checks (default 20s)
      --heartbeat-enable                                                 If true, vttablet records (if master) or checks (if replica) the current time of a replication heartbeat in the sidecar database's heartbeat table. The result is used to inform the serving state of the vttablet via healthchecks.
      --heartbeat-interval duration                                      How frequently to read and write replication heartbeat. (default 1s)
      --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
  -h, --help                                                             help for vttablet
      --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)
      --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)
      --hot-row-protection-max-queue-size int                            Maximum number of BeginExecute RPCs which will be queued for the same row (range). (default 20)
      --init-db-name-override string                                     (init parameter) override the name of the db used by vttablet. Without this flag, the db name defaults to vt_<keyspacename>
      --init-keyspace string                                             (init parameter) keyspace to use for this tablet
      --init-shard string                                                (init parameter) shard to use for this tablet
      --init-tablet-type string                                          (init parameter) tablet type to use for this tablet. Valid values are: PRIMARY, REPLICA, SPARE, and RDONLY. The default is REPLICA.
      --init-tags StringMap                                              (init parameter) comma separated list of key:value pairs used to tag the tablet
      --init-timeout duration                                            (init parameter) timeout to use for the init phase. (default 1m0s)
      --jaeger-agent-host string                                         host and port to send spans to. if empty, no tracing will be done
      --keep-logs duration                                               keep logs for this long (using ctime) (zero to keep forever)
      --keep-logs-by-mtime duration                                      keep logs for this long (using mtime) (zero to keep forever)
      --lameduck-period duration                                         keep running at least this long after SIGTERM before stopping (default 50ms)
      --lock-tables-timeout duration                                     How long to keep the table locked before timing out (default 1m0s)
      --lock-timeout duration                                            Maximum time to wait when attempting to acquire a lock from the topo server (default 45s)
      --log-err-stacks                                                   log stack traces for errors
      --log-queries                                                      Enable query logging to syslog.
      --log-queries-to-file string                                       Enable query logging to the specified file
      --log-rotate-max-size uint                                         size in bytes at which logs are rotated (glog.MaxSize) (default 1887436800)
      --log_backtrace_at traceLocations                                  when logging hits line file:N, emit a stack trace
      --log_dir string                                                   If non-empty, write log files in this directory
      --logtostderr                                                      log to standard error instead of files
      --manifest-external-decompressor string                            command with arguments to store in the backup manifest when compressing a backup with an external compression engine.
      --max-concurrent-online-ddl int                                    Maximum number of online DDL changes that may run concurrently (default 256)
      --max-stack-size int                                               configure the maximum stack size in bytes (default 67108864)
      --migration-check-interval duration                                Interval between migration checks (default 1m0s)
      --mycnf-bin-log-path string                                        mysql binlog path
      --mycnf-data-dir string                                            data directory for mysql
      --mycnf-error-log-path string                                      mysql error log path
      --mycnf-file string                                                path to my.cnf, if reading all config params from there
      --mycnf-general-log-path string                                    mysql general log path
      --mycnf-innodb-data-home-dir string                                Innodb data home directory
      --mycnf-innodb-log-group-home-dir string                           Innodb log group home directory
      --mycnf-master-info-file string                                    mysql master.info file
      --mycnf-mysql-port int                                             port mysql is listening on
      --mycnf-pid-file string                                            mysql pid file
      --mycnf-relay-log-index-path string                                mysql relay log index path
      --mycnf-relay-log-info-path string                                 mysql relay log info path
      --mycnf-relay-log-path string                                      mysql relay log path
      --mycnf-secure-file-priv string                                    mysql path for loading secure files
      --mycnf-server-id int                                              mysql server id of the server (if specified, mycnf-file will be ignored)
      --mycnf-slow-log-path string                                       mysql slow query log path
      --mycnf-socket-file string                                         mysql socket file
      --mycnf-tmp-dir string                                             mysql tmp directory
      --mysql-server-version string                                      MySQL server version to advertise. (default "8.4.6-Vitess")
      --mysql-shell-backup-location string                               location where the backup will be stored
      --mysql-shell-dump-flags string                                    flags to pass to mysql shell dump utility. This should be a JSON string and will be saved in the MANIFEST (default "{\"threads\": 4}")
      --mysql-shell-flags string                                         execution flags to pass to mysqlsh binary to be used during dump/load (default "--defaults-file=/dev/null --js -h localhost")
      --mysql-shell-load-flags string                                    flags to pass to mysql shell load utility. This should be a JSON string (default "{\"threads\": 4, \"loadUsers\": true, \"updateGtidSet\": \"replace\", \"skipBinlog\": true, \"progressFile\": \"\"}")
      --mysql-shell-should-drain                                         decide if we should drain while taking a backup or continue to serving traffic
      --mysql-shell-speedup-restore                                      speed up restore by disabling redo logging and double write buffer during the restore process
      --mysql-shutdown-timeout duration                                  Timeout to use when MySQL is being shut down. (default 5m0s)
      --mysqlctl-mycnf-template string                                   template file to use for generating the my.cnf file during server init
      --mysqlctl-socket string                                           socket file to use for remote mysqlctl actions (empty for local actions)
      --onclose-timeout duration                                         wait no more than this for OnClose handlers before stopping (default 10s)
      --onterm-timeout duration                                          wait no more than this for OnTermSync handlers before stopping (default 10s)
      --opentsdb-uri string                                              URI of opentsdb /api/put method
      --pid-file string                                                  If set, the process will write its pid to the named file, and delete it on graceful shutdown.
      --pool-hostname-resolve-interval duration                          if set force an update to all hostnames and reconnect if changed, defaults to 0 (disabled)
      --port int                                                         port for the server
      --pprof strings                                                    enable profiling
      --pprof-http                                                       enable pprof http endpoints
      --publish-retry-interval duration                                  how long vttablet waits to retry publishing the tablet record (default 30s)
      --purge-logs-interval duration                                     how often try to remove old logs (default 1h0m0s)
      --query-log-stream-handler string                                  URL handler for streaming queries log (default "/debug/querylog")
      --query-throttler-config-refresh-interval duration                 How frequently to refresh configuration for the query throttler (default 1m0s)
      --querylog-emit-on-any-condition-met                               Emit to query log when any of the conditions (row-threshold, time-threshold, filter-tag) is met (default false)
      --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
      --querylog-format string                                           format for query logs ("text" or "json") (default "text")
      --querylog-mode string                                             Mode for logging queries. "error" will only log queries that return an error. Otherwise all queries will be logged. (default "all")
      --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.
      --querylog-sample-rate float                                       Sample rate for logging queries. Value must be between 0.0 (no logging) and 1.0 (all queries)
      --querylog-time-threshold duration                                 Execution time duration a query needs to run over before being logged; time duration expressed in the form recognized by time.ParseDuration; not useful for streaming queries.
      --queryserver-config-acl-exempt-acl string                         an acl that exempt from table acl checking (this acl is free to access any vitess tables).
      --queryserver-config-annotate-queries                              prefix queries to MySQL backend with comment indicating vtgate principal (user) and target tablet type
      --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
      --queryserver-config-idle-timeout duration                         query server idle timeout, 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 30m0s)
      --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)
      --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)
      --queryserver-config-olap-transaction-timeout duration             query server transaction timeout (in seconds), after which a transaction in an OLAP session will be killed (default 30s)
      --queryserver-config-passthrough-dmls                              query server pass through all dml statements without rewriting
      --queryserver-config-pool-conn-max-lifetime duration               query server connection max lifetime, vttablet manages various mysql connection pools. This config means if a connection has lived at least this long, it connection will be removed from pool upon the next time it is returned to the pool.
      --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)
      --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)
      --queryserver-config-query-pool-max-idle-count int                 query server query pool - maximum number of idle connections to retain in the pool. Use this to balance between faster response times during traffic bursts and resource efficiency during low-traffic periods.
      --queryserver-config-query-pool-timeout duration                   query server query pool timeout, 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.
      --queryserver-config-query-timeout duration                        query server query timeout, this is the query timeout in vttablet side. If a query takes more than this timeout, it will be killed. (default 30s)
      --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)
      --queryserver-config-schema-reload-time duration                   query server schema reload time, how often vttablet reloads schemas from underlying MySQL instance. vttablet keeps table schemas in its own memory and periodically refreshes it from MySQL. This config controls the reload time. (default 30m0s)
      --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)
      --queryserver-config-stream-pool-max-idle-count int                query server stream pool - maximum number of idle connections to retain in the pool. Use this to balance between faster response times during traffic bursts and resource efficiency during low-traffic periods.
      --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)
      --queryserver-config-stream-pool-timeout duration                  query server stream pool timeout, it is how long vttablet waits for a connection from the stream pool. If set to 0 (default) then there is no timeout.
      --queryserver-config-strict-table-acl                              only allow queries that pass table acl checks
      --queryserver-config-terse-errors                                  prevent bind vars from escaping in client error messages
      --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)
      --queryserver-config-transaction-timeout duration                  query server transaction timeout, a transaction will be killed if it takes longer than this value (default 30s)
      --queryserver-config-truncate-error-len int                        truncate errors sent to client if they are longer than this value (0 means do not truncate)
      --queryserver-config-txpool-max-idle-count int                     query server transaction pool - maximum number of idle connections to retain in the pool. Use this to balance between faster response times during traffic bursts and resource efficiency during low-traffic periods.
      --queryserver-config-txpool-timeout duration                       query server transaction pool timeout, it is how long vttablet waits if tx pool is full (default 1s)
      --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
      --queryserver-enable-online-ddl                                    Enable online DDL. (default true)
      --queryserver-enable-views                                         Enable views support in vttablet.
      --redact-debug-ui-queries                                          redact full queries and bind variables from debug UI
      --relay-log-max-items int                                          Maximum number of rows for vreplication target buffering. (default 5000)
      --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)
      --remote-operation-timeout duration                                time to wait for a remote operation (default 15s)
      --replication-connect-retry duration                               how long to wait in between replica reconnect attempts. Only precise to the second. (default 10s)
      --restore-concurrency int                                          (init restore parameter) how many concurrent files to restore at once (default 4)
      --restore-from-backup                                              (init restore parameter) will check BackupStorage for a recent backup at startup and start there
      --restore-from-backup-allowed-engines strings                      (init restore parameter) if set, only backups taken with the specified engines are eligible to be restored
      --restore-from-backup-ts string                                    (init restore parameter) if set, restore the latest backup taken at or before this timestamp. Example: '2021-04-29.133050'
      --restore-to-pos string                                            (init incremental restore parameter) if set, run a point in time recovery that ends with the given position. This will attempt to use one full backup followed by zero or more incremental backups
      --restore-to-timestamp string                                      (init incremental restore parameter) if set, run a point in time recovery that restores up to the given timestamp, if possible. Given timestamp in RFC3339 format. Example: '2006-01-02T15:04:05Z07:00'
      --retain-online-ddl-tables duration                                How long should vttablet keep an old migrated table before purging it (default 24h0m0s)
      --s3-backup-aws-endpoint string                                    endpoint of the S3 backend (region must be provided).
      --s3-backup-aws-min-partsize int                                   Minimum part size to use, defaults to 5MiB but can be increased due to the dataset size. (default 5242880)
      --s3-backup-aws-region string                                      AWS region to use. (default "us-east-1")
      --s3-backup-aws-retries int                                        AWS request retries. (default -1)
      --s3-backup-force-path-style                                       force the s3 path style.
      --s3-backup-log-level string                                       determine the S3 loglevel to use from LogOff, LogDebug, LogDebugWithSigning, LogDebugWithHTTPBody, LogDebugWithRequestRetries, LogDebugWithRequestErrors. (default "LogOff")
      --s3-backup-server-side-encryption string                          server-side encryption algorithm (e.g., AES256, aws:kms, sse_c:/path/to/key/file).
      --s3-backup-storage-bucket string                                  S3 bucket to use for backups.
      --s3-backup-storage-root string                                    root prefix for all backup-related object names.
      --s3-backup-tls-skip-verify-cert                                   skip the 'certificate is valid' check for SSL connections.
      --sanitize-log-messages                                            Remove potentially sensitive information in tablet INFO, WARNING, and ERROR log messages such as query parameters.
      --schema-change-reload-timeout duration                            query server schema change reload timeout, this is how long to wait for the signaled schema reload operation to complete before giving up (default 30s)
      --schema-version-max-age-seconds int                               max age of schema version records to kept in memory by the vreplication historian
      --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)
      --semi-sync-monitor-interval duration                              How frequently the semi-sync monitor checks if the primary is blocked on semi-sync ACKs (default 10s)
      --service-map strings                                              comma separated list of services to enable (or disable if prefixed with '-') Example: grpc-queryservice
      --serving-state-grace-period duration                              how long to pause after broadcasting health to vtgate, before enforcing a new serving state
      --shard-sync-retry-delay duration                                  delay between retries of updates to keep the tablet and its shard record in sync (default 30s)
      --shutdown-grace-period duration                                   how long to wait for queries and transactions to complete during graceful shutdown. (default 3s)
      --skip-user-metrics                                                If true, user based stats are not recorded.
      --sql-max-length-errors int                                        truncate queries in error logs to the given length (default unlimited)
      --sql-max-length-ui int                                            truncate queries in debug UIs to the given length (default 512) (default 512)
      --srv-topo-cache-refresh duration                                  how frequently to refresh the topology for cached entries (default 1s)
      --srv-topo-cache-ttl duration                                      how long to use cached entries for topology (default 1s)
      --srv-topo-timeout duration                                        topo server timeout (default 5s)
      --stats-backend string                                             The name of the registered push-based monitoring/stats backend to use
      --stats-combine-dimensions string                                  List of dimensions to be combined into a single "all" value in exported stats vars
      --stats-common-tags strings                                        Comma-separated list of common tags for the stats backend. It provides both label and values. Example: label1:value1,label2:value2
      --stats-drop-variables string                                      Variables to be dropped from the list of exported variables.
      --stats-emit-period duration                                       Interval between emitting stats to all registered backends (default 1m0s)
      --statsd-address string                                            Address for statsd client
      --statsd-sample-rate float                                         Sample rate for statsd metrics (default 1)
      --stderrthreshold severityFlag                                     logs at or above this threshold go to stderr (default 1)
      --stream-health-buffer-size uint                                   max streaming health entries to buffer per streaming health client (default 20)
      --table-acl-config string                                          path to table access checker config file; send SIGHUP to reload this file
      --table-acl-config-reload-interval duration                        Ticker to reload ACLs. Duration flag, format e.g.: 30s. Default: do not reload
      --table-gc-lifecycle string                                        States for a DROP TABLE garbage collection cycle. Default is 'hold,purge,evac,drop', use any subset ('drop' implicitly always included) (default "hold,purge,evac,drop")
      --table-refresh-interval int                                       interval in milliseconds to refresh tables in status page with refreshRequired class
      --tablet-config string                                             YAML file config for tablet
      --tablet-dir string                                                The directory within the vtdataroot to store vttablet/mysql files. Defaults to being generated by the tablet uid.
      --tablet-grpc-ca string                                            the server ca to use to validate servers when connecting
      --tablet-grpc-cert string                                          the cert to use to connect
      --tablet-grpc-crl string                                           the server crl to use to validate server certificates when connecting
      --tablet-grpc-key string                                           the key to use to connect
      --tablet-grpc-server-name string                                   the server name to use to validate server certificate
      --tablet-hostname string                                           if not empty, this hostname will be assumed instead of trying to resolve it
      --tablet-manager-grpc-ca string                                    the server ca to use to validate servers when connecting
      --tablet-manager-grpc-cert string                                  the cert to use to connect
      --tablet-manager-grpc-concurrency int                              concurrency to use to talk to a vttablet server for performance-sensitive RPCs (like ExecuteFetchAs{Dba,App}, CheckThrottler and FullStatus) (default 8)
      --tablet-manager-grpc-connpool-size int                            number of tablets to keep tmclient connections open to (default 100)
      --tablet-manager-grpc-crl string                                   the server crl to use to validate server certificates when connecting
      --tablet-manager-grpc-key string                                   the key to use to connect
      --tablet-manager-grpc-server-name string                           the server name to use to validate server certificate
      --tablet-manager-protocol string                                   Protocol to use to make tabletmanager RPCs to vttablets. (default "grpc")
      --tablet-path string                                               tablet alias
      --tablet-protocol string                                           Protocol to use to make queryservice RPCs to vttablets. (default "grpc")
      --throttle-tablet-types string                                     Comma separated VTTablet types to be considered by the throttler. default: 'replica'. example: 'replica,rdonly'. 'replica' always implicitly included (default "replica")
      --topo-consul-lock-delay duration                                  LockDelay for consul session. (default 15s)
      --topo-consul-lock-session-checks string                           List of checks for consul session. (default "serfHealth")
      --topo-consul-lock-session-ttl string                              TTL for consul session.
      --topo-consul-watch-poll-duration duration                         time of the long poll for watch queries. (default 30s)
      --topo-etcd-lease-ttl int                                          Lease TTL for locks and leader election. The client will use KeepAlive to keep the lease going. (default 30)
      --topo-etcd-tls-ca string                                          path to the ca to use to validate the server cert when connecting to the etcd topo server
      --topo-etcd-tls-cert string                                        path to the client cert to use to connect to the etcd topo server, requires topo-etcd-tls-key, enables TLS
      --topo-etcd-tls-key string                                         path to the client key to use to connect to the etcd topo server, enables TLS
      --topo-global-root string                                          the path of the global topology data in the global topology server
      --topo-global-server-address string                                the address of the global topology server
      --topo-implementation string                                       the topology implementation to use
      --topo-read-concurrency int                                        Maximum concurrency of topo reads per global or local cell. (default 32)
      --topo-zk-auth-file string                                         auth to use when connecting to the zk topo server, file contents should be <scheme>:<auth>, e.g., digest:user:pass
      --topo-zk-base-timeout duration                                    zk base timeout (see zk.Connect) (default 30s)
      --topo-zk-max-concurrency int                                      maximum number of pending requests to send to a Zookeeper server. (default 64)
      --topo-zk-tls-ca string                                            the server ca to use to validate servers when connecting to the zk topo server
      --topo-zk-tls-cert string                                          the cert to use to connect to the zk topo server, requires topo-zk-tls-key, enables TLS
      --topo-zk-tls-key string                                           the key to use to connect to the zk topo server, enables TLS
      --topocustomrule-cell string                                       topo cell for customrules file. (default "global")
      --topocustomrule-path string                                       path for customrules file. Disabled if empty.
      --tracer string                                                    tracing service to use (default "noop")
      --tracing-enable-logging                                           whether to enable logging in the tracing service
      --tracing-sampling-rate float                                      sampling rate for the probabilistic jaeger sampler (default 0.1)
      --tracing-sampling-type string                                     sampling strategy to use for jaeger. possible values are 'const', 'probabilistic', 'rateLimiting', or 'remote' (default "const")
      --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
      --transaction-limit-by-component                                   Include CallerID.component when considering who the user is for the purpose of transaction limit.
      --transaction-limit-by-principal                                   Include CallerID.principal when considering who the user is for the purpose of transaction limit. (default true)
      --transaction-limit-by-subcomponent                                Include CallerID.subcomponent when considering who the user is for the purpose of transaction limit.
      --transaction-limit-by-username                                    Include VTGateCallerID.username when considering who the user is for the purpose of transaction limit. (default true)
      --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)
      --transaction-log-stream-handler string                            URL handler for streaming transactions log (default "/debug/txlog")
      --twopc-abandon-age time.Duration                                  Any unresolved transaction older than this time will be sent to the coordinator to be resolved. NOTE: Providing time as seconds (float64) is deprecated. Use time.Duration format (e.g., '1s', '2m', '1h'). (default 15m0s)
      --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 max_replication_lag_sec:10 initial_rate:100 max_increase:1 emergency_decrease:0.5 min_duration_between_increases_sec:40 max_duration_between_increases_sec:62 min_duration_between_decreases_sec:20 spread_backlog_across_sec:20 age_bad_rate_after_sec:180 bad_rate_increase:0.1 max_rate_approach_threshold:0.9")
      --tx-throttler-default-priority int                                Default priority assigned to queries that lack priority information (default 100)
      --tx-throttler-dry-run                                             If present, the transaction throttler only records metrics about requests received and throttled, but does not actually throttle any requests.
      --tx-throttler-healthcheck-cells strings                           A comma-separated list of cells. Only tabletservers running in these cells will be monitored for replication lag by the transaction throttler.
      --tx-throttler-tablet-types strings                                A comma-separated list of tablet types. Only tablets of this type are monitored for replication lag by the transaction throttler. Supported types are replica and/or rdonly. (default replica)
      --tx-throttler-topo-refresh-interval duration                      The rate that the transaction throttler will refresh the topology to find cells. (default 5m0s)
      --unhealthy-threshold duration                                     replication lag after which a replica is considered unhealthy (default 2h0m0s)
      --unmanaged                                                        Indicates an unmanaged tablet, i.e. using an external mysql-compatible database
      --v Level                                                          log level for V logs
  -v, --version                                                          print binary version
      --vmodule vModuleFlag                                              comma-separated list of pattern=N settings for file-filtered logging
      --vreplication-copy-phase-duration duration                        Duration for each copy phase loop (before running the next catchup: default 1h) (default 1h0m0s)
      --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 10000000)
      --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)
      --vreplication-experimental-flags int                              (Bitmask) of experimental features in vreplication to enable (default 7)
      --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)
      --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
      --vreplication-net-read-timeout int                                Session value of net_read_timeout for vreplication, in seconds (default 300)
      --vreplication-net-write-timeout int                               Session value of net_write_timeout for vreplication, in seconds (default 600)
      --vreplication-parallel-insert-workers int                         Number of parallel insertion workers to use during copy phase. Set <= 1 to disable parallelism, or > 1 to enable concurrent insertion during copy phase. (default 1)
      --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)
      --vreplication-retry-delay duration                                delay before retrying a failed workflow event in the replication phase (default 5s)
      --vreplication-store-compressed-gtid                               Store compressed gtids in the pos column of the sidecar database's vreplication table
      --vstream-binlog-rotation-threshold int                            Byte size at which a VStreamer will attempt to rotate the source's open binary log before starting a GTID snapshot based stream (e.g. a ResultStreamer or RowStreamer) (default 67108864)
      --vstream-dynamic-packet-size                                      Enable dynamic packet sizing for vstreamers. This will adjust the packet size in vreplication workflows to improve performance. (default true)
      --vstream-packet-size int                                          Suggested packet size for vstreamers. The actual packet size may be more or less than this amount. (default 250000)
      --vttablet-skip-buildinfo-tags string                              comma-separated list of buildinfo tags to skip from merging with --init-tags. each tag is either an exact match or a regular expression of the form '/regexp/'. (default "/.*/")
      --wait-for-backup-interval duration                                (init restore parameter) if this is greater than 0, instead of starting up empty when no backups are found, keep checking at this interval for a backup to appear
      --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.
      --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
      --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
      --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
      --xtrabackup-root-path string                                      Directory location of the xtrabackup and xbstream executables, e.g., /usr/bin
      --xtrabackup-should-drain                                          Decide if we should drain while taking a backup or continue to serving traffic
      --xtrabackup-stream-mode string                                    Which mode to use if streaming, valid values are tar and xbstream. Please note that tar is not supported in XtraBackup 8.0 (default "tar")
      --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)
      --xtrabackup-stripes uint                                          If greater than 0, use data striping across this many destination files to parallelize data transfer and decompression
      --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.
Options (397)
OptionDescriptionSource
--service-map 'grpc-queryservicehelp
--alsologtostderrlog to standard error as well as fileshelp
--app-idle-timeout durationIdle timeout for app connections (default 1m0s)help
--app-pool-size intSize of the connection pool for app connections (default 40)help
--azblob-backup-account-key-file stringPath to a file containing the Azure Storage account key;help
--azblob-backup-account-name stringAzure Storage Account name for backups;help
--azblob-backup-buffer-size intThe memory buffer size to use in bytes, per file or stripe, when streaming to Azure Blob Service.help
--azblob-backup-container-name stringAzure Blob Container Name.help
--azblob-backup-parallelism intAzure Blob operation parallelism (requires extra memory when increased -- a multiple of azblob-backup-buffer-size).help
--azblob-backup-storage-root stringRoot prefix for all backup-related Azure Blobs;help
--backup-engine-implementation stringSpecifies which implementation to use for creating new backups (builtin or xtrabackup).help
--backup-storage-block-size intif backup-storage-compress is true, backup-storage-block-size sets the byte size for each block while compressing (default is 250000).help
--backup-storage-compressif set, the backup files will be compressed.help
--backup-storage-implementation stringWhich backup storage implementation to use for creating and restoring backups.help
--backup-storage-number-blocks intif backup-storage-compress is true, backup-storage-number-blocks sets the number of blocks that can be processed, in parallel, before the writer blocks, during compression (default is 2).help
--bind-address stringBind address for the server.help
--binlog-in-memory-decompressor-max-size uintThis value sets the uncompressed transaction payload size at which we switch from in-memory buffer based decompression to the slower streaming mode.help
--binlog-player-grpc-ca stringthe server ca to use to validate servers when connectinghelp
--binlog-player-grpc-cert stringthe cert to use to connecthelp
--binlog-player-grpc-crl stringthe server crl to use to validate server certificates when connectinghelp
--binlog-player-grpc-key stringthe key to use to connecthelp
--binlog-player-grpc-server-name stringthe server name to use to validate server certificatehelp
--binlog-player-protocol stringthe protocol to download binlogs from a vttablet (default "grpc")help
--builtinbackup-file-read-buffer-size uintread files using an IO buffer of this many bytes.help
--builtinbackup-file-write-buffer-size uintwrite files using an IO buffer of this many bytes.help
--builtinbackup-incremental-restore-path stringthe directory where incremental restore files, namely binlog files, are extracted to.help
--builtinbackup-mysqld-timeout durationhow long to wait for mysqld to shutdown at the start of the backup.help
--builtinbackup-progress durationhow often to send progress updates when backing up large files.help
--catch-sigpipecatch and ignore SIGPIPE on stdout and stderr if specifiedhelp
--ceph-backup-storage-config stringPath to JSON config file for ceph backup storage.help
--compression-engine-name stringcompressor engine used for compression.help
--compression-level intwhat level to pass to the compressor.help
--config-file stringFull path of the config file (with extension) to use.help
--config-file-not-found-handling ConfigFileNotFoundHandlingBehavior when a config file is not found.help
--config-name stringName of the config file (without extension) to search for.help
--config-path stringsPaths to search for config files in.help
--config-persistence-min-interval durationminimum interval between persisting dynamic config changes back to disk (if no change has occurred, nothing is done).help
--config-type stringConfig file type (omit to infer config type from file extension).help
--consolidator-query-waiter-cap intConfigure the maximum number of clients allowed to wait on the consolidator.help
--consolidator-stream-query-size intConfigure the stream consolidator query size in bytes.help
--consolidator-stream-total-size intConfigure the stream consolidator total size in bytes.help
--consul-auth-static-file stringJSON File to read the topos/tokens from.help
--datadog-agent-host stringhost to send spans to.help
--datadog-agent-port stringport to send spans to.help
--datadog-trace-debug-modeenable debug mode for datadog tracinghelp
--db-allprivs-password stringdb allprivs passwordhelp
--db-allprivs-use-sslSet this flag to false to make the allprivs connection to not use ssl (default true)help
--db-allprivs-user stringdb allprivs user userKey (default "vt_allprivs")help
--db-app-password stringdb app passwordhelp
--db-app-use-sslSet this flag to false to make the app connection to not use ssl (default true)help
--db-app-user stringdb app user userKey (default "vt_app")help
--db-appdebug-password stringdb appdebug passwordhelp
--db-appdebug-use-sslSet this flag to false to make the appdebug connection to not use ssl (default true)help
--db-appdebug-user stringdb appdebug user userKey (default "vt_appdebug")help
--db-charset stringCharacter set/collation used for this tablet.help
--db-conn-query-infoenable parsing and processing of QUERY_OK info fieldshelp
--db-connect-timeout-ms intconnection timeout to mysqld in milliseconds (0 for no timeout)help
--db-credentials-file stringdb credentials file;help
--db-credentials-server stringdb credentials server type ('file' - file implementation;help
--db-credentials-vault-addr stringURL to Vault serverhelp
--db-credentials-vault-path stringVault path to credentials JSON blob, e.g.: secret/data/prod/dbcredshelp
--db-credentials-vault-role-mountpoint stringVault AppRole mountpoint;help
--db-credentials-vault-role-secretidfile stringPath to file containing Vault AppRole secret_id;help
--db-credentials-vault-roleid stringVault AppRole id;help
--db-credentials-vault-timeout durationTimeout for vault API operations (default 10s)help
--db-credentials-vault-tls-ca stringPath to CA PEM for validating Vault server certificatehelp
--db-credentials-vault-tokenfile stringPath to file containing Vault auth token;help
--db-credentials-vault-ttl durationHow long to cache DB credentials from the Vault server (default 30m0s)help
--db-dba-password stringdb dba passwordhelp
--db-dba-use-sslSet this flag to false to make the dba connection to not use ssl (default true)help
--db-dba-user stringdb dba user userKey (default "vt_dba")help
--db-erepl-password stringdb erepl passwordhelp
--db-erepl-use-sslSet this flag to false to make the erepl connection to not use ssl (default true)help
--db-erepl-user stringdb erepl user userKey (default "vt_erepl")help
--db-filtered-password stringdb filtered passwordhelp
--db-filtered-use-sslSet this flag to false to make the filtered connection to not use ssl (default true)help
--db-filtered-user stringdb filtered user userKey (default "vt_filtered")help
--db-flags uintFlag values as defined by MySQL.help
--db-flavor stringFlavor overrid.help
--db-host stringThe host name for the tcp connection.help
--db-port inttcp porthelp
--db-repl-password stringdb repl passwordhelp
--db-repl-use-sslSet this flag to false to make the repl connection to not use ssl (default true)help
--db-repl-user stringdb repl user userKey (default "vt_repl")help
--db-server-name stringserver name of the DB we are connecting to.help
--db-socket stringThe unix socket to connect on.help
--db-ssl-ca stringconnection ssl cahelp
--db-ssl-ca-path stringconnection ssl ca pathhelp
--db-ssl-cert stringconnection ssl certificatehelp
--db-ssl-key stringconnection ssl keyhelp
--db-ssl-mode SslModeSSL mode to connect with.help
--db-tls-min-version stringConfigures the minimal TLS version negotiated when SSL is enabled.help
--dba-idle-timeout durationIdle timeout for dba connections (default 1m0s)help
--dba-pool-size intSize of the connection pool for dba connections (default 20)help
--degraded-threshold durationreplication lag after which a replica is considered degraded (default 30s)help
--disk-write-dir stringif provided, tablet will attempt to write a file to this directory to check if the disk is stalledhelp
--disk-write-interval durationhow often to write to the disk to check whether it is stalled (default 5s)help
--disk-write-timeout durationif writes exceed this duration, the disk is considered stalled (default 30s)help
--emit-statsIf set, emit stats to push-based monitoring and stats backendshelp
--enable-consolidatorThis option enables the query consolidator.help
--enable-consolidator-replicasThis option enables the query consolidator only on replicas.help
--enable-hot-row-protectionIf true, incoming transactions for the same row (range) will be queued and cannot consume all txpool slots.help
--enable-hot-row-protection-dry-runIf true, hot row protection is not enforced but logs if transactions would have been queued.help
--enable-per-workload-table-metricsIf true, query counts and query error metrics include a label that identifies the workloadhelp
--enable-replication-reporterUse polling to track replication lag.help
--enable-transaction-limitIf true, limit on number of transactions open at the same time will be enforced for all users.help
--enable-transaction-limit-dry-runIf true, limit on number of transactions open at the same time will be tracked for all users, but not enforced.help
--enable-tx-throttlerIf true replication-lag-based throttling on transactions will be enabled.help
--enforce-strict-trans-tablesIf true, vttablet requires MySQL to run with STRICT_TRANS_TABLES or STRICT_ALL_TABLES on.help
--enforce-tableacl-configif this flag is true, vttablet will fail to start if a valid tableacl config does not existhelp
--external-compressor stringcommand with arguments to use when compressing a backup.help
--external-compressor-extension stringextension to use when using an external compressor.help
--external-decompressor stringcommand with arguments to use when decompressing a backup.help
--external-decompressor-use-manifestallows the decompressor command stored in the backup manifest to be used at restore time.help
--file-backup-storage-root stringRoot directory for the file backup storage.help
--filecustomrules stringfile based custom rule pathhelp
--filecustomrules-watchset up a watch on the target file and reload query rules when it changeshelp
--gc-check-interval durationInterval between garbage collection checks (default 1h0m0s)help
--gc-purge-check-interval durationInterval between purge discovery checks (default 1m0s)help
--gcs-backup-storage-bucket stringGoogle Cloud Storage bucket to use for backups.help
--gcs-backup-storage-root stringRoot prefix for all backup-related object names.help
--grpc-auth-mode stringWhich auth plugin implementation to use (eg: static)help
--grpc-auth-mtls-allowed-substrings stringList of substrings of at least one of the client certificate names (separated by colon).help
--grpc-auth-static-client-creds stringWhen using grpc_static_auth in the server, this file provides the credentials to use to authenticate with server.help
--grpc-auth-static-password-file stringJSON File to read the users/passwords from.help
--grpc-bind-address stringBind address for gRPC calls.help
--grpc-ca stringserver CA to use for gRPC connections, requires TLS, and enforces client certificate checkhelp
--grpc-cert stringserver certificate to use for gRPC connections, requires grpc-key, enables TLShelp
--grpc-compression stringWhich protocol to use for compressing gRPC.help
--grpc-crl stringpath to a certificate revocation list in PEM format, client certificates will be further verified against this file during TLS handshakehelp
--grpc-dial-concurrency-limit intMaximum concurrency of grpc dial operations.help
--grpc-enable-optional-tlsenable optional TLS mode when a server accepts both TLS and plain-text connections on the same port;help
--grpc-enable-orca-metricsgRPC server option to enable sending ORCA metrics to clients for load balancinghelp
--grpc-enable-tracingEnable gRPC tracing.help
--grpc-initial-conn-window-size intgRPC initial connection window sizehelp
--grpc-initial-window-size intgRPC initial window sizehelp
--grpc-keepalive-time durationAfter 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.help
--grpc-keepalive-timeout durationAfter 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.help
--grpc-key stringserver private key to use for gRPC connections, requires grpc-cert, enables TLShelp
--grpc-max-connection-age durationMaximum age of a client connection before GoAway is sent.help
--grpc-max-connection-age-grace durationAdditional grace period after grpc-max-connection-age, after which connections are forcibly closed.help
--grpc-max-message-size intMaximum allowed RPC message size.help
--grpc-port intPort to listen on for gRPC calls.help
--grpc-prometheusEnable gRPC monitoring with Prometheus.help
--grpc-server-ca stringpath to server CA in PEM format, which will be combine with server cert, return full certificate chain to clientshelp
--grpc-server-initial-conn-window-size intgRPC server initial connection window sizehelp
--grpc-server-initial-window-size intgRPC server initial window sizehelp
--grpc-server-keepalive-enforcement-policy-min-time durationgRPC server minimum keepalive time (default 10s)help
--grpc-server-keepalive-enforcement-policy-permit-without-streamgRPC server permit client keepalive pings even when there are no active streams (RPCs)help
--grpc-server-keepalive-time durationAfter a duration of this time, if the server doesn't see any activity, it pings the client to see if the transport is still alive.help
--grpc-server-keepalive-timeout durationAfter having pinged for keepalive check, the server waits for a duration of Timeout and if no activity is seen even after that the connection is closed.help
--health-check-interval durationInterval between health checks (default 20s)help
--heartbeat-enableIf true, vttablet records (if master) or checks (if replica) the current time of a replication heartbeat in the sidecar database's heartbeat table.help
--heartbeat-interval durationHow frequently to read and write replication heartbeat.help
--heartbeat-on-demand-duration durationIf non-zero, heartbeats are only written upon consumer request, and only run for up to given duration following the request.help
-h, --helphelp for vttablethelp
--hot-row-protection-concurrent-transactions intNumber of concurrent transactions let through to the txpool/MySQL for the same hot row.help
--hot-row-protection-max-global-queue-size intGlobal queue limit across all row (ranges).help
--hot-row-protection-max-queue-size intMaximum number of BeginExecute RPCs which will be queued for the same row (range).help
--init-db-name-override string(init parameter) override the name of the db used by vttablet.help
--init-keyspace string(init parameter) keyspace to use for this tablethelp
--init-shard string(init parameter) shard to use for this tablethelp
--init-tablet-type string(init parameter) tablet type to use for this tablet.help
--init-tags StringMap(init parameter) comma separated list of key:value pairs used to tag the tablethelp
--init-timeout duration(init parameter) timeout to use for the init phase.help
--jaeger-agent-host stringhost and port to send spans to.help
--keep-logs durationkeep logs for this long (using ctime) (zero to keep forever)help
--keep-logs-by-mtime durationkeep logs for this long (using mtime) (zero to keep forever)help
--lameduck-period durationkeep running at least this long after SIGTERM before stopping (default 50ms)help
--lock-tables-timeout durationHow long to keep the table locked before timing out (default 1m0s)help
--lock-timeout durationMaximum time to wait when attempting to acquire a lock from the topo server (default 45s)help
--log-err-stackslog stack traces for errorshelp
--log-queriesEnable query logging to syslog.help
--log-queries-to-file stringEnable query logging to the specified filehelp
--log-rotate-max-size uintsize in bytes at which logs are rotated (glog.MaxSize) (default 1887436800)help
--log_backtrace_at traceLocationswhen logging hits line file:N, emit a stack tracehelp
--log_dir stringIf non-empty, write log files in this directoryhelp
--logtostderrlog to standard error instead of fileshelp
--manifest-external-decompressor stringcommand with arguments to store in the backup manifest when compressing a backup with an external compression engine.help
--max-concurrent-online-ddl intMaximum number of online DDL changes that may run concurrently (default 256)help
--max-stack-size intconfigure the maximum stack size in bytes (default 67108864)help
--migration-check-interval durationInterval between migration checks (default 1m0s)help
--mycnf-bin-log-path stringmysql binlog pathhelp
--mycnf-data-dir stringdata directory for mysqlhelp
--mycnf-error-log-path stringmysql error log pathhelp
--mycnf-file stringpath to my.cnf, if reading all config params from therehelp
--mycnf-general-log-path stringmysql general log pathhelp
--mycnf-innodb-data-home-dir stringInnodb data home directoryhelp
--mycnf-innodb-log-group-home-dir stringInnodb log group home directoryhelp
--mycnf-master-info-file stringmysql master.info filehelp
--mycnf-mysql-port intport mysql is listening onhelp
--mycnf-pid-file stringmysql pid filehelp
--mycnf-relay-log-index-path stringmysql relay log index pathhelp
--mycnf-relay-log-info-path stringmysql relay log info pathhelp
--mycnf-relay-log-path stringmysql relay log pathhelp
--mycnf-secure-file-priv stringmysql path for loading secure fileshelp
--mycnf-server-id intmysql server id of the server (if specified, mycnf-file will be ignored)help
--mycnf-slow-log-path stringmysql slow query log pathhelp
--mycnf-socket-file stringmysql socket filehelp
--mycnf-tmp-dir stringmysql tmp directoryhelp
--mysql-server-version stringMySQL server version to advertise.help
--mysql-shell-backup-location stringlocation where the backup will be storedhelp
--mysql-shell-dump-flags stringflags to pass to mysql shell dump utility.help
--mysql-shell-flags stringexecution flags to pass to mysqlsh binary to be used during dump/load (default "--defaults-file=/dev/null --js -h localhost")help
--mysql-shell-load-flags stringflags to pass to mysql shell load utility.help
--mysql-shell-should-draindecide if we should drain while taking a backup or continue to serving traffichelp
--mysql-shell-speedup-restorespeed up restore by disabling redo logging and double write buffer during the restore processhelp
--mysql-shutdown-timeout durationTimeout to use when MySQL is being shut down.help
--mysqlctl-mycnf-template stringtemplate file to use for generating the my.cnf file during server inithelp
--mysqlctl-socket stringsocket file to use for remote mysqlctl actions (empty for local actions)help
--onclose-timeout durationwait no more than this for OnClose handlers before stopping (default 10s)help
--onterm-timeout durationwait no more than this for OnTermSync handlers before stopping (default 10s)help
--opentsdb-uri stringURI of opentsdb /api/put methodhelp
--pid-file stringIf set, the process will write its pid to the named file, and delete it on graceful shutdown.help
--pool-hostname-resolve-interval durationif set force an update to all hostnames and reconnect if changed, defaults to 0 (disabled)help
--port intport for the serverhelp
--pprof stringsenable profilinghelp
--pprof-httpenable pprof http endpointshelp
--publish-retry-interval durationhow long vttablet waits to retry publishing the tablet record (default 30s)help
--purge-logs-interval durationhow often try to remove old logs (default 1h0m0s)help
--query-log-stream-handler stringURL handler for streaming queries log (default "/debug/querylog")help
--query-throttler-config-refresh-interval durationHow frequently to refresh configuration for the query throttler (default 1m0s)help
--querylog-emit-on-any-condition-metEmit to query log when any of the conditions (row-threshold, time-threshold, filter-tag) is met (default false)help
--querylog-filter-tag stringstring that must be present in the query for it to be logged;help
--querylog-format stringformat for query logs ("text" or "json") (default "text")help
--querylog-mode stringMode for logging queries.help
--querylog-row-threshold uintNumber of rows a query has to return or affect before being logged;help
--querylog-sample-rate floatSample rate for logging queries.help
--querylog-time-threshold durationExecution time duration a query needs to run over before being logged;help
--queryserver-config-acl-exempt-acl stringan acl that exempt from table acl checking (this acl is free to access any vitess tables).help
--queryserver-config-annotate-queriesprefix queries to MySQL backend with comment indicating vtgate principal (user) and target tablet typehelp
--queryserver-config-enable-table-acl-dry-runIf this flag is enabled, tabletserver will emit monitoring metrics and let the request pass regardless of table acl check resultshelp
--queryserver-config-idle-timeout durationquery server idle timeout, vttablet manages various mysql connection pools.help
--queryserver-config-max-result-size intquery server max result size, maximum number of rows allowed to return from vttablet for non-streaming queries.help
--queryserver-config-message-postpone-cap intquery server message postpone cap is the maximum number of messages that can be postponed at any given time.help
--queryserver-config-olap-transaction-timeout durationquery server transaction timeout (in seconds), after which a transaction in an OLAP session will be killed (default 30s)help
--queryserver-config-passthrough-dmlsquery server pass through all dml statements without rewritinghelp
--queryserver-config-pool-conn-max-lifetime durationquery server connection max lifetime, vttablet manages various mysql connection pools.help
--queryserver-config-pool-size intquery server read pool size, connection pool is used by regular queries (non streaming, not in a transaction) (default 16)help
--queryserver-config-query-cache-memory intquery server query cache size in bytes, maximum amount of memory to be used for caching.help
--queryserver-config-query-pool-max-idle-count intquery server query pool - maximum number of idle connections to retain in the pool.help
--queryserver-config-query-pool-timeout durationquery server query pool timeout, it is how long vttablet waits for a connection from the query pool.help
--queryserver-config-query-timeout durationquery server query timeout, this is the query timeout in vttablet side.help
--queryserver-config-schema-change-signalquery server schema signal, will signal connected vtgates that schema has changed whenever this is detected.help
--queryserver-config-schema-reload-time durationquery server schema reload time, how often vttablet reloads schemas from underlying MySQL instance.help
--queryserver-config-stream-buffer-size intquery server stream buffer size, the maximum number of bytes sent from vttablet for each stream call.help
--queryserver-config-stream-pool-max-idle-count intquery server stream pool - maximum number of idle connections to retain in the pool.help
--queryserver-config-stream-pool-size intquery server stream connection pool size, stream pool is used by stream queries: queries that return results to client in a streaming fashion (default 200)help
--queryserver-config-stream-pool-timeout durationquery server stream pool timeout, it is how long vttablet waits for a connection from the stream pool.help
--queryserver-config-strict-table-aclonly allow queries that pass table acl checkshelp
--queryserver-config-terse-errorsprevent bind vars from escaping in client error messageshelp
--queryserver-config-transaction-cap intquery server transaction cap is the maximum number of transactions allowed to happen at any given point of a time for a single vttablet.help
--queryserver-config-transaction-timeout durationquery server transaction timeout, a transaction will be killed if it takes longer than this value (default 30s)help
--queryserver-config-truncate-error-len inttruncate errors sent to client if they are longer than this value (0 means do not truncate)help
--queryserver-config-txpool-max-idle-count intquery server transaction pool - maximum number of idle connections to retain in the pool.help
--queryserver-config-txpool-timeout durationquery server transaction pool timeout, it is how long vttablet waits if tx pool is full (default 1s)help
--queryserver-config-warn-result-size intquery server result size warning threshold, warn if number of rows returned from vttablet for non-streaming queries exceeds thishelp
--queryserver-enable-online-ddlEnable online DDL.help
--queryserver-enable-viewsEnable views support in vttablet.help
--redact-debug-ui-queriesredact full queries and bind variables from debug UIhelp
--relay-log-max-items intMaximum number of rows for vreplication target buffering.help
--relay-log-max-size intMaximum buffer size (in bytes) for vreplication target buffering.help
--remote-operation-timeout durationtime to wait for a remote operation (default 15s)help
--replication-connect-retry durationhow long to wait in between replica reconnect attempts.help
--restore-concurrency int(init restore parameter) how many concurrent files to restore at once (default 4)help
--restore-from-backup(init restore parameter) will check BackupStorage for a recent backup at startup and start therehelp
--restore-from-backup-allowed-engines strings(init restore parameter) if set, only backups taken with the specified engines are eligible to be restoredhelp
--restore-from-backup-ts string(init restore parameter) if set, restore the latest backup taken at or before this timestamp.help
--restore-to-pos string(init incremental restore parameter) if set, run a point in time recovery that ends with the given position.help
--restore-to-timestamp string(init incremental restore parameter) if set, run a point in time recovery that restores up to the given timestamp, if possible.help
--retain-online-ddl-tables durationHow long should vttablet keep an old migrated table before purging it (default 24h0m0s)help
--s3-backup-aws-endpoint stringendpoint of the S3 backend (region must be provided).help
--s3-backup-aws-min-partsize intMinimum part size to use, defaults to 5MiB but can be increased due to the dataset size.help
--s3-backup-aws-region stringAWS region to use.help
--s3-backup-aws-retries intAWS request retries.help
--s3-backup-force-path-styleforce the s3 path style.help
--s3-backup-log-level stringdetermine the S3 loglevel to use from LogOff, LogDebug, LogDebugWithSigning, LogDebugWithHTTPBody, LogDebugWithRequestRetries, LogDebugWithRequestErrors.help
--s3-backup-server-side-encryption stringserver-side encryption algorithm (e.g., AES256, aws:kms, sse_c:/path/to/key/file).help
--s3-backup-storage-bucket stringS3 bucket to use for backups.help
--s3-backup-storage-root stringroot prefix for all backup-related object names.help
--s3-backup-tls-skip-verify-certskip the 'certificate is valid' check for SSL connections.help
--sanitize-log-messagesRemove potentially sensitive information in tablet INFO, WARNING, and ERROR log messages such as query parameters.help
--schema-change-reload-timeout durationquery server schema change reload timeout, this is how long to wait for the signaled schema reload operation to complete before giving up (default 30s)help
--schema-version-max-age-seconds intmax age of schema version records to kept in memory by the vreplication historianhelp
--security-policy stringthe name of a registered security policy to use for controlling access to URLs - empty means allow all for anyone (built-in policies: deny-all, read-only)help
--semi-sync-monitor-interval durationHow frequently the semi-sync monitor checks if the primary is blocked on semi-sync ACKs (default 10s)help
--serving-state-grace-period durationhow long to pause after broadcasting health to vtgate, before enforcing a new serving statehelp
--shard-sync-retry-delay durationdelay between retries of updates to keep the tablet and its shard record in sync (default 30s)help
--shutdown-grace-period durationhow long to wait for queries and transactions to complete during graceful shutdown.help
--skip-user-metricsIf true, user based stats are not recorded.help
--sql-max-length-errors inttruncate queries in error logs to the given length (default unlimited)help
--sql-max-length-ui inttruncate queries in debug UIs to the given length (default 512) (default 512)help
--srv-topo-cache-refresh durationhow frequently to refresh the topology for cached entries (default 1s)help
--srv-topo-cache-ttl durationhow long to use cached entries for topology (default 1s)help
--srv-topo-timeout durationtopo server timeout (default 5s)help
--stats-backend stringThe name of the registered push-based monitoring/stats backend to usehelp
--stats-combine-dimensions stringList of dimensions to be combined into a single "all" value in exported stats varshelp
--stats-common-tags stringsComma-separated list of common tags for the stats backend.help
--stats-drop-variables stringVariables to be dropped from the list of exported variables.help
--stats-emit-period durationInterval between emitting stats to all registered backends (default 1m0s)help
--statsd-address stringAddress for statsd clienthelp
--statsd-sample-rate floatSample rate for statsd metrics (default 1)help
--stderrthreshold severityFlaglogs at or above this threshold go to stderr (default 1)help
--stream-health-buffer-size uintmax streaming health entries to buffer per streaming health client (default 20)help
--table-acl-config stringpath to table access checker config file;help
--table-acl-config-reload-interval durationTicker to reload ACLs.help
--table-gc-lifecycle stringStates for a DROP TABLE garbage collection cycle.help
--table-refresh-interval intinterval in milliseconds to refresh tables in status page with refreshRequired classhelp
--tablet-config stringYAML file config for tablethelp
--tablet-dir stringThe directory within the vtdataroot to store vttablet/mysql files.help
--tablet-grpc-ca stringthe server ca to use to validate servers when connectinghelp
--tablet-grpc-cert stringthe cert to use to connecthelp
--tablet-grpc-crl stringthe server crl to use to validate server certificates when connectinghelp
--tablet-grpc-key stringthe key to use to connecthelp
--tablet-grpc-server-name stringthe server name to use to validate server certificatehelp
--tablet-hostname stringif not empty, this hostname will be assumed instead of trying to resolve ithelp
--tablet-manager-grpc-ca stringthe server ca to use to validate servers when connectinghelp
--tablet-manager-grpc-cert stringthe cert to use to connecthelp
--tablet-manager-grpc-concurrency intconcurrency to use to talk to a vttablet server for performance-sensitive RPCs (like ExecuteFetchAs{Dba,App}, CheckThrottler and FullStatus) (default 8)help
--tablet-manager-grpc-connpool-size intnumber of tablets to keep tmclient connections open to (default 100)help
--tablet-manager-grpc-crl stringthe server crl to use to validate server certificates when connectinghelp
--tablet-manager-grpc-key stringthe key to use to connecthelp
--tablet-manager-grpc-server-name stringthe server name to use to validate server certificatehelp
--tablet-manager-protocol stringProtocol to use to make tabletmanager RPCs to vttablets.help
--tablet-path stringtablet aliashelp
--tablet-protocol stringProtocol to use to make queryservice RPCs to vttablets.help
--throttle-tablet-types stringComma separated VTTablet types to be considered by the throttler.help
--topo-consul-lock-delay durationLockDelay for consul session.help
--topo-consul-lock-session-checks stringList of checks for consul session.help
--topo-consul-lock-session-ttl stringTTL for consul session.help
--topo-consul-watch-poll-duration durationtime of the long poll for watch queries.help
--topo-etcd-lease-ttl intLease TTL for locks and leader election.help
--topo-etcd-tls-ca stringpath to the ca to use to validate the server cert when connecting to the etcd topo serverhelp
--topo-etcd-tls-cert stringpath to the client cert to use to connect to the etcd topo server, requires topo-etcd-tls-key, enables TLShelp
--topo-etcd-tls-key stringpath to the client key to use to connect to the etcd topo server, enables TLShelp
--topo-global-root stringthe path of the global topology data in the global topology serverhelp
--topo-global-server-address stringthe address of the global topology serverhelp
--topo-implementation stringthe topology implementation to usehelp
--topo-read-concurrency intMaximum concurrency of topo reads per global or local cell.help
--topo-zk-auth-file stringauth to use when connecting to the zk topo server, file contents should be <scheme>:<auth>, e.g., digest:user:passhelp
--topo-zk-base-timeout durationzk base timeout (see zk.Connect) (default 30s)help
--topo-zk-max-concurrency intmaximum number of pending requests to send to a Zookeeper server.help
--topo-zk-tls-ca stringthe server ca to use to validate servers when connecting to the zk topo serverhelp
--topo-zk-tls-cert stringthe cert to use to connect to the zk topo server, requires topo-zk-tls-key, enables TLShelp
--topo-zk-tls-key stringthe key to use to connect to the zk topo server, enables TLShelp
--topocustomrule-cell stringtopo cell for customrules file.help
--topocustomrule-path stringpath for customrules file.help
--tracer stringtracing service to use (default "noop")help
--tracing-enable-loggingwhether to enable logging in the tracing servicehelp
--tracing-sampling-rate floatsampling rate for the probabilistic jaeger sampler (default 0.1)help
--tracing-sampling-type stringsampling strategy to use for jaeger.help
--track-schema-versionsWhen enabled, vttablet will store versions of schemas at each position that a DDL is applied and allow retrieval of the schema corresponding to a positionhelp
--transaction-limit-by-componentInclude CallerID.component when considering who the user is for the purpose of transaction limit.help
--transaction-limit-by-principalInclude CallerID.principal when considering who the user is for the purpose of transaction limit.help
--transaction-limit-by-subcomponentInclude CallerID.subcomponent when considering who the user is for the purpose of transaction limit.help
--transaction-limit-by-usernameInclude VTGateCallerID.username when considering who the user is for the purpose of transaction limit.help
--transaction-limit-per-user floatMaximum number of transactions a single user is allowed to use at any time, represented as fraction of -transaction_cap.help
--transaction-log-stream-handler stringURL handler for streaming transactions log (default "/debug/txlog")help
--twopc-abandon-age time.DurationAny unresolved transaction older than this time will be sent to the coordinator to be resolved.help
--tx-throttler-config stringThe configuration of the transaction throttler as a text-formatted throttlerdata.Configuration protocol buffer message.help
--tx-throttler-default-priority intDefault priority assigned to queries that lack priority information (default 100)help
--tx-throttler-dry-runIf present, the transaction throttler only records metrics about requests received and throttled, but does not actually throttle any requests.help
--tx-throttler-healthcheck-cells stringsA comma-separated list of cells.help
--tx-throttler-tablet-types stringsA comma-separated list of tablet types.help
--tx-throttler-topo-refresh-interval durationThe rate that the transaction throttler will refresh the topology to find cells.help
--unhealthy-threshold durationreplication lag after which a replica is considered unhealthy (default 2h0m0s)help
--unmanagedIndicates an unmanaged tablet, i.e. using an external mysql-compatible databasehelp
--v Levellog level for V logshelp
-v, --versionprint binary versionhelp
--vmodule vModuleFlagcomma-separated list of pattern=N settings for file-filtered logginghelp
--vreplication-copy-phase-duration durationDuration for each copy phase loop (before running the next catchup: default 1h) (default 1h0m0s)help
--vreplication-copy-phase-max-innodb-history-list-length intThe maximum InnoDB transaction history that can exist on a vstreamer (source) before starting another round of copying rows.help
--vreplication-copy-phase-max-mysql-replication-lag intThe maximum MySQL replication lag (in seconds) that can exist on a vstreamer (source) before starting another round of copying rows.help
--vreplication-experimental-flags int(Bitmask) of experimental features in vreplication to enable (default 7)help
--vreplication-heartbeat-update-interval intFrequency (in seconds, default 1, max 60) at which the time_updated column of a vreplication stream when idling (default 1)help
--vreplication-max-time-to-retry-on-error durationstop automatically retrying when we've had consecutive failures with the same error for this long after the first occurrencehelp
--vreplication-net-read-timeout intSession value of net_read_timeout for vreplication, in seconds (default 300)help
--vreplication-net-write-timeout intSession value of net_write_timeout for vreplication, in seconds (default 600)help
--vreplication-parallel-insert-workers intNumber of parallel insertion workers to use during copy phase.help
--vreplication-replica-lag-tolerance durationReplica lag threshold duration: once lag is below this we switch from copy phase to the replication (streaming) phase (default 1m0s)help
--vreplication-retry-delay durationdelay before retrying a failed workflow event in the replication phase (default 5s)help
--vreplication-store-compressed-gtidStore compressed gtids in the pos column of the sidecar database's vreplication tablehelp
--vstream-binlog-rotation-threshold intByte size at which a VStreamer will attempt to rotate the source's open binary log before starting a GTID snapshot based stream (e.g. a ResultStreamer or RowStreamer) (default 67108864)help
--vstream-dynamic-packet-sizeEnable dynamic packet sizing for vstreamers.help
--vstream-packet-size intSuggested packet size for vstreamers.help
--vttablet-skip-buildinfo-tags stringcomma-separated list of buildinfo tags to skip from merging with --init-tags.help
--wait-for-backup-interval duration(init restore parameter) if this is greater than 0, instead of starting up empty when no backups are found, keep checking at this interval for a backup to appearhelp
--watch-replication-streamWhen enabled, vttablet will stream the MySQL replication stream from the local server, and use it to update schema when it sees a DDL.help
--xbstream-restore-flags stringFlags to pass to xbstream command during restore.help
--xtrabackup-backup-flags stringFlags to pass to backup command.help
--xtrabackup-prepare-flags stringFlags to pass to prepare command.help
--xtrabackup-root-path stringDirectory location of the xtrabackup and xbstream executables, e.g., /usr/binhelp
--xtrabackup-should-drainDecide if we should drain while taking a backup or continue to serving traffichelp
--xtrabackup-stream-mode stringWhich mode to use if streaming, valid values are tar and xbstream.help
--xtrabackup-stripe-block-size uintSize in bytes of each block that gets sent to a given stripe before rotating to the next stripe (default 102400)help
--xtrabackup-stripes uintIf greater than 0, use data striping across this many destination files to parallelize data transfer and decompressionhelp
--xtrabackup-user stringUser that xtrabackup will use to connect to the database server.help

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