vitess.io/vitess@v0.16.2/doc/flags/14.0-to-15.0-transition/vtctld.diff (about) 1 diff --git a/flags/14.0/vtctld.txt b/flags/15.0/vtctld.txt 2 index a063b8c..887a4da 100644 3 --- a/flags/14.0/vtctld.txt 4 +++ b/flags/15.0/vtctld.txt 5 @@ -1,84 +1,45 @@ 6 Usage of vtctld: 7 --action_timeout duration time to wait for an action before resorting to force (default 2m0s) 8 - --allowed_tablet_types value Specifies the tablet types this vtgate is allowed to route queries to 9 --alsologtostderr log to standard error as well as files 10 - --app_idle_timeout duration Idle timeout for app connections (default 1m0s) 11 - --app_pool_size int Size of the connection pool for app connections (default 40) 12 - --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) 13 - --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 14 - --azblob_backup_container_name string Azure Blob Container Name 15 - --azblob_backup_parallelism int Azure Blob operation parallelism (requires extra memory when increased) (default 1) 16 - --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/') 17 - --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) 18 + --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). 19 + --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. 20 + --azblob_backup_container_name string Azure Blob Container Name. 21 + --azblob_backup_parallelism int Azure Blob operation parallelism (requires extra memory when increased). (default 1) 22 + --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/'). 23 + --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") 24 --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) 25 --backup_storage_compress if set, the backup files will be compressed (default is true). Set to false for instance if a backup_storage_hook is specified and it compresses the data. (default true) 26 - --backup_storage_hook string if set, we send the contents of the backup files through this hook. 27 - --backup_storage_implementation string which implementation to use for the backup storage feature 28 - --backup_storage_number_blocks int if backup_storage_compress is true, backup_storage_number_blocks sets the number of blocks that can be processed, at once, before the writer blocks, during compression (default is 2). It should be equal to the number of CPUs available for compression (default 2) 29 - --binlog_player_protocol string the protocol to download binlogs from a vttablet (default grpc) 30 - --binlog_use_v3_resharding_mode (DEPRECATED) True if and only if the binlog streamer should use V3-style sharding, which doesn't require a preset sharding key column. (default true) 31 - --builtinbackup_mysqld_timeout duration how long to wait for mysqld to shutdown at the start of the backup (default 10m0s) 32 - --builtinbackup_progress duration how often to send progress updates when backing up large files (default 5s) 33 + --backup_storage_implementation string Which backup storage implementation to use for creating and restoring backups. 34 + --backup_storage_number_blocks int if backup_storage_compress is true, backup_storage_number_blocks sets the number of blocks that can be processed, at once, before the writer blocks, during compression (default is 2). It should be equal to the number of CPUs available for compression. (default 2) 35 + --builtinbackup_mysqld_timeout duration how long to wait for mysqld to shutdown at the start of the backup. (default 10m0s) 36 + --builtinbackup_progress duration how often to send progress updates when backing up large files. (default 5s) 37 --catch-sigpipe catch and ignore SIGPIPE on stdout and stderr if specified 38 --cell string cell to use 39 - --ceph_backup_storage_config string Path to JSON config file for ceph backup storage (default ceph_backup_config.json) 40 - --client-found-rows-pool-size int DEPRECATED: queryserver-config-transaction-cap will be used instead. 41 + --ceph_backup_storage_config string Path to JSON config file for ceph backup storage. (default "ceph_backup_config.json") 42 + --compression-engine-name string compressor engine used for compression. (default "pargzip") 43 + --compression-level int what level to pass to the compressor. (default 1) 44 --consul_auth_static_file string JSON File to read the topos/tokens from. 45 - --cpu_profile string deprecated: use '-pprof=cpu' instead 46 --datadog-agent-host string host to send spans to. if empty, no tracing will be done 47 --datadog-agent-port string port to send spans to. if empty, no tracing will be done 48 - --db-credentials-file string db credentials file; send SIGHUP to reload this file 49 - --db-credentials-server string db credentials server type ('file' - file implementation; 'vault' - HashiCorp Vault implementation) (default file) 50 - --db-credentials-vault-addr string URL to Vault server 51 - --db-credentials-vault-path string Vault path to credentials JSON blob, e.g.: secret/data/prod/dbcreds 52 - --db-credentials-vault-role-mountpoint string Vault AppRole mountpoint; can also be passed using VAULT_MOUNTPOINT environment variable (default approle) 53 - --db-credentials-vault-role-secretidfile string Path to file containing Vault AppRole secret_id; can also be passed using VAULT_SECRETID environment variable 54 - --db-credentials-vault-roleid string Vault AppRole id; can also be passed using VAULT_ROLEID environment variable 55 - --db-credentials-vault-timeout duration Timeout for vault API operations (default 10s) 56 - --db-credentials-vault-tls-ca string Path to CA PEM for validating Vault server certificate 57 - --db-credentials-vault-tokenfile string Path to file containing Vault auth token; token can also be passed using VAULT_TOKEN environment variable 58 - --db-credentials-vault-ttl duration How long to cache DB credentials from the Vault server (default 30m0s) 59 - --dba_idle_timeout duration Idle timeout for dba connections (default 1m0s) 60 - --dba_pool_size int Size of the connection pool for dba connections (default 20) 61 - --degraded_threshold duration replication lag after which a replica is considered degraded (default 30s) 62 --disable_active_reparents if set, do not allow active reparents. Use this to protect a cluster using external reparents. 63 - --discovery_high_replication_lag_minimum_serving duration the replication lag that is considered too high when applying the min_number_serving_vttablets threshold (default 2h0m0s) 64 - --discovery_low_replication_lag duration the replication lag that is considered low enough to be healthy (default 30s) 65 - --durability_policy string type of durability to enforce. Default is none. Other values are dictated by registered plugins (default none) 66 + --durability_policy string type of durability to enforce. Default is none. Other values are dictated by registered plugins (default "none") 67 --emit_stats If set, emit stats to push-based monitoring and stats backends 68 - --enable-autocommit This flag is deprecated. Autocommit is always allowed. (default true) 69 - --enable-consolidator Synonym to -enable_consolidator (default true) 70 - --enable-consolidator-replicas Synonym to -enable_consolidator_replicas 71 - --enable-lag-throttler Synonym to -enable_lag_throttler 72 - --enable-query-plan-field-caching Synonym to -enable_query_plan_field_caching (default true) 73 - --enable-tx-throttler Synonym to -enable_tx_throttler 74 - --enable_consolidator This option enables the query consolidator. (default true) 75 - --enable_consolidator_replicas This option enables the query consolidator only on replicas. 76 - --enable_hot_row_protection If true, incoming transactions for the same row (range) will be queued and cannot consume all txpool slots. 77 - --enable_hot_row_protection_dry_run If true, hot row protection is not enforced but logs if transactions would have been queued. 78 - --enable_lag_throttler If true, vttablet will run a throttler service, and will implicitly enable heartbeats 79 - --enable_queries [DEPRECATED - query commands via vtctl are being deprecated] if set, allows vtgate and vttablet queries. May have security implications, as the queries will be run from this process. 80 - --enable_query_plan_field_caching This option fetches & caches fields (columns) when storing query plans (default true) 81 - --enable_realtime_stats Required for the Realtime Stats view. If set, vtctld will maintain a streaming RPC to each tablet (in all cells) to gather the realtime health stats. 82 - --enable_replication_reporter Use polling to track replication lag. 83 - --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. 84 - --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. 85 - --enable_tx_throttler If true replication-lag-based throttling on transactions will be enabled. 86 - --enable_vtctld_ui If true, the vtctld web interface will be enabled. Default is true. (default true) 87 - --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) 88 - --file_backup_storage_root string root directory for the file backup storage 89 - --gcs_backup_storage_bucket string Google Cloud Storage bucket to use for backups 90 - --gcs_backup_storage_root string root prefix for all backup-related object names 91 + --external-compressor string command with arguments to use when compressing a backup. 92 + --external-compressor-extension string extension to use when using an external compressor. 93 + --external-decompressor string command with arguments to use when decompressing a backup. 94 + --file_backup_storage_root string Root directory for the file backup storage. 95 + --gcs_backup_storage_bucket string Google Cloud Storage bucket to use for backups. 96 + --gcs_backup_storage_root string Root prefix for all backup-related object names. 97 --grpc_auth_mode string Which auth plugin implementation to use (eg: static) 98 --grpc_auth_mtls_allowed_substrings string List of substrings of at least one of the client certificate names (separated by colon). 99 - --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 100 + --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. 101 --grpc_auth_static_password_file string JSON File to read the users/passwords from. 102 --grpc_ca string server CA to use for gRPC connections, requires TLS, and enforces client certificate check 103 --grpc_cert string server certificate to use for gRPC connections, requires grpc_key, enables TLS 104 --grpc_compression string Which protocol to use for compressing gRPC. Default: nothing. Supported: snappy 105 --grpc_crl string path to a certificate revocation list in PEM format, client certificates will be further verified against this file during TLS handshake 106 --grpc_enable_optional_tls enable optional TLS mode when a server accepts both TLS and plain-text connections on the same port 107 - --grpc_enable_tracing Enable GRPC tracing 108 + --grpc_enable_tracing Enable gRPC tracing. 109 --grpc_initial_conn_window_size int gRPC initial connection window size 110 --grpc_initial_window_size int gRPC initial window size 111 --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) 112 @@ -87,132 +48,57 @@ Usage of vtctld: 113 --grpc_max_connection_age duration Maximum age of a client connection before GoAway is sent. (default 2562047h47m16.854775807s) 114 --grpc_max_connection_age_grace duration Additional grace period after grpc_max_connection_age, after which connections are forcibly closed. (default 2562047h47m16.854775807s) 115 --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) 116 - --grpc_port int Port to listen on for gRPC calls 117 - --grpc_prometheus Enable gRPC monitoring with Prometheus 118 + --grpc_port int Port to listen on for gRPC calls. If zero, do not listen. 119 + --grpc_prometheus Enable gRPC monitoring with Prometheus. 120 --grpc_server_ca string path to server CA in PEM format, which will be combine with server cert, return full certificate chain to clients 121 --grpc_server_initial_conn_window_size int gRPC server initial connection window size 122 --grpc_server_initial_window_size int gRPC server initial window size 123 --grpc_server_keepalive_enforcement_policy_min_time duration gRPC server minimum keepalive time (default 10s) 124 --grpc_server_keepalive_enforcement_policy_permit_without_stream gRPC server permit client keepalive pings even when there are no active streams (RPCs) 125 - --health_check_interval duration Interval between health checks (default 20s) 126 - --heartbeat_enable If true, vttablet records (if master) or checks (if replica) the current time of a replication heartbeat in the table _vt.heartbeat. The result is used to inform the serving state of the vttablet via healthchecks. 127 - --heartbeat_interval duration How frequently to read and write replication heartbeat. (default 1s) 128 - --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 129 - --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) 130 - --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) 131 - --hot_row_protection_max_queue_size int Maximum number of BeginExecute RPCs which will be queued for the same row (range). (default 20) 132 + -h, --help display usage and exit 133 --jaeger-agent-host string host and port to send spans to. if empty, no tracing will be done 134 --keep_logs duration keep logs for this long (using ctime) (zero to keep forever) 135 --keep_logs_by_mtime duration keep logs for this long (using mtime) (zero to keep forever) 136 - --keyspaces_to_watch value Specifies which keyspaces this vtgate should have access to while routing queries or accessing the vschema 137 --lameduck-period duration keep running at least this long after SIGTERM before stopping (default 50ms) 138 - --legacy_replication_lag_algorithm use the legacy algorithm when selecting the vttablets for serving (default true) 139 - --log_backtrace_at value when logging hits line file:N, emit a stack trace 140 + --log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0) 141 --log_dir string If non-empty, write log files in this directory 142 --log_err_stacks log stack traces for errors 143 --log_rotate_max_size uint size in bytes at which logs are rotated (glog.MaxSize) (default 1887436800) 144 --logtostderr log to standard error instead of files 145 - --master_connect_retry duration Deprecated, use -replication_connect_retry (default 10s) 146 - --mem-profile-rate int deprecated: use '-pprof=mem' instead (default 524288) 147 - --min_number_serving_vttablets int the minimum number of vttablets for each replicating tablet_type (e.g. replica, rdonly) that will be continue to be used even with replication lag above discovery_low_replication_lag, but still below discovery_high_replication_lag_minimum_serving (default 2) 148 - --mutex-profile-fraction int deprecated: use '-pprof=mutex' instead 149 - --mysql_auth_server_static_file string JSON File to read the users/passwords from. 150 - --mysql_auth_server_static_string string JSON representation of the users/passwords config. 151 - --mysql_auth_static_reload_interval duration Ticker to reload credentials 152 - --mysql_clientcert_auth_method string client-side authentication method to use. Supported values: mysql_clear_password, dialog. (default mysql_clear_password) 153 - --mysql_server_flush_delay duration Delay after which buffered response will be flushed to the client. (default 100ms) 154 - --mysql_server_version string MySQL server version to advertise. 155 - --mysqlctl_client_protocol string the protocol to use to talk to the mysqlctl server (default grpc) 156 - --mysqlctl_mycnf_template string template file to use for generating the my.cnf file during server init 157 - --mysqlctl_socket string socket file to use for remote mysqlctl actions (empty for local actions) 158 --onclose_timeout duration wait no more than this for OnClose handlers before stopping (default 1ns) 159 - --online_ddl_check_interval duration deprecated. Will be removed in next Vitess version 160 --onterm_timeout duration wait no more than this for OnTermSync handlers before stopping (default 10s) 161 --opentsdb_uri string URI of opentsdb /api/put method 162 --pid_file string If set, the process will write its pid to the named file, and delete it on graceful shutdown. 163 - --pool-name-prefix string Deprecated 164 - --pool_hostname_resolve_interval duration if set force an update to all hostnames and reconnect if changed, defaults to 0 (disabled) 165 --port int port for the server 166 - --pprof string enable profiling 167 + --pprof strings enable profiling 168 --proxy_tablets Setting this true will make vtctld proxy the tablet status instead of redirecting to them 169 --purge_logs_interval duration how often try to remove old logs (default 1h0m0s) 170 - --query-log-stream-handler string URL handler for streaming queries log (default /debug/querylog) 171 - --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 172 - --querylog-format string format for query logs ("text" or "json") (default text) 173 - --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. 174 - --queryserver-config-acl-exempt-acl string an acl that exempt from table acl checking (this acl is free to access any vitess tables). 175 - --queryserver-config-allowunsafe-dmls deprecated 176 - --queryserver-config-annotate-queries prefix queries to MySQL backend with comment indicating vtgate principal (user) and target tablet type 177 - --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 178 - --queryserver-config-idle-timeout float query server idle timeout (in seconds), vttablet manages various mysql connection pools. This config means if a connection has not been used in given idle timeout, this connection will be removed from pool. This effectively manages number of connection objects and optimize the pool performance. (default 1800) 179 - --queryserver-config-max-dml-rows int query server max dml rows per statement, maximum number of rows allowed to return at a time for an update or delete with either 1) an equality where clauses on primary keys, or 2) a subselect statement. For update and delete statements in above two categories, vttablet will split the original query into multiple small queries based on this configuration value. 180 - --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) 181 - --queryserver-config-message-conn-pool-prefill-parallelism int DEPRECATED: Unused. 182 - --queryserver-config-message-conn-pool-size int DEPRECATED 183 - --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) 184 - --queryserver-config-passthrough-dmls query server pass through all dml statements without rewriting 185 - --queryserver-config-pool-prefill-parallelism int query server read pool prefill parallelism, a non-zero value will prefill the pool using the specified parallism. 186 - --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) 187 - --queryserver-config-query-cache-lfu query server cache algorithm. when set to true, a new cache algorithm based on a TinyLFU admission policy will be used to improve cache behavior and prevent pollution from sparse queries (default true) 188 - --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) 189 - --queryserver-config-query-cache-size int query server query cache size, maximum number of queries to be cached. vttablet analyzes every incoming query and generate a query plan, these plans are being cached in a lru cache. This config controls the capacity of the lru cache. (default 5000) 190 - --queryserver-config-query-pool-timeout float query server query pool timeout (in seconds), it is how long vttablet waits for a connection from the query pool. If set to 0 (default) then the overall query timeout is used instead. 191 - --queryserver-config-query-pool-waiter-cap int query server query pool waiter limit, this is the maximum number of queries that can be queued waiting to get a connection (default 5000) 192 - --queryserver-config-query-timeout float query server query timeout (in seconds), this is the query timeout in vttablet side. If a query takes more than this timeout, it will be killed. (default 30) 193 - --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) 194 - --queryserver-config-schema-change-signal-interval float query server schema change signal interval defines at which interval the query server shall send schema updates to vtgate. (default 5) 195 - --queryserver-config-schema-reload-time float query server schema reload time, how often vttablet reloads schemas from underlying MySQL instance in seconds. vttablet keeps table schemas in its own memory and periodically refreshes it from MySQL. This config controls the reload time. (default 1800) 196 - --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) 197 - --queryserver-config-stream-pool-prefill-parallelism int query server stream pool prefill parallelism, a non-zero value will prefill the pool using the specified parallelism 198 - --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) 199 - --queryserver-config-stream-pool-timeout float query server stream pool timeout (in seconds), it is how long vttablet waits for a connection from the stream pool. If set to 0 (default) then there is no timeout. 200 - --queryserver-config-stream-pool-waiter-cap int query server stream pool waiter limit, this is the maximum number of streaming queries that can be queued waiting to get a connection 201 - --queryserver-config-strict-table-acl only allow queries that pass table acl checks 202 - --queryserver-config-terse-errors prevent bind vars from escaping in client error messages 203 - --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) 204 - --queryserver-config-transaction-prefill-parallelism int query server transaction prefill parallelism, a non-zero value will prefill the pool using the specified parallism. 205 - --queryserver-config-transaction-timeout float query server transaction timeout (in seconds), a transaction will be killed if it takes longer than this value (default 30) 206 - --queryserver-config-txpool-timeout float query server transaction pool timeout, it is how long vttablet waits if tx pool is full (default 1) 207 - --queryserver-config-txpool-waiter-cap int query server transaction pool waiter limit, this is the maximum number of transactions that can be queued waiting to get a connection (default 5000) 208 - --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 209 - --queryserver_enable_online_ddl Enable online DDL. (default true) 210 - --redact-debug-ui-queries redact full queries and bind variables from debug UI 211 - --relay_log_max_items int Maximum number of rows for VReplication target buffering. (default 5000) 212 - --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) 213 --remote_operation_timeout duration time to wait for a remote operation (default 30s) 214 - --replication_connect_retry duration how long to wait in between replica reconnect attempts. Only precise to the second. (default 10s) 215 - --s3_backup_aws_endpoint string endpoint of the S3 backend (region must be provided) 216 - --s3_backup_aws_region string AWS region to use (default us-east-1) 217 - --s3_backup_aws_retries int AWS request retries (default -1) 218 - --s3_backup_force_path_style force the s3 path style 219 - --s3_backup_log_level string determine the S3 loglevel to use from LogOff, LogDebug, LogDebugWithSigning, LogDebugWithHTTPBody, LogDebugWithRequestRetries, LogDebugWithRequestErrors (default LogOff) 220 - --s3_backup_server_side_encryption string server-side encryption algorithm (e.g., AES256, aws:kms, sse_c:/path/to/key/file) 221 - --s3_backup_storage_bucket string S3 bucket to use for backups 222 - --s3_backup_storage_root string root prefix for all backup-related object names 223 - --s3_backup_tls_skip_verify_cert skip the 'certificate is valid' check for SSL connections 224 - --sanitize_log_messages Remove potentially sensitive information in tablet INFO, WARNING, and ERROR log messages such as query parameters. 225 - --schema_change_check_interval int this value decides how often we check schema change dir, in seconds (default 60) 226 - --schema_change_controller string schema change controller is responsible for finding schema changes and responding to schema change events 227 - --schema_change_dir string directory contains schema changes for all keyspaces. Each keyspace has its own directory and schema changes are expected to live in '$KEYSPACE/input' dir. e.g. test_keyspace/input/*sql, each sql file represents a schema change 228 - --schema_change_replicas_timeout duration how long to wait for replicas to receive the schema change (default 10s) 229 - --schema_change_user string The user who submits this schema change. 230 + --s3_backup_aws_endpoint string endpoint of the S3 backend (region must be provided). 231 + --s3_backup_aws_region string AWS region to use. (default "us-east-1") 232 + --s3_backup_aws_retries int AWS request retries. (default -1) 233 + --s3_backup_force_path_style force the s3 path style. 234 + --s3_backup_log_level string determine the S3 loglevel to use from LogOff, LogDebug, LogDebugWithSigning, LogDebugWithHTTPBody, LogDebugWithRequestRetries, LogDebugWithRequestErrors. (default "LogOff") 235 + --s3_backup_server_side_encryption string server-side encryption algorithm (e.g., AES256, aws:kms, sse_c:/path/to/key/file). 236 + --s3_backup_storage_bucket string S3 bucket to use for backups. 237 + --s3_backup_storage_root string root prefix for all backup-related object names. 238 + --s3_backup_tls_skip_verify_cert skip the 'certificate is valid' check for SSL connections. 239 + --schema_change_check_interval duration How often the schema change dir is checked for schema changes (deprecated: if passed as a bare integer, the duration will be in seconds). (default 1m0s) 240 + --schema_change_controller string Schema change controller is responsible for finding schema changes and responding to schema change events. 241 + --schema_change_dir string Directory containing schema changes for all keyspaces. Each keyspace has its own directory, and schema changes are expected to live in '$KEYSPACE/input' dir. (e.g. 'test_keyspace/input/*sql'). Each sql file represents a schema change. 242 + --schema_change_replicas_timeout duration How long to wait for replicas to receive a schema change. (default 10s) 243 + --schema_change_user string The user who schema changes are submitted on behalf of. 244 --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) 245 - --service_map value comma separated list of services to enable (or disable if prefixed with '-') Example: grpc-vtworker 246 - --serving_state_grace_period duration how long to pause after broadcasting health to vtgate, before enforcing a new serving state 247 - --shutdown_grace_period float how long to wait (in seconds) for queries and transactions to complete during graceful shutdown. 248 + --service_map strings comma separated list of services to enable (or disable if prefixed with '-') Example: grpc-queryservice 249 --sql-max-length-errors int truncate queries in error logs to the given length (default unlimited) 250 --sql-max-length-ui int truncate queries in debug UIs to the given length (default 512) (default 512) 251 - --srv_topo_cache_refresh duration how frequently to refresh the topology for cached entries (default 1s) 252 - --srv_topo_cache_ttl duration how long to use cached entries for topology (default 1s) 253 - --srv_topo_timeout duration topo server timeout (default 5s) 254 --stats_backend string The name of the registered push-based monitoring/stats backend to use 255 --stats_combine_dimensions string List of dimensions to be combined into a single "all" value in exported stats vars 256 - --stats_common_tags string Comma-separated list of common tags for the stats backend. It provides both label and values. Example: label1:value1,label2:value2 257 + --stats_common_tags strings Comma-separated list of common tags for the stats backend. It provides both label and values. Example: label1:value1,label2:value2 258 --stats_drop_variables string Variables to be dropped from the list of exported variables. 259 --stats_emit_period duration Interval between emitting stats to all registered backends (default 1m0s) 260 - --stderrthreshold value logs at or above this threshold go to stderr (default 1) 261 + --stderrthreshold severity logs at or above this threshold go to stderr (default 1) 262 --tablet_dir string The directory within the vtdataroot to store vttablet/mysql files. Defaults to being generated by the tablet uid. 263 - --tablet_filters value Specifies a comma-separated list of 'keyspace|shard_name or keyrange' values to filter the tablets to watch 264 --tablet_grpc_ca string the server ca to use to validate servers when connecting 265 --tablet_grpc_cert string the cert to use to connect 266 --tablet_grpc_crl string the server crl to use to validate server certificates when connecting 267 @@ -226,24 +112,13 @@ Usage of vtctld: 268 --tablet_manager_grpc_crl string the server crl to use to validate server certificates when connecting 269 --tablet_manager_grpc_key string the key to use to connect 270 --tablet_manager_grpc_server_name string the server name to use to validate server certificate 271 - --tablet_manager_protocol string the protocol to use to talk to vttablet (default grpc) 272 - --tablet_protocol string how to talk to the vttablets (default grpc) 273 - --tablet_refresh_interval duration tablet refresh interval (default 1m0s) 274 - --tablet_refresh_known_tablets tablet refresh reloads the tablet address/port map from topo in case it changes (default true) 275 - --tablet_url_template string format string describing debug tablet url formatting. See the Go code for getTabletDebugURL() how to customize this. (default http://{{.GetTabletHostPort}}) 276 - --throttle_check_as_check_self Should throttler/check return a throttler/check-self result (changes throttler behavior for writes) 277 - --throttle_metrics_query SELECT Override default heartbeat/lag metric. Use either SELECT (must return single row, single value) or `SHOW GLOBAL ... LIKE ...` queries. Set -throttle_metrics_threshold respectively. 278 - --throttle_metrics_threshold float Override default throttle threshold, respective to -throttle_metrics_query (default 1.7976931348623157e+308) 279 - --throttle_tablet_types string Comma separated VTTablet types to be considered by the throttler. default: 'replica'. example: 'replica,rdonly'. 'replica' aways implicitly included (default replica) 280 - --throttle_threshold duration Replication lag threshold for default lag throttling (default 1s) 281 - --throttler_client_grpc_ca string the server ca to use to validate servers when connecting 282 - --throttler_client_grpc_cert string the cert to use to connect 283 - --throttler_client_grpc_crl string the server crl to use to validate server certificates when connecting 284 - --throttler_client_grpc_key string the key to use to connect 285 - --throttler_client_grpc_server_name string the server name to use to validate server certificate 286 - --throttler_client_protocol string the protocol to use to talk to the integrated throttler service (default grpc) 287 + --tablet_manager_protocol string Protocol to use to make tabletmanager RPCs to vttablets. (default "grpc") 288 + --tablet_protocol string Protocol to use to make queryservice RPCs to vttablets. (default "grpc") 289 + --tablet_refresh_interval duration Tablet refresh interval. (default 1m0s) 290 + --tablet_refresh_known_tablets Whether to reload the tablet's address/port map from topo in case they change. (default true) 291 + --tablet_url_template string Format string describing debug tablet url formatting. See getTabletDebugURL() for how to customize this. (default "http://{{.GetTabletHostPort}}") 292 --topo_consul_lock_delay duration LockDelay for consul session. (default 15s) 293 - --topo_consul_lock_session_checks string List of checks for consul session. (default serfHealth) 294 + --topo_consul_lock_session_checks string List of checks for consul session. (default "serfHealth") 295 --topo_consul_lock_session_ttl string TTL for consul session. 296 --topo_consul_watch_poll_duration duration time of the long poll for watch queries. (default 30s) 297 --topo_etcd_lease_ttl int Lease TTL for locks and leader election. The client will use KeepAlive to keep the lease going. (default 30) 298 @@ -256,106 +131,22 @@ Usage of vtctld: 299 --topo_k8s_context string The kubeconfig context to use, overrides the 'current-context' from the config 300 --topo_k8s_kubeconfig string Path to a valid kubeconfig file. When running as a k8s pod inside the same cluster you wish to use as the topo, you may omit this and the below arguments, and Vitess is capable of auto-discovering the correct values. https://kubernetes.io/docs/tasks/access-application-cluster/access-cluster/#accessing-the-api-from-a-pod 301 --topo_k8s_namespace string The kubernetes namespace to use for all objects. Default comes from the context or in-cluster config 302 - --topo_read_concurrency int concurrent topo reads (default 32) 303 + --topo_read_concurrency int Concurrency of topo reads. (default 32) 304 --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 305 --topo_zk_base_timeout duration zk base timeout (see zk.Connect) (default 30s) 306 --topo_zk_max_concurrency int maximum number of pending requests to send to a Zookeeper server. (default 64) 307 --topo_zk_tls_ca string the server ca to use to validate servers when connecting to the zk topo server 308 --topo_zk_tls_cert string the cert to use to connect to the zk topo server, requires topo_zk_tls_key, enables TLS 309 --topo_zk_tls_key string the key to use to connect to the zk topo server, enables TLS 310 - --tracer string tracing service to use (default noop) 311 + --tracer string tracing service to use (default "noop") 312 --tracing-enable-logging whether to enable logging in the tracing service 313 - --tracing-sampling-rate value sampling rate for the probabilistic jaeger sampler (default 0.1) 314 - --tracing-sampling-type value sampling strategy to use for jaeger. possible values are 'const', 'probabilistic', 'rateLimiting', or 'remote' (default const) 315 - --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 316 - --transaction-log-stream-handler string URL handler for streaming transactions log (default /debug/txlog) 317 - --transaction_limit_by_component Include CallerID.component when considering who the user is for the purpose of transaction limit. 318 - --transaction_limit_by_principal Include CallerID.principal when considering who the user is for the purpose of transaction limit. (default true) 319 - --transaction_limit_by_subcomponent Include CallerID.subcomponent when considering who the user is for the purpose of transaction limit. 320 - --transaction_limit_by_username Include VTGateCallerID.username when considering who the user is for the purpose of transaction limit. (default true) 321 - --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) 322 - --transaction_shutdown_grace_period float DEPRECATED: use shutdown_grace_period instead. 323 - --twopc_abandon_age float time in seconds. Any unresolved transaction older than this time will be sent to the coordinator to be resolved. 324 - --twopc_coordinator_address string address of the (VTGate) process(es) that will be used to notify of abandoned transactions. 325 - --twopc_enable if the flag is on, 2pc is enabled. Other 2pc flags must be supplied. 326 - --tx-throttler-config string Synonym to -tx_throttler_config (default target_replication_lag_sec: 2 327 -max_replication_lag_sec: 10 328 -initial_rate: 100 329 -max_increase: 1 330 -emergency_decrease: 0.5 331 -min_duration_between_increases_sec: 40 332 -max_duration_between_increases_sec: 62 333 -min_duration_between_decreases_sec: 20 334 -spread_backlog_across_sec: 20 335 -age_bad_rate_after_sec: 180 336 -bad_rate_increase: 0.1 337 -max_rate_approach_threshold: 0.9 338 -) 339 - --tx-throttler-healthcheck-cells value Synonym to -tx_throttler_healthcheck_cells 340 - --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 341 -max_replication_lag_sec: 10 342 -initial_rate: 100 343 -max_increase: 1 344 -emergency_decrease: 0.5 345 -min_duration_between_increases_sec: 40 346 -max_duration_between_increases_sec: 62 347 -min_duration_between_decreases_sec: 20 348 -spread_backlog_across_sec: 20 349 -age_bad_rate_after_sec: 180 350 -bad_rate_increase: 0.1 351 -max_rate_approach_threshold: 0.9 352 -) 353 - --tx_throttler_healthcheck_cells value A comma-separated list of cells. Only tabletservers running in these cells will be monitored for replication lag by the transaction throttler. 354 - --unhealthy_threshold duration replication lag after which a replica is considered unhealthy (default 2h0m0s) 355 - --v value log level for V logs 356 - --version print binary version 357 - --vmodule value comma-separated list of pattern=N settings for file-filtered logging 358 - --vreplication_copy_phase_duration duration Duration for each copy phase loop (before running the next catchup: default 1h) (default 1h0m0s) 359 - --vreplication_copy_phase_max_innodb_history_list_length int The maximum InnoDB transaction history that can exist on a vstreamer (source) before starting another round of copying rows. This helps to limit the impact on the source tablet. (default 1000000) 360 - --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) 361 - --vreplication_experimental_flags int (Bitmask) of experimental features in vreplication to enable (default 1) 362 - --vreplication_healthcheck_retry_delay duration healthcheck retry delay (default 5s) 363 - --vreplication_healthcheck_timeout duration healthcheck retry delay (default 1m0s) 364 - --vreplication_healthcheck_topology_refresh duration refresh interval for re-reading the topology (default 30s) 365 - --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) 366 - --vreplication_max_time_to_retry_on_error duration stop automatically retrying when we've had consecutive failures with the same error for this long after the first occurrence (default 15m0s) 367 - --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) 368 - --vreplication_retry_delay duration delay before retrying a failed workflow event in the replication phase (default 5s) 369 - --vreplication_store_compressed_gtid Store compressed gtids in the pos column of _vt.vreplication 370 - --vreplication_tablet_type string comma separated list of tablet types used as a source (default in_order:REPLICA,PRIMARY) 371 - --vstream_dynamic_packet_size Enable dynamic packet sizing for VReplication. This will adjust the packet size during replication to improve performance. (default true) 372 - --vstream_packet_size int Suggested packet size for VReplication streamer. This is used only as a recommendation. The actual packet size may be more or less than this amount. (default 250000) 373 - --vtctl_client_protocol string the protocol to use to talk to the vtctl server (default grpc) 374 + --tracing-sampling-rate float sampling rate for the probabilistic jaeger sampler (default 0.1) 375 + --tracing-sampling-type string sampling strategy to use for jaeger. possible values are 'const', 'probabilistic', 'rateLimiting', or 'remote' (default "const") 376 + --v Level log level for V logs 377 + -v, --version print binary version 378 + --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging 379 --vtctl_healthcheck_retry_delay duration delay before retrying a failed healthcheck (default 5s) 380 --vtctl_healthcheck_timeout duration the health check timeout period (default 1m0s) 381 --vtctl_healthcheck_topology_refresh duration refresh interval for re-reading the topology (default 30s) 382 --vtctld_sanitize_log_messages When true, vtctld sanitizes logging. 383 --vtctld_show_topology_crud Controls the display of the CRUD topology actions in the vtctld UI. (default true) 384 - --vtgate_grpc_ca string the server ca to use to validate servers when connecting 385 - --vtgate_grpc_cert string the cert to use to connect 386 - --vtgate_grpc_crl string the server crl to use to validate server certificates when connecting 387 - --vtgate_grpc_key string the key to use to connect 388 - --vtgate_grpc_server_name string the server name to use to validate server certificate 389 - --vtgate_protocol string how to talk to vtgate (default grpc) 390 - --vtworker_client_grpc_ca string (DEPRECATED) the server ca to use to validate servers when connecting 391 - --vtworker_client_grpc_cert string (DEPRECATED) the cert to use to connect 392 - --vtworker_client_grpc_crl string (DEPRECATED) the server crl to use to validate server certificates when connecting 393 - --vtworker_client_grpc_key string (DEPRECATED) the key to use to connect 394 - --vtworker_client_grpc_server_name string (DEPRECATED) the server name to use to validate server certificate 395 - --vtworker_client_protocol string (DEPRECATED) the protocol to use to talk to the vtworker server (default grpc) 396 - --wait_for_drain_sleep_rdonly duration (DEPRECATED) time to wait before shutting the query service on old RDONLY tablets during MigrateServedTypes (default 5s) 397 - --wait_for_drain_sleep_replica duration (DEPRECATED) time to wait before shutting the query service on old REPLICA tablets during MigrateServedTypes (default 15s) 398 - --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. 399 - --web_dir string NOT USED, here for backward compatibility 400 - --web_dir2 string NOT USED, here for backward compatibility 401 - --workflow_manager_disable value comma separated list of workflow types to disable 402 - --workflow_manager_init Initialize the workflow manager in this vtctld instance. 403 - --workflow_manager_use_election if specified, will use a topology server-based master election to ensure only one workflow manager is active at a time. 404 - --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 405 - --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 406 - --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 407 - --xtrabackup_root_path string directory location of the xtrabackup and xbstream executables, e.g., /usr/bin 408 - --xtrabackup_stream_mode string which mode to use if streaming, valid values are tar and xbstream (default tar) 409 - --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) 410 - --xtrabackup_stripes uint If greater than 0, use data striping across this many destination files to parallelize data transfer and decompression 411 - --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.